P2-04.5: kill host.default_paths in favour of manual schedules
CI / Test (linux/amd64) (push) Has been cancelled
CI / Lint (push) Has been cancelled
CI / Build (windows/amd64) (push) Has been cancelled
CI / Build (linux/amd64) (push) Has been cancelled
CI / Build (linux/arm64) (push) Has been cancelled

Two independent path lists for "what does this host back up?" was
a real divergence footgun — operator types one set at Add-host time
and a different set into a schedule, both end up in the same repo,
the snapshot history looks fine until restore. Resolution: drop
host.default_paths entirely; add a `manual` flag on schedules.
A manual schedule has paths/excludes/tags/retention like any other
but no cron — it fires only via per-schedule Run-now. Single source
of truth for what gets backed up.

Schema (migration 0007):
* schedules.manual INTEGER NOT NULL DEFAULT 0.
* For every host with non-empty default_paths, seed a manual
  schedule with those paths and bump host_schedule_version.
* ALTER TABLE hosts DROP COLUMN default_paths.
* ALTER TABLE enrollment_tokens RENAME COLUMN default_paths
  TO initial_paths.

Original draft of this migration rebuilt hosts via the
create-new + drop-old + rename-new pattern. With foreign_keys=ON
(set in the connection DSN), DROP TABLE on the parent fired
ON DELETE CASCADE on every child of hosts(id) — schedules /
jobs / snapshots / host_credentials all wiped on the smoke env
when I tried it. SQLite 3.35+ supports column-level ALTERs
directly, so we skip the rebuild dance and avoid the cascade
trap. Six lines of SQL instead of sixty, no FK risk.

Run-now rewiring:
* New `dispatchScheduleNow(hostID, scheduleID, conn?)` helper
  unifies the agent-driven path (cron fire → schedule.fire →
  OnScheduleFire callback) and the UI-driven path (operator
  clicks Run-now on a schedule row). Conn arg is optional; nil
  falls back to Hub.Send.
* New POST /hosts/{id}/schedules/{sid}/run endpoint — per-row
  Run-now button on the schedules list.
* Dashboard's per-host Run-now (handleUIRunBackup) now picks the
  host's only enabled manual schedule, falls back to the only
  enabled schedule, else returns "pick one in Schedules tab".
  Keeps one-click for the common case.

Agent:
* Scheduler skips manual schedules in cron build (silent — they're
  a normal data shape, not an error).
* Wire Schedule struct gains Manual flag.
* Schedule.fire flow unchanged — the agent only ever fires
  non-manual schedules anyway.

UI:
* Add-host form retitled "Initial schedule · manual" so the
  operator knows the paths become an editable schedule under
  the Schedules tab. Result page calls out the manual schedule
  + points at Host > Schedules.
* Schedule edit form: "Manual schedule" checkbox at the top of
  the When section; toggling it hides/shows the cron field via
  inline JS. Server-side validator skips the cron requirement
  when manual=true.
* Schedule list shows a "manual" tag under the status pill and
  renders the When column as "— run-now only —" for manual rows.
  Each row gets a Run-now button when the schedule is enabled
  and the host is online.

Tests + go test ./... green.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
2026-05-02 12:26:06 +01:00
parent 160d788bae
commit 148e61b33b
18 changed files with 327 additions and 132 deletions
+18 -18
View File
@@ -19,26 +19,25 @@ import (
// later via PUT /api/hosts/{id}/repo-credentials; the agent will
// refuse backup jobs until that lands.
//
// defaultPaths is the JSON-encoded path list (the agent invokes
// `restic backup` with these on a run-now without explicit paths).
// Empty string is treated as "[]". Not encrypted — paths aren't
// secret.
func (s *Store) CreateEnrollmentToken(ctx context.Context, tokenHash string, ttl time.Duration, encRepoCreds, defaultPaths string) error {
// initialPaths is the JSON-encoded path list seeded into the host's
// initial manual schedule on consume. Empty string is treated as
// "[]". Not encrypted — paths aren't secret.
func (s *Store) CreateEnrollmentToken(ctx context.Context, tokenHash string, ttl time.Duration, encRepoCreds, initialPaths string) error {
now := time.Now().UTC()
var enc any = nil
if encRepoCreds != "" {
enc = encRepoCreds
}
if defaultPaths == "" {
defaultPaths = "[]"
if initialPaths == "" {
initialPaths = "[]"
}
_, err := s.db.ExecContext(ctx,
`INSERT INTO enrollment_tokens (token_hash, created_at, expires_at, enc_repo_creds, default_paths)
`INSERT INTO enrollment_tokens (token_hash, created_at, expires_at, enc_repo_creds, initial_paths)
VALUES (?, ?, ?, ?, ?)`,
tokenHash,
now.Format(time.RFC3339Nano),
now.Add(ttl).Format(time.RFC3339Nano),
enc, defaultPaths)
enc, initialPaths)
if err != nil {
return fmt.Errorf("store: create enrollment token: %w", err)
}
@@ -77,9 +76,10 @@ type EnrollmentTokenAttachments struct {
// EncRepoCreds is the AEAD ciphertext bound (additional-data) to
// "token:" + token_hash. Empty if no creds were stashed.
EncRepoCreds string
// DefaultPaths is the operator's run-now path list. Always
// non-nil (empty slice if none were set).
DefaultPaths []string
// InitialPaths is the operator-supplied path list seeded into
// the host's initial manual schedule. Always non-nil (empty
// slice if none were set).
InitialPaths []string
}
// GetEnrollmentTokenAttachments returns the operator-supplied
@@ -93,25 +93,25 @@ type EnrollmentTokenAttachments struct {
func (s *Store) GetEnrollmentTokenAttachments(ctx context.Context, tokenHash string) (EnrollmentTokenAttachments, error) {
now := time.Now().UTC().Format(time.RFC3339Nano)
row := s.db.QueryRowContext(ctx,
`SELECT enc_repo_creds, default_paths FROM enrollment_tokens
`SELECT enc_repo_creds, initial_paths FROM enrollment_tokens
WHERE token_hash = ? AND consumed_at IS NULL AND expires_at > ?`,
tokenHash, now)
var (
enc sql.NullString
defaultPaths string
initialPaths string
)
if err := row.Scan(&enc, &defaultPaths); err != nil {
if err := row.Scan(&enc, &initialPaths); err != nil {
if errors.Is(err, sql.ErrNoRows) {
return EnrollmentTokenAttachments{}, ErrNotFound
}
return EnrollmentTokenAttachments{}, fmt.Errorf("store: get enrollment token attachments: %w", err)
}
out := EnrollmentTokenAttachments{DefaultPaths: []string{}}
out := EnrollmentTokenAttachments{InitialPaths: []string{}}
if enc.Valid {
out.EncRepoCreds = enc.String
}
if defaultPaths != "" {
_ = json.Unmarshal([]byte(defaultPaths), &out.DefaultPaths)
if initialPaths != "" {
_ = json.Unmarshal([]byte(initialPaths), &out.InitialPaths)
}
return out, nil
}
+7 -19
View File
@@ -17,25 +17,17 @@ func (s *Store) CreateHost(ctx context.Context, h Host, agentTokenHash, certPinS
if err != nil {
return fmt.Errorf("store: marshal tags: %w", err)
}
if h.DefaultPaths == nil {
h.DefaultPaths = []string{}
}
defaultPaths, err := json.Marshal(h.DefaultPaths)
if err != nil {
return fmt.Errorf("store: marshal default_paths: %w", err)
}
_, err = s.db.ExecContext(ctx,
`INSERT INTO hosts (
id, name, os, arch, agent_version, restic_version, protocol_version,
enrolled_at, status, tags,
agent_token_hash, cert_pin_sha256, default_paths
) VALUES (?, ?, ?, ?, ?, ?, ?, ?, 'offline', ?, ?, ?, ?)`,
agent_token_hash, cert_pin_sha256
) VALUES (?, ?, ?, ?, ?, ?, ?, ?, 'offline', ?, ?, ?)`,
h.ID, h.Name, h.OS, h.Arch,
h.AgentVersion, h.ResticVersion, h.ProtocolVersion,
h.EnrolledAt.UTC().Format(time.RFC3339Nano),
string(tags),
agentTokenHash, certPinSHA256,
string(defaultPaths))
agentTokenHash, certPinSHA256)
if err != nil {
return fmt.Errorf("store: create host: %w", err)
}
@@ -50,7 +42,7 @@ func (s *Store) LookupHostByAgentToken(ctx context.Context, tokenHash string) (*
enrolled_at, last_seen_at, status, repo_id, tags,
current_job_id, last_backup_at, last_backup_status,
repo_size_bytes, snapshot_count, open_alert_count,
applied_schedule_version, default_paths, repo_initialised_at
applied_schedule_version, repo_initialised_at
FROM hosts WHERE agent_token_hash = ?`,
tokenHash)
return scanHost(row)
@@ -63,7 +55,7 @@ func (s *Store) GetHost(ctx context.Context, id string) (*Host, error) {
enrolled_at, last_seen_at, status, repo_id, tags,
current_job_id, last_backup_at, last_backup_status,
repo_size_bytes, snapshot_count, open_alert_count,
applied_schedule_version, default_paths, repo_initialised_at
applied_schedule_version, repo_initialised_at
FROM hosts WHERE id = ?`, id)
return scanHost(row)
}
@@ -124,7 +116,7 @@ func (s *Store) ListHosts(ctx context.Context) ([]Host, error) {
enrolled_at, last_seen_at, status, repo_id, tags,
current_job_id, last_backup_at, last_backup_status,
repo_size_bytes, snapshot_count, open_alert_count,
applied_schedule_version, default_paths, repo_initialised_at
applied_schedule_version, repo_initialised_at
FROM hosts ORDER BY name`)
if err != nil {
return nil, fmt.Errorf("store: list hosts: %w", err)
@@ -162,7 +154,6 @@ func scanHostRow(s hostScanner) (*Host, error) {
repoID, currentJob, lastBkSt sql.NullString
enrolled string
tags string
defaultPaths string
repoInitAt sql.NullString
)
err := s.Scan(&h.ID, &h.Name, &h.OS, &h.Arch,
@@ -170,7 +161,7 @@ func scanHostRow(s hostScanner) (*Host, error) {
&enrolled, &lastSeen, &h.Status, &repoID, &tags,
&currentJob, &lastBackupAt, &lastBkSt,
&h.RepoSizeBytes, &h.SnapshotCount, &h.OpenAlertCount,
&h.AppliedScheduleVersion, &defaultPaths, &repoInitAt)
&h.AppliedScheduleVersion, &repoInitAt)
if err != nil {
if errors.Is(err, sql.ErrNoRows) {
return nil, ErrNotFound
@@ -211,9 +202,6 @@ func scanHostRow(s hostScanner) (*Host, error) {
if tags != "" {
_ = json.Unmarshal([]byte(tags), &h.Tags)
}
if defaultPaths != "" {
_ = json.Unmarshal([]byte(defaultPaths), &h.DefaultPaths)
}
if repoInitAt.Valid {
t, err := time.Parse(time.RFC3339Nano, repoInitAt.String)
if err != nil {
@@ -0,0 +1,53 @@
-- 0007_manual_schedules.sql
--
-- Unify "what does this host back up?" under schedules. Drop the
-- legacy host.default_paths column in favour of a `manual` flag on
-- schedules: a manual schedule carries paths/excludes/tags/retention
-- like any other but has no cron expression — it only fires when
-- the operator clicks Run-now.
--
-- Steps (each is a single ALTER, no table rebuilds):
-- 1. Add schedules.manual.
-- 2. For every host with non-empty default_paths, create a manual
-- schedule seeded with those paths and bump host_schedule_version
-- so the next push reaches the agent.
-- 3. ALTER TABLE hosts DROP COLUMN default_paths.
-- 4. ALTER TABLE enrollment_tokens RENAME COLUMN default_paths
-- TO initial_paths.
--
-- The earlier draft of this migration rebuilt hosts via the
-- create-new + drop-old + rename pattern. With foreign_keys=ON
-- (which the connection DSN sets), DROP TABLE on the parent
-- triggered ON DELETE CASCADE on every child of hosts(id) — the
-- smoke env lost schedules / jobs / snapshots / host_credentials
-- as a result. SQLite 3.35+ supports column-level ALTERs, so we
-- skip the rebuild entirely and avoid the cascade trap.
ALTER TABLE schedules ADD COLUMN manual INTEGER NOT NULL DEFAULT 0;
INSERT INTO schedules (
id, host_id, kind, cron_expr,
paths, excludes, tags, retention_policy, options,
pre_hook, post_hook, enabled, manual, created_at, updated_at
)
SELECT
lower(hex(randomblob(13))),
id, 'backup', '',
default_paths, '[]', '[]', '{}', '{}',
'', '', 1, 1,
strftime('%Y-%m-%dT%H:%M:%fZ', 'now'),
strftime('%Y-%m-%dT%H:%M:%fZ', 'now')
FROM hosts
WHERE default_paths IS NOT NULL
AND default_paths != ''
AND default_paths != '[]';
INSERT INTO host_schedule_version (host_id, version)
SELECT id, 1 FROM hosts
WHERE default_paths IS NOT NULL
AND default_paths != ''
AND default_paths != '[]'
ON CONFLICT(host_id) DO UPDATE SET version = version + 1;
ALTER TABLE hosts DROP COLUMN default_paths;
ALTER TABLE enrollment_tokens RENAME COLUMN default_paths TO initial_paths;
+10 -9
View File
@@ -43,13 +43,13 @@ func (st *Store) CreateSchedule(ctx context.Context, s *Schedule) error {
if _, err := tx.ExecContext(ctx,
`INSERT INTO schedules (
id, host_id, kind, cron_expr, paths, excludes, tags,
retention_policy, options, pre_hook, post_hook, enabled,
retention_policy, options, pre_hook, post_hook, enabled, manual,
created_at, updated_at
) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)`,
) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)`,
s.ID, s.HostID, s.Kind, s.CronExpr,
string(pathsJSON), string(excludesJSON), string(tagsJSON),
string(retentionJSON), string(optionsJSON),
s.PreHook, s.PostHook, boolToInt(s.Enabled),
s.PreHook, s.PostHook, boolToInt(s.Enabled), boolToInt(s.Manual),
now.Format(time.RFC3339Nano), now.Format(time.RFC3339Nano),
); err != nil {
return fmt.Errorf("store: create schedule: %w", err)
@@ -94,13 +94,13 @@ func (st *Store) UpdateSchedule(ctx context.Context, s *Schedule) error {
`UPDATE schedules SET
cron_expr = ?, paths = ?, excludes = ?, tags = ?,
retention_policy = ?, options = ?,
pre_hook = ?, post_hook = ?, enabled = ?,
pre_hook = ?, post_hook = ?, enabled = ?, manual = ?,
updated_at = ?
WHERE id = ? AND host_id = ?`,
s.CronExpr,
string(pathsJSON), string(excludesJSON), string(tagsJSON),
string(retentionJSON), string(optionsJSON),
s.PreHook, s.PostHook, boolToInt(s.Enabled),
s.PreHook, s.PostHook, boolToInt(s.Enabled), boolToInt(s.Manual),
now.Format(time.RFC3339Nano),
s.ID, s.HostID,
)
@@ -148,7 +148,7 @@ func (st *Store) DeleteSchedule(ctx context.Context, hostID, scheduleID string)
func (st *Store) GetSchedule(ctx context.Context, hostID, scheduleID string) (*Schedule, error) {
row := st.db.QueryRowContext(ctx,
`SELECT id, host_id, kind, cron_expr, paths, excludes, tags,
retention_policy, options, pre_hook, post_hook, enabled,
retention_policy, options, pre_hook, post_hook, enabled, manual,
created_at, updated_at
FROM schedules WHERE id = ? AND host_id = ?`,
scheduleID, hostID)
@@ -164,7 +164,7 @@ func (st *Store) GetSchedule(ctx context.Context, hostID, scheduleID string) (*S
func (st *Store) ListSchedulesByHost(ctx context.Context, hostID string) ([]Schedule, error) {
rows, err := st.db.QueryContext(ctx,
`SELECT id, host_id, kind, cron_expr, paths, excludes, tags,
retention_policy, options, pre_hook, post_hook, enabled,
retention_policy, options, pre_hook, post_hook, enabled, manual,
created_at, updated_at
FROM schedules WHERE host_id = ? ORDER BY created_at`,
hostID)
@@ -238,11 +238,11 @@ func scanScheduleRow(s scheduleScanner) (*Schedule, error) {
out Schedule
paths, excludes, tags, retention, options string
createdAt, updatedAt string
enabled int
enabled, manual int
)
err := s.Scan(&out.ID, &out.HostID, &out.Kind, &out.CronExpr,
&paths, &excludes, &tags, &retention, &options,
&out.PreHook, &out.PostHook, &enabled,
&out.PreHook, &out.PostHook, &enabled, &manual,
&createdAt, &updatedAt)
if err != nil {
return nil, err
@@ -263,6 +263,7 @@ func scanScheduleRow(s scheduleScanner) (*Schedule, error) {
_ = json.Unmarshal([]byte(options), &out.Options)
}
out.Enabled = enabled != 0
out.Manual = manual != 0
if t, err := time.Parse(time.RFC3339Nano, createdAt); err == nil {
out.CreatedAt = t
}
+6 -4
View File
@@ -60,10 +60,6 @@ type Host struct {
SnapshotCount int
OpenAlertCount int
AppliedScheduleVersion int64
// DefaultPaths is what `restic backup` is invoked with when an
// operator hits "Run now" without supplying paths. Phase 1
// interim — schedules (P2-01) supersede this.
DefaultPaths []string
// RepoInitialisedAt is non-nil once we've confirmed the host's
// repo has been initialised — either the operator clicked the
// init button, or a backup succeeded, or snapshots.report came
@@ -90,6 +86,12 @@ type Schedule struct {
PreHook string
PostHook string
Enabled bool
// Manual schedules carry paths/excludes/tags/retention like any
// other but have no cron — they only fire when the operator
// clicks Run-now. Lets us keep one data shape for "what gets
// backed up" without forcing every host to have an automated
// schedule. Created by Add-host with the typed paths.
Manual bool
CreatedAt time.Time
UpdatedAt time.Time
}