kanade_shared/manifest.rs
1use serde::{Deserialize, Serialize};
2
3use crate::ipc::jobs::JobCategory;
4use crate::wire::{RunAs, Shell, Staleness};
5
6/// YAML job manifest (= registered "what to run", v0.18.0+).
7///
8/// Owns only script-intrinsic fields. **Who** (`target`), **how to
9/// phase fanout** (`rollout`), and **when to stagger start**
10/// (`jitter`) all moved to the Schedule / exec request side — same
11/// script can now be fired against different targets / rollouts
12/// without copying the script body.
13///
14/// #492: these types are READ fleet-wide (agents decode them from
15/// BUCKET_JOBS / BUCKET_SCHEDULES and inside live Commands), so they
16/// must tolerate unknown fields — `deny_unknown_fields` here made a
17/// gradually-upgrading fleet's OLD agents reject the whole object
18/// the moment a newer backend added any field. Operator typo
19/// protection (the old reason for the attribute) lives at the WRITE
20/// boundaries instead: `kanade job/schedule create` and the backend
21/// POST extractor parse via [`crate::strict`], which rejects unknown
22/// keys with their full paths. The wire rule: new fields always get
23/// `#[serde(default)]` (+ `skip_serializing_if` while old readers
24/// may still be strict).
25#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone)]
26pub struct Manifest {
27 pub id: String,
28 pub version: String,
29 #[serde(default)]
30 pub description: Option<String>,
31 pub execute: Execute,
32 #[serde(default)]
33 pub require_approval: bool,
34 /// Opt-in marker that this job produces a JSON inventory fact
35 /// payload on stdout. When present, the backend's results
36 /// projector parses `ExecResult.stdout` as JSON and upserts an
37 /// `inventory_facts` row keyed by `(pc_id, manifest.id)`. The
38 /// `display` sub-config drives the SPA's Inventory page render.
39 #[serde(default)]
40 pub inventory: Option<InventoryHint>,
41 /// Issue #246: opt-in marker that this job emits per-line
42 /// observability events on stdout (one JSON `ObsEvent` per
43 /// newline). When present, the agent — after the script exits
44 /// successfully — parses each non-empty stdout line as an
45 /// `ObsEvent`, publishes it on `obs.<pc_id>` via the
46 /// `obs_outbox`, and (intentionally) **omits the stdout from
47 /// the `ExecResult`** so the timeline data doesn't double up
48 /// in `execution_results.stdout` (which would multiply rows
49 /// by ~50/day/PC of noise).
50 ///
51 /// Distinct from `inventory:` (single JSON object → projector
52 /// upsert) — events are append-only timeline points consumed
53 /// by the dedicated `obs_events` table.
54 #[serde(default)]
55 pub emit: Option<EmitConfig>,
56 /// #290: opt-in marker that this job is an operator-defined
57 /// **health check** whose result feeds the Client App's Health
58 /// tab over KLP (`StateSnapshot.checks`). The script prints a
59 /// free-form JSON object on stdout (like any inventory job); the
60 /// agent reads the [`CheckHint::status_field`] value dynamically
61 /// into a [`crate::ipc::state::Check`] named `check.name`.
62 /// Cadence / windows / conditions come from
63 /// the job's Schedule (exactly like inventory) — there is
64 /// deliberately no interval here. **Composes with `inventory:`**:
65 /// the script's stdout is one JSON object, so a check can also
66 /// carry an `inventory:` block to project the rest of that object
67 /// (incl. `explode` sub-tables) for SPA fleet-querying. Only
68 /// `emit:` (NDJSON stdout) is incompatible.
69 #[serde(default)]
70 pub check: Option<CheckHint>,
71 /// v0.26: Layer 2 staleness policy (SPEC.md §2.6.2). Controls
72 /// what the agent does at fire time when it can't verify the
73 /// `script_current` / `script_status` KV values are fresh —
74 /// especially relevant for `runs_on: agent` schedules where
75 /// the agent may fire from cache while offline. Defaults to
76 /// `Staleness::Cached` (silently use cached values), which
77 /// matches every pre-v0.26 Manifest.
78 #[serde(default)]
79 pub staleness: Staleness,
80 /// #291: opt-in marker that this job is offered to **end users**
81 /// in the Client App's job tabs over KLP (`jobs.list` →
82 /// `jobs.execute`). Parallel to [`inventory`] / [`check`] /
83 /// [`emit`]: the block's mere presence is the opt-in, and it
84 /// groups the end-user presentation fields (name / category /
85 /// icon) that only make sense for a user-facing job. `None`
86 /// (the default) ⇒ an operator-only job — inventory, checks,
87 /// scheduled maintenance — that never surfaces in the catalog.
88 ///
89 /// The agent re-reads this at every `jobs.list` / `jobs.execute`
90 /// (SPEC §2.1), so removing the block takes a job out of a
91 /// running client on its next action.
92 ///
93 /// [`inventory`]: Manifest::inventory
94 /// [`check`]: Manifest::check
95 /// [`emit`]: Manifest::emit
96 #[serde(default, skip_serializing_if = "Option::is_none")]
97 pub client: Option<ClientHint>,
98}
99
100/// "Who + how + when-to-stagger" — the fanout-plan side of an exec.
101/// Used both as the POST `/api/exec/{job_id}` body and as the embedded
102/// `target` / `rollout` / `jitter` slot on [`Schedule`]. Centralising
103/// here keeps the validation + serialisation logic in one place.
104#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone, Default)]
105pub struct FanoutPlan {
106 #[serde(default)]
107 pub target: Target,
108 /// Optional wave rollout — when present, the backend publishes
109 /// each wave's group subject on its own delay schedule instead
110 /// of fanning out the `target` block in one go. `target` then
111 /// only labels the deploy for the audit log.
112 #[serde(default, skip_serializing_if = "Option::is_none")]
113 pub rollout: Option<Rollout>,
114 /// Optional humantime jitter; agent uses it to randomise
115 /// execution start. Lives here (not on the script) so different
116 /// schedules / ad-hoc fires of the same job can pick different
117 /// stagger windows.
118 #[serde(default, skip_serializing_if = "Option::is_none")]
119 pub jitter: Option<String>,
120 /// Absolute time the scheduler stamps on each emitted Command
121 /// when this exec was driven by a [`Schedule`] with
122 /// `starting_deadline`. Agents receiving a Command after this
123 /// instant publish a synthetic skipped-result instead of
124 /// running the script. `None` (default) = no deadline / catch
125 /// up whenever delivered. Operators don't usually set this
126 /// directly — the scheduler computes it from `tick_at +
127 /// starting_deadline`.
128 #[serde(default, skip_serializing_if = "Option::is_none")]
129 pub deadline_at: Option<chrono::DateTime<chrono::Utc>>,
130}
131
132/// Manifest sub-section: how the SPA should render the inventory
133/// facts this job produces. Each field name (`field`) is a top-level
134/// key in the stdout JSON, e.g. `hostname`, `ram_gb`.
135///
136/// Two render modes:
137/// * `display` — vertical "field / value" per PC, used by the
138/// `/inventory?pc=<id>` detail view. ALL columns the operator
139/// wants visible on the detail page.
140/// * `summary` — horizontal table across the fleet (row = PC,
141/// column = field) on `/inventory`. Optional; when omitted the
142/// SPA falls back to `display`, but operators usually want a
143/// trimmer "hostname / OS / CPU / RAM" set for the fleet view.
144#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone)]
145pub struct InventoryHint {
146 /// Detail-view columns, in order.
147 pub display: Vec<DisplayField>,
148 /// Optional fleet-list columns (row = PC). Defaults to `display`
149 /// when omitted, but operators usually pick a 3-5 column subset.
150 #[serde(default, skip_serializing_if = "Option::is_none")]
151 pub summary: Option<Vec<DisplayField>>,
152 /// v0.31 / #40: payload arrays that should be exploded into
153 /// per-element rows of a derived SQLite table. Lets operators
154 /// answer cross-PC questions ("which PCs still have Chrome <
155 /// 120?", "C: >90% full") with normal SQL filters + indexes
156 /// instead of grepping JSON. The projector creates the derived
157 /// table on register and replaces this PC's rows on each result
158 /// (DELETE WHERE pc_id=? AND job_id=? + bulk INSERT). See
159 /// [`ExplodeSpec`] for the per-spec schema.
160 #[serde(default, skip_serializing_if = "Option::is_none")]
161 pub explode: Option<Vec<ExplodeSpec>>,
162 /// v0.35 / #93: top-level scalar fields whose changes the
163 /// projector logs to `inventory_history` (one event per
164 /// changed field per scan). Pairs with `explode[].track_history`
165 /// — that covers array elements; this covers single-valued
166 /// fields like `ram_bytes` / `os_version` / `cpu_model` /
167 /// `os_build` that operators want to track for "did the RAM
168 /// get upgraded?" / "when did Win 11 land on this PC?" /
169 /// "BIOS / firmware bumped?" questions. Field name = `field_path`
170 /// in the history row, `identity_json` is NULL, `before_json`
171 /// / `after_json` each carry `{"value": <prior or new value>}`.
172 /// First-ever observation of a scalar (no prior facts row)
173 /// emits `added`; subsequent value changes emit `changed`. No
174 /// `removed` events — a scalar disappearing from the payload
175 /// is rare and the operator can still see the last value via
176 /// the `before_json` of the most recent change.
177 #[serde(default, skip_serializing_if = "Option::is_none")]
178 pub history_scalars: Option<Vec<String>>,
179}
180
181/// Manifest sub-section (#290): marks a job as an operator-defined
182/// **health check**. Parallel to [`InventoryHint`] / `EmitConfig`.
183/// The stdout contract is a free-form JSON object (same as any
184/// inventory job) from which the agent reads `status_field` /
185/// `detail_field` to build the KLP [`crate::ipc::state::Check`] shown
186/// on the Client App's Health tab.
187///
188/// There is deliberately **no timing field** — when / how often /
189/// in which window a check runs is driven by the job's Schedule,
190/// exactly like inventory jobs, so operators get the full `when:` /
191/// rollout / `runs_on` expressiveness for free.
192///
193/// A check's stdout is a **free-form inventory object** (arbitrary
194/// key/value pairs + arrays) — same as any inventory job — that also
195/// carries a status field. `check:` adds only the health semantics on
196/// top: which field is the ok/warn/fail/unknown status, an optional
197/// one-line summary field, and a remediation job. Everything else
198/// (rich per-PC detail, `explode` sub-tables like a software list) is
199/// driven by a co-present [`InventoryHint`] and rendered with the
200/// SAME display logic the SPA Inventory page uses — on the Client App
201/// too. This keeps checks maximally expressive without a bespoke
202/// payload type.
203#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone)]
204pub struct CheckHint {
205 /// Stable check id → [`Check.name`](crate::ipc::state::Check),
206 /// the SPA/Client React key + analytics label. Unique within the
207 /// fleet's check set.
208 pub name: String,
209 /// Top-level stdout field whose string value
210 /// (`ok`/`warn`/`fail`/`unknown`) becomes the Health-tab light
211 /// ([`CheckStatus`](crate::ipc::state::CheckStatus)). Defaults to
212 /// `"status"`; a missing / unparseable value → `unknown`.
213 #[serde(default = "default_status_field")]
214 pub status_field: String,
215 /// Top-level stdout field used as the Health-tab row's one-line
216 /// summary. Defaults to `"detail"`; absent in the payload → no
217 /// detail line (the rich breakdown lives in the inventory view).
218 #[serde(default = "default_detail_field")]
219 pub detail_field: String,
220 /// Optional remediation job id →
221 /// [`Check.troubleshoot`](crate::ipc::state::Check). The Client
222 /// App shows a "修復する" button when present; that job must be
223 /// `user_invokable`.
224 #[serde(default, skip_serializing_if = "Option::is_none")]
225 pub troubleshoot: Option<String>,
226 /// #290 PR-E: when `true` (default), the backend also projects this
227 /// check's `status` / `detail` into the `check_status` table so the
228 /// operator SPA gets a fleet-wide compliance view for free — no
229 /// `inventory:` block needed. Set `fleet: false` for a client-only
230 /// check the operator doesn't want surfaced across the fleet.
231 #[serde(default = "default_fleet")]
232 pub fleet: bool,
233}
234
235fn default_status_field() -> String {
236 "status".to_string()
237}
238
239fn default_detail_field() -> String {
240 "detail".to_string()
241}
242
243fn default_fleet() -> bool {
244 true
245}
246
247/// Manifest sub-section (#291): marks a job as **user-invokable**
248/// from the Client App and carries how it presents to the end user.
249/// Parallel to [`InventoryHint`] / [`CheckHint`] / `EmitConfig` —
250/// the block's presence is the opt-in (no separate boolean), and its
251/// required fields (`name`, `category`) are enforced by serde at
252/// parse time, so a half-filled catalog entry fails
253/// `kanade job create` instead of rendering a nameless / tab-less row.
254///
255/// The agent maps this 1:1 into the KLP
256/// [`UserInvokableJob`](crate::ipc::jobs::UserInvokableJob) wire shape
257/// that `jobs.list` returns; the Client App renders one row per job in
258/// the tab named by `category`.
259#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone)]
260pub struct ClientHint {
261 /// End-user-facing title for the job row. The operator-internal
262 /// `Manifest::id` slug is rarely what an end user should read, so
263 /// this is required (and validated non-empty by
264 /// [`Manifest::validate`]). Maps to `UserInvokableJob::display_name`.
265 pub name: String,
266 /// Optional one-line subtitle under `name` in the Client App.
267 /// Distinct from the operator-facing top-level
268 /// [`Manifest::description`] — this one is written for the end
269 /// user. Maps to `UserInvokableJob::display_description`.
270 #[serde(default, skip_serializing_if = "Option::is_none")]
271 pub description: Option<String>,
272 /// Which Client App tab the job lives in (`software_update` →
273 /// アップデート, `troubleshoot` → 困ったとき, `catalog` → software
274 /// catalog). Required — without it the agent can't place the job
275 /// in a tab.
276 pub category: JobCategory,
277 /// Optional icon hint for the job row — a lucide-react icon name
278 /// or a `data:` URL. `None` ⇒ the Client App falls back to the
279 /// category's default icon. Surfaced verbatim in
280 /// `jobs.list[].icon`.
281 #[serde(default, skip_serializing_if = "Option::is_none")]
282 pub icon: Option<String>,
283}
284
285/// Issue #246 — `emit:` manifest block for jobs whose stdout is
286/// NDJSON observability events (one `ObsEvent` per line). Parallel
287/// to `inventory:` but for the append-only timeline pipeline; see
288/// `Manifest::emit` for the full contract.
289#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone)]
290pub struct EmitConfig {
291 /// What kind of payload the agent should expect on stdout. Only
292 /// `events` is defined today (parses each non-empty line as
293 /// `ObsEvent` and publishes on `obs.<pc_id>`); future variants
294 /// (e.g. metrics streams, structured trace events) plug in here.
295 #[serde(rename = "type")]
296 pub kind: EmitKind,
297 /// Operator hint for where the script keeps its own state — the
298 /// watermark file the PowerShell / sh body reads + writes
299 /// between runs so it only emits NEW events since the last
300 /// poll. The agent doesn't read this; it's documentation that
301 /// the SPA (and `kanade job edit`) can surface to operators
302 /// reviewing the manifest. Optional; the script is allowed to
303 /// keep state anywhere (registry, env, etc.) — the field's
304 /// presence makes the convention discoverable.
305 #[serde(default, skip_serializing_if = "Option::is_none")]
306 pub watermark_path: Option<String>,
307}
308
309/// `emit.type` enum. Lowercase serde so manifests read
310/// `type: events` rather than `Events`.
311#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone, Copy, PartialEq, Eq)]
312#[serde(rename_all = "lowercase")]
313pub enum EmitKind {
314 /// Per-line `ObsEvent` JSON. Agent parses + publishes on
315 /// `obs.<pc_id>`, drops the stdout from the resulting
316 /// `ExecResult`.
317 Events,
318}
319
320/// v0.31 / #40: declarative "flatten this JSON array into a real
321/// SQLite table" spec on an inventory manifest. The projector
322/// creates the table on first registration (CREATE TABLE IF NOT
323/// EXISTS + indexes) and writes a row per element of
324/// `payload[field]` on every result, scoped by (pc_id, job_id) so
325/// each PC's rows replace cleanly without a per-PC schema.
326#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone)]
327pub struct ExplodeSpec {
328 /// JSON array key under the payload to explode. E.g. `"apps"`
329 /// for `payload: { apps: [{...}, {...}] }`.
330 pub field: String,
331 /// Derived SQLite table name. Operators choose this — pick
332 /// something namespaced + stable (`inventory_sw_apps`, not
333 /// `apps`) so multiple inventory manifests don't collide on a
334 /// generic name.
335 pub table: String,
336 /// Element-level fields that uniquely identify a row inside one
337 /// PC's payload. The full PK is `(pc_id, job_id) + these
338 /// columns`. Required — operators must think about uniqueness
339 /// (e.g. `["name", "source"]` for installed apps because the
340 /// same name appears in multiple uninstall hives).
341 ///
342 /// v0.31 / #41: same tuple drives history identity. When
343 /// `track_history` is on, the projector serialises these
344 /// fields' values into `inventory_history.identity_json` for
345 /// every change event, so queries like "every PC that ever
346 /// installed Chrome (any source)" filter on identity_json
347 /// content without a per-manifest schema.
348 pub primary_key: Vec<String>,
349 /// Per-element fields that become columns in the derived table.
350 pub columns: Vec<ExplodeColumn>,
351 /// v0.31 / #41: when true (default false), the projector
352 /// diffs each PC's incoming payload against the prior rows
353 /// for the same (pc_id, job_id) BEFORE the DELETE-then-INSERT
354 /// replace, and writes added / removed / changed events into
355 /// `inventory_history`. Lets operators answer time-dimension
356 /// questions ("when did Chrome 120 first appear on PC X?",
357 /// "what's the Win 11 23H2 rollout curve") without storing
358 /// per-scan snapshots. Off by default so operators opt in
359 /// per-spec — history has a real storage cost on long-lived
360 /// deployments (mitigated by the 90-day default retention
361 /// sweeper, see `cleanup` module).
362 #[serde(default)]
363 pub track_history: bool,
364}
365
366/// One column in an [`ExplodeSpec`]'s derived table.
367#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone)]
368pub struct ExplodeColumn {
369 /// JSON key under each array element. Becomes the column name
370 /// in the derived SQLite table — we don't rename.
371 pub field: String,
372 /// SQLite affinity: `"text"` (default), `"integer"`, `"real"`.
373 /// Storage maps directly via `sqlx::query.bind(...)`; type
374 /// mismatches at INSERT-time fail loudly rather than silently
375 /// dropping the row.
376 #[serde(default, skip_serializing_if = "Option::is_none")]
377 #[serde(rename = "type")]
378 pub kind: Option<String>,
379 /// When true, the projector creates a `CREATE INDEX` on this
380 /// column at table-creation time. Boost for the common-filter
381 /// columns (`name`, `version`) — operators mark them
382 /// explicitly, the projector won't guess.
383 #[serde(default)]
384 pub index: bool,
385}
386
387#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone)]
388pub struct DisplayField {
389 /// Top-level key in the stdout JSON.
390 pub field: String,
391 /// Human-readable column header.
392 pub label: String,
393 /// Optional render hint — `"number"`, `"bytes"`, `"timestamp"`,
394 /// or `"table"` (#39). Defaults to plain text rendering on the
395 /// SPA side. `"table"` expects the field's value to be a JSON
396 /// array of objects and renders a nested sub-table on the
397 /// per-PC detail page using `columns` as the schema; the fleet
398 /// summary view falls back to showing the row count for
399 /// `"table"` cells so the wide list stays compact.
400 #[serde(default, skip_serializing_if = "Option::is_none")]
401 #[serde(rename = "type")]
402 pub kind: Option<String>,
403 /// v0.30 / #39: when `kind == "table"`, the SPA renders the
404 /// field's value (an array of objects like
405 /// `disks: [{ device_id, size_bytes, ... }]`) as a nested
406 /// sub-table using these columns. Each column is itself a
407 /// `DisplayField`, so the nested cells reuse the same render
408 /// hints (`bytes`, `number`, `timestamp`) — no parallel format
409 /// pipeline. Ignored for any other `kind`.
410 #[serde(default, skip_serializing_if = "Option::is_none")]
411 pub columns: Option<Vec<DisplayField>>,
412}
413
414#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone)]
415pub struct Rollout {
416 #[serde(default)]
417 pub strategy: RolloutStrategy,
418 pub waves: Vec<Wave>,
419}
420
421#[derive(
422 Serialize, Deserialize, schemars::JsonSchema, Debug, Clone, Copy, PartialEq, Eq, Default,
423)]
424#[serde(rename_all = "lowercase")]
425pub enum RolloutStrategy {
426 #[default]
427 Wave,
428}
429
430#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone)]
431pub struct Wave {
432 pub group: String,
433 /// humantime delay measured from the deploy's publish time. wave[0]
434 /// typically has "0s"; subsequent waves use minutes / hours.
435 pub delay: String,
436}
437
438#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone, Default)]
439pub struct Target {
440 #[serde(default)]
441 pub groups: Vec<String>,
442 #[serde(default)]
443 pub pcs: Vec<String>,
444 #[serde(default)]
445 pub all: bool,
446}
447
448impl Target {
449 /// At least one of all / groups / pcs is set.
450 pub fn is_specified(&self) -> bool {
451 self.all || !self.groups.is_empty() || !self.pcs.is_empty()
452 }
453}
454
455#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone)]
456pub struct Execute {
457 pub shell: ExecuteShell,
458 /// Inline script body. Mutually exclusive with [`script_file`]
459 /// and [`script_object`]; exactly one of the three must be set
460 /// (enforced by [`Execute::validate_script_source`] at the
461 /// write-side parse boundaries — `kanade job create` and
462 /// `POST /api/jobs`).
463 ///
464 /// Empty string is treated as **unset** so operators can swap
465 /// to a `script_file:` / `script_object:` alternative just by
466 /// commenting out the body, without having to also drop the
467 /// `script:` key entirely.
468 ///
469 /// [`script_file`]: Self::script_file
470 /// [`script_object`]: Self::script_object
471 #[serde(default, skip_serializing_if = "Option::is_none")]
472 pub script: Option<String>,
473 /// Repo-local file path resolved by the operator-side CLI at
474 /// `kanade job create` time. The CLI reads the file, slots its
475 /// contents into `script`, and clears this field before
476 /// POSTing — so the backend / agents never see `script_file`
477 /// in stored manifests. SPEC §2.4.1.
478 ///
479 /// Resolver lands in a follow-up PR
480 /// (yukimemi/kanade#210); today this field passes parse-time
481 /// validation but the operator-side CLI bails with "not yet
482 /// implemented" until the resolver ships, so manifests that
483 /// reach the backend with `script_file` set are treated as a
484 /// schema-bug.
485 #[serde(default, skip_serializing_if = "Option::is_none")]
486 pub script_file: Option<String>,
487 /// Object Store reference (`<name>/<version>`) into the
488 /// `scripts` bucket (`OBJECT_SCRIPTS`). Agents fetch the body
489 /// at Execute time via `/api/script-objects/{name}/{version}`
490 /// and cache it locally. SPEC §2.4.1.
491 ///
492 /// Resolver lands in the same follow-up PR as `script_file`;
493 /// today this field passes parse-time validation but the
494 /// backend / agent exec paths bail with "not yet implemented"
495 /// when they see it.
496 #[serde(default, skip_serializing_if = "Option::is_none")]
497 pub script_object: Option<String>,
498 /// humantime duration string (e.g. "30s", "10m"). Script-intrinsic
499 /// — represents how long this script reasonably takes to run.
500 pub timeout: String,
501 /// Token + session combination the agent uses to launch the
502 /// script (v0.21). Default = [`RunAs::System`] (Session 0,
503 /// LocalSystem privileges, no GUI) — matches pre-v0.21 behavior.
504 #[serde(default)]
505 pub run_as: RunAs,
506 /// Working directory for the spawned child (v0.21.1). When
507 /// unset, the child inherits the agent's cwd — on Windows that
508 /// means `%SystemRoot%\System32` for the prod service, which is
509 /// almost never what operators actually want. Use an absolute
510 /// path; relative paths are passed through to the OS verbatim.
511 /// `%PROGRAMDATA%` works for `run_as: system`; for `run_as: user`
512 /// you'd want `%USERPROFILE%` (but expansion happens in the
513 /// shell, so write `$env:USERPROFILE` for PowerShell, or set
514 /// it via teravars before `kanade job create`).
515 #[serde(default, skip_serializing_if = "Option::is_none")]
516 pub cwd: Option<String>,
517}
518
519impl Execute {
520 /// Treat an empty `script:` body as "intentionally unset". Operators
521 /// commenting out a block-scalar tend to leave the key behind, and
522 /// failing the validator on `script: ""` would surprise them.
523 fn has_inline_script(&self) -> bool {
524 matches!(&self.script, Some(s) if !s.is_empty())
525 }
526
527 /// Enforce that exactly one of `script` / `script_file` /
528 /// `script_object` is set. Called at the write-side parse
529 /// boundaries (CLI `kanade job create` + backend
530 /// `POST /api/jobs`) so ambiguous YAML is rejected before it
531 /// reaches the JOBS KV. Read paths (projector, agent
532 /// scheduler, list endpoints) skip this check — they only ever
533 /// see what the write path already validated.
534 pub fn validate_script_source(&self) -> Result<(), String> {
535 let inline = self.has_inline_script();
536 let file = self.script_file.is_some();
537 let obj = self.script_object.is_some();
538 let set = [inline, file, obj].into_iter().filter(|b| *b).count();
539 match set {
540 1 => Ok(()),
541 0 => Err("execute: one of `script`, `script_file`, `script_object` must be set".into()),
542 _ => Err(format!(
543 "execute: only one of `script` / `script_file` / `script_object` may be set \
544 (got script={inline}, script_file={file}, script_object={obj})"
545 )),
546 }
547 }
548}
549
550impl Manifest {
551 /// Cross-field semantic checks that don't fit into pure serde
552 /// derive. Currently delegates to
553 /// [`Execute::validate_script_source`] — see that method's
554 /// docs for the rationale on which call sites should run this.
555 pub fn validate(&self) -> Result<(), String> {
556 self.execute.validate_script_source()?;
557 // Stdout-format compatibility. `inventory:` and `check:` both
558 // consume the SAME single JSON object — they COMPOSE: a check
559 // can extract `status`/`detail` for the Health tab while the
560 // projector explodes the rest into SPA sub-tables. `emit:` is
561 // different — its stdout is NDJSON and the agent omits it from
562 // the result entirely — so it can't be paired with either.
563 if self.emit.is_some() && (self.inventory.is_some() || self.check.is_some()) {
564 return Err(
565 "`emit:` is incompatible with `inventory:` / `check:` — emit's stdout is NDJSON \
566 timeline events (and omitted from the result), while inventory/check read a \
567 single JSON object from stdout"
568 .to_string(),
569 );
570 }
571 // A check's `name` is the Health-tab row id (React key); the
572 // field names tell the agent where to read status/detail.
573 // An empty value is an invisible runtime bug, and the serde
574 // defaults don't guard an operator who writes `status_field:
575 // ""` explicitly — reject all three here.
576 if let Some(check) = &self.check {
577 for (label, value) in [
578 ("check.name", &check.name),
579 ("check.status_field", &check.status_field),
580 ("check.detail_field", &check.detail_field),
581 ] {
582 if value.trim().is_empty() {
583 return Err(format!("{label} must not be empty"));
584 }
585 }
586 // A present-but-blank `troubleshoot` is a broken
587 // remediation job id (the "修復する" button would target
588 // an empty manifest id) — reject it too.
589 if let Some(troubleshoot) = &check.troubleshoot {
590 if troubleshoot.trim().is_empty() {
591 return Err("check.troubleshoot must not be empty when set".to_string());
592 }
593 }
594 }
595 // #291: a `client:` job is rendered in the Client App's
596 // catalog (`jobs.list` → `jobs.execute`). serde already makes
597 // `name` + `category` required at parse time; the only gap is
598 // a present-but-blank `name`, which would render an empty row
599 // title — reject it like the other display-id fields.
600 if let Some(client) = &self.client {
601 if client.name.trim().is_empty() {
602 return Err("client.name must not be empty".to_string());
603 }
604 // Optional display fields, when present, must be
605 // meaningful: a blank `description` renders an empty
606 // subtitle and a blank `icon` is a dangling lucide name.
607 // Same present-but-blank guard the `check:` block applies
608 // to its optional `troubleshoot` id.
609 for (label, value) in [
610 ("client.description", &client.description),
611 ("client.icon", &client.icon),
612 ] {
613 if let Some(v) = value {
614 if v.trim().is_empty() {
615 return Err(format!("{label} must not be empty when set"));
616 }
617 }
618 }
619 }
620 Ok(())
621 }
622}
623
624#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone, Copy, PartialEq, Eq)]
625#[serde(rename_all = "lowercase")]
626pub enum ExecuteShell {
627 Powershell,
628 Cmd,
629}
630
631impl From<ExecuteShell> for Shell {
632 fn from(s: ExecuteShell) -> Self {
633 match s {
634 ExecuteShell::Powershell => Shell::Powershell,
635 ExecuteShell::Cmd => Shell::Cmd,
636 }
637 }
638}
639
640#[cfg(test)]
641mod tests {
642 use super::*;
643
644 /// The example check-job + schedule YAMLs shipped under `configs/`
645 /// must stay valid as the schema evolves (#290 PR-C). `include_str!`
646 /// pins them at compile time so a breaking edit fails `cargo test`
647 /// rather than only `kanade job create` at deploy time.
648 #[test]
649 fn example_check_job_yamls_parse_and_validate() {
650 let jobs = [
651 (
652 "check-bitlocker",
653 include_str!("../../../configs/jobs/check-bitlocker.yaml"),
654 ),
655 (
656 "check-av-signature",
657 include_str!("../../../configs/jobs/check-av-signature.yaml"),
658 ),
659 (
660 "check-cert-expiry",
661 include_str!("../../../configs/jobs/check-cert-expiry.yaml"),
662 ),
663 ];
664 for (name, yaml) in jobs {
665 let m: Manifest =
666 serde_yaml::from_str(yaml).unwrap_or_else(|e| panic!("{name} parse: {e}"));
667 m.validate()
668 .unwrap_or_else(|e| panic!("{name} validate: {e}"));
669 let check = m
670 .check
671 .as_ref()
672 .unwrap_or_else(|| panic!("{name} must carry a check: hint"));
673 assert!(!check.name.trim().is_empty(), "{name} check.name empty");
674 // These three examples all read admin-only WMI namespaces,
675 // so they run_as system. NOTE: that's a property of these
676 // particular checks, NOT of the `check:` contract — a check
677 // probing user-session state could legitimately run_as user.
678 assert_eq!(
679 m.execute.run_as,
680 RunAs::System,
681 "{name} should run_as system"
682 );
683 }
684 }
685
686 /// The example user-invokable job YAMLs (#291) shipped under
687 /// `configs/jobs/` must stay valid as the `client:` schema
688 /// evolves. `include_str!` pins them at compile time so a breaking
689 /// edit fails `cargo test`, not `kanade job create` at deploy.
690 #[test]
691 fn example_client_job_yamls_parse_and_validate() {
692 let jobs = [
693 (
694 "fix-teams-cache",
695 JobCategory::Troubleshoot,
696 include_str!("../../../configs/jobs/fix-teams-cache.yaml"),
697 ),
698 (
699 "chrome-update",
700 JobCategory::SoftwareUpdate,
701 include_str!("../../../configs/jobs/chrome-update.yaml"),
702 ),
703 (
704 "install-slack",
705 JobCategory::Catalog,
706 include_str!("../../../configs/jobs/install-slack.yaml"),
707 ),
708 ];
709 for (id, category, yaml) in jobs {
710 let m: Manifest =
711 serde_yaml::from_str(yaml).unwrap_or_else(|e| panic!("{id} parse: {e}"));
712 m.validate()
713 .unwrap_or_else(|e| panic!("{id} validate: {e}"));
714 assert_eq!(m.id, id, "{id} id mismatch");
715 let client = m
716 .client
717 .as_ref()
718 .unwrap_or_else(|| panic!("{id} must carry a client: block"));
719 assert!(!client.name.trim().is_empty(), "{id} client.name empty");
720 assert_eq!(client.category, category, "{id} category");
721 }
722 }
723
724 #[test]
725 fn example_check_schedule_yamls_parse_and_validate() {
726 let schedules = [
727 (
728 "check-bitlocker",
729 include_str!("../../../configs/schedules/check-bitlocker.yaml"),
730 ),
731 (
732 "check-av-signature",
733 include_str!("../../../configs/schedules/check-av-signature.yaml"),
734 ),
735 (
736 "check-cert-expiry",
737 include_str!("../../../configs/schedules/check-cert-expiry.yaml"),
738 ),
739 ];
740 for (name, yaml) in schedules {
741 let s: Schedule =
742 serde_yaml::from_str(yaml).unwrap_or_else(|e| panic!("{name} schedule parse: {e}"));
743 s.validate()
744 .unwrap_or_else(|e| panic!("{name} schedule validate: {e}"));
745 assert_eq!(s.job_id, name, "{name} schedule must reference its job");
746 }
747 }
748
749 #[test]
750 fn target_is_specified_requires_at_least_one_field() {
751 let empty = Target::default();
752 assert!(!empty.is_specified());
753
754 let with_all = Target {
755 all: true,
756 ..Target::default()
757 };
758 assert!(with_all.is_specified());
759
760 let with_groups = Target {
761 groups: vec!["canary".into()],
762 ..Target::default()
763 };
764 assert!(with_groups.is_specified());
765
766 let with_pcs = Target {
767 pcs: vec!["pc-01".into()],
768 ..Target::default()
769 };
770 assert!(with_pcs.is_specified());
771 }
772
773 #[test]
774 fn manifest_deserialises_minimal_yaml() {
775 // Matches jobs/echo-test.yaml. v0.18: no target/rollout/jitter
776 // — those live on the schedule / exec request now.
777 let yaml = r#"
778id: echo-test
779version: 0.0.1
780execute:
781 shell: powershell
782 script: "echo 'kanade'"
783 timeout: 30s
784"#;
785 let m: Manifest = serde_yaml::from_str(yaml).expect("parse");
786 assert_eq!(m.id, "echo-test");
787 assert_eq!(m.version, "0.0.1");
788 assert!(matches!(m.execute.shell, ExecuteShell::Powershell));
789 assert_eq!(
790 m.execute.script.as_deref().map(str::trim),
791 Some("echo 'kanade'")
792 );
793 assert!(m.execute.script_file.is_none());
794 assert!(m.execute.script_object.is_none());
795 assert_eq!(m.execute.timeout, "30s");
796 assert!(!m.require_approval);
797 m.validate()
798 .expect("inline-script manifest passes validation");
799 }
800
801 #[test]
802 fn manifest_parses_check_job_and_validates() {
803 // An operator-defined health check (#290): a `check:` hint +
804 // a PowerShell script that prints {status, detail}.
805 let yaml = r#"
806id: check-bitlocker
807version: 0.1.0
808execute:
809 shell: powershell
810 run_as: system
811 timeout: 15s
812 script: |
813 [pscustomobject]@{ status = 'ok'; detail = 'all volumes protected' } | ConvertTo-Json -Compress
814check:
815 name: bitlocker
816 troubleshoot: fix-bitlocker
817"#;
818 let m: Manifest = serde_yaml::from_str(yaml).expect("parse");
819 let check = m.check.as_ref().expect("check hint present");
820 assert_eq!(check.name, "bitlocker");
821 assert_eq!(check.troubleshoot.as_deref(), Some("fix-bitlocker"));
822 // Field names default to the conventional "status" / "detail".
823 assert_eq!(check.status_field, "status");
824 assert_eq!(check.detail_field, "detail");
825 assert!(m.inventory.is_none() && m.emit.is_none());
826 m.validate().expect("check-only manifest passes validation");
827 }
828
829 #[test]
830 fn manifest_check_defaults_and_custom_fields() {
831 // Minimal: only `name`; status/detail fields default.
832 let m: Manifest = serde_yaml::from_str(
833 r#"
834id: check-disk
835version: 0.1.0
836execute:
837 shell: powershell
838 script: "[pscustomobject]@{ status = 'ok' } | ConvertTo-Json -Compress"
839 timeout: 10s
840check:
841 name: disk_free
842"#,
843 )
844 .expect("parse");
845 let c = m.check.as_ref().unwrap();
846 assert_eq!(c.name, "disk_free");
847 assert_eq!(c.status_field, "status");
848 assert_eq!(c.detail_field, "detail");
849 assert!(c.troubleshoot.is_none());
850 m.validate().expect("validates");
851
852 // The operator can point status/detail at any field of their
853 // free-form inventory object.
854 let m2: Manifest = serde_yaml::from_str(
855 r#"
856id: check-custom
857version: 0.1.0
858execute:
859 shell: powershell
860 script: "echo x"
861 timeout: 10s
862check:
863 name: patch_level
864 status_field: compliance
865 detail_field: summary
866"#,
867 )
868 .expect("parse");
869 let c2 = m2.check.as_ref().unwrap();
870 assert_eq!(c2.status_field, "compliance");
871 assert_eq!(c2.detail_field, "summary");
872 }
873
874 #[test]
875 fn manifest_allows_check_composed_with_inventory() {
876 // `check:` + `inventory:` COMPOSE on the same stdout object:
877 // status/detail → Health tab, the rest → SPA projection +
878 // explode sub-tables. Must pass validation.
879 let yaml = r#"
880id: check-bitlocker-detailed
881version: 0.1.0
882execute:
883 shell: powershell
884 script: "echo x"
885 timeout: 10s
886check:
887 name: bitlocker
888inventory:
889 display:
890 - { field: status, label: Status }
891"#;
892 let m: Manifest = serde_yaml::from_str(yaml).expect("parse");
893 assert!(m.check.is_some() && m.inventory.is_some());
894 m.validate().expect("check + inventory compose");
895 }
896
897 #[test]
898 fn manifest_rejects_check_combined_with_emit() {
899 // `emit:` stdout is NDJSON (and omitted from the result), so
900 // it can't pair with `check:` (which needs a single JSON
901 // object on stdout).
902 let yaml = r#"
903id: bad-mix
904version: 0.1.0
905execute:
906 shell: powershell
907 script: "echo x"
908 timeout: 10s
909check:
910 name: bitlocker
911emit:
912 type: events
913"#;
914 let m: Manifest = serde_yaml::from_str(yaml).expect("parse");
915 let err = m.validate().expect_err("emit + check must fail");
916 assert!(err.contains("incompatible"), "err: {err}");
917 }
918
919 #[test]
920 fn manifest_rejects_emit_combined_with_inventory() {
921 // The other half of the emit-incompatibility condition.
922 let yaml = r#"
923id: bad-mix-2
924version: 0.1.0
925execute:
926 shell: powershell
927 script: "echo x"
928 timeout: 10s
929emit:
930 type: events
931inventory:
932 display:
933 - { field: status, label: Status }
934"#;
935 let m: Manifest = serde_yaml::from_str(yaml).expect("parse");
936 let err = m.validate().expect_err("emit + inventory must fail");
937 assert!(err.contains("incompatible"), "err: {err}");
938 }
939
940 #[test]
941 fn manifest_rejects_empty_check_field_names() {
942 // Empty name / status_field / detail_field are invisible
943 // runtime bugs (empty React key, agent reads the wrong field)
944 // — reject them even though serde supplies non-empty defaults.
945 let base = |inner: &str| {
946 format!(
947 "id: c\nversion: 0.1.0\nexecute:\n shell: powershell\n script: \"echo x\"\n timeout: 10s\ncheck:\n{inner}"
948 )
949 };
950 for inner in [
951 " name: \"\"\n",
952 " name: ok\n status_field: \"\"\n",
953 " name: ok\n detail_field: \" \"\n",
954 // present-but-blank troubleshoot → broken remediation id.
955 " name: ok\n troubleshoot: \" \"\n",
956 ] {
957 let m: Manifest = serde_yaml::from_str(&base(inner)).expect("parse");
958 let err = m.validate().expect_err("empty field must fail");
959 assert!(err.contains("must not be empty"), "err: {err}");
960 }
961 }
962
963 #[test]
964 fn manifest_client_absent_by_default() {
965 // A plain operator job (the overwhelming majority) carries no
966 // `client:` block, so it never surfaces in the end-user
967 // catalog.
968 let yaml = r#"
969id: echo-test
970version: 0.0.1
971execute:
972 shell: powershell
973 script: "echo 'kanade'"
974 timeout: 30s
975"#;
976 let m: Manifest = serde_yaml::from_str(yaml).expect("parse");
977 assert!(m.client.is_none());
978 m.validate().expect("operator-only job validates");
979 }
980
981 #[test]
982 fn manifest_client_parses_and_validates() {
983 // The Client App "困ったとき" remediation job shape: a
984 // user-invokable troubleshoot job with the end-user fields the
985 // KLP `jobs.list` wire needs, grouped under `client:`.
986 let yaml = r#"
987id: fix-teams-cache
988version: 1.0.0
989execute:
990 shell: powershell
991 script: "echo clearing"
992 timeout: 60s
993client:
994 name: "Teams のキャッシュをクリア"
995 description: "Teams が重いときに試してください"
996 category: troubleshoot
997 icon: brush-cleaning
998"#;
999 let m: Manifest = serde_yaml::from_str(yaml).expect("parse");
1000 let c = m.client.as_ref().expect("client block present");
1001 assert_eq!(c.name, "Teams のキャッシュをクリア");
1002 assert_eq!(
1003 c.description.as_deref(),
1004 Some("Teams が重いときに試してください")
1005 );
1006 assert_eq!(c.category, JobCategory::Troubleshoot);
1007 assert_eq!(c.icon.as_deref(), Some("brush-cleaning"));
1008 m.validate().expect("user-invokable job validates");
1009 }
1010
1011 #[test]
1012 fn manifest_client_minimal_only_name_and_category() {
1013 // description + icon are optional; name + category are the
1014 // serde-required minimum.
1015 let yaml = r#"
1016id: install-slack
1017version: 1.0.0
1018execute:
1019 shell: powershell
1020 script: "echo install"
1021 timeout: 600s
1022client:
1023 name: Slack
1024 category: catalog
1025"#;
1026 let m: Manifest = serde_yaml::from_str(yaml).expect("parse");
1027 let c = m.client.as_ref().expect("client present");
1028 assert_eq!(c.category, JobCategory::Catalog);
1029 assert!(c.description.is_none() && c.icon.is_none());
1030 m.validate().expect("minimal client validates");
1031 }
1032
1033 #[test]
1034 fn manifest_client_rejects_blank_name() {
1035 // serde guarantees `name`/`category` are present; the one gap
1036 // is a present-but-blank name → empty catalog row title.
1037 let yaml = r#"
1038id: j
1039version: 1.0.0
1040execute:
1041 shell: powershell
1042 script: "echo x"
1043 timeout: 30s
1044client:
1045 name: " "
1046 category: catalog
1047"#;
1048 let m: Manifest = serde_yaml::from_str(yaml).expect("parse");
1049 let err = m.validate().expect_err("blank name must fail");
1050 assert!(err.contains("client.name"), "err: {err}");
1051 }
1052
1053 #[test]
1054 fn manifest_client_rejects_blank_optional_fields() {
1055 // description / icon are optional, but a present-but-blank
1056 // value is a bug (empty subtitle / dangling icon name) — reject
1057 // it, mirroring the check: block's troubleshoot guard.
1058 for (field, line) in [
1059 ("client.description", " description: \" \"\n"),
1060 ("client.icon", " icon: \"\"\n"),
1061 ] {
1062 let yaml = format!(
1063 "id: j\nversion: 1.0.0\nexecute:\n shell: powershell\n script: \"echo x\"\n timeout: 30s\nclient:\n name: A\n category: catalog\n{line}"
1064 );
1065 let m: Manifest = serde_yaml::from_str(&yaml).expect("parse");
1066 let err = m.validate().expect_err("blank optional field must fail");
1067 assert!(err.contains(field), "expected {field} in err: {err}");
1068 }
1069 }
1070
1071 #[test]
1072 fn manifest_client_requires_category_at_parse() {
1073 // A `client:` block missing `category` is a hard parse error
1074 // (serde required field) — no manual validate() needed.
1075 let yaml = r#"
1076id: j
1077version: 1.0.0
1078execute:
1079 shell: powershell
1080 script: "echo x"
1081 timeout: 30s
1082client:
1083 name: "A job"
1084"#;
1085 let r: Result<Manifest, _> = serde_yaml::from_str(yaml);
1086 assert!(
1087 r.is_err(),
1088 "missing category must be a parse error, got {r:?}"
1089 );
1090 }
1091
1092 #[test]
1093 fn manifest_client_rejects_unknown_field() {
1094 // #492: the strict create boundary catches a fat-fingered
1095 // `displayname:` (with its path) instead of silently
1096 // dropping it; the tolerant read path accepts it.
1097 let yaml = r#"
1098id: j
1099version: 1.0.0
1100execute:
1101 shell: powershell
1102 script: "echo x"
1103 timeout: 30s
1104client:
1105 name: "A job"
1106 category: catalog
1107 displayname: oops
1108"#;
1109 let r = crate::strict::from_yaml_str::<Manifest>(yaml);
1110 let err = r.expect_err("unknown client field must be rejected at the write boundary");
1111 // serde_ignored renders the Option layer as `?`:
1112 // `client.?.displayname`. Assert on the leaf key.
1113 assert!(err.contains("displayname"), "{err}");
1114 // The READ path tolerates the same payload (gradual-upgrade
1115 // contract: an old agent must accept a newer writer's field).
1116 let m: Manifest = serde_yaml::from_str(yaml).expect("tolerant read");
1117 assert_eq!(m.client.as_ref().map(|c| c.name.as_str()), Some("A job"));
1118 }
1119
1120 fn execute_with(
1121 script: Option<&str>,
1122 script_file: Option<&str>,
1123 script_object: Option<&str>,
1124 ) -> Execute {
1125 Execute {
1126 shell: ExecuteShell::Powershell,
1127 script: script.map(str::to_owned),
1128 script_file: script_file.map(str::to_owned),
1129 script_object: script_object.map(str::to_owned),
1130 timeout: "30s".into(),
1131 run_as: RunAs::default(),
1132 cwd: None,
1133 }
1134 }
1135
1136 #[test]
1137 fn validate_accepts_inline_script() {
1138 let e = execute_with(Some("echo hi"), None, None);
1139 assert!(e.validate_script_source().is_ok());
1140 }
1141
1142 #[test]
1143 fn validate_accepts_script_file_alone() {
1144 let e = execute_with(None, Some("scripts/cleanup.ps1"), None);
1145 assert!(e.validate_script_source().is_ok());
1146 }
1147
1148 #[test]
1149 fn validate_accepts_script_object_alone() {
1150 let e = execute_with(None, None, Some("cleanup/1.0.0"));
1151 assert!(e.validate_script_source().is_ok());
1152 }
1153
1154 #[test]
1155 fn validate_treats_empty_inline_script_as_unset() {
1156 // `script: ""` + `script_object` set is the natural shape
1157 // when an operator comments out the YAML block-scalar body
1158 // but leaves the key. Should pass.
1159 let e = execute_with(Some(""), None, Some("cleanup/1.0.0"));
1160 assert!(e.validate_script_source().is_ok());
1161 }
1162
1163 #[test]
1164 fn validate_rejects_zero_sources() {
1165 let e = execute_with(None, None, None);
1166 let err = e.validate_script_source().unwrap_err();
1167 assert!(err.contains("must be set"), "got: {err}");
1168 }
1169
1170 #[test]
1171 fn validate_rejects_empty_inline_only() {
1172 let e = execute_with(Some(""), None, None);
1173 let err = e.validate_script_source().unwrap_err();
1174 assert!(err.contains("must be set"), "got: {err}");
1175 }
1176
1177 #[test]
1178 fn validate_rejects_inline_plus_file() {
1179 let e = execute_with(Some("echo hi"), Some("scripts/cleanup.ps1"), None);
1180 let err = e.validate_script_source().unwrap_err();
1181 assert!(err.contains("only one of"), "got: {err}");
1182 }
1183
1184 #[test]
1185 fn validate_rejects_inline_plus_object() {
1186 let e = execute_with(Some("echo hi"), None, Some("cleanup/1.0.0"));
1187 let err = e.validate_script_source().unwrap_err();
1188 assert!(err.contains("only one of"), "got: {err}");
1189 }
1190
1191 #[test]
1192 fn validate_rejects_file_plus_object() {
1193 let e = execute_with(None, Some("scripts/cleanup.ps1"), Some("cleanup/1.0.0"));
1194 let err = e.validate_script_source().unwrap_err();
1195 assert!(err.contains("only one of"), "got: {err}");
1196 }
1197
1198 #[test]
1199 fn validate_rejects_all_three() {
1200 let e = execute_with(
1201 Some("echo hi"),
1202 Some("scripts/cleanup.ps1"),
1203 Some("cleanup/1.0.0"),
1204 );
1205 let err = e.validate_script_source().unwrap_err();
1206 assert!(err.contains("only one of"), "got: {err}");
1207 }
1208
1209 #[test]
1210 fn manifest_deserialises_script_object_yaml() {
1211 // SPEC §2.4.1 example shape with the Object Store
1212 // reference picked over inline.
1213 let yaml = r#"
1214id: cleanup-disk-temp
1215version: 1.0.1
1216execute:
1217 shell: powershell
1218 script_object: cleanup-disk-temp/1.0.1
1219 timeout: 600s
1220"#;
1221 let m: Manifest = serde_yaml::from_str(yaml).expect("parse");
1222 assert_eq!(
1223 m.execute.script_object.as_deref(),
1224 Some("cleanup-disk-temp/1.0.1")
1225 );
1226 assert!(m.execute.script.is_none());
1227 m.validate()
1228 .expect("script_object-only manifest passes validation");
1229 }
1230
1231 #[test]
1232 fn manifest_rejects_typo_in_script_field_name() {
1233 // #492: the strict create boundary catches `script_objectt`
1234 // and similar fat-fingers (with the full path) instead of
1235 // letting them silently fall through to "all three unset".
1236 let yaml = r#"
1237id: typo
1238version: 1.0.0
1239execute:
1240 shell: powershell
1241 script_objectt: oops
1242 timeout: 30s
1243"#;
1244 let err = crate::strict::from_yaml_str::<Manifest>(yaml)
1245 .expect_err("typo'd execute field must be rejected at the write boundary");
1246 assert!(err.contains("execute.script_objectt"), "{err}");
1247 }
1248
1249 #[test]
1250 fn schedule_carries_target_and_rollout() {
1251 let yaml = r#"
1252id: hourly-cleanup-canary
1253when:
1254 per_pc: { every: 1h }
1255job_id: cleanup
1256enabled: true
1257target:
1258 groups: [canary, wave1]
1259jitter: 30s
1260rollout:
1261 strategy: wave
1262 waves:
1263 - { group: canary, delay: 0s }
1264 - { group: wave1, delay: 5s }
1265"#;
1266 let s: Schedule = serde_yaml::from_str(yaml).expect("parse");
1267 assert_eq!(s.id, "hourly-cleanup-canary");
1268 assert_eq!(s.job_id, "cleanup");
1269 assert_eq!(s.plan.target.groups, vec!["canary", "wave1"]);
1270 assert_eq!(s.plan.jitter.as_deref(), Some("30s"));
1271 let rollout = s.plan.rollout.expect("rollout present");
1272 assert_eq!(rollout.waves.len(), 2);
1273 assert_eq!(rollout.waves[0].group, "canary");
1274 assert_eq!(rollout.waves[1].delay, "5s");
1275 assert_eq!(rollout.strategy, RolloutStrategy::Wave);
1276 }
1277
1278 #[test]
1279 fn schedule_minimal_target_all() {
1280 let yaml = r#"
1281id: kitting
1282when:
1283 per_pc: once
1284enabled: true
1285job_id: scheduled-echo
1286target: { all: true }
1287"#;
1288 let s: Schedule = serde_yaml::from_str(yaml).expect("parse");
1289 assert_eq!(s.id, "kitting");
1290 assert_eq!(s.when, When::PerPc(PerPolicy::Once(OnceLiteral::Once)));
1291 assert!(s.enabled);
1292 assert_eq!(s.job_id, "scheduled-echo");
1293 assert!(s.plan.target.all);
1294 assert!(s.plan.rollout.is_none());
1295 assert!(s.plan.jitter.is_none());
1296 assert!(s.active.is_empty());
1297 }
1298
1299 #[test]
1300 fn schedule_enabled_defaults_to_true() {
1301 let yaml = r#"
1302id: x
1303when:
1304 per_pc: once
1305job_id: y
1306target: { all: true }
1307"#;
1308 let s: Schedule = serde_yaml::from_str(yaml).expect("parse");
1309 assert!(s.enabled);
1310 }
1311
1312 // ---- `when` parsing (#418 Phase 1) ----
1313
1314 fn schedule_yaml_with(when_block: &str) -> String {
1315 format!(
1316 r#"
1317id: x
1318when:
1319{when_block}
1320job_id: y
1321target: {{ all: true }}
1322"#
1323 )
1324 }
1325
1326 #[test]
1327 fn when_per_pc_every_parses_unquoted_humantime() {
1328 // `6h` is digit-led but non-numeric → YAML string, same as
1329 // the old `cooldown: 6h` convention. No quotes needed.
1330 let s: Schedule =
1331 serde_yaml::from_str(&schedule_yaml_with(" per_pc: { every: 6h }")).expect("parse");
1332 assert_eq!(
1333 s.when,
1334 When::PerPc(PerPolicy::Every(EverySpec { every: "6h".into() }))
1335 );
1336 }
1337
1338 #[test]
1339 fn when_per_target_every_parses() {
1340 let s: Schedule = serde_yaml::from_str(&schedule_yaml_with(" per_target: { every: 24h }"))
1341 .expect("parse");
1342 assert_eq!(
1343 s.when,
1344 When::PerTarget(PerPolicy::Every(EverySpec {
1345 every: "24h".into()
1346 }))
1347 );
1348 }
1349
1350 #[test]
1351 fn when_per_target_once_parses() {
1352 // Falls out of the shared PerPolicy shape and decide_fire
1353 // already implements it ("any one pc succeeds → skip the
1354 // target forever"), so it is allowed, not rejected.
1355 let s: Schedule =
1356 serde_yaml::from_str(&schedule_yaml_with(" per_target: once")).expect("parse");
1357 assert_eq!(s.when, When::PerTarget(PerPolicy::Once(OnceLiteral::Once)));
1358 }
1359
1360 #[test]
1361 fn when_calendar_time_parses() {
1362 let s: Schedule = serde_yaml::from_str(&schedule_yaml_with(
1363 " calendar:\n at: \"09:00\"\n days: [mon-fri]",
1364 ))
1365 .expect("parse");
1366 match &s.when {
1367 When::Calendar(c) => {
1368 assert_eq!(c.at, "09:00");
1369 assert_eq!(c.days, vec!["mon-fri"]);
1370 }
1371 other => panic!("expected calendar, got {other:?}"),
1372 }
1373 }
1374
1375 #[test]
1376 fn when_calendar_days_default_empty() {
1377 let s: Schedule =
1378 serde_yaml::from_str(&schedule_yaml_with(" calendar:\n at: \"09:00\""))
1379 .expect("parse");
1380 match &s.when {
1381 When::Calendar(c) => assert!(c.days.is_empty(), "days defaults to empty (= daily)"),
1382 other => panic!("expected calendar, got {other:?}"),
1383 }
1384 }
1385
1386 #[test]
1387 fn when_calendar_datetime_parses_all_separators() {
1388 // one-shot: date+time in hyphen / ISO-T / slash forms
1389 for at in ["2026-06-10 09:00", "2026-06-10T09:00", "2026/06/10 09:00"] {
1390 let block = format!(" calendar:\n at: \"{at}\"");
1391 let s: Schedule = serde_yaml::from_str(&schedule_yaml_with(&block))
1392 .unwrap_or_else(|e| panic!("parse '{at}': {e}"));
1393 match &s.when {
1394 When::Calendar(c) => {
1395 use chrono::Datelike;
1396 let p = c.parse_at().expect("parse_at");
1397 let d = p.date.expect("datetime at carries a date");
1398 assert_eq!((d.year(), d.month(), d.day()), (2026, 6, 10), "for '{at}'");
1399 }
1400 other => panic!("expected calendar, got {other:?}"),
1401 }
1402 }
1403 }
1404
1405 #[test]
1406 fn when_rejects_bad_once_keyword() {
1407 // `onec` must be a parse error, not a silently-absorbed
1408 // string (OnceLiteral is a single-variant enum for exactly
1409 // this reason).
1410 let r: Result<Schedule, _> = serde_yaml::from_str(&schedule_yaml_with(" per_pc: onec"));
1411 assert!(r.is_err(), "expected parse error, got {r:?}");
1412 }
1413
1414 #[test]
1415 fn when_rejects_unknown_key_in_every() {
1416 // `{ evry: 6h }` still fails on the tolerant read path: the
1417 // required `every` key is missing, so no PerPolicy variant
1418 // matches (#492 removed deny_unknown_fields, but required
1419 // keys keep the untagged disambiguation honest).
1420 let r: Result<Schedule, _> =
1421 serde_yaml::from_str(&schedule_yaml_with(" per_pc: { evry: 6h }"));
1422 assert!(r.is_err(), "expected parse error, got {r:?}");
1423 }
1424
1425 #[test]
1426 fn when_rejects_unknown_variant() {
1427 let r: Result<Schedule, _> =
1428 serde_yaml::from_str(&schedule_yaml_with(" per_galaxy: once"));
1429 assert!(r.is_err(), "expected parse error, got {r:?}");
1430 }
1431
1432 #[test]
1433 fn when_rejects_old_top_level_cron_field() {
1434 // Pre-#418 shape: top-level `cron:` + no `when:`. Must fail
1435 // loudly (missing `when`), which is what turns stale KV
1436 // blobs into warn-skips after the upgrade.
1437 let yaml = r#"
1438id: x
1439cron: "* * * * * *"
1440job_id: y
1441target: { all: true }
1442"#;
1443 let r: Result<Schedule, _> = serde_yaml::from_str(yaml);
1444 assert!(r.is_err(), "expected parse error, got {r:?}");
1445 }
1446
1447 #[test]
1448 fn when_rejects_retired_cron_escape_hatch() {
1449 // #418 Phase 2 retired `when: { cron: "..." }`. A raw cron
1450 // is now an unknown variant → parse error (operators use the
1451 // calendar form instead).
1452 let r: Result<Schedule, _> =
1453 serde_yaml::from_str(&schedule_yaml_with(" cron: \"0 0 9 * * mon-fri\""));
1454 assert!(
1455 r.is_err(),
1456 "expected parse error for retired cron, got {r:?}"
1457 );
1458 }
1459
1460 #[test]
1461 fn when_round_trips_json_and_yaml() {
1462 // Round-trip through the full Schedule: that is the wire
1463 // unit for both stores (JSON catalog KV + YAML mirror), and
1464 // it exercises the singleton_map field attribute that keeps
1465 // serde_yaml on the map shape instead of `!per_pc` tags.
1466 for when in [
1467 When::PerPc(PerPolicy::Once(OnceLiteral::Once)),
1468 When::PerPc(PerPolicy::Every(EverySpec { every: "6h".into() })),
1469 When::PerTarget(PerPolicy::Once(OnceLiteral::Once)),
1470 When::PerTarget(PerPolicy::Every(EverySpec {
1471 every: "24h".into(),
1472 })),
1473 calendar("09:00", &["mon-fri"]),
1474 calendar("2026-06-10 09:00", &[]),
1475 ] {
1476 let s = schedule_with(when.clone(), RunsOn::Backend);
1477
1478 let json = serde_json::to_string(&s).expect("json serialise");
1479 let back: Schedule = serde_json::from_str(&json).expect("json deserialise");
1480 assert_eq!(back.when, when, "json round-trip for {when}");
1481
1482 let yaml = serde_yaml::to_string(&s).expect("yaml serialise");
1483 assert!(
1484 !yaml.contains('!'),
1485 "yaml must use the map shape, not tags: {yaml}"
1486 );
1487 let back: Schedule = serde_yaml::from_str(&yaml).expect("yaml deserialise");
1488 assert_eq!(back.when, when, "yaml round-trip for {when}");
1489 }
1490 }
1491
1492 #[test]
1493 fn when_once_serialises_as_bare_keyword() {
1494 // The wire shape operators see in the YAML mirror must stay
1495 // the ergonomic `per_pc: once`, not a one-variant map.
1496 let json = serde_json::to_value(When::PerPc(PerPolicy::Once(OnceLiteral::Once)))
1497 .expect("serialise");
1498 assert_eq!(json, serde_json::json!({ "per_pc": "once" }));
1499 }
1500
1501 #[test]
1502 fn when_displays_operator_summary() {
1503 for (when, expected) in [
1504 (
1505 When::PerPc(PerPolicy::Once(OnceLiteral::Once)),
1506 "per_pc once",
1507 ),
1508 (
1509 When::PerPc(PerPolicy::Every(EverySpec { every: "6h".into() })),
1510 "per_pc every 6h",
1511 ),
1512 (
1513 When::PerTarget(PerPolicy::Every(EverySpec {
1514 every: "24h".into(),
1515 })),
1516 "per_target every 24h",
1517 ),
1518 (calendar("09:00", &["mon-fri"]), "at 09:00 [mon-fri]"),
1519 (calendar("2026-06-10 09:00", &[]), "at 2026-06-10 09:00"),
1520 ] {
1521 assert_eq!(when.to_string(), expected);
1522 }
1523 }
1524
1525 // ---- lowering (#418: when → engine vocabulary) ----
1526
1527 fn schedule_with(when: When, runs_on: RunsOn) -> Schedule {
1528 Schedule {
1529 id: "x".into(),
1530 when,
1531 job_id: "y".into(),
1532 plan: FanoutPlan::default(),
1533 active: Active::default(),
1534 constraints: Constraints::default(),
1535 on_failure: OnFailure::default(),
1536 tz: ScheduleTz::default(),
1537 starting_deadline: None,
1538 runs_on,
1539 enabled: true,
1540 }
1541 }
1542
1543 fn calendar(at: &str, days: &[&str]) -> When {
1544 When::Calendar(CalendarSpec {
1545 at: at.into(),
1546 days: days.iter().map(|d| (*d).to_string()).collect(),
1547 })
1548 }
1549
1550 #[test]
1551 fn next_calendar_fire_returns_next_utc_occurrence() {
1552 use chrono::TimeZone;
1553 // Daily 09:00, evaluated in UTC. From 08:00 the same day, the
1554 // next strict occurrence is 09:00 that day.
1555 let mut s = schedule_with(calendar("09:00", &[]), RunsOn::Backend);
1556 s.tz = ScheduleTz::Utc;
1557 let now = chrono::Utc.with_ymd_and_hms(2026, 6, 9, 8, 0, 0).unwrap();
1558 let next = s.next_calendar_fire(now).expect("calendar has a next fire");
1559 assert_eq!(
1560 next,
1561 chrono::Utc.with_ymd_and_hms(2026, 6, 9, 9, 0, 0).unwrap()
1562 );
1563 }
1564
1565 #[test]
1566 fn next_calendar_fire_is_strictly_after_now() {
1567 use chrono::TimeZone;
1568 // Standing exactly on a fire instant must preview the *next*
1569 // one (inclusive = false), not the one firing right now.
1570 let mut s = schedule_with(calendar("09:00", &[]), RunsOn::Backend);
1571 s.tz = ScheduleTz::Utc;
1572 let on_fire = chrono::Utc.with_ymd_and_hms(2026, 6, 9, 9, 0, 0).unwrap();
1573 let next = s
1574 .next_calendar_fire(on_fire)
1575 .expect("calendar has a next fire");
1576 assert_eq!(
1577 next,
1578 chrono::Utc.with_ymd_and_hms(2026, 6, 10, 9, 0, 0).unwrap()
1579 );
1580 }
1581
1582 #[test]
1583 fn next_calendar_fire_none_for_reconcile_shapes() {
1584 // `per_pc` / `per_target` lower to the every-minute poll cron —
1585 // no discrete upcoming event to preview, so `None`.
1586 let now = chrono::Utc::now();
1587 for when in [
1588 When::PerPc(PerPolicy::Once(OnceLiteral::Once)),
1589 When::PerTarget(PerPolicy::Once(OnceLiteral::Once)),
1590 When::PerPc(PerPolicy::Every(EverySpec { every: "6h".into() })),
1591 When::PerTarget(PerPolicy::Every(EverySpec {
1592 every: "24h".into(),
1593 })),
1594 ] {
1595 let s = schedule_with(when, RunsOn::Backend);
1596 assert!(
1597 s.next_calendar_fire(now).is_none(),
1598 "reconcile shapes have no calendar fire",
1599 );
1600 }
1601 }
1602
1603 // ---- preview_fires (#418 dry-run / preview) ----
1604
1605 fn cal_utc(at: &str, days: &[&str]) -> Schedule {
1606 let mut s = schedule_with(calendar(at, days), RunsOn::Backend);
1607 s.tz = ScheduleTz::Utc; // host-independent assertions
1608 s
1609 }
1610
1611 #[test]
1612 fn preview_lists_next_calendar_occurrences() {
1613 use chrono::TimeZone;
1614 // Weekday 09:00, from Wed 2026-06-10 00:00 UTC: the next five
1615 // fires skip the weekend (Sat 13 / Sun 14).
1616 let s = cal_utc("09:00", &["mon-fri"]);
1617 let now = chrono::Utc.with_ymd_and_hms(2026, 6, 10, 0, 0, 0).unwrap();
1618 let got = s.preview_fires(now, 5);
1619 let want: Vec<_> = [
1620 (2026, 6, 10), // Wed
1621 (2026, 6, 11), // Thu
1622 (2026, 6, 12), // Fri
1623 (2026, 6, 15), // Mon (skips Sat 13 / Sun 14)
1624 (2026, 6, 16), // Tue
1625 ]
1626 .iter()
1627 .map(|(y, m, d)| chrono::Utc.with_ymd_and_hms(*y, *m, *d, 9, 0, 0).unwrap())
1628 .collect();
1629 assert_eq!(got, want);
1630 }
1631
1632 #[test]
1633 fn preview_handles_nth_and_last_weekday() {
1634 use chrono::TimeZone;
1635 let now = chrono::Utc.with_ymd_and_hms(2026, 6, 1, 0, 0, 0).unwrap();
1636 // 2nd Tuesday (Patch Tuesday): Jun 9, Jul 14 2026.
1637 let nth = cal_utc("09:00", &["tue#2"]).preview_fires(now, 2);
1638 assert_eq!(
1639 nth,
1640 vec![
1641 chrono::Utc.with_ymd_and_hms(2026, 6, 9, 9, 0, 0).unwrap(),
1642 chrono::Utc.with_ymd_and_hms(2026, 7, 14, 9, 0, 0).unwrap(),
1643 ]
1644 );
1645 // Last Friday of the month: Jun 26, Jul 31 2026.
1646 let last = cal_utc("22:00", &["friL"]).preview_fires(now, 2);
1647 assert_eq!(
1648 last,
1649 vec![
1650 chrono::Utc.with_ymd_and_hms(2026, 6, 26, 22, 0, 0).unwrap(),
1651 chrono::Utc.with_ymd_and_hms(2026, 7, 31, 22, 0, 0).unwrap(),
1652 ]
1653 );
1654 }
1655
1656 #[test]
1657 fn preview_is_empty_for_reconcile_and_zero_count() {
1658 let now = chrono::Utc::now();
1659 // reconcile shapes have no discrete fire times
1660 let recon = schedule_with(
1661 When::PerPc(PerPolicy::Every(EverySpec { every: "6h".into() })),
1662 RunsOn::Backend,
1663 );
1664 assert!(recon.preview_fires(now, 5).is_empty());
1665 // count == 0 yields nothing even for a calendar
1666 assert!(cal_utc("09:00", &[]).preview_fires(now, 0).is_empty());
1667 }
1668
1669 #[test]
1670 fn preview_skips_outside_active_window() {
1671 use chrono::TimeZone;
1672 // Daily 09:00, active only [2026-06-15, 2026-06-17). Occurrences
1673 // before `from` are skipped; `until` is exclusive, so 06-17's
1674 // fire is out — leaving exactly the 15th and 16th.
1675 let mut s = cal_utc("09:00", &[]);
1676 s.active = Active {
1677 from: Some("2026-06-15".into()),
1678 until: Some("2026-06-17".into()),
1679 };
1680 let now = chrono::Utc.with_ymd_and_hms(2026, 6, 10, 0, 0, 0).unwrap();
1681 let got = s.preview_fires(now, 5);
1682 assert_eq!(
1683 got,
1684 vec![
1685 chrono::Utc.with_ymd_and_hms(2026, 6, 15, 9, 0, 0).unwrap(),
1686 chrono::Utc.with_ymd_and_hms(2026, 6, 16, 9, 0, 0).unwrap(),
1687 ]
1688 );
1689 }
1690
1691 #[test]
1692 fn preview_empty_when_calendar_time_outside_window() {
1693 use chrono::TimeZone;
1694 // Fires at 09:00 but the maintenance window is overnight — it can
1695 // never run, so the preview is empty (matches
1696 // `calendar_outside_window`), and the scan still terminates.
1697 let mut s = cal_utc("09:00", &[]);
1698 s.constraints = Constraints {
1699 window: Some("22:00-05:00".into()),
1700 ..Constraints::default()
1701 };
1702 let now = chrono::Utc.with_ymd_and_hms(2026, 6, 10, 0, 0, 0).unwrap();
1703 assert!(s.preview_fires(now, 5).is_empty());
1704 // Every candidate tick is rejected, so this also exercises the
1705 // SCAN_CAP bound: a large `count` must still terminate (and
1706 // return empty) rather than spin (claude #578 review).
1707 assert!(s.preview_fires(now, 50).is_empty());
1708 }
1709
1710 #[test]
1711 fn preview_past_one_shot_is_empty() {
1712 use chrono::TimeZone;
1713 // A dated one-shot whose instant has passed never fires again.
1714 let s = cal_utc("2026-06-10 09:00", &[]);
1715 let now = chrono::Utc.with_ymd_and_hms(2026, 6, 11, 0, 0, 0).unwrap();
1716 assert!(s.preview_fires(now, 5).is_empty());
1717 // …but from before it, the single future fire shows up.
1718 let before = chrono::Utc.with_ymd_and_hms(2026, 6, 1, 0, 0, 0).unwrap();
1719 assert_eq!(
1720 s.preview_fires(before, 5),
1721 vec![chrono::Utc.with_ymd_and_hms(2026, 6, 10, 9, 0, 0).unwrap()]
1722 );
1723 }
1724
1725 #[test]
1726 fn lowering_matches_the_418_table() {
1727 let cases = [
1728 (
1729 When::PerPc(PerPolicy::Once(OnceLiteral::Once)),
1730 (POLL_CRON, ExecMode::OncePerPc, None),
1731 ),
1732 (
1733 When::PerPc(PerPolicy::Every(EverySpec { every: "6h".into() })),
1734 (POLL_CRON, ExecMode::OncePerPc, Some("6h")),
1735 ),
1736 (
1737 When::PerTarget(PerPolicy::Once(OnceLiteral::Once)),
1738 (POLL_CRON, ExecMode::OncePerTarget, None),
1739 ),
1740 (
1741 When::PerTarget(PerPolicy::Every(EverySpec {
1742 every: "24h".into(),
1743 })),
1744 (POLL_CRON, ExecMode::OncePerTarget, Some("24h")),
1745 ),
1746 // calendar repeating → 6-field cron
1747 (
1748 calendar("09:00", &["mon-fri"]),
1749 ("0 0 9 * * mon-fri", ExecMode::EveryTick, None),
1750 ),
1751 // calendar daily (no days) → DOW *
1752 (
1753 calendar("18:30", &[]),
1754 ("0 30 18 * * *", ExecMode::EveryTick, None),
1755 ),
1756 // calendar one-shot → 7-field year cron
1757 (
1758 calendar("2026-06-10 09:00", &[]),
1759 ("0 0 9 10 6 * 2026", ExecMode::EveryTick, None),
1760 ),
1761 ];
1762 for (when, (cron, mode, cooldown)) in cases {
1763 let l = schedule_with(when.clone(), RunsOn::Backend).lowered();
1764 assert_eq!(l.cron, cron, "cron for {when}");
1765 assert_eq!(l.mode, mode, "mode for {when}");
1766 assert_eq!(l.cooldown.as_deref(), cooldown, "cooldown for {when}");
1767 }
1768 }
1769
1770 #[test]
1771 fn lowered_carries_schedule_tz() {
1772 for (tz, want) in [
1773 (ScheduleTz::Local, ScheduleTz::Local),
1774 (ScheduleTz::Utc, ScheduleTz::Utc),
1775 ] {
1776 let mut s = schedule_with(calendar("09:00", &["mon-fri"]), RunsOn::Backend);
1777 s.tz = tz;
1778 assert_eq!(s.lowered().tz, want, "calendar carries tz");
1779 // reconcile shapes carry tz too (for the active-window check)
1780 let mut s = schedule_with(
1781 When::PerPc(PerPolicy::Once(OnceLiteral::Once)),
1782 RunsOn::Backend,
1783 );
1784 s.tz = tz;
1785 assert_eq!(s.lowered().tz, want, "reconcile carries tz");
1786 }
1787 }
1788
1789 #[test]
1790 fn poll_cron_is_accepted_by_the_engine_parser() {
1791 // POLL_CRON is system-generated — if the engine's parser
1792 // ever rejected it every reconcile schedule would die at
1793 // register time. Validate it with the same croner config
1794 // (Seconds::Required, dom_and_dow, year optional).
1795 croner::parser::CronParser::builder()
1796 .seconds(croner::parser::Seconds::Required)
1797 .dom_and_dow(true)
1798 .build()
1799 .parse(POLL_CRON)
1800 .expect("POLL_CRON must parse");
1801 }
1802
1803 // ---- Schedule::validate() (#418 decision F) ----
1804
1805 #[test]
1806 fn validate_accepts_reconcile_shapes() {
1807 for when in [
1808 When::PerPc(PerPolicy::Once(OnceLiteral::Once)),
1809 When::PerPc(PerPolicy::Every(EverySpec { every: "6h".into() })),
1810 When::PerTarget(PerPolicy::Once(OnceLiteral::Once)),
1811 When::PerTarget(PerPolicy::Every(EverySpec {
1812 every: "24h".into(),
1813 })),
1814 ] {
1815 schedule_with(when.clone(), RunsOn::Backend)
1816 .validate()
1817 .unwrap_or_else(|e| panic!("{when} should validate: {e}"));
1818 }
1819 }
1820
1821 #[test]
1822 fn validate_accepts_per_pc_on_agent() {
1823 schedule_with(
1824 When::PerPc(PerPolicy::Every(EverySpec { every: "1h".into() })),
1825 RunsOn::Agent,
1826 )
1827 .validate()
1828 .expect("per_pc + agent is the offline-inventory shape");
1829 }
1830
1831 #[test]
1832 fn validate_rejects_per_target_on_agent() {
1833 let err = schedule_with(
1834 When::PerTarget(PerPolicy::Every(EverySpec {
1835 every: "24h".into(),
1836 })),
1837 RunsOn::Agent,
1838 )
1839 .validate()
1840 .unwrap_err();
1841 assert!(err.contains("per_target"), "got: {err}");
1842 assert!(err.contains("runs_on: agent"), "got: {err}");
1843
1844 // per_target: once is also backend-only.
1845 let err = schedule_with(
1846 When::PerTarget(PerPolicy::Once(OnceLiteral::Once)),
1847 RunsOn::Agent,
1848 )
1849 .validate()
1850 .unwrap_err();
1851 assert!(err.contains("per_target"), "got (once): {err}");
1852 assert!(err.contains("runs_on: agent"), "got (once): {err}");
1853 }
1854
1855 #[test]
1856 fn validate_rejects_bad_every_duration() {
1857 let err = schedule_with(
1858 When::PerPc(PerPolicy::Every(EverySpec { every: "6x".into() })),
1859 RunsOn::Backend,
1860 )
1861 .validate()
1862 .unwrap_err();
1863 assert!(err.contains("when.every"), "got: {err}");
1864 }
1865
1866 #[test]
1867 fn validate_rejects_bad_jitter_and_starting_deadline() {
1868 let mut s = schedule_with(
1869 When::PerPc(PerPolicy::Once(OnceLiteral::Once)),
1870 RunsOn::Backend,
1871 );
1872 s.plan.jitter = Some("5x".into());
1873 let err = s.validate().unwrap_err();
1874 assert!(err.contains("jitter"), "got: {err}");
1875
1876 let mut s = schedule_with(
1877 When::PerPc(PerPolicy::Once(OnceLiteral::Once)),
1878 RunsOn::Backend,
1879 );
1880 s.starting_deadline = Some("soon".into());
1881 let err = s.validate().unwrap_err();
1882 assert!(err.contains("starting_deadline"), "got: {err}");
1883 }
1884
1885 #[test]
1886 fn validate_accepts_calendar_shapes() {
1887 for when in [
1888 calendar("09:00", &["mon-fri"]), // weekday morning
1889 calendar("00:00", &["sun"]), // weekly
1890 calendar("18:30", &[]), // daily
1891 calendar("2026-06-10 09:00", &[]), // one-shot
1892 calendar("2026/12/25 00:00", &[]), // one-shot, slash form
1893 ] {
1894 schedule_with(when.clone(), RunsOn::Backend)
1895 .validate()
1896 .unwrap_or_else(|e| panic!("{when} should validate: {e}"));
1897 }
1898 }
1899
1900 #[test]
1901 fn validate_rejects_bad_at() {
1902 for bad in ["25:00", "09:60", "9", "noon", "2026-13-01 09:00"] {
1903 let err = schedule_with(calendar(bad, &[]), RunsOn::Backend)
1904 .validate()
1905 .unwrap_err();
1906 assert!(err.contains("when.at"), "for '{bad}', got: {err}");
1907 }
1908 }
1909
1910 #[test]
1911 fn validate_rejects_datetime_at_with_days() {
1912 // A dated `at` is a one-shot — pairing it with days is a
1913 // contradiction (the date already pins the day).
1914 let err = schedule_with(calendar("2026-06-10 09:00", &["mon"]), RunsOn::Backend)
1915 .validate()
1916 .unwrap_err();
1917 assert!(
1918 err.contains("one-shot") && err.contains("days"),
1919 "got: {err}"
1920 );
1921 }
1922
1923 #[test]
1924 fn validate_rejects_bad_day_name() {
1925 // A garbage DOW token is caught by the days pre-flight and
1926 // reported against `when.days`, not the confusing
1927 // "when.at lowered to invalid cron" (claude #432 review).
1928 let err = schedule_with(calendar("09:00", &["funday"]), RunsOn::Backend)
1929 .validate()
1930 .unwrap_err();
1931 assert!(err.contains("when.days"), "got: {err}");
1932 assert!(err.contains("funday"), "names the bad token: {err}");
1933 // a degenerate range like `mon-` reports the whole token, not
1934 // a cryptic empty part (claude #432 follow-up)
1935 let err = schedule_with(calendar("09:00", &["mon-"]), RunsOn::Backend)
1936 .validate()
1937 .unwrap_err();
1938 assert!(err.contains("'mon-'"), "names the whole token: {err}");
1939 // valid names / ranges / numeric / * all pass
1940 for ok in [
1941 calendar("09:00", &["mon-fri"]),
1942 calendar("09:00", &["mon", "wed", "sun"]),
1943 calendar("09:00", &["1-5"]),
1944 ] {
1945 schedule_with(ok.clone(), RunsOn::Backend)
1946 .validate()
1947 .unwrap_or_else(|e| panic!("{ok} should validate: {e}"));
1948 }
1949 }
1950
1951 #[test]
1952 fn validate_accepts_nth_weekday() {
1953 // #418: nth-weekday (Patch Tuesday). validate() also lowers to
1954 // a cron and parses it with croner, so passing here proves the
1955 // whole chain — token → DOW field → engine-acceptable cron.
1956 for ok in [
1957 calendar("09:00", &["tue#2"]), // 2nd Tuesday
1958 calendar("09:00", &["fri#1"]), // 1st Friday
1959 calendar("03:00", &["sun#5"]), // 5th Sunday
1960 calendar("09:00", &["tue#2", "thu#2"]), // a list of nths
1961 calendar("09:00", &["2#2"]), // numeric DOW + ordinal
1962 // Case-insensitive both sides: validate lowercases, croner
1963 // upper-cases the whole pattern before aliasing (claude #547).
1964 calendar("09:00", &["TUE#2"]),
1965 ] {
1966 schedule_with(ok.clone(), RunsOn::Backend)
1967 .validate()
1968 .unwrap_or_else(|e| panic!("{ok} should validate: {e}"));
1969 }
1970 }
1971
1972 #[test]
1973 fn validate_rejects_bad_nth_weekday() {
1974 // ordinal out of 1..5, a range with #, and a bad day before #.
1975 for bad in ["tue#0", "tue#6", "tue#x", "mon-fri#2", "funday#2"] {
1976 let err = schedule_with(calendar("09:00", &[bad]), RunsOn::Backend)
1977 .validate()
1978 .unwrap_err();
1979 assert!(err.contains("when.days"), "for '{bad}', got: {err}");
1980 }
1981 }
1982
1983 #[test]
1984 fn validate_accepts_last_weekday() {
1985 // #418: last-weekday (`friL` = last Friday). Like the nth case,
1986 // validate() lowers to a cron and round-trips it through croner,
1987 // so passing proves token → DOW field → engine-acceptable cron
1988 // with the verified last-<dow>-of-month semantics.
1989 for ok in [
1990 calendar("09:00", &["friL"]), // last Friday
1991 calendar("03:00", &["sunL"]), // last Sunday
1992 calendar("22:00", &["5L"]), // numeric DOW + last
1993 calendar("00:00", &["0L"]), // numeric Sunday (0…
1994 calendar("00:00", &["7L"]), // …and its 7 alias)
1995 calendar("09:00", &["monL", "friL"]), // a list of last-weekdays
1996 // Case-insensitive both the weekday and the `L` suffix:
1997 // validate lowercases the day, croner upper-cases the whole
1998 // pattern before aliasing (claude #547).
1999 calendar("09:00", &["FRIL"]),
2000 calendar("09:00", &["fril"]),
2001 ] {
2002 schedule_with(ok.clone(), RunsOn::Backend)
2003 .validate()
2004 .unwrap_or_else(|e| panic!("{ok} should validate: {e}"));
2005 }
2006 }
2007
2008 #[test]
2009 fn validate_rejects_bad_last_weekday() {
2010 // bare `L` (no weekday — a footgun croner reads as Saturday), a
2011 // range with L, a bad day before L, and an internal space that
2012 // would otherwise leak a malformed cron downstream (gemini #560).
2013 for bad in ["L", "l", "mon-friL", "fundayL", "8L", "*L", "fri L"] {
2014 let err = schedule_with(calendar("09:00", &[bad]), RunsOn::Backend)
2015 .validate()
2016 .unwrap_err();
2017 assert!(err.contains("when.days"), "for '{bad}', got: {err}");
2018 }
2019 }
2020
2021 #[test]
2022 fn calendar_oneshot_instant_detects_past() {
2023 use chrono::TimeZone;
2024 // a dated `at` resolves to an absolute instant…
2025 let c = CalendarSpec {
2026 at: "2024-01-01 09:00".into(),
2027 days: vec![],
2028 };
2029 let t = c
2030 .oneshot_instant(ScheduleTz::Utc)
2031 .expect("one-shot instant");
2032 assert_eq!(
2033 t,
2034 chrono::Utc.with_ymd_and_hms(2024, 1, 1, 9, 0, 0).unwrap()
2035 );
2036 assert!(t < chrono::Utc::now(), "2024 is in the past");
2037 // …while a repeating (time-only) calendar has no instant
2038 let rep = CalendarSpec {
2039 at: "09:00".into(),
2040 days: vec!["mon-fri".into()],
2041 };
2042 assert!(rep.oneshot_instant(ScheduleTz::Utc).is_none());
2043 }
2044
2045 fn schedule_with_active(from: Option<&str>, until: Option<&str>) -> Schedule {
2046 let mut s = schedule_with(
2047 When::PerPc(PerPolicy::Once(OnceLiteral::Once)),
2048 RunsOn::Backend,
2049 );
2050 s.active = Active {
2051 from: from.map(str::to_owned),
2052 until: until.map(str::to_owned),
2053 };
2054 s
2055 }
2056
2057 #[test]
2058 fn validate_accepts_active_window() {
2059 schedule_with_active(Some("2026-07-01"), Some("2026-08-01T12:00:00+09:00"))
2060 .validate()
2061 .expect("date + rfc3339 bounds should validate");
2062 }
2063
2064 #[test]
2065 fn validate_rejects_unparseable_active_bound() {
2066 let err = schedule_with_active(Some("July 1st"), None)
2067 .validate()
2068 .unwrap_err();
2069 assert!(err.contains("active"), "got: {err}");
2070 }
2071
2072 #[test]
2073 fn validate_rejects_from_not_before_until() {
2074 let err = schedule_with_active(Some("2026-08-01"), Some("2026-07-01"))
2075 .validate()
2076 .unwrap_err();
2077 assert!(err.contains("strictly before"), "got: {err}");
2078
2079 let err = schedule_with_active(Some("2026-07-01"), Some("2026-07-01"))
2080 .validate()
2081 .unwrap_err();
2082 assert!(err.contains("strictly before"), "got: {err}");
2083 }
2084
2085 // ---- Active window semantics ----
2086
2087 #[test]
2088 fn active_window_is_half_open() {
2089 use chrono::TimeZone;
2090 let active = Active {
2091 from: Some("2026-07-01".into()),
2092 until: Some("2026-08-01".into()),
2093 };
2094 // UTC tz so the date bounds are UTC midnight.
2095 let at = |y, m, d, h| chrono::Utc.with_ymd_and_hms(y, m, d, h, 0, 0).unwrap();
2096 let c = |t| active.contains(t, ScheduleTz::Utc);
2097 assert!(!c(at(2026, 6, 30, 23)), "before from");
2098 assert!(c(at(2026, 7, 1, 0)), "at from (inclusive)");
2099 assert!(c(at(2026, 7, 15, 12)), "inside");
2100 assert!(!c(at(2026, 8, 1, 0)), "at until (exclusive)");
2101 assert!(!c(at(2026, 8, 2, 0)), "after until");
2102 }
2103
2104 #[test]
2105 fn active_empty_window_is_always_active() {
2106 assert!(Active::default().contains(chrono::Utc::now(), ScheduleTz::Local));
2107 }
2108
2109 #[test]
2110 fn active_rfc3339_bound_honours_offset_regardless_of_tz() {
2111 use chrono::TimeZone;
2112 let active = Active {
2113 from: Some("2026-07-01T09:00:00+09:00".into()),
2114 until: None,
2115 };
2116 // RFC3339 carries its own offset → tz arg is ignored.
2117 // 09:00 JST = 00:00 UTC.
2118 for tz in [ScheduleTz::Utc, ScheduleTz::Local] {
2119 assert!(
2120 !active.contains(
2121 chrono::Utc
2122 .with_ymd_and_hms(2026, 6, 30, 23, 59, 0)
2123 .unwrap(),
2124 tz
2125 )
2126 );
2127 assert!(active.contains(
2128 chrono::Utc.with_ymd_and_hms(2026, 7, 1, 0, 0, 0).unwrap(),
2129 tz
2130 ));
2131 }
2132 }
2133
2134 #[test]
2135 fn active_date_bound_respects_tz() {
2136 // A bare `YYYY-MM-DD` bound is midnight *in the schedule's
2137 // tz* (#418 Phase 2). The UTC interpretation is exact and
2138 // host-independent; assert that precisely.
2139 use chrono::TimeZone;
2140 let utc = Active::parse_bound("2026-07-01", ScheduleTz::Utc).expect("utc");
2141 assert_eq!(
2142 utc,
2143 chrono::Utc.with_ymd_and_hms(2026, 7, 1, 0, 0, 0).unwrap()
2144 );
2145
2146 // The local interpretation must equal what chrono::Local
2147 // computes for the same wall-clock midnight — proves the tz
2148 // path is wired to the host zone (the magnitude vs UTC is
2149 // host-dependent, so we compare against Local directly rather
2150 // than hard-coding the JST offset, keeping CI green on UTC
2151 // runners).
2152 let local = Active::parse_bound("2026-07-01", ScheduleTz::Local).expect("local");
2153 let want = chrono::Local
2154 .with_ymd_and_hms(2026, 7, 1, 0, 0, 0)
2155 .single()
2156 .expect("local midnight is unambiguous")
2157 .with_timezone(&chrono::Utc);
2158 assert_eq!(local, want, "date bound resolved in host-local tz");
2159 }
2160
2161 #[test]
2162 fn active_empty_is_skipped_when_serialising() {
2163 let s = schedule_with(
2164 When::PerPc(PerPolicy::Once(OnceLiteral::Once)),
2165 RunsOn::Backend,
2166 );
2167 let json = serde_json::to_value(&s).expect("serialise");
2168 assert!(
2169 json.get("active").is_none(),
2170 "empty active must not appear on the wire: {json}"
2171 );
2172 }
2173
2174 // ---- constraints.window (#418 Phase 3) ----
2175
2176 fn with_window(win: &str) -> Schedule {
2177 let mut s = schedule_with(
2178 When::PerPc(PerPolicy::Every(EverySpec { every: "6h".into() })),
2179 RunsOn::Backend,
2180 );
2181 s.constraints.window = Some(win.into());
2182 s
2183 }
2184
2185 #[test]
2186 fn constraints_window_parses_and_round_trips() {
2187 let yaml = r#"
2188id: x
2189when:
2190 per_pc: { every: 6h }
2191job_id: y
2192target: { all: true }
2193constraints:
2194 window: "22:00-05:00"
2195"#;
2196 let s: Schedule = serde_yaml::from_str(yaml).expect("parse");
2197 assert_eq!(s.constraints.window.as_deref(), Some("22:00-05:00"));
2198 let back: Schedule =
2199 serde_json::from_str(&serde_json::to_string(&s).expect("ser")).expect("de");
2200 assert_eq!(back.constraints.window.as_deref(), Some("22:00-05:00"));
2201 }
2202
2203 #[test]
2204 fn constraints_empty_is_skipped_when_serialising() {
2205 let s = schedule_with(
2206 When::PerPc(PerPolicy::Once(OnceLiteral::Once)),
2207 RunsOn::Backend,
2208 );
2209 let json = serde_json::to_value(&s).expect("serialise");
2210 assert!(
2211 json.get("constraints").is_none(),
2212 "empty constraints must not appear on the wire: {json}"
2213 );
2214 }
2215
2216 #[test]
2217 fn window_no_constraint_always_allows() {
2218 let c = Constraints::default();
2219 assert!(c.allows(chrono::Utc::now(), ScheduleTz::Local));
2220 }
2221
2222 #[test]
2223 fn window_same_day_is_half_open() {
2224 use chrono::TimeZone;
2225 let s = with_window("09:00-17:00");
2226 let at = |h, m| chrono::Utc.with_ymd_and_hms(2026, 6, 9, h, m, 0).unwrap();
2227 let a = |t| s.constraints.allows(t, ScheduleTz::Utc);
2228 assert!(!a(at(8, 59)), "before start");
2229 assert!(a(at(9, 0)), "at start (inclusive)");
2230 assert!(a(at(16, 59)), "inside");
2231 assert!(!a(at(17, 0)), "at end (exclusive)");
2232 assert!(!a(at(23, 0)), "after end");
2233 }
2234
2235 #[test]
2236 fn window_crossing_midnight() {
2237 use chrono::TimeZone;
2238 let s = with_window("22:00-05:00");
2239 let at = |h, m| chrono::Utc.with_ymd_and_hms(2026, 6, 9, h, m, 0).unwrap();
2240 let a = |t| s.constraints.allows(t, ScheduleTz::Utc);
2241 assert!(a(at(22, 0)), "at start tonight");
2242 assert!(a(at(23, 30)), "late tonight");
2243 assert!(a(at(3, 0)), "early tomorrow");
2244 assert!(!a(at(5, 0)), "at end (exclusive)");
2245 assert!(!a(at(12, 0)), "midday outside");
2246 assert!(!a(at(21, 59)), "just before start");
2247 }
2248
2249 #[test]
2250 fn window_respects_tz() {
2251 // The same instant is inside the window under one tz and may
2252 // be outside under another. Compare UTC vs Local via the
2253 // host's own offset (kept CI-green on UTC runners like the
2254 // active tz test does).
2255 use chrono::TimeZone;
2256 let s = with_window("09:00-17:00");
2257 let noon_utc = chrono::Utc.with_ymd_and_hms(2026, 6, 9, 12, 0, 0).unwrap();
2258 // Under UTC, 12:00 is inside 09:00-17:00.
2259 assert!(s.constraints.allows(noon_utc, ScheduleTz::Utc));
2260 // Under Local, the verdict tracks the host wall-clock time;
2261 // assert it matches a direct wall_time membership check.
2262 let local_t = noon_utc.with_timezone(&chrono::Local).time();
2263 let in_local = local_t >= chrono::NaiveTime::from_hms_opt(9, 0, 0).unwrap()
2264 && local_t < chrono::NaiveTime::from_hms_opt(17, 0, 0).unwrap();
2265 assert_eq!(s.constraints.allows(noon_utc, ScheduleTz::Local), in_local);
2266 }
2267
2268 #[test]
2269 fn validate_accepts_good_window() {
2270 for w in ["09:00-17:00", "22:00-05:00", "00:00-23:59"] {
2271 with_window(w)
2272 .validate()
2273 .unwrap_or_else(|e| panic!("'{w}' should validate: {e}"));
2274 }
2275 }
2276
2277 #[test]
2278 fn validate_rejects_bad_window() {
2279 for bad in ["9-5", "22:00", "22:00-22:00", "25:00-05:00", "09:00_17:00"] {
2280 let err = with_window(bad).validate().unwrap_err();
2281 assert!(
2282 err.contains("constraints.window"),
2283 "for '{bad}', got: {err}"
2284 );
2285 }
2286 }
2287
2288 // ---- constraints.max_concurrent (#418) ----
2289
2290 fn with_max_concurrent(max: u32, runs_on: RunsOn) -> Schedule {
2291 let mut s = schedule_with(
2292 When::PerPc(PerPolicy::Every(EverySpec { every: "6h".into() })),
2293 runs_on,
2294 );
2295 s.constraints.max_concurrent = Some(max);
2296 s
2297 }
2298
2299 #[test]
2300 fn validate_accepts_backend_max_concurrent() {
2301 with_max_concurrent(5, RunsOn::Backend)
2302 .validate()
2303 .expect("backend max_concurrent should validate");
2304 }
2305
2306 #[test]
2307 fn validate_rejects_max_concurrent_on_agent() {
2308 // Decision E: a central running-instance cap needs a central
2309 // counter, which agents don't have.
2310 let err = with_max_concurrent(5, RunsOn::Agent)
2311 .validate()
2312 .unwrap_err();
2313 assert!(err.contains("constraints.max_concurrent"), "got: {err}");
2314 assert!(err.contains("runs_on: agent"), "got: {err}");
2315 }
2316
2317 #[test]
2318 fn validate_rejects_zero_max_concurrent() {
2319 let err = with_max_concurrent(0, RunsOn::Backend)
2320 .validate()
2321 .unwrap_err();
2322 assert!(err.contains("max_concurrent must be >= 1"), "got: {err}");
2323 }
2324
2325 #[test]
2326 fn max_concurrent_round_trips_and_skips_when_absent() {
2327 let s = with_max_concurrent(3, RunsOn::Backend);
2328 let json = serde_json::to_value(&s.constraints).expect("ser");
2329 assert_eq!(json.get("max_concurrent").and_then(|v| v.as_u64()), Some(3));
2330 // A schedule with no constraints omits the whole block.
2331 let bare = schedule_with(
2332 When::PerPc(PerPolicy::Once(OnceLiteral::Once)),
2333 RunsOn::Backend,
2334 );
2335 assert!(bare.constraints.is_empty());
2336 }
2337
2338 #[test]
2339 fn window_fail_closed_on_corrupt_blob() {
2340 // A malformed window (only reachable via a hand-edited KV
2341 // blob — validate() rejects it at create) must BLOCK, not
2342 // silently allow fires during a change-freeze (gemini #452).
2343 let s = with_window("22:00_05:00");
2344 assert!(
2345 !s.constraints.allows(chrono::Utc::now(), ScheduleTz::Utc),
2346 "corrupt window fails closed"
2347 );
2348 // …and the scheduler can surface why it's stuck.
2349 assert!(
2350 s.bad_window().is_some(),
2351 "bad_window reports the parse error"
2352 );
2353 assert!(with_window("22:00-05:00").bad_window().is_none());
2354 }
2355
2356 #[test]
2357 fn calendar_outside_window_is_flagged() {
2358 // at 09:00 can never fall in 22:00-05:00 → never fires.
2359 let mut s = schedule_with(calendar("09:00", &["mon-fri"]), RunsOn::Backend);
2360 s.constraints.window = Some("22:00-05:00".into());
2361 assert!(s.calendar_outside_window(), "09:00 is not in 22:00-05:00");
2362
2363 // at 23:00 IS inside the overnight window → fine.
2364 let mut s = schedule_with(calendar("23:00", &[]), RunsOn::Backend);
2365 s.constraints.window = Some("22:00-05:00".into());
2366 assert!(!s.calendar_outside_window(), "23:00 is in 22:00-05:00");
2367
2368 // reconcile shapes are never flagged (they poll every minute).
2369 let mut s = schedule_with(
2370 When::PerPc(PerPolicy::Every(EverySpec { every: "6h".into() })),
2371 RunsOn::Backend,
2372 );
2373 s.constraints.window = Some("22:00-05:00".into());
2374 assert!(!s.calendar_outside_window(), "reconcile is unaffected");
2375
2376 // no window → never flagged.
2377 let s = schedule_with(calendar("09:00", &[]), RunsOn::Backend);
2378 assert!(!s.calendar_outside_window());
2379 }
2380
2381 // ---- on_failure.retry (#418 Phase 4) ----
2382
2383 fn with_retry(max: u32, backoff: &str) -> Schedule {
2384 let mut s = schedule_with(
2385 When::PerPc(PerPolicy::Every(EverySpec { every: "6h".into() })),
2386 RunsOn::Backend,
2387 );
2388 s.on_failure.retry = Some(Retry {
2389 max,
2390 backoff: backoff.into(),
2391 });
2392 s
2393 }
2394
2395 #[test]
2396 fn on_failure_parses_and_round_trips() {
2397 let yaml = r#"
2398id: x
2399when:
2400 per_pc: { every: 6h }
2401job_id: y
2402target: { all: true }
2403on_failure:
2404 retry: { max: 3, backoff: 10m }
2405"#;
2406 let s: Schedule = serde_yaml::from_str(yaml).expect("parse");
2407 let r = s.on_failure.retry.as_ref().expect("retry present");
2408 assert_eq!(r.max, 3);
2409 assert_eq!(r.backoff, "10m");
2410 let back: Schedule =
2411 serde_json::from_str(&serde_json::to_string(&s).expect("ser")).expect("de");
2412 assert_eq!(back.on_failure, s.on_failure);
2413 }
2414
2415 #[test]
2416 fn on_failure_empty_is_skipped_when_serialising() {
2417 let s = schedule_with(
2418 When::PerPc(PerPolicy::Once(OnceLiteral::Once)),
2419 RunsOn::Backend,
2420 );
2421 let json = serde_json::to_value(&s).expect("serialise");
2422 assert!(
2423 json.get("on_failure").is_none(),
2424 "empty on_failure must not appear on the wire: {json}"
2425 );
2426 }
2427
2428 #[test]
2429 fn validate_accepts_good_retry() {
2430 for (max, backoff) in [(1, "30s"), (3, "10m"), (10, "1h")] {
2431 with_retry(max, backoff)
2432 .validate()
2433 .unwrap_or_else(|e| panic!("retry {{max:{max}, backoff:{backoff}}}: {e}"));
2434 }
2435 }
2436
2437 #[test]
2438 fn validate_rejects_bad_backoff() {
2439 let err = with_retry(3, "soon").validate().unwrap_err();
2440 assert!(err.contains("on_failure.retry.backoff"), "got: {err}");
2441 }
2442
2443 #[test]
2444 fn validate_rejects_sub_second_backoff() {
2445 // "500ms" parses as humantime but lowers to 0s on the wire —
2446 // reject it so the operator doesn't get a silent no-wait
2447 // (coderabbit #466).
2448 for bad in ["500ms", "0s", "999ms"] {
2449 let err = with_retry(3, bad).validate().unwrap_err();
2450 assert!(
2451 err.contains("on_failure.retry.backoff must be >= 1s"),
2452 "for '{bad}', got: {err}"
2453 );
2454 }
2455 }
2456
2457 #[test]
2458 fn validate_rejects_out_of_range_max() {
2459 for bad in [0u32, 11, 1000] {
2460 let err = with_retry(bad, "10m").validate().unwrap_err();
2461 assert!(
2462 err.contains("on_failure.retry.max"),
2463 "for max={bad}, got: {err}"
2464 );
2465 }
2466 }
2467
2468 #[test]
2469 fn lowered_retry_reduces_backoff_to_seconds() {
2470 let s = with_retry(3, "10m");
2471 let spec = s.on_failure.lowered_retry().expect("a retry policy");
2472 assert_eq!(spec.max, 3);
2473 assert_eq!(spec.backoff_secs, 600);
2474 }
2475
2476 #[test]
2477 fn lowered_retry_is_none_without_policy() {
2478 let s = schedule_with(
2479 When::PerPc(PerPolicy::Once(OnceLiteral::Once)),
2480 RunsOn::Backend,
2481 );
2482 assert!(s.on_failure.lowered_retry().is_none());
2483 }
2484
2485 // ---- global change-freeze (#418 Phase 5) ----
2486
2487 #[test]
2488 fn freeze_empty_window_is_always_active() {
2489 // The big-red-button shape: no bounds = frozen until cleared.
2490 let f = Freeze::default();
2491 assert!(f.is_active(chrono::Utc::now()));
2492 }
2493
2494 #[test]
2495 fn freeze_window_is_half_open() {
2496 use chrono::TimeZone;
2497 let f = Freeze {
2498 from: Some("2026-12-20T00:00:00+00:00".into()),
2499 until: Some("2027-01-05T00:00:00+00:00".into()),
2500 reason: Some("year-end".into()),
2501 tz: ScheduleTz::Utc,
2502 };
2503 let at = |y, mo, d| chrono::Utc.with_ymd_and_hms(y, mo, d, 0, 0, 0).unwrap();
2504 assert!(!f.is_active(at(2026, 12, 19)), "before from = not frozen");
2505 assert!(f.is_active(at(2026, 12, 20)), "from is inclusive");
2506 assert!(f.is_active(at(2026, 12, 31)), "inside window");
2507 assert!(!f.is_active(at(2027, 1, 5)), "until is exclusive");
2508 assert!(!f.is_active(at(2027, 1, 6)), "after until = not frozen");
2509 }
2510
2511 #[test]
2512 fn freeze_fails_closed_on_corrupt_bound() {
2513 // A freeze is a safety switch: an unparseable bound (only
2514 // reachable via a hand-edited KV blob) must read as FROZEN, not
2515 // "fire normally" (coderabbit #472) — the opposite of `active`,
2516 // which fail-opens.
2517 let f = Freeze {
2518 from: Some("not-a-date".into()),
2519 until: None,
2520 reason: None,
2521 tz: ScheduleTz::Utc,
2522 };
2523 assert!(f.is_active(chrono::Utc::now()), "corrupt bound → frozen");
2524 }
2525
2526 #[test]
2527 fn freeze_validate_accepts_good_bounds() {
2528 Freeze {
2529 from: Some("2026-12-20".into()),
2530 until: Some("2027-01-05T12:00:00+09:00".into()),
2531 reason: None,
2532 tz: ScheduleTz::Local,
2533 }
2534 .validate()
2535 .expect("date + rfc3339 bounds should validate");
2536 // Empty (indefinite) freeze is valid.
2537 Freeze::default().validate().expect("empty freeze is valid");
2538 }
2539
2540 #[test]
2541 fn freeze_validate_rejects_bad_bound_and_inverted_window() {
2542 let err = Freeze {
2543 from: Some("never".into()),
2544 ..Default::default()
2545 }
2546 .validate()
2547 .unwrap_err();
2548 assert!(err.contains("freeze:"), "got: {err}");
2549
2550 let inverted = Freeze {
2551 from: Some("2027-01-05".into()),
2552 until: Some("2026-12-20".into()),
2553 ..Default::default()
2554 }
2555 .validate()
2556 .unwrap_err();
2557 assert!(inverted.contains("freeze.from"), "got: {inverted}");
2558 }
2559
2560 #[test]
2561 fn freeze_round_trips_and_skips_empty_fields() {
2562 let f = Freeze {
2563 from: None,
2564 until: Some("2027-01-05".into()),
2565 reason: Some("INC-1234".into()),
2566 tz: ScheduleTz::Utc,
2567 };
2568 let json = serde_json::to_value(&f).expect("serialise");
2569 assert!(json.get("from").is_none(), "empty from omitted: {json}");
2570 let back: Freeze = serde_json::from_value(json).expect("round-trip");
2571 assert_eq!(back, f);
2572 }
2573
2574 #[test]
2575 fn shipped_schedule_configs_parse_and_validate() {
2576 // Every YAML under configs/schedules/ must parse with the
2577 // current Schedule serde AND pass validate() — keeps the
2578 // shipped examples from drifting out of sync with the model
2579 // (#418 removed back-compat, so drift = broken at create).
2580 let dir = std::path::Path::new(env!("CARGO_MANIFEST_DIR")).join("../../configs/schedules");
2581 let mut seen = 0;
2582 for entry in std::fs::read_dir(&dir).expect("read configs/schedules") {
2583 let path = entry.expect("dir entry").path();
2584 if path.extension().and_then(|e| e.to_str()) != Some("yaml") {
2585 continue;
2586 }
2587 let body = std::fs::read_to_string(&path).expect("read yaml");
2588 let s: Schedule = serde_yaml::from_str(&body)
2589 .unwrap_or_else(|e| panic!("{} failed to parse: {e}", path.display()));
2590 s.validate()
2591 .unwrap_or_else(|e| panic!("{} failed validate(): {e}", path.display()));
2592 seen += 1;
2593 }
2594 assert!(seen > 0, "no schedule YAMLs found in {}", dir.display());
2595 }
2596
2597 // ---- pre-existing enum wire formats (unchanged by #418) ----
2598
2599 #[test]
2600 fn exec_mode_serialises_snake_case() {
2601 for (mode, expected) in [
2602 (ExecMode::EveryTick, "every_tick"),
2603 (ExecMode::OncePerPc, "once_per_pc"),
2604 (ExecMode::OncePerTarget, "once_per_target"),
2605 ] {
2606 let s = serde_json::to_value(mode).expect("serialise");
2607 assert_eq!(s, serde_json::Value::String(expected.into()));
2608 let back: ExecMode = serde_json::from_value(serde_json::Value::String(expected.into()))
2609 .expect("deserialise");
2610 assert_eq!(back, mode, "round-trip for {expected}");
2611 }
2612 }
2613
2614 #[test]
2615 fn schedule_runs_on_defaults_to_backend() {
2616 let yaml = r#"
2617id: x
2618when:
2619 per_pc: once
2620job_id: y
2621target: { all: true }
2622"#;
2623 let s: Schedule = serde_yaml::from_str(yaml).expect("parse");
2624 assert_eq!(s.runs_on, RunsOn::Backend);
2625 }
2626
2627 #[test]
2628 fn schedule_runs_on_agent_parses() {
2629 let yaml = r#"
2630id: offline-inv
2631when:
2632 per_pc: { every: 1h }
2633job_id: inventory-hw
2634target: { all: true }
2635runs_on: agent
2636"#;
2637 let s: Schedule = serde_yaml::from_str(yaml).expect("parse");
2638 assert_eq!(s.runs_on, RunsOn::Agent);
2639 assert_eq!(s.lowered().mode, ExecMode::OncePerPc);
2640 }
2641
2642 #[test]
2643 fn runs_on_serialises_snake_case() {
2644 for (mode, expected) in [(RunsOn::Backend, "backend"), (RunsOn::Agent, "agent")] {
2645 let s = serde_json::to_value(mode).expect("serialise");
2646 assert_eq!(s, serde_json::Value::String(expected.into()));
2647 let back: RunsOn = serde_json::from_value(serde_json::Value::String(expected.into()))
2648 .expect("deserialise");
2649 assert_eq!(back, mode);
2650 }
2651 }
2652
2653 #[test]
2654 fn execute_shell_into_wire_shell() {
2655 assert_eq!(Shell::from(ExecuteShell::Powershell), Shell::Powershell);
2656 assert_eq!(Shell::from(ExecuteShell::Cmd), Shell::Cmd);
2657 }
2658
2659 #[test]
2660 fn manifest_staleness_defaults_to_cached() {
2661 let yaml = r#"
2662id: x
2663version: 1.0.0
2664execute:
2665 shell: powershell
2666 script: "echo"
2667 timeout: 1s
2668"#;
2669 let m: Manifest = serde_yaml::from_str(yaml).expect("parse");
2670 assert_eq!(m.staleness, Staleness::Cached);
2671 }
2672
2673 #[test]
2674 fn manifest_strict_staleness_parses() {
2675 let yaml = r#"
2676id: urgent-patch
2677version: 2.5.1
2678execute:
2679 shell: powershell
2680 script: Install-Hotfix
2681 timeout: 5m
2682staleness:
2683 mode: strict
2684 max_cache_age: 0s
2685"#;
2686 let m: Manifest = serde_yaml::from_str(yaml).expect("parse");
2687 match m.staleness {
2688 Staleness::Strict { max_cache_age } => assert_eq!(max_cache_age, "0s"),
2689 other => panic!("expected strict, got {other:?}"),
2690 }
2691 }
2692
2693 #[test]
2694 fn manifest_unchecked_staleness_parses() {
2695 let yaml = r#"
2696id: legacy
2697version: 0.1.0
2698execute:
2699 shell: cmd
2700 script: "echo"
2701 timeout: 1s
2702staleness:
2703 mode: unchecked
2704"#;
2705 let m: Manifest = serde_yaml::from_str(yaml).expect("parse");
2706 assert_eq!(m.staleness, Staleness::Unchecked);
2707 }
2708
2709 #[test]
2710 fn missing_required_field_errors() {
2711 // `id` missing.
2712 let yaml = r#"
2713version: 1.0.0
2714target: { all: true }
2715execute:
2716 shell: powershell
2717 script: "echo"
2718 timeout: 1s
2719"#;
2720 let r: Result<Manifest, _> = serde_yaml::from_str(yaml);
2721 assert!(r.is_err(), "expected error, got {:?}", r);
2722 }
2723
2724 #[test]
2725 fn display_field_table_kind_round_trips_with_nested_columns() {
2726 // #39: `type: table` + `columns:` on a DisplayField gets
2727 // round-tripped through serde so the SPA receives the
2728 // nested schema verbatim. Nested columns themselves are
2729 // DisplayFields so they can carry `type: bytes` /
2730 // `type: number` for cell formatting.
2731 let yaml = r#"
2732id: inv-hw
2733version: 1.0.0
2734execute:
2735 shell: powershell
2736 script: "echo"
2737 timeout: 60s
2738inventory:
2739 display:
2740 - field: hostname
2741 label: Hostname
2742 - field: disks
2743 label: Disks
2744 type: table
2745 columns:
2746 - field: device_id
2747 label: Drive
2748 - field: size_bytes
2749 label: Size
2750 type: bytes
2751 - field: free_bytes
2752 label: Free
2753 type: bytes
2754 - field: file_system
2755 label: FS
2756"#;
2757 let m: Manifest = serde_yaml::from_str(yaml).expect("parse");
2758 let inv = m.inventory.as_ref().expect("inventory hint");
2759 let disks = inv
2760 .display
2761 .iter()
2762 .find(|d| d.field == "disks")
2763 .expect("disks display row");
2764 assert_eq!(disks.kind.as_deref(), Some("table"));
2765 let cols = disks.columns.as_ref().expect("table needs columns");
2766 assert_eq!(cols.len(), 4);
2767 assert_eq!(cols[1].field, "size_bytes");
2768 assert_eq!(cols[1].kind.as_deref(), Some("bytes"));
2769 }
2770
2771 #[test]
2772 fn display_field_scalar_kind_keeps_columns_none() {
2773 // Defensive: when type is a scalar (`bytes` / `number` /
2774 // `timestamp`) the `columns` field stays None — the SPA
2775 // uses its presence as the "render nested table" signal,
2776 // so it must not leak in via serde defaults.
2777 let yaml = r#"
2778id: x
2779version: 1.0.0
2780execute:
2781 shell: powershell
2782 script: "echo"
2783 timeout: 5s
2784inventory:
2785 display:
2786 - { field: ram_bytes, label: RAM, type: bytes }
2787"#;
2788 let m: Manifest = serde_yaml::from_str(yaml).expect("parse");
2789 let inv = m.inventory.as_ref().unwrap();
2790 assert!(inv.display[0].columns.is_none());
2791 }
2792}
2793
2794/// Periodic schedule (spec §2.4.3). v0.18.0 carries the fanout plan
2795/// (target + optional rollout + optional jitter) inline; the
2796/// referenced job (`job_id` → [`BUCKET_JOBS`]) supplies only the
2797/// script body. Two schedules of the same job can target different
2798/// groups on different cadences without copying the manifest.
2799///
2800/// #418 Phase 1: the cadence is the single [`When`] field. The old
2801/// `cron` × `mode` × `cooldown` × `auto_disable_when_done` quartet
2802/// is gone (no back-compat — pre-Phase-1 KV blobs fail to parse and
2803/// are warn-skipped; re-`schedule create` to upgrade them). The
2804/// engine underneath is unchanged: [`Schedule::lowered`] maps `when`
2805/// onto the same (cron, ExecMode, cooldown) trio the scheduler and
2806/// `decide_fire` always ran on.
2807#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone)]
2808pub struct Schedule {
2809 pub id: String,
2810 /// When to fire — a reconcile cadence (`per_pc` / `per_target`)
2811 /// or a calendar time trigger (`at` / `days`). See [`When`].
2812 ///
2813 /// `singleton_map`: serde_yaml 0.9 renders externally-tagged
2814 /// enums as `!per_pc` YAML tags by default; this keeps the
2815 /// operator-facing map shape (`when: { per_pc: once }`). JSON
2816 /// output is identical either way, and the schemars schema
2817 /// (external tagging = oneOf of single-key objects) already
2818 /// matches the singleton-map wire shape.
2819 #[serde(with = "serde_yaml::with::singleton_map")]
2820 #[schemars(with = "When")]
2821 pub when: When,
2822 /// Key into [`crate::kv::BUCKET_JOBS`]. Must equal a registered
2823 /// Manifest's `id`.
2824 pub job_id: String,
2825 /// Who + how-to-phase + when-to-stagger. The Manifest doesn't
2826 /// carry these any more — same job + different fanout = different
2827 /// schedule.
2828 #[serde(flatten)]
2829 pub plan: FanoutPlan,
2830 /// Optional validity window. Outside `[from, until)` the
2831 /// schedule is dormant — still registered, still visible, but
2832 /// every tick is skipped (deleted ≠ dormant: a campaign that
2833 /// ended stays inspectable and can be re-armed by editing the
2834 /// window). Checked at tick time on both the backend scheduler
2835 /// and the agent's local scheduler.
2836 #[serde(default, skip_serializing_if = "Active::is_empty")]
2837 pub active: Active,
2838 /// #418 Phase 3: operational constraints gating *when within an
2839 /// active period* a fire may happen. Currently just `window`
2840 /// (a maintenance time-of-day window); future `require`
2841 /// (env gates) and `max_concurrent` land in the same namespace.
2842 /// Evaluated in the schedule's `tz` like the other wall-clock
2843 /// fields. Checked at tick time on both schedulers.
2844 #[serde(default, skip_serializing_if = "Constraints::is_empty")]
2845 pub constraints: Constraints,
2846 /// #418 Phase 4: what to do after a fire's script comes back
2847 /// failed. Currently just `retry` (fixed-backoff in-process
2848 /// re-run); future `notify` / `disable` join the same namespace.
2849 /// Applied fire-side in `handle_command` (the retry policy is
2850 /// lowered onto every Command this schedule produces), so it
2851 /// covers both `runs_on` locations.
2852 #[serde(default, skip_serializing_if = "OnFailure::is_empty")]
2853 pub on_failure: OnFailure,
2854 /// #418 Phase 2: the timezone this schedule's wall-clock fields
2855 /// are evaluated in — both the calendar `at` firing time AND the
2856 /// `active.{from,until}` window bounds. `local` (default) = the
2857 /// running host's TZ (the agent's for `runs_on: agent`, the
2858 /// backend server's otherwise); `utc` for TZ-independent
2859 /// schedules. Reconcile shapes (`per_pc`/`per_target`) ignore it
2860 /// for firing (poll cron runs every minute regardless) but still
2861 /// honor it for the `active` window.
2862 #[serde(default)]
2863 pub tz: ScheduleTz,
2864 /// v0.22: optional humantime window after a cron tick during
2865 /// which the Command is still considered "live". The scheduler
2866 /// computes `tick_at + starting_deadline` and stamps it onto
2867 /// each Command as `deadline_at`; agents skip Commands they
2868 /// receive after that absolute time. `None` (default) = no
2869 /// deadline, meaning a Command queued in the broker / stream
2870 /// during agent downtime runs whenever the agent reconnects —
2871 /// good for kitting / inventory / cleanup. Set this for
2872 /// time-of-day notifications, lunch reminders, etc., where
2873 /// "fire 3 hours late" would be wrong.
2874 #[serde(default, skip_serializing_if = "Option::is_none")]
2875 pub starting_deadline: Option<String>,
2876 /// v0.23: where does the cron tick happen? `Backend` (default,
2877 /// historical) = backend's scheduler fires Commands via NATS;
2878 /// agents passively receive. `Agent` = each targeted agent runs
2879 /// its own internal cron and fires locally, so the schedule
2880 /// keeps ticking even when the broker is unreachable (laptop on
2881 /// the train, broker maintenance window, full WAN outage). The
2882 /// two locations are mutually exclusive — when `Agent`, the
2883 /// backend scheduler stays out and just keeps the definition in
2884 /// KV for agents to read.
2885 #[serde(default)]
2886 pub runs_on: RunsOn,
2887 #[serde(default = "default_true")]
2888 pub enabled: bool,
2889}
2890
2891/// v0.23 — where the cron tick fires from.
2892#[derive(
2893 Serialize, Deserialize, schemars::JsonSchema, Debug, Clone, Copy, PartialEq, Eq, Default,
2894)]
2895#[serde(rename_all = "snake_case")]
2896pub enum RunsOn {
2897 /// Backend's central scheduler ticks and publishes Commands to
2898 /// NATS. Historical default, what every pre-v0.23 schedule
2899 /// uses. Agent offline ⇒ Command queued in STREAM_EXEC; agent
2900 /// reconnects ⇒ catch-up via [`command_replay`](crate)
2901 /// (see kanade-agent's command_replay module).
2902 #[default]
2903 Backend,
2904 /// Each targeted agent runs the cron tick locally. Survives
2905 /// broker / WAN outages. Best for laptops / mobile devices that
2906 /// roam off the corporate network. Agent must be online for the
2907 /// initial schedule + job-catalog pull, but once cached the
2908 /// agent fires the script standalone.
2909 Agent,
2910}
2911
2912/// Per-pc/per-target dedup semantics for a [`Schedule`] (v0.19).
2913#[derive(
2914 Serialize, Deserialize, schemars::JsonSchema, Debug, Clone, Copy, PartialEq, Eq, Default,
2915)]
2916#[serde(rename_all = "snake_case")]
2917pub enum ExecMode {
2918 /// Fire on every cron tick at the whole target. Historical
2919 /// (pre-v0.19) behavior; no dedup.
2920 #[default]
2921 EveryTick,
2922 /// Fire at each pc until that pc succeeds; then skip it until
2923 /// the optional cooldown elapses (or forever if no cooldown).
2924 /// Use for kitting / first-boot / per-pc compliance checks.
2925 OncePerPc,
2926 /// Fire at the whole target until **any** pc succeeds; then
2927 /// skip the whole target until the optional cooldown elapses
2928 /// (or forever if no cooldown). Use for "one delegate is
2929 /// enough" tasks like license check-in.
2930 OncePerTarget,
2931}
2932
2933/// #418 Phase 1 — the single "when does this fire" axis.
2934///
2935/// Replaces the old `cron` + `mode` + `cooldown` trio whose
2936/// interactions were implicit (cron doubled as both a real
2937/// time-of-day trigger and a reconcile poll period; contradictory
2938/// combinations silently no-opped). Two shapes:
2939///
2940/// * **reconcile** (`per_pc` / `per_target`) — desired-state: "each
2941/// pc (or one delegate) should have run this within `every`".
2942/// The poll period is system-generated ([`POLL_CRON`], every
2943/// minute) and no longer the operator's concern.
2944/// * **calendar** (`{ at, days }`) — a wall-clock time trigger
2945/// (#418 Phase 2, replacing the old raw-cron escape hatch). Fires
2946/// the whole target at the given time, no dedup. `at: "09:00"` +
2947/// `days` repeats; `at: "2026-06-10 09:00"` (a date+time) fires
2948/// exactly once. Evaluated in the schedule's top-level `tz`.
2949#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone, PartialEq, Eq)]
2950#[serde(rename_all = "snake_case")]
2951pub enum When {
2952 /// Fire at each targeted pc: `once` (kitting — succeed once,
2953 /// skip forever, forever catching brand-new / re-imaged pcs)
2954 /// or `{ every: <humantime> }` (patrol — re-arm per pc after
2955 /// the interval).
2956 PerPc(PerPolicy),
2957 /// Fire until **any** one pc of the target succeeds, then skip
2958 /// the whole target (`once`) or re-arm after `every`. Needs
2959 /// fleet-wide completion data, so it is backend-only —
2960 /// `runs_on: agent` + `per_target` is rejected by
2961 /// [`Schedule::validate`].
2962 PerTarget(PerPolicy),
2963 /// Calendar time trigger: `{ at: "09:00", days: [mon-fri] }`
2964 /// (repeating) or `{ at: "2026-06-10 09:00" }` (one-shot). Fires
2965 /// the whole target at that wall-clock time in the schedule's
2966 /// `tz` — no dedup, no cooldown.
2967 Calendar(CalendarSpec),
2968}
2969
2970/// Calendar time trigger (#418 Phase 2). `at` is either a time of
2971/// day (`"HH:MM"`, repeating — combine with `days`) or a full
2972/// date+time (`"YYYY-MM-DD HH:MM"`, a one-shot that fires once and
2973/// never again). Evaluated in the schedule's top-level `tz`.
2974#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone, PartialEq, Eq)]
2975pub struct CalendarSpec {
2976 /// `"HH:MM"` (24h) for a repeating trigger, or
2977 /// `"YYYY-MM-DD HH:MM"` (hyphen / slash / `T` separators all
2978 /// accepted) for a one-shot. Parsed lazily —
2979 /// [`Schedule::validate`] rejects garbage at create time.
2980 pub at: String,
2981 /// Day-of-week filter for a time-of-day `at`: `["mon-fri"]`,
2982 /// `["mon","wed","fri"]`, … (passed verbatim to the cron DOW
2983 /// field, so ranges and names both work). An **nth-weekday**
2984 /// `["tue#2"]` fires only on the 2nd Tuesday of each month
2985 /// ("Patch Tuesday"); the ordinal is `1..5`. A **last-weekday**
2986 /// `["friL"]` fires only on the last Friday of each month (handy
2987 /// for monthly maintenance). Empty = every day. Must be empty
2988 /// when `at` carries a date (the date already pins the day).
2989 #[serde(default, skip_serializing_if = "Vec::is_empty")]
2990 pub days: Vec<String>,
2991}
2992
2993/// Parsed `CalendarSpec.at`: the wall-clock minute/hour, plus the
2994/// date for a one-shot (`None` = repeating time-of-day).
2995struct ParsedAt {
2996 minute: u32,
2997 hour: u32,
2998 date: Option<chrono::NaiveDate>,
2999}
3000
3001impl CalendarSpec {
3002 /// Parse `at`: a date+time (`YYYY-MM-DD HH:MM`, hyphen / slash /
3003 /// `T` separators) is a one-shot; a bare `HH:MM` is repeating.
3004 fn parse_at(&self) -> Result<ParsedAt, String> {
3005 use chrono::Timelike;
3006 let s = self.at.trim();
3007 for fmt in ["%Y-%m-%d %H:%M", "%Y-%m-%dT%H:%M", "%Y/%m/%d %H:%M"] {
3008 if let Ok(dt) = chrono::NaiveDateTime::parse_from_str(s, fmt) {
3009 return Ok(ParsedAt {
3010 minute: dt.minute(),
3011 hour: dt.hour(),
3012 date: Some(dt.date()),
3013 });
3014 }
3015 }
3016 if let Ok(t) = chrono::NaiveTime::parse_from_str(s, "%H:%M") {
3017 return Ok(ParsedAt {
3018 minute: t.minute(),
3019 hour: t.hour(),
3020 date: None,
3021 });
3022 }
3023 Err(format!(
3024 "when.at: unparseable '{}' (want HH:MM or YYYY-MM-DD HH:MM)",
3025 self.at
3026 ))
3027 }
3028
3029 /// Pre-flight check on the `days` tokens so a bad day name gives
3030 /// a `when.days:`-scoped error instead of croner's confusing
3031 /// "when.at lowered to invalid cron" (claude #432 review). Each
3032 /// token is a day name (`mon`..`sun`), a numeric DOW (`0`..`7`),
3033 /// `*`, a `-` range of those, an **nth-weekday** like `tue#2`
3034 /// (2nd Tuesday of the month — "Patch Tuesday"), or a
3035 /// **last-weekday** like `friL` (last Friday of the month).
3036 fn validate_days(&self) -> Result<(), String> {
3037 const NAMES: [&str; 7] = ["mon", "tue", "wed", "thu", "fri", "sat", "sun"];
3038 let is_day = |p: &str| NAMES.contains(&p) || p.parse::<u8>().is_ok_and(|n| n <= 7);
3039 for tok in &self.days {
3040 // Report the whole token on a malformed range like `mon-`
3041 // (which would otherwise split to a cryptic empty part —
3042 // claude #432 follow-up).
3043 let invalid = |reason: &str| {
3044 Err(format!(
3045 "when.days: invalid day token '{tok}' ({reason}; \
3046 want mon..sun, 0-7, a range like mon-fri, an nth-weekday \
3047 like tue#2, a last-weekday like friL, or *)"
3048 ))
3049 };
3050 // #418: nth-weekday suffix (`tue#2` = 2nd Tuesday). Croner
3051 // accepts `<dow>#<n>` (n = 1..5) in the DOW field, and
3052 // `to_cron` passes the token through verbatim, so the
3053 // engine fires only on that occurrence. It's a single
3054 // weekday + ordinal — not combinable with a range.
3055 if let Some((day_part, nth_part)) = tok.split_once('#') {
3056 // Normalize once and use `d` consistently (gemini #547);
3057 // the outer `invalid` already echoes the raw `tok`.
3058 let d = day_part.trim().to_ascii_lowercase();
3059 if d.contains('-') || !is_day(&d) {
3060 return invalid("the part before # must be a single weekday");
3061 }
3062 match nth_part.trim().parse::<u8>() {
3063 Ok(n) if (1..=5).contains(&n) => {}
3064 _ => return invalid("the # ordinal must be 1..5 (e.g. tue#2 = 2nd Tuesday)"),
3065 }
3066 continue;
3067 }
3068 // #418: last-weekday suffix (`friL` = last Friday of the
3069 // month — the monthly-maintenance sibling of Patch Tuesday).
3070 // Croner accepts `<dow>L` in the DOW field with verified
3071 // last-<dow>-of-month semantics, and `to_cron` passes it
3072 // through verbatim. A single weekday + `L` — bare `L` and
3073 // ranges are rejected (croner would read bare `L` as
3074 // Saturday, which is a confusing footgun).
3075 if let Some(day_part) = tok.strip_suffix(['L', 'l']) {
3076 // No `.trim()`: a cron DOW token can't carry internal
3077 // whitespace, so `"fri L"` must be *rejected* here (its
3078 // strip leaves `"fri "`, and `is_day` catches the space)
3079 // rather than trimmed into a clean `"fri"` that then
3080 // produces a malformed `fri L` cron downstream and a
3081 // confusing croner error (gemini #560).
3082 let d = day_part.to_ascii_lowercase();
3083 if d.is_empty() {
3084 return invalid("`L` (last-weekday) needs a weekday before it, e.g. friL");
3085 }
3086 if d.contains('-') || !is_day(&d) {
3087 return invalid(
3088 "the part before L must be a single weekday (e.g. friL = last Friday)",
3089 );
3090 }
3091 continue;
3092 }
3093 for part in tok.split('-') {
3094 let p = part.trim().to_ascii_lowercase();
3095 if p.is_empty() {
3096 return invalid("empty range bound");
3097 }
3098 if p != "*" && !is_day(&p) {
3099 return invalid(&format!("'{part}' is not a day"));
3100 }
3101 }
3102 }
3103 Ok(())
3104 }
3105
3106 /// For a one-shot (`at` carries a date), the absolute instant it
3107 /// fires in `tz`. `None` for a repeating calendar. Used to warn
3108 /// about a one-shot whose date is already in the past (it would
3109 /// never fire).
3110 pub fn oneshot_instant(&self, tz: ScheduleTz) -> Option<chrono::DateTime<chrono::Utc>> {
3111 let p = self.parse_at().ok()?;
3112 let date = p.date?;
3113 let naive = date.and_hms_opt(p.hour, p.minute, 0)?;
3114 tz.naive_to_utc(naive)
3115 }
3116
3117 /// The wall-clock time-of-day this calendar fires at (`None` if
3118 /// `at` is unparseable — validate() guards that). Used to detect
3119 /// a calendar whose fire time can never fall inside its
3120 /// `constraints.window` (claude #452 review).
3121 pub fn fire_time(&self) -> Option<chrono::NaiveTime> {
3122 let p = self.parse_at().ok()?;
3123 chrono::NaiveTime::from_hms_opt(p.hour, p.minute, 0)
3124 }
3125
3126 /// Lower to the cron string the scheduler engine runs. Repeating
3127 /// → 6-field `0 {min} {hour} * * {dow}`; one-shot → 7-field
3128 /// `0 {min} {hour} {day} {month} * {year}` (a past year never
3129 /// fires — that's what makes it one-shot).
3130 fn to_cron(&self) -> Result<String, String> {
3131 use chrono::Datelike;
3132 let ParsedAt { minute, hour, date } = self.parse_at()?;
3133 match date {
3134 Some(d) => {
3135 if !self.days.is_empty() {
3136 return Err(
3137 "when.at with a date is a one-shot and cannot be combined with days".into(),
3138 );
3139 }
3140 Ok(format!(
3141 "0 {minute} {hour} {} {} * {}",
3142 d.day(),
3143 d.month(),
3144 d.year()
3145 ))
3146 }
3147 None => {
3148 let dow = if self.days.is_empty() {
3149 "*".to_string()
3150 } else {
3151 self.validate_days()?;
3152 self.days.join(",")
3153 };
3154 Ok(format!("0 {minute} {hour} * * {dow}"))
3155 }
3156 }
3157 }
3158}
3159
3160/// The timezone a schedule's wall-clock fields (`when.at`,
3161/// `active.{from,until}`) are evaluated in (#418 Phase 2).
3162#[derive(
3163 Serialize, Deserialize, schemars::JsonSchema, Debug, Clone, Copy, PartialEq, Eq, Default,
3164)]
3165#[serde(rename_all = "snake_case")]
3166pub enum ScheduleTz {
3167 /// The running host's local timezone — the agent's for
3168 /// `runs_on: agent`, the backend server's otherwise. Default.
3169 #[default]
3170 Local,
3171 /// UTC — for timezone-independent schedules.
3172 Utc,
3173}
3174
3175impl ScheduleTz {
3176 /// Interpret a naive (zoneless) datetime as being in this tz and
3177 /// convert to UTC. On a DST *fold* (the local time occurs twice
3178 /// when clocks go back) we pick `.earliest()` rather than
3179 /// rejecting it; `None` is reserved for a true DST *gap* (a local
3180 /// time that never exists). `Utc` is fixed-offset so neither ever
3181 /// happens; `Local` is whatever timezone the running host is set
3182 /// to and *can* hit a gap/fold on any DST-observing host — not
3183 /// just the JST we run today (gemini + claude #432 review).
3184 fn naive_to_utc(self, naive: chrono::NaiveDateTime) -> Option<chrono::DateTime<chrono::Utc>> {
3185 use chrono::TimeZone;
3186 match self {
3187 ScheduleTz::Utc => Some(chrono::DateTime::from_naive_utc_and_offset(
3188 naive,
3189 chrono::Utc,
3190 )),
3191 ScheduleTz::Local => chrono::Local
3192 .from_local_datetime(&naive)
3193 .earliest()
3194 .map(|dt| dt.with_timezone(&chrono::Utc)),
3195 }
3196 }
3197
3198 /// The wall-clock time-of-day `now` reads as in this tz — used by
3199 /// [`Constraints::allows`] to test a maintenance window
3200 /// (#418 Phase 3). `Utc` is the naive UTC time; `Local` is the
3201 /// running host's local time.
3202 fn wall_time(self, now: chrono::DateTime<chrono::Utc>) -> chrono::NaiveTime {
3203 match self {
3204 ScheduleTz::Utc => now.time(),
3205 ScheduleTz::Local => now.with_timezone(&chrono::Local).time(),
3206 }
3207 }
3208
3209 /// Stable lowercase wire/display label (`local` / `utc`) — matches
3210 /// the serde `snake_case` representation. Used for the preview
3211 /// response's `tz` field so the JSON shape isn't coupled to the
3212 /// `Debug` repr (claude #578 review).
3213 pub fn as_str(self) -> &'static str {
3214 match self {
3215 ScheduleTz::Local => "local",
3216 ScheduleTz::Utc => "utc",
3217 }
3218 }
3219}
3220
3221impl std::fmt::Display for ScheduleTz {
3222 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
3223 f.write_str(self.as_str())
3224 }
3225}
3226
3227/// `once` vs `{ every: <humantime> }` — shared by `per_pc` /
3228/// `per_target`. Untagged so the YAML stays the bare keyword or a
3229/// one-key map, nothing more ceremonial.
3230#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone, PartialEq, Eq)]
3231#[serde(untagged)]
3232pub enum PerPolicy {
3233 /// The bare string `once`: succeed once, then skip permanently
3234 /// (cooldown = infinity).
3235 Once(OnceLiteral),
3236 /// Re-arm after the humantime interval, e.g. `{ every: 6h }`.
3237 Every(EverySpec),
3238}
3239
3240/// Single-variant enum so serde accepts exactly the string `once`
3241/// (a free-form `String` would swallow typos like `onec`).
3242#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone, Copy, PartialEq, Eq)]
3243#[serde(rename_all = "snake_case")]
3244pub enum OnceLiteral {
3245 Once,
3246}
3247
3248/// `{ every: <humantime> }`. Standalone struct (not an inline
3249/// struct variant). `{ evry: 6h }` still fails to parse (the
3250/// required `every` key is missing), and the create boundaries
3251/// reject the unknown `evry` via [`crate::strict`] with its path —
3252/// while agents reading a future writer's extra fields tolerate
3253/// them (#492).
3254#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone, PartialEq, Eq)]
3255pub struct EverySpec {
3256 /// Humantime interval (`10m`, `6h`, `1d`...). Parsed lazily —
3257 /// [`Schedule::validate`] rejects garbage at create time.
3258 pub every: String,
3259}
3260
3261impl PerPolicy {
3262 /// The cooldown this policy lowers to: `once` = `None`
3263 /// (permanent skip), `every` = the interval.
3264 fn cooldown(&self) -> Option<String> {
3265 match self {
3266 PerPolicy::Once(_) => None,
3267 PerPolicy::Every(EverySpec { every }) => Some(every.clone()),
3268 }
3269 }
3270}
3271
3272impl std::fmt::Display for When {
3273 /// Operator-facing one-liner (`per_pc once` / `per_pc every 6h`
3274 /// / `at 09:00 [mon-fri]` / `at 2026-06-10 09:00`) for log
3275 /// lines, audit payloads and the API's `ScheduleSummary`.
3276 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
3277 let policy = |p: &PerPolicy| match p {
3278 PerPolicy::Once(_) => "once".to_string(),
3279 PerPolicy::Every(EverySpec { every }) => format!("every {every}"),
3280 };
3281 match self {
3282 When::PerPc(p) => write!(f, "per_pc {}", policy(p)),
3283 When::PerTarget(p) => write!(f, "per_target {}", policy(p)),
3284 When::Calendar(c) if c.days.is_empty() => write!(f, "at {}", c.at),
3285 When::Calendar(c) => write!(f, "at {} [{}]", c.at, c.days.join(",")),
3286 }
3287 }
3288}
3289
3290/// Optional validity window for a [`Schedule`] (#418 decision G).
3291/// Half-open `[from, until)`; either bound may be omitted. Bounds
3292/// are `YYYY-MM-DD` (= that day's 00:00 in the schedule's `tz`) or
3293/// full RFC3339 (offset is honored as-is, `tz` ignored). Kept as
3294/// strings so the JSON Schema the SPA editor consumes stays two
3295/// plain string fields, mirroring `jitter` / `starting_deadline`.
3296///
3297/// #418 Phase 2: bounds are evaluated in the schedule's top-level
3298/// `tz` (was UTC-only in Phase 1) so `tz: local` makes both the
3299/// calendar `at` AND the `active` window local — one consistent
3300/// timezone per schedule.
3301#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone, Default, PartialEq, Eq)]
3302pub struct Active {
3303 /// Dormant before this instant.
3304 #[serde(default, skip_serializing_if = "Option::is_none")]
3305 pub from: Option<String>,
3306 /// Dormant from this instant on (exclusive).
3307 #[serde(default, skip_serializing_if = "Option::is_none")]
3308 pub until: Option<String>,
3309}
3310
3311impl Active {
3312 /// `skip_serializing_if` helper — an empty window means "always
3313 /// active" and is omitted from the wire format entirely.
3314 pub fn is_empty(&self) -> bool {
3315 self.from.is_none() && self.until.is_none()
3316 }
3317
3318 /// Parse one bound: RFC3339 first (offset honored, `tz`
3319 /// ignored), then bare `YYYY-MM-DD` (00:00 in `tz`).
3320 pub fn parse_bound(s: &str, tz: ScheduleTz) -> Result<chrono::DateTime<chrono::Utc>, String> {
3321 if let Ok(dt) = chrono::DateTime::parse_from_rfc3339(s) {
3322 return Ok(dt.with_timezone(&chrono::Utc));
3323 }
3324 if let Ok(d) = chrono::NaiveDate::parse_from_str(s, "%Y-%m-%d") {
3325 let midnight = d.and_hms_opt(0, 0, 0).expect("00:00:00 is always valid");
3326 return tz.naive_to_utc(midnight).ok_or_else(|| {
3327 format!("active: bound '{s}' falls in a DST gap for the schedule's tz")
3328 });
3329 }
3330 Err(format!(
3331 "active: unparseable bound '{s}' (want YYYY-MM-DD or RFC3339)"
3332 ))
3333 }
3334
3335 /// Is `now` inside the window? Unparseable bounds are treated
3336 /// as absent here (fail-open) — [`Schedule::validate`] is the
3337 /// place that rejects them loudly; this runs on every tick and
3338 /// must never panic on a stale KV blob.
3339 pub fn contains(&self, now: chrono::DateTime<chrono::Utc>, tz: ScheduleTz) -> bool {
3340 let bound = |s: &Option<String>| s.as_deref().and_then(|s| Self::parse_bound(s, tz).ok());
3341 if bound(&self.from).is_some_and(|from| now < from) {
3342 return false;
3343 }
3344 if bound(&self.until).is_some_and(|until| now >= until) {
3345 return false;
3346 }
3347 true
3348 }
3349}
3350
3351/// Operational constraints on a [`Schedule`] (#418 Phase 3). Where
3352/// [`Active`] decides *over what date range* a schedule is live,
3353/// `Constraints` decides *when, within an active period,* a fire is
3354/// allowed. `window` (a maintenance time-of-day window) and
3355/// `max_concurrent` (a fleet-wide running-instance cap) so far;
3356/// `require` (env gates) joins this struct in a later phase.
3357#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone, Default, PartialEq, Eq)]
3358pub struct Constraints {
3359 /// `"HH:MM-HH:MM"` wall-clock window (evaluated in the schedule's
3360 /// `tz`). Fires outside it are skipped — mainly for reconcile
3361 /// cadences ("patrol every 6h, but only fire overnight") and
3362 /// daytime change-freezes. `start > end` crosses midnight
3363 /// (`"22:00-05:00"` = 22:00 through 05:00 next morning). Parsed
3364 /// lazily; [`Schedule::validate`] rejects garbage at create time.
3365 #[serde(default, skip_serializing_if = "Option::is_none")]
3366 pub window: Option<String>,
3367 /// Fleet-wide cap on how many instances of this schedule's job may
3368 /// run **at the same time** (#418 "同時実行ハード上限"). The
3369 /// backend scheduler counts the job's still-in-flight runs
3370 /// (`execution_results.finished_at IS NULL`) each tick and only
3371 /// dispatches to as many remaining pcs as there are free slots —
3372 /// a rolling window that refills as runs complete. Useful for
3373 /// disk/CPU/network-heavy jobs you don't want hammering the whole
3374 /// fleet at once.
3375 ///
3376 /// **Backend-only** (it needs a central counter): combining it
3377 /// with `runs_on: agent` is rejected by [`Schedule::validate`]
3378 /// (#418 decision E — "中央上限には中央が要る"). Most meaningful
3379 /// for `per_pc` reconcile cadences, where the poll re-ticks and
3380 /// refills slots. `None` (default) = no cap.
3381 #[serde(default, skip_serializing_if = "Option::is_none")]
3382 pub max_concurrent: Option<u32>,
3383}
3384
3385impl Constraints {
3386 /// `skip_serializing_if` helper — empty constraints are omitted
3387 /// from the wire format entirely.
3388 pub fn is_empty(&self) -> bool {
3389 self.window.is_none() && self.max_concurrent.is_none()
3390 }
3391
3392 /// Parse `"HH:MM-HH:MM"` into `(start, end)`. Equal bounds are an
3393 /// error (a zero-width or all-day window is ambiguous — write no
3394 /// window for "always").
3395 pub fn parse_window(s: &str) -> Result<(chrono::NaiveTime, chrono::NaiveTime), String> {
3396 let (a, b) = s
3397 .split_once('-')
3398 .ok_or_else(|| format!("constraints.window: '{s}' must be 'HH:MM-HH:MM'"))?;
3399 let parse = |part: &str| {
3400 chrono::NaiveTime::parse_from_str(part.trim(), "%H:%M")
3401 .map_err(|e| format!("constraints.window: invalid time '{}': {e}", part.trim()))
3402 };
3403 let (start, end) = (parse(a)?, parse(b)?);
3404 if start == end {
3405 return Err(format!(
3406 "constraints.window: start and end are equal ('{s}'); omit window for 'always'"
3407 ));
3408 }
3409 Ok((start, end))
3410 }
3411
3412 /// Is a fire allowed at `now` (evaluated in `tz`)? No window =
3413 /// always allowed. Half-open `[start, end)`; `start > end`
3414 /// crosses midnight.
3415 ///
3416 /// **Fail-closed** on an unparseable window (returns `false`,
3417 /// gemini #452 review): a window is a *restrictive* constraint
3418 /// (change-freeze / overnight-only), so a corrupt one must NOT
3419 /// silently allow fires during the restricted hours. Bad windows
3420 /// are rejected at create time by [`Schedule::validate`]; this
3421 /// only bites a hand-edited KV blob, where blocking is the safe
3422 /// direction. The scheduler warns at register time
3423 /// ([`Schedule::bad_window`]) so a stuck schedule is diagnosable.
3424 /// The tick path never panics regardless.
3425 pub fn allows(&self, now: chrono::DateTime<chrono::Utc>, tz: ScheduleTz) -> bool {
3426 match self.window.as_deref() {
3427 // No window → always allowed.
3428 None => true,
3429 // Window set: membership, or fail-closed if unparseable
3430 // (`window_contains` returns None for a corrupt window).
3431 Some(_) => self.window_contains(tz.wall_time(now)).unwrap_or(false),
3432 }
3433 }
3434
3435 /// Membership of a wall-clock time-of-day in the window. `None`
3436 /// when there is no window or it's unparseable (callers decide
3437 /// the failure direction). `start > end` crosses midnight.
3438 fn window_contains(&self, t: chrono::NaiveTime) -> Option<bool> {
3439 let (start, end) = Self::parse_window(self.window.as_deref()?).ok()?;
3440 Some(if start <= end {
3441 start <= t && t < end
3442 } else {
3443 t >= start || t < end
3444 })
3445 }
3446}
3447
3448/// What to do when a fire's script fails (#418 Phase 4 — the "高"
3449/// retry/backoff gap). Where [`Constraints`] gates *whether* a fire
3450/// happens, `OnFailure` decides what happens *after* one ran and
3451/// came back bad. Only `retry` so far; future `notify` / `disable`
3452/// would join the same namespace.
3453#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone, Default, PartialEq, Eq)]
3454pub struct OnFailure {
3455 /// Re-run the script in-process when it exits non-zero (or times
3456 /// out), up to a cap, with a fixed backoff between attempts.
3457 /// `None` (default) = no retry: a failed run is published as-is
3458 /// and (for reconcile cadences) simply re-fires on the next poll
3459 /// tick. See [`Retry`].
3460 #[serde(default, skip_serializing_if = "Option::is_none")]
3461 pub retry: Option<Retry>,
3462}
3463
3464impl OnFailure {
3465 /// `skip_serializing_if` helper — an empty policy is omitted from
3466 /// the wire format entirely.
3467 pub fn is_empty(&self) -> bool {
3468 self.retry.is_none()
3469 }
3470
3471 /// Lower the operator-facing `retry` (humantime backoff) onto the
3472 /// engine vocabulary the agent's executor runs on (backoff in
3473 /// whole seconds). Single seam shared by the backend command
3474 /// builder and the agent's local scheduler so the two stamp the
3475 /// same [`crate::wire::RetrySpec`] onto every Command. Returns
3476 /// `None` when there is no retry policy or the backoff is
3477 /// unparseable (validate() rejects the latter at create time;
3478 /// this stays fail-safe = "no retry" for a hand-edited KV blob
3479 /// rather than panicking on the fire path).
3480 pub fn lowered_retry(&self) -> Option<crate::wire::RetrySpec> {
3481 let r = self.retry.as_ref()?;
3482 let backoff_secs = humantime::parse_duration(&r.backoff).ok()?.as_secs();
3483 Some(crate::wire::RetrySpec {
3484 max: r.max,
3485 backoff_secs,
3486 })
3487 }
3488}
3489
3490/// Fixed-backoff retry policy (#418 Phase 4). `max` is the number of
3491/// *additional* attempts after the first run (so `max: 3` = up to 4
3492/// total executions); `backoff` is the humantime delay slept between
3493/// attempts. The retry happens fire-side (inside `kanade fire` /
3494/// `handle_command`) on every OS for the PoC — the Windows-native
3495/// "restart on failure" Task Scheduler path is deferred to the
3496/// native-delegation phase (#418 decision H).
3497#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone, PartialEq, Eq)]
3498pub struct Retry {
3499 /// Max additional attempts after the first failure. Bounded
3500 /// `1..=10` by [`Schedule::validate`] — a typo'd `max: 1000`
3501 /// with a short backoff would otherwise pin a flapping script in
3502 /// a tight loop for the whole window.
3503 pub max: u32,
3504 /// Humantime delay slept between attempts (`"10m"`, `"30s"`).
3505 pub backoff: String,
3506}
3507
3508/// Fleet-wide change-freeze (#418 Phase 5 — the "メンテナンス窓 /
3509/// 変更凍結" gap's global half). Where [`Constraints::window`] is a
3510/// *per-schedule* time-of-day gate, a `Freeze` is a *single, fleet-
3511/// global* "stop all automated change" switch the operator flips
3512/// during an incident or a year-end change-freeze. It lives in its
3513/// own KV singleton ([`crate::kv::KEY_FREEZE`]); when present and
3514/// active, both the backend scheduler and every agent's local
3515/// scheduler skip *every* fire.
3516///
3517/// Shapes:
3518/// * `{}` (no bounds) — frozen indefinitely until the operator
3519/// clears it (incident "big red button").
3520/// * `{ from, until }` — frozen only within `[from, until)`,
3521/// evaluated in `tz` (planned change-freeze; auto-thaws).
3522///
3523/// The KV key being *absent* means "not frozen" — so clearing the
3524/// freeze is a KV delete, and `is_active` only ever runs on a freeze
3525/// the operator actually set.
3526#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone, Default, PartialEq, Eq)]
3527pub struct Freeze {
3528 /// Frozen from this instant (RFC3339 or bare `YYYY-MM-DD` in
3529 /// `tz`). `None` ⇒ frozen from the beginning of time.
3530 #[serde(default, skip_serializing_if = "Option::is_none")]
3531 pub from: Option<String>,
3532 /// Thawed from this instant on, exclusive. `None` ⇒ frozen with
3533 /// no scheduled end (manual clear required).
3534 #[serde(default, skip_serializing_if = "Option::is_none")]
3535 pub until: Option<String>,
3536 /// Operator-supplied note surfaced on the freeze-skip log and the
3537 /// SPA banner ("year-end change freeze", "INC-1234"). Advisory.
3538 #[serde(default, skip_serializing_if = "Option::is_none")]
3539 pub reason: Option<String>,
3540 /// Timezone the bare-date bounds are evaluated in (RFC3339 bounds
3541 /// carry their own offset). Defaults to host-local like a
3542 /// schedule's `tz`.
3543 #[serde(default)]
3544 pub tz: ScheduleTz,
3545}
3546
3547impl Freeze {
3548 /// Is the fleet frozen at `now`? An empty window (`from`/`until`
3549 /// both absent) is frozen unconditionally; otherwise membership of
3550 /// `[from, until)` in `tz`. Half-open like [`Active::contains`],
3551 /// but **fails CLOSED** on an unparseable bound — a freeze is a
3552 /// safety switch, so a corrupt window (only reachable via a
3553 /// hand-edited KV blob; `validate` rejects it at set time) must
3554 /// mean "frozen", not "fire normally" (coderabbit #472). This is
3555 /// the one deliberate divergence from `active`'s fail-OPEN
3556 /// behaviour, where an unparseable bound dormant-skips a schedule.
3557 pub fn is_active(&self, now: chrono::DateTime<chrono::Utc>) -> bool {
3558 // Parse a bound; an unparseable one short-circuits the whole
3559 // check to `true` (frozen) via the closure's `None` sentinel
3560 // handled below.
3561 let bound = |s: &Option<String>| -> Result<Option<chrono::DateTime<chrono::Utc>>, ()> {
3562 match s.as_deref() {
3563 None => Ok(None),
3564 Some(raw) => Active::parse_bound(raw, self.tz).map(Some).map_err(|_| ()),
3565 }
3566 };
3567 let (from, until) = match (bound(&self.from), bound(&self.until)) {
3568 (Ok(f), Ok(u)) => (f, u),
3569 // Any corrupt bound → fail closed (frozen).
3570 _ => return true,
3571 };
3572 if from.is_some_and(|f| now < f) {
3573 return false;
3574 }
3575 if until.is_some_and(|u| now >= u) {
3576 return false;
3577 }
3578 true
3579 }
3580
3581 /// Reject unparseable bounds / `from >= until` at set time (the
3582 /// API + CLI counterpart to [`Schedule::validate`]).
3583 pub fn validate(&self) -> Result<(), String> {
3584 let from = self
3585 .from
3586 .as_deref()
3587 .map(|s| Active::parse_bound(s, self.tz))
3588 .transpose()
3589 .map_err(|e| e.replace("active:", "freeze:"))?;
3590 let until = self
3591 .until
3592 .as_deref()
3593 .map(|s| Active::parse_bound(s, self.tz))
3594 .transpose()
3595 .map_err(|e| e.replace("active:", "freeze:"))?;
3596 if let (Some(f), Some(u)) = (from, until) {
3597 if f >= u {
3598 return Err(format!(
3599 "freeze.from ({}) must be strictly before freeze.until ({})",
3600 self.from.as_deref().unwrap_or_default(),
3601 self.until.as_deref().unwrap_or_default(),
3602 ));
3603 }
3604 }
3605 Ok(())
3606 }
3607}
3608
3609/// The system-generated poll cadence every reconcile-shaped `when`
3610/// lowers to. Operators never write this: the real inter-run
3611/// spacing is the `every` cooldown; this only bounds "how soon do
3612/// we notice somebody is due" (#418 decision B took the poll
3613/// period away from the operator).
3614pub const POLL_CRON: &str = "0 * * * * *";
3615
3616/// What a [`When`] lowers to — the exact (cron, mode, cooldown)
3617/// trio the pre-#418 engine ran on. Keeping the engine vocabulary
3618/// unchanged is what lets Phase 1 swap the operator surface without
3619/// touching the tick / dedup machinery.
3620pub struct Lowered {
3621 /// Cron handed to `tokio-cron-scheduler` — [`POLL_CRON`] for
3622 /// reconcile shapes, a 6/7-field cron for calendar shapes.
3623 pub cron: String,
3624 /// Dedup semantics for `decide_fire`.
3625 pub mode: ExecMode,
3626 /// Humantime re-arm interval (`None` = succeed once, skip
3627 /// forever).
3628 pub cooldown: Option<String>,
3629 /// Timezone to evaluate `cron` in (#418 Phase 2). The scheduler
3630 /// passes this to `Job::new_async_tz`. Reconcile shapes carry
3631 /// the schedule's tz too even though POLL_CRON is tz-agnostic,
3632 /// so the same value drives the `active`-window check.
3633 pub tz: ScheduleTz,
3634}
3635
3636impl Schedule {
3637 /// The error message if this schedule's `constraints.window` is
3638 /// set but unparseable, else `None`. The scheduler logs this at
3639 /// register time so a fail-closed (never-firing) schedule from a
3640 /// hand-edited KV blob is diagnosable (gemini #452 review).
3641 pub fn bad_window(&self) -> Option<String> {
3642 let w = self.constraints.window.as_deref()?;
3643 Constraints::parse_window(w).err()
3644 }
3645
3646 /// True when this is a `calendar` schedule whose fire time can
3647 /// never fall inside its `constraints.window` — the cron fires,
3648 /// the window check rejects it, and (firing only at that
3649 /// time-of-day) it effectively never runs. An easy misconfig to
3650 /// set up by accident; the scheduler warns at register time
3651 /// (claude #452 review). Reconcile shapes poll every minute, so
3652 /// they always catch the window opening and aren't affected.
3653 pub fn calendar_outside_window(&self) -> bool {
3654 let When::Calendar(c) = &self.when else {
3655 return false;
3656 };
3657 let Some(t) = c.fire_time() else {
3658 return false;
3659 };
3660 matches!(self.constraints.window_contains(t), Some(false))
3661 }
3662
3663 /// Up to `count` future instants this schedule will fire, as
3664 /// absolute UTC, strictly after `now` — the dry-run / preview
3665 /// surface (#418 "ドライラン / プレビュー"). Only **calendar**
3666 /// schedules have discrete fire times; reconcile shapes
3667 /// (`per_pc`/`per_target`) poll every minute gated by cooldown, so
3668 /// they return an empty vec and the caller describes the cadence
3669 /// instead. Occurrences outside the `active.{from,until}` window or
3670 /// the `constraints.window` are **skipped**, so the list reflects
3671 /// when the schedule will ACTUALLY run, not the raw cron ticks.
3672 /// Evaluated in the schedule's `tz`, exactly like the scheduler's
3673 /// `Job::new_async_tz`, and with the same croner config the
3674 /// scheduler / [`Schedule::validate`] use, so a preview can never
3675 /// disagree with a real fire. A schedule that can never fire (a
3676 /// calendar time wholly outside its window, a past one-shot,
3677 /// `enabled: false` is *not* considered here — callers gate on
3678 /// `enabled` separately) yields an empty vec.
3679 pub fn preview_fires(
3680 &self,
3681 now: chrono::DateTime<chrono::Utc>,
3682 count: usize,
3683 ) -> Vec<chrono::DateTime<chrono::Utc>> {
3684 use croner::parser::{CronParser, Seconds};
3685 if !matches!(self.when, When::Calendar(_)) {
3686 return Vec::new();
3687 }
3688 // Same lowering + croner config as `next_calendar_fire` and the
3689 // live scheduler, so a preview can never disagree with a real
3690 // fire. `preview_fires` adds the N-occurrence walk and the
3691 // active / window filtering on top of that single seam.
3692 let lowered = self.lowered();
3693 let Ok(cron) = CronParser::builder()
3694 .seconds(Seconds::Required)
3695 .dom_and_dow(true)
3696 .build()
3697 .parse(&lowered.cron)
3698 else {
3699 return Vec::new();
3700 };
3701 let accept = |utc: chrono::DateTime<chrono::Utc>| {
3702 self.active.contains(utc, self.tz) && self.constraints.allows(utc, self.tz)
3703 };
3704 match self.tz {
3705 ScheduleTz::Utc => Self::next_occurrences(&cron, now, count, accept),
3706 ScheduleTz::Local => {
3707 Self::next_occurrences(&cron, now.with_timezone(&chrono::Local), count, accept)
3708 }
3709 }
3710 }
3711
3712 /// Walk croner forward from `after` collecting up to `count`
3713 /// accepted occurrences (converted to UTC). Generic over the tz the
3714 /// cron is evaluated in so `preview_fires` can run it in either
3715 /// `Utc` or `Local` without duplicating the loop.
3716 fn next_occurrences<Tz>(
3717 cron: &croner::Cron,
3718 after: chrono::DateTime<Tz>,
3719 count: usize,
3720 accept: impl Fn(chrono::DateTime<chrono::Utc>) -> bool,
3721 ) -> Vec<chrono::DateTime<chrono::Utc>>
3722 where
3723 Tz: chrono::TimeZone,
3724 {
3725 // Bound the scan so an `active`/window dead-end (every future
3726 // tick rejected) can't spin forever: ~4096 raw ticks covers
3727 // >10y of a daily calendar while staying instant for croner.
3728 const SCAN_CAP: usize = 4096;
3729 let mut out = Vec::with_capacity(count.min(SCAN_CAP));
3730 let mut cursor = after;
3731 let mut scanned = 0usize;
3732 while out.len() < count && scanned < SCAN_CAP {
3733 scanned += 1;
3734 let Ok(next) = cron.find_next_occurrence(&cursor, false) else {
3735 break;
3736 };
3737 let utc = next.with_timezone(&chrono::Utc);
3738 if accept(utc) {
3739 out.push(utc);
3740 }
3741 // `find_next_occurrence(.., inclusive = false)` already
3742 // advances strictly past `cursor`, so handing it `next`
3743 // verbatim gets the following occurrence — no manual +1s
3744 // nudge (and `DateTime<Tz>` is `Copy`, so no clone).
3745 cursor = next;
3746 }
3747 out
3748 }
3749
3750 /// Lower the operator-facing `when` onto the engine vocabulary.
3751 /// Single seam shared by the backend scheduler and the agent's
3752 /// local scheduler so the two can never drift.
3753 pub fn lowered(&self) -> Lowered {
3754 let tz = self.tz;
3755 match &self.when {
3756 When::PerPc(p) => Lowered {
3757 cron: POLL_CRON.into(),
3758 mode: ExecMode::OncePerPc,
3759 cooldown: p.cooldown(),
3760 tz,
3761 },
3762 When::PerTarget(p) => Lowered {
3763 cron: POLL_CRON.into(),
3764 mode: ExecMode::OncePerTarget,
3765 cooldown: p.cooldown(),
3766 tz,
3767 },
3768 // `to_cron` only fails on a malformed `at` (rejected by
3769 // validate() at create time). For a hand-edited KV blob
3770 // that slipped past, emit a deliberately-invalid cron so
3771 // register()'s Job::new_async_tz fails → warn+skip,
3772 // rather than firing at the wrong time.
3773 When::Calendar(c) => Lowered {
3774 cron: c
3775 .to_cron()
3776 .unwrap_or_else(|_| "# invalid calendar at".into()),
3777 mode: ExecMode::EveryTick,
3778 cooldown: None,
3779 tz,
3780 },
3781 }
3782 }
3783
3784 /// The next absolute (UTC) time this schedule fires, or `None` when
3785 /// it has no discrete upcoming fire to preview.
3786 ///
3787 /// Used by the KLP `maintenance.list` preview ("what's about to
3788 /// happen on my PC", SPEC §2.1). Returns `None` for:
3789 ///
3790 /// - reconcile shapes (`per_pc` / `per_target`) — they lower to the
3791 /// every-minute [`POLL_CRON`] and re-converge state continuously,
3792 /// so "next fire" is always ~60s away and means nothing to a user
3793 /// previewing upcoming maintenance;
3794 /// - a calendar schedule whose lowered cron won't parse (a
3795 /// hand-edited KV blob that slipped past [`Schedule::validate`]);
3796 /// - a cron with no future occurrence.
3797 ///
3798 /// The wall-clock fire is evaluated in the schedule's own `tz`
3799 /// (matching the live tick's `Job::new_async_tz`) then normalised
3800 /// to UTC for the wire. `inclusive = false`: strictly the *next*
3801 /// fire after `now`, never one matching the current instant.
3802 pub fn next_calendar_fire(
3803 &self,
3804 now: chrono::DateTime<chrono::Utc>,
3805 ) -> Option<chrono::DateTime<chrono::Utc>> {
3806 if !matches!(self.when, When::Calendar(_)) {
3807 return None;
3808 }
3809 let lowered = self.lowered();
3810 // Same parser configuration tokio-cron-scheduler 0.15 uses
3811 // internally, so this can never compute a fire the live
3812 // scheduler wouldn't (seconds required, DOM-and-DOW honored).
3813 let cron = croner::parser::CronParser::builder()
3814 .seconds(croner::parser::Seconds::Required)
3815 .dom_and_dow(true)
3816 .build()
3817 .parse(&lowered.cron)
3818 .ok()?;
3819 match lowered.tz {
3820 ScheduleTz::Utc => cron.find_next_occurrence(&now, false).ok(),
3821 ScheduleTz::Local => {
3822 let now_local = now.with_timezone(&chrono::Local);
3823 cron.find_next_occurrence(&now_local, false)
3824 .ok()
3825 .map(|t| t.with_timezone(&chrono::Utc))
3826 }
3827 }
3828 }
3829
3830 /// Cross-field semantic checks that don't fit pure serde derive
3831 /// — the [`Manifest::validate`] counterpart (#418 decision F;
3832 /// pre-Phase-1 a broken schedule was accepted at create time
3833 /// and silently warn-skipped at tick time). Run at every create
3834 /// site: `kanade schedule create` (client-side) and
3835 /// `POST /api/schedules`. The job_id-exists check lives in the
3836 /// API handler instead — it needs the JOBS KV.
3837 pub fn validate(&self) -> Result<(), String> {
3838 if matches!(self.runs_on, RunsOn::Agent) && matches!(self.when, When::PerTarget(_)) {
3839 return Err(
3840 "when.per_target needs fleet-wide completion data and is backend-only; \
3841 it cannot be combined with runs_on: agent (each agent self-schedules, \
3842 so per-target dedup would be deduping across a target of 1)"
3843 .into(),
3844 );
3845 }
3846 if let Some(cd) = self.lowered().cooldown.as_deref() {
3847 humantime::parse_duration(cd)
3848 .map_err(|e| format!("when.every: invalid duration '{cd}': {e}"))?;
3849 }
3850 if let When::Calendar(c) = &self.when {
3851 // Lower the calendar form to its cron (catches a bad `at`
3852 // and the date+days conflict), then validate that cron
3853 // with the same parser configuration tokio-cron-scheduler
3854 // 0.15 uses internally (croner, seconds required,
3855 // DOM-and-DOW both honored, year optional) — create-time
3856 // validation can never accept what register() rejects.
3857 let cron = c.to_cron()?;
3858 croner::parser::CronParser::builder()
3859 .seconds(croner::parser::Seconds::Required)
3860 .dom_and_dow(true)
3861 .build()
3862 .parse(&cron)
3863 .map_err(|e| format!("when.at lowered to invalid cron '{cron}': {e}"))?;
3864 }
3865 // The other humantime strings on the schedule (claude #419
3866 // review): runtime degrades gracefully on both (bad jitter →
3867 // silent no-op, bad starting_deadline → warn + skipped tick),
3868 // but "rejected at create time" should cover every field the
3869 // operator can typo, not just `when`.
3870 if let Some(j) = &self.plan.jitter {
3871 humantime::parse_duration(j)
3872 .map_err(|e| format!("jitter: invalid duration '{j}': {e}"))?;
3873 }
3874 if let Some(sd) = &self.starting_deadline {
3875 humantime::parse_duration(sd)
3876 .map_err(|e| format!("starting_deadline: invalid duration '{sd}': {e}"))?;
3877 }
3878 let from = self
3879 .active
3880 .from
3881 .as_deref()
3882 .map(|s| Active::parse_bound(s, self.tz))
3883 .transpose()?;
3884 let until = self
3885 .active
3886 .until
3887 .as_deref()
3888 .map(|s| Active::parse_bound(s, self.tz))
3889 .transpose()?;
3890 if let (Some(f), Some(u)) = (from, until) {
3891 if f >= u {
3892 return Err(format!(
3893 "active.from ({}) must be strictly before active.until ({})",
3894 self.active.from.as_deref().unwrap_or_default(),
3895 self.active.until.as_deref().unwrap_or_default(),
3896 ));
3897 }
3898 }
3899 // #418 Phase 3: a bad maintenance window is rejected at create
3900 // time (parse_window also catches equal bounds).
3901 if let Some(w) = self.constraints.window.as_deref() {
3902 Constraints::parse_window(w)?;
3903 }
3904 // #418: constraints.max_concurrent is a central running-instance
3905 // cap, so it needs the backend's counter — reject it on
3906 // runs_on: agent (decision E), and reject a meaningless 0.
3907 if let Some(mc) = self.constraints.max_concurrent {
3908 // Check the structural incompatibility (agent has no central
3909 // counter) before the value range, so a `max_concurrent: 0`
3910 // + `runs_on: agent` combo reports the more fundamental
3911 // problem first (claude #542).
3912 if matches!(self.runs_on, RunsOn::Agent) {
3913 return Err(
3914 "constraints.max_concurrent needs a central counter and is backend-only; \
3915 it cannot be combined with runs_on: agent (each agent self-schedules, \
3916 so there is no fleet-wide count to cap against)"
3917 .into(),
3918 );
3919 }
3920 if mc == 0 {
3921 return Err(
3922 "constraints.max_concurrent must be >= 1 (0 would never fire; \
3923 omit it for no cap)"
3924 .into(),
3925 );
3926 }
3927 }
3928 // #418 Phase 4: a bad on_failure.retry is rejected at create
3929 // time — backoff must be valid humantime, and max is bounded
3930 // so a typo can't pin a flapping script in a tight loop.
3931 if let Some(r) = &self.on_failure.retry {
3932 let backoff = humantime::parse_duration(&r.backoff).map_err(|e| {
3933 format!(
3934 "on_failure.retry.backoff: invalid duration '{}': {e}",
3935 r.backoff
3936 )
3937 })?;
3938 // The wire form lowers backoff to whole seconds, so a
3939 // sub-second value would silently become a 0s no-wait
3940 // (coderabbit #466). Reject it rather than honour a backoff
3941 // the operator can't actually get.
3942 if backoff.as_secs() < 1 {
3943 return Err(format!(
3944 "on_failure.retry.backoff must be >= 1s (got '{}'); sub-second backoffs \
3945 round to 0 on the wire",
3946 r.backoff
3947 ));
3948 }
3949 if !(1..=10).contains(&r.max) {
3950 return Err(format!(
3951 "on_failure.retry.max must be 1..=10 (got {}); it counts additional \
3952 attempts after the first run",
3953 r.max
3954 ));
3955 }
3956 }
3957 Ok(())
3958 }
3959}
3960
3961fn default_true() -> bool {
3962 true
3963}