caixa_core/upgrade.rs
1//! Erlang/OTP-style appup — declarative upgrade instructions per
2//! prior caixa version. Composes with the `:behavior :on-state-change`
3//! callback to deliver state migration during hot upgrades.
4//!
5//! See `theory/INSPIRATIONS.md` §II.4 for the prior-art frame.
6//!
7//! ```lisp
8//! (defcaixa
9//! :nome "hello-rio"
10//! :versao "0.2.0"
11//! :upgrade-from
12//! ((:from "0.1.0"
13//! :instructions ((:load-module "hello-rio")
14//! (:state-change "lib/migrations/v01-to-v02.lisp")
15//! (:soft-purge "hello-rio-old")))
16//! (:from "0.1.5"
17//! :instructions ((:load-module "hello-rio")
18//! (:soft-purge "hello-rio-old")))))
19//! ```
20//!
21//! Each `(:from <prior>)` block declares the upgrade path *from* that
22//! version *to* the current `:versao`. wasm-operator picks the
23//! matching block at upgrade time, runs the instructions in order,
24//! and only swaps traffic to the new instance after all instructions
25//! succeed (transactional upgrade). On any failure, the current
26//! version stays load-bearing — a typed atomic upgrade.
27
28use std::path::PathBuf;
29
30use serde::{Deserialize, Serialize};
31use thiserror::Error;
32
33/// One upgrade instruction. The set mirrors OTP's appup low-level
34/// instructions: enough to express every common upgrade pattern,
35/// few enough that the wasm-operator can implement each
36/// deterministically.
37#[derive(
38 Serialize,
39 Deserialize,
40 Debug,
41 Clone,
42 PartialEq,
43 Eq,
44 gen_platform::TypedDispatcher,
45 gen_platform::Discriminant,
46 gen_platform::IsVariant,
47)]
48#[serde(tag = "kind", rename_all = "kebab-case")]
49pub enum UpgradeInstruction {
50 /// Load a new wasm module alongside the current one — the analog
51 /// of OTP's `code:load_module/1`. Both versions remain in memory
52 /// after this instruction; in-flight requests stay on the old
53 /// version, new requests route to the new version.
54 LoadModule { module: String },
55
56 /// Run a state-migration tatara-lisp file. Receives the old state
57 /// + the prior version string; returns the new state. Analog of
58 /// `gen_server:code_change/3`.
59 StateChange { script: PathBuf },
60
61 /// Wait for in-flight requests on a named module to drain, then
62 /// GC it — the analog of `code:soft_purge/1`. Default cooldown is
63 /// 60s; longer-running requests block the upgrade.
64 SoftPurge { module: String },
65
66 /// Discard a named module immediately, without waiting for
67 /// drain — the analog of `code:purge/1`. Used when we don't
68 /// care about in-flight callers (cron, oneShot).
69 Purge { module: String },
70
71 /// Fall back to a full restart for this entry. Used when a typed
72 /// upgrade is impossible (e.g. wasm component world incompatible).
73 Restart,
74}
75
76// Fleet-wide dispatcher-catalog registration. UpgradeInstruction is
77// the OTP-style hot-upgrade primitive (load_module/code_change/
78// soft_purge/purge/restart) — the first NON-ADAPTER consumer of
79// gen-platform's typed-dispatcher catamorphism, satisfying the ★★
80// "two classes of consumer" promotion criterion from
81// theory/QUIRK-APPLIER.md §V.1.
82//
83// Operators query via:
84// gen dispatchers --from-catalog | jq '.[] | select(.label=="caixa.upgrade-instruction")'
85//
86// The substrate's lib/build/shared/fleet-catalog-coverage-test.nix
87// adds an assertion row for this label on the next snapshot refresh.
88gen_platform::register_dispatcher!("caixa.upgrade-instruction", UpgradeInstruction);
89
90/// One upgrade entry: the *prior* version we're upgrading from, plus
91/// the instruction sequence to execute.
92#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
93#[serde(rename_all = "camelCase")]
94pub struct UpgradeFromEntry {
95 /// Semver of the *prior* version. Authored as a literal string;
96 /// validated lazily by [`UpgradeFromEntry::validate`].
97 pub from: String,
98
99 /// Ordered list of instructions to execute. Empty list = "no-op
100 /// upgrade" (rare; usually means only documentation changed).
101 #[serde(default)]
102 pub instructions: Vec<UpgradeInstruction>,
103}
104
105impl UpgradeFromEntry {
106 /// Prior-versao semver-2 literal this entry declares an upgrade
107 /// path *from* — the string the OTP-shape `release_handler:install_release/1`
108 /// analog matches the running caixa's `:versao` against at hot-
109 /// upgrade dispatch time to pick this entry's `:instructions`
110 /// sequence. Returned byte-for-byte from the typed slot's own
111 /// `String` storage; no cloning, no re-parsing.
112 ///
113 /// The M2 companion of the closed M3 mesh-slot scalar-accessor
114 /// family — sibling in shape to [`crate::Membro::versao_requirement`]
115 /// (a40b0e3), [`crate::Membro::nome`] (4a32abf), and the
116 /// [`crate::WitContract::{source, destination, world_ref}`]
117 /// (7f0fd43 / 0804823) / [`crate::Entrada::{hostname, destination}`]
118 /// (11f3dfe / 6db982c) `&str` accessors already routing every
119 /// per-mesh-slot-atom scalar-value axis through one typed dispatch
120 /// on the substrate primitive — extended here onto the first per-
121 /// M2-slot scalar-value axis. Every downstream consumer of the
122 /// M2 `:upgrade-from :from` axis (the [`UpgradeFromEntry::validate`]
123 /// SemVer-2 parse gate, the [`validate_upgrade_from`] cross-entry
124 /// duplicate-detection re-parse assertion, the
125 /// [`validate_upgrade_from_against_versao`] precedence gate,
126 /// the [`validate_upgrade_from_against_behavior`] state-change-
127 /// callback coherence gate, every per-arm error variant carrying
128 /// the offending `:from` verbatim for `feira lint` rendering)
129 /// now reads through this one accessor rather than open-coding
130 /// `&self.from` / `&entry.from` / `self.from.clone()` /
131 /// `entry.from.clone()`.
132 ///
133 /// A future extension of the axis (an M4 typed `:from`-range slot
134 /// composing multiple prior versions into one entry, an operator-
135 /// side pre-parsed [`semver::Version`] cache the accessor could
136 /// materialize behind the same `&str` return contract, a per-
137 /// cluster `:placement`-scoped prior-versao overlay the
138 /// `caixa-operator` reconciles ahead of dispatch) migrates as a
139 /// single caixa-core edit rather than a coordinated rewrite of
140 /// the four validate-side call sites + every downstream error-
141 /// variant carrying `:from`.
142 #[must_use]
143 pub const fn prior_versao(&self) -> &str {
144 self.from.as_str()
145 }
146
147 /// Substrate-canonical per-`:upgrade-from :instructions`
148 /// OTP-appup migration-instruction-list slice-return accessor
149 /// every per-entry instructions-list reader keys off — returns
150 /// the author-declared `:instructions` list verbatim as a
151 /// `&[UpgradeInstruction]` slice-view over the same backing
152 /// buffer the raw `self.instructions.as_slice()` field access
153 /// borrows from. Non-optional: an empty slice is the load-bearing
154 /// "author declared `:instructions ()`" sentinel — the
155 /// `Vec<UpgradeInstruction>::default()`-produced empty tail the
156 /// [`UpgradeFromEntry::instructions`] field's own docstring already
157 /// names as the "no-op upgrade" shape (a metadata-only upgrade
158 /// entry — the operator's `:from`-match dispatch matches the entry
159 /// but runs no instructions, advancing straight to the "traffic
160 /// swap" step) and every peer within-entry cross-instruction gate
161 /// no-ops against without allocating a new `Vec` per gate.
162 ///
163 /// The `:upgrade-from :instructions` slot carries the per-`:from`
164 /// OTP-appup ordered instruction list the wasm-operator's hot-
165 /// upgrade dispatch materializes one per-instruction runtime
166 /// primitive from — the Erlang/OTP appup's per-`{from, to,
167 /// UpgradeInstructions, DowngradeInstructions}` entry's
168 /// `UpgradeInstructions` list (`code:load_module/1` /
169 /// `gen_server:code_change/3` / `code:soft_purge/1` /
170 /// `code:purge/1` / `restart_new_emulator` — see INSPIRATIONS
171 /// §II.4), projected through the tatara-lisp
172 /// `:upgrade-from ((:from … :instructions …))` author surface
173 /// onto a typed `Vec<UpgradeInstruction>` whose per-element
174 /// variant is [`UpgradeInstruction::LoadModule`] /
175 /// [`UpgradeInstruction::StateChange`] /
176 /// [`UpgradeInstruction::SoftPurge`] / [`UpgradeInstruction::Purge`]
177 /// / [`UpgradeInstruction::Restart`]. Every downstream consumer
178 /// that fans on the per-entry instruction list keys off this
179 /// slice (the [`UpgradeFromEntry::validate`] per-instruction
180 /// shape-check fan-out, the seven paired within-entry cross-
181 /// instruction gates [`Self::validate_restart_exclusive`] /
182 /// [`Self::validate_state_change_ordering`] /
183 /// [`Self::validate_purge_ordering`] /
184 /// [`Self::validate_state_change_before_cleanup`] /
185 /// [`Self::validate_load_singularity`] /
186 /// [`Self::validate_state_change_singularity`] /
187 /// [`Self::validate_cleanup_singularity`], the layout-side
188 /// [`crate::layout::StandardLayout`]'s per-`:state-change`
189 /// script-existence fan-out
190 /// ([`crate::layout::LayoutError::MissingEntry`]'s
191 /// `LAYOUT_MISSING_ENTRY_KIND_UPGRADE_SCRIPT` arm), the cross-slot
192 /// [`validate_upgrade_from_against_behavior`] gate's per-entry
193 /// `:state-change`-instruction detection loop, every future
194 /// wasm-operator (M2.5) per-`:from`-match hot-upgrade dispatch's
195 /// per-instruction runtime-primitive fan-out, every future M4
196 /// `mesh.pleme.io/v1alpha1/Caixa` CR materializer's per-entry
197 /// upgrade-plan admission-webhook fan-out).
198 ///
199 /// Prior to this lift the `.instructions` `Vec<UpgradeInstruction>`
200 /// was accessed inline at nine production sites across
201 /// `caixa-core/src/upgrade.rs` and `caixa-core/src/layout.rs` —
202 /// the [`UpgradeFromEntry::validate`] per-instruction shape-check
203 /// fan-out (`for instr in &self.instructions`), the paired
204 /// [`Self::validate_restart_exclusive`] restart-count / other-kind
205 /// projections + `.len()` probe (three raw-access sites in one
206 /// gate), the [`Self::validate_state_change_ordering`] /
207 /// [`Self::validate_purge_ordering`] /
208 /// [`Self::validate_state_change_before_cleanup`] /
209 /// [`Self::validate_load_singularity`] /
210 /// [`Self::validate_state_change_singularity`] /
211 /// [`Self::validate_cleanup_singularity`] within-entry cross-
212 /// instruction gate traversal heads, the peer
213 /// [`validate_upgrade_from_against_behavior`] cross-slot
214 /// composition gate's `for instr in &entry.instructions`
215 /// per-entry `:state-change` detection loop, and the
216 /// [`crate::layout::StandardLayout`]-side
217 /// `for instr in &entry.instructions` per-`:state-change`
218 /// script-existence fan-out — nine open-coded field-accesses
219 /// that expressed no compile-time link back to the typed slot.
220 /// A future extension of the `:instructions` axis to a richer
221 /// author surface (a per-cluster overlay the operator pins
222 /// through a future `:upgrade-from :instructions-overrides` slot
223 /// so a canary cluster runs a `(:state-change …)` before the
224 /// production fleet does, a per-tenant instruction-list overlay
225 /// the M4 CR materializer resolves per-CR to inject cluster-
226 /// specific `(:soft-purge …)` cooldown adjustments, a promotion
227 /// of the plain `Vec<UpgradeInstruction>` to a richer
228 /// `{static, dynamic}` partition once virtual-actor-style
229 /// dynamic-instruction composition (an operator-derived
230 /// `(:load-module …)` sequence computed from the running
231 /// module set at upgrade time) comes into typed scope, a
232 /// per-instruction pre-condition scalar the future adaptive-
233 /// upgrade engine reads to bias per-instruction retry
234 /// strategy) would have had to be threaded through all nine
235 /// open-coded copies in lockstep or one consumer would silently
236 /// disagree with the peers on which instruction sequence a
237 /// given `:upgrade-from` entry resolves to — the per-
238 /// instruction shape-check reading the raw slot while the
239 /// paired within-entry ordering gates read an operator-resolved
240 /// slot would silently split the build-time per-entry gate
241 /// cohort from the layout-side script-existence gate + the
242 /// cross-slot behavior-composition gate + the runtime hot-
243 /// upgrade dispatch, a nine-consumer split across the seven
244 /// within-entry cross-instruction gates + the layout invariant +
245 /// the cross-slot composition gate far from the source
246 /// `caixa.lisp` with no field naming the instruction-sequence-
247 /// drift root cause. Lifting the resolution rule to a typed
248 /// method on the substrate primitive means every downstream
249 /// consumer of the per-entry OTP-appup instruction-list surface
250 /// reaches for exactly one typed dispatch — the resolver's
251 /// accept-set migrates as a unit on any future axis addition.
252 ///
253 /// Fifth slice-return (`&[T]`) accessor on any M2 or M3 typed
254 /// slot — sibling to the seed M2
255 /// [`crate::SupervisorSpec::children`] (bc92bce) `&[ChildSpec]`
256 /// accessor on the peer per-`:supervisor` static-child-list
257 /// `Vec`-carry axis, the M3 [`crate::Placement::clusters`]
258 /// (a6e18d7) `&[String]` accessor on the peer per-`:placement`
259 /// distribution-target-list `Vec`-carry axis, the M3
260 /// [`crate::AplicacaoSpec::membros`] (6c77e36) `&[Membro]`
261 /// accessor on the peer per-`:membros` node-list `Vec`-carry
262 /// axis, and the M3 [`crate::AplicacaoSpec::contratos`]
263 /// (0dcc926) `&[WitContract]` accessor on the peer per-
264 /// `:contratos` edge-list `Vec`-carry axis. This lift closes the
265 /// last unlifted `Vec`-carry axis on any M2 or M3 typed slot in
266 /// the substrate — the four peer axes named in the
267 /// [`crate::SupervisorSpec::children`] seed docstring
268 /// (`Placement::clusters`, `AplicacaoSpec::membros`,
269 /// `AplicacaoSpec::contratos`, `UpgradeFromEntry::instructions`)
270 /// are now all closed. The per-`UpgradeFromEntry` type carried
271 /// two axes: the scalar `Copy`-return
272 /// [`UpgradeFromEntry::prior_versao`] (75d27a8) on the
273 /// `:from` axis, and now the slice-return
274 /// [`UpgradeFromEntry::instructions`] on the peer
275 /// `:instructions` axis. Named `instructions()` to match the
276 /// storage field's name verbatim and the tatara-lisp
277 /// author-surface term (`:instructions`) the field's own
278 /// docstring already carries; the accessor's identity maps
279 /// onto the canonical OTP-appup vocabulary the
280 /// [`crate::upgrade`] module doc already reaches for ("runs
281 /// the instructions in order"). Returns `&[UpgradeInstruction]`
282 /// (not `&Vec<UpgradeInstruction>`) because every downstream
283 /// consumer of the instruction list treats it as a read-only
284 /// sequence — the slice-view is the narrowest borrow that
285 /// supports every present + roadmapped consumer (`.iter()`,
286 /// `.len()`, `.filter(...).count()`) without leaking the
287 /// backing `Vec`'s grow/push/reserve surface that no consumer
288 /// of the typed view reaches for (the storage-side `Vec`
289 /// remains reachable through the `pub instructions` field for
290 /// the mutation-carrying `Serialize`/`Deserialize` derive
291 /// round-trip and per-test fixture-mutation paths).
292 #[must_use]
293 pub const fn instructions(&self) -> &[UpgradeInstruction] {
294 self.instructions.as_slice()
295 }
296
297 /// Verify the `:from` field is a valid semver, every instruction's
298 /// typed shape, the within-entry `(:restart)`-exclusivity invariant
299 /// (an entry containing `(:restart)` must contain exactly one
300 /// `(:restart)` and nothing else — see
301 /// [`Self::validate_restart_exclusive`]), the within-entry
302 /// state-change-ordering invariant (every `(:state-change …)` must
303 /// be preceded by a `(:load-module …)` — see
304 /// [`Self::validate_state_change_ordering`]), the within-entry
305 /// purge-ordering invariant (every `(:soft-purge …)` / `(:purge …)`
306 /// must be preceded by a `(:load-module …)` — see
307 /// [`Self::validate_purge_ordering`]), the within-entry
308 /// state-change-before-cleanup ordering invariant (no
309 /// `(:state-change …)` may appear after any `(:soft-purge …)` /
310 /// `(:purge …)` — see
311 /// [`Self::validate_state_change_before_cleanup`]), the within-
312 /// entry load-singularity invariant (no module appears as the
313 /// target of `(:load-module …)` more than once — see
314 /// [`Self::validate_load_singularity`]), the within-entry
315 /// state-change-singularity invariant (no script appears as the
316 /// target of `(:state-change …)` more than once — see
317 /// [`Self::validate_state_change_singularity`]), and the within-
318 /// entry cleanup-singularity invariant (no module appears as the
319 /// target of `(:soft-purge …)` or `(:purge …)` more than once
320 /// total — see [`Self::validate_cleanup_singularity`]).
321 pub fn validate(&self) -> Result<(), UpgradeError> {
322 use semver::Version;
323 Version::parse(self.prior_versao()).map_err(|e| UpgradeError::FromInvalid {
324 from: self.prior_versao().to_string(),
325 reason: e.to_string(),
326 })?;
327 // Per-instruction typed shape: kind-tagged `:module` /
328 // `:script` value-shape gates fire here, *before* the
329 // within-entry restart-exclusivity gate below — so a
330 // malformed-shape diagnostic on a Module/Script-bearing
331 // instruction surfaces with its narrower self-locating
332 // wording (`ModuleEmpty`, `ModuleInvalid`, `EmptyScript`,
333 // `AbsoluteScript`, `ParentEscapeScript`) rather than
334 // collapsing two unrelated authoring errors into a single
335 // exclusivity diagnostic. Same empty-first cascade discipline
336 // every peer DNS-1123 / path-shape gate inside this module
337 // uses (`validate_module`'s ModuleEmpty arm precedes the
338 // DNS-1123 predicate; `validate` on `StateChange` consults
339 // the lifted `is_sandboxed_relative_path` shape gate first).
340 // Route the per-instruction shape-check fan-out through the
341 // lifted [`Self::instructions`] slice-return accessor rather
342 // than the raw `self.instructions` field access — first of
343 // nine paired production consumers of the per-`:upgrade-from
344 // :instructions` OTP-appup migration-instruction-list surface
345 // that now key off exactly one typed dispatch on the substrate
346 // primitive.
347 for instr in self.instructions() {
348 instr.validate()?;
349 }
350 self.validate_restart_exclusive()?;
351 self.validate_state_change_ordering()?;
352 self.validate_purge_ordering()?;
353 self.validate_state_change_before_cleanup()?;
354 self.validate_load_singularity()?;
355 self.validate_state_change_singularity()?;
356 self.validate_cleanup_singularity()?;
357 Ok(())
358 }
359
360 /// Reject `:upgrade-from :instructions` lists that carry
361 /// `(:restart)` alongside any other instruction, or that carry
362 /// more than one `(:restart)`. The valid Restart-bearing shape is
363 /// exactly `((:restart))` — a single `Restart` as the entry's
364 /// whole instructions list.
365 ///
366 /// Per [`UpgradeInstruction::Restart`]'s doc comment, `(:restart)`
367 /// is the *fallback* for an entry whose typed upgrade is
368 /// impossible (wasm component-model world incompatibility,
369 /// irreversible state shape change). The fallback is terminal by
370 /// construction: the operator restarts the pod and the new version
371 /// comes up fresh, so any other instructions in the same entry
372 /// are dead code in both directions — either the typed sequence
373 /// would have succeeded and `(:restart)` is unreached, or it
374 /// wouldn't and the typed instructions are dead because the
375 /// operator restarts anyway. Two canonical authoring footguns
376 /// close here:
377 ///
378 /// - `((:load-module …) (:state-change …) (:restart))` — the
379 /// "I'll try the typed path *then* restart anyway" footgun.
380 /// There is no coherent OTP-shaped semantic for this: if the
381 /// typed sequence succeeds, the trailing restart discards the
382 /// work that just succeeded (defeating the whole point of
383 /// declaring it); if it fails, the restart is never reached
384 /// because the entry already failed.
385 /// - `((:restart) (:restart))` — multiple `Restart` variants in
386 /// one entry. The fallback is a single semantic; repeating it
387 /// is at best redundant, at worst suggests the author thought
388 /// the second one would re-trigger after the first.
389 ///
390 /// Same within-entry exclusivity discipline OTP's `relup` enforces
391 /// at the `restart_new_emulator | restart_emulator` instruction
392 /// boundary — those instructions are terminal in the upgrade
393 /// script (`systools(3)` rejects sequences that continue past
394 /// them); pleme-io lifts the same shape to a build-time gate,
395 /// matching the CAIXA-SDLC §III "build errors, not runtime
396 /// surprises" frame.
397 ///
398 /// Same within-entry cross-instruction discipline the
399 /// [`crate::AplicacaoSpec::validate_placement`] strategy ↔
400 /// shard-key partition (934bc58) and
401 /// [`validate_upgrade_from_against_versao`]'s `:from` ↔ `:versao`
402 /// precedence partition (de7ab1a) apply on cross-slot axes — now
403 /// extended onto the first within-list cross-instruction axis on
404 /// the `:upgrade-from` typed slot.
405 fn validate_restart_exclusive(&self) -> Result<(), UpgradeError> {
406 // Route the paired restart-count / instructions-len / other-
407 // kind projections through the lifted [`Self::instructions`]
408 // slice-return accessor rather than the raw `self.instructions`
409 // field access — three raw-access sites in one gate collapse
410 // onto exactly one typed dispatch on the substrate primitive.
411 //
412 // The paired positive / negated `Self::Restart` arm-discriminator
413 // predicates route through the `gen_platform::IsVariant`
414 // derive-generated [`UpgradeInstruction::is_restart`] rather than
415 // the raw `matches!(i, UpgradeInstruction::Restart)` /
416 // `!matches!(i, UpgradeInstruction::Restart)` open-coded pattern-
417 // matches — same closed-set-typed-enum arm-discriminator dispatch
418 // discipline the sibling [`crate::CaixaKind`] `IsVariant` derive
419 // (f5bba80) extended onto its ten `caixa.kind() == CaixaKind::X`
420 // / `!= CaixaKind::X` production sites in the substrate's own
421 // layout invariant verifier + typed-view projection gates,
422 // extended here onto the last unlifted `matches!`-based
423 // arm-discriminator axis on the [`UpgradeInstruction`] closed-set
424 // typed enum. A future sixth `UpgradeInstruction` arm (an
425 // adaptive-upgrade-shaped `AwaitReadiness` gate the M2.5
426 // wasm-operator's hot-upgrade runtime could adopt to bracket the
427 // typed instruction sequence against a per-cluster readiness
428 // probe, a `Downgrade` variant OTP's `relup` acknowledges on the
429 // reverse axis, a `CanaryTraffic` split-traffic variant the M4 CR
430 // materializer could resolve per-CR) migrates as a single
431 // enum-declaration edit — the derive auto-generates the paired
432 // `.is_<new_arm>()` predicate; every consumer inherits the new
433 // arm on the next re-derive, rather than the two `matches!` sites
434 // here having to be threaded through in lockstep.
435 let instructions = self.instructions();
436 let restart_count = instructions.iter().filter(|i| i.is_restart()).count();
437 if restart_count == 0 {
438 return Ok(());
439 }
440 if restart_count == 1 && instructions.len() == 1 {
441 return Ok(());
442 }
443 let other_kinds: Vec<&'static str> = instructions
444 .iter()
445 .filter(|i| !i.is_restart())
446 .map(UpgradeInstruction::lisp_form)
447 .collect();
448 Err(UpgradeError::RestartNotExclusive {
449 from: self.prior_versao().to_string(),
450 restart_count,
451 other_kinds,
452 })
453 }
454
455 /// Reject an entry whose `(:state-change …)` is not preceded by a
456 /// `(:load-module …)` in the same `:instructions` list.
457 ///
458 /// `StateChange` is the `gen_server:code_change/3` analog
459 /// ([`UpgradeInstruction::StateChange`] doc; INSPIRATIONS §II.4):
460 /// it runs the migration script that folds the *old* state into the
461 /// shape the *new* code expects. In OTP, `code_change/3` is invoked
462 /// in the context of the newly-loaded code — `release_handler`
463 /// always loads the new module before running the advanced update
464 /// that triggers the callback. caixa decomposes that into two
465 /// explicit instructions (`LoadModule` brings the new version up
466 /// "alongside the current one"; `StateChange` migrates the state),
467 /// and the module doc pins that the operator "runs the instructions
468 /// in order" and only swaps traffic after all succeed. So a
469 /// `:state-change` with no preceding `:load-module` migrates state
470 /// into code that was never loaded — the migration script runs while
471 /// the only resident version is still the *old* one, which expects
472 /// the *old* state. Two authoring footguns close here:
473 ///
474 /// - `((:state-change "…"))` — the "I wrote the migration but
475 /// forgot to load the new module" footgun. The new code that
476 /// defines the new state representation (and that the migration
477 /// output is destined for) never comes up; the operator runs
478 /// the script against the old code and either no-ops or corrupts
479 /// live state.
480 /// - `((:state-change "…") (:load-module "…"))` — the
481 /// right-instructions-wrong-order footgun. Because the operator
482 /// executes in declared order, the migration runs *before* the
483 /// new code is resident, then the load brings up code expecting
484 /// already-migrated state that the just-run script produced
485 /// against the old version's shape. The canonical order is
486 /// `(:load-module …) (:state-change …) (:soft-purge …)`
487 /// (module doc example).
488 ///
489 /// Same within-entry cross-instruction discipline as
490 /// [`Self::validate_restart_exclusive`] (the `(:restart)` terminal-
491 /// exclusivity gate it runs beside): both reject an
492 /// `:instructions` list whose instructions are individually
493 /// well-shaped but jointly incoherent, at the typed build surface
494 /// rather than as a runtime surprise. Runs *after*
495 /// `validate_restart_exclusive` so a `((:state-change …)
496 /// (:restart))` shape still surfaces the more-fundamental
497 /// `RestartNotExclusive` (a valid `(:restart)` entry is `(:restart)`
498 /// alone, so no Restart-bearing entry reaches this gate carrying a
499 /// `StateChange`).
500 fn validate_state_change_ordering(&self) -> Result<(), UpgradeError> {
501 // Route the per-instruction load-family arm-discriminator through
502 // the `gen_platform::IsVariant`-derive-generated
503 // [`UpgradeInstruction::is_load_module`] predicate and the
504 // per-instruction migration-family `:script` scalar projection
505 // through the sibling lifted [`UpgradeInstruction::declared_path`]
506 // `Option<&PathBuf>` accessor rather than the raw two-arm
507 // `match instr { UpgradeInstruction::LoadModule { .. } =>
508 // loaded = true, UpgradeInstruction::StateChange { script } if
509 // !loaded => …, _ => {} }` open-coded pattern-match — closes the
510 // last unlifted `match`-shaped per-arm-hand-rolled load-family
511 // arm-discriminator + migration-family script-projection pair
512 // inside `impl UpgradeFromEntry`. Sibling of the peer
513 // [`Self::validate_purge_ordering`] (580d0f1) routing already
514 // lifted onto [`UpgradeInstruction::is_load_module`] on the paired
515 // load → cleanup ordering axis, the peer
516 // [`Self::validate_load_singularity`] (c9ce91d) routing lifted
517 // onto the [`UpgradeInstruction::is_load_module`] +
518 // [`UpgradeInstruction::declared_module`] pair on the singularity
519 // axis, and the peer [`Self::validate_state_change_singularity`]
520 // routing already lifted onto the sibling
521 // [`UpgradeInstruction::declared_path`] `Option<&PathBuf>`
522 // accessor on the migration-family script-projection axis — both
523 // ordering-gate load-family sticky-latch dispatches now key off
524 // exactly one typed dispatch on the substrate primitive for
525 // their load-family arm-discriminator, and both migration-family
526 // projection sites (this ordering gate + the peer singularity
527 // gate) now key off exactly one typed dispatch on the substrate
528 // primitive for the `:script`-carrying axis. A future sixth arm
529 // on [`UpgradeInstruction`] (an `AwaitReadiness` gate, a
530 // `Downgrade` reverse-axis variant OTP's `relup` acknowledges, a
531 // `CanaryTraffic` split-traffic variant the M4 CR materializer
532 // could resolve per-CR — INSPIRATIONS §II.4) migrates as one
533 // enum-declaration edit through the derive rather than a
534 // coordinated rewrite of every ordering / singularity gate's
535 // per-arm hand-rolled pattern-match. Byte-identity of this
536 // dispatch against the pre-lift `match` shape is pinned by
537 // [`tests::validate_state_change_ordering_projects_scripts_through_is_load_module_and_declared_path_accessors`].
538 let mut loaded = false;
539 for instr in self.instructions() {
540 if instr.is_load_module() {
541 loaded = true;
542 } else if !loaded && let Some(script) = instr.declared_path() {
543 return Err(UpgradeError::StateChangeWithoutPriorLoad {
544 from: self.prior_versao().to_string(),
545 script: script.clone(),
546 });
547 }
548 }
549 Ok(())
550 }
551
552 /// Reject an entry whose `(:soft-purge …)` or `(:purge …)` is not
553 /// preceded by a `(:load-module …)` in the same `:instructions` list.
554 ///
555 /// `SoftPurge` and `Purge` are the `code:soft_purge/1` /
556 /// `code:purge/1` analogs (INSPIRATIONS §II.4): they remove the
557 /// *old* module from memory after the new one is resident. OTP's
558 /// two-phase code load is `code:load_module/1` *then*
559 /// `code:soft_purge/1` — load the new version alongside the old
560 /// (both in memory, new requests route to new), then purge the old
561 /// after in-flight callers drain. caixa decomposes that into two
562 /// explicit instructions (`LoadModule` brings the new version up
563 /// "alongside the current one", per [`UpgradeInstruction::LoadModule`]
564 /// doc; `SoftPurge` "waits for in-flight requests on a named module
565 /// to drain, then GC it", per [`UpgradeInstruction::SoftPurge`] doc),
566 /// and the module doc pins that the operator "runs the instructions
567 /// in order". So a `:soft-purge` / `:purge` with no preceding
568 /// `:load-module` purges old code while the only resident version is
569 /// still the *same* old code, leaving the upgrade entry asking the
570 /// operator to drain or discard the live module with no replacement
571 /// resident. Two authoring footguns close here:
572 ///
573 /// - `((:soft-purge "…"))` / `((:purge "…"))` — the "I wrote the
574 /// cleanup but forgot to load the new module" footgun. The new
575 /// code never comes up alongside; the operator either drains the
576 /// old version to nothing (`SoftPurge`) or discards it outright
577 /// mid-request (`Purge`), with no replacement to route in-flight
578 /// or future requests to.
579 /// - `((:soft-purge "…") (:load-module "…"))` /
580 /// `((:purge "…") (:load-module "…"))` — the right-instructions-
581 /// wrong-order footgun. Because the operator executes in declared
582 /// order, the cleanup runs *before* the new code is resident,
583 /// leaving a window during which neither version is available;
584 /// the canonical order is `(:load-module …) (:state-change …)
585 /// (:soft-purge …)` (module doc example).
586 ///
587 /// Same within-entry cross-instruction discipline as
588 /// [`Self::validate_state_change_ordering`] (the `:state-change`-
589 /// ordering gate it runs beside): both close the same load-before-X
590 /// post-condition on the OTP appup ordering contract, now extending
591 /// the typed coverage from "new code resident before its state
592 /// migration runs" to "new code resident before the old code is
593 /// drained or discarded" — the second half of OTP's two-phase code
594 /// load. Runs *after* `validate_state_change_ordering` so an entry
595 /// like `((:state-change …) (:soft-purge …))` surfaces the more-
596 /// fundamental `StateChangeWithoutPriorLoad` first (both instructions
597 /// are load-less, but state-change is the load-bearing semantic — the
598 /// purge is meaningless either way without a preceding load, so the
599 /// author should see the migration-side diagnostic first).
600 fn validate_purge_ordering(&self) -> Result<(), UpgradeError> {
601 let mut loaded = false;
602 for instr in self.instructions() {
603 // Route the per-instruction cleanup-family arm-discriminator
604 // through the lifted [`UpgradeInstruction::is_cleanup`] typed
605 // predicate rather than the raw
606 // `UpgradeInstruction::SoftPurge { module } |
607 // UpgradeInstruction::Purge { module }` open-coded per-arm
608 // union pattern-match — the first of three within-entry cross-
609 // instruction cleanup-facing gates now keys off exactly one
610 // typed dispatch on the substrate primitive, so any future
611 // fifth cleanup-shaped variant (a `Discard` variant the
612 // `code:delete/1` peer inspires) added to
613 // [`UpgradeInstruction`] + a composing `|| self.is_discard()`
614 // term at [`UpgradeInstruction::is_cleanup`] reaches this gate
615 // through the accessor's one body. The paired cleanup-arm
616 // `:module` scalar is routed through the sibling
617 // [`UpgradeInstruction::declared_module`] accessor rather than
618 // the raw pattern-bound `module` binding — same substrate-
619 // primitive-owns-the-scalar discipline every peer
620 // per-`UpgradeInstruction` scalar-value axis already routes
621 // through, with the `is_cleanup`-implies-`declared_module`-is-
622 // `Some` composition pin at
623 // [`tests::upgrade_instruction_is_cleanup_implies_declared_module_is_some`]
624 // making the `.expect(…)` structurally infallible at build
625 // time. Peer of the sibling
626 // [`UpgradeFromEntry::validate_restart_exclusive`]
627 // paired positive / negated
628 // [`UpgradeInstruction::is_restart`] routing (915a934) on the
629 // per-arm terminal-fallback partition — same closed-set-typed-
630 // enum arm-discriminator dispatch discipline extended from
631 // the single-arm terminal-fallback family onto the two-arm
632 // cleanup family here.
633 //
634 // Route the paired load-family arm-discriminator through the
635 // `gen_platform::IsVariant`-derive-generated
636 // [`UpgradeInstruction::is_load_module`] predicate rather than
637 // the raw `matches!(instr, UpgradeInstruction::LoadModule
638 // { .. })` open-coded pattern-match — closes the last
639 // unlifted `matches!`-based per-variant arm-discriminator
640 // axis on the [`UpgradeInstruction`] closed-set typed enum,
641 // sibling of the [`UpgradeInstruction::is_restart`] terminal-
642 // fallback routing (915a934) and the
643 // [`UpgradeInstruction::is_cleanup`] two-arm cleanup-family
644 // routing (0bc469f) that already lifted the paired
645 // arm-discriminator sites in this method. Every arm-family
646 // partition the gate keys off — load-family (`LoadModule`),
647 // cleanup-family (`SoftPurge | Purge`), terminal-fallback
648 // (`Restart`) — now consults exactly one typed dispatch on
649 // the substrate primitive, so a future sixth arm added to
650 // [`UpgradeInstruction`] (an `AwaitReadiness` gate, a
651 // `Downgrade` reverse-axis variant OTP's `relup` acknowledges,
652 // a `CanaryTraffic` split-traffic variant the M4 CR
653 // materializer could resolve per-CR — INSPIRATIONS §II.4)
654 // migrates as a single enum-declaration edit through the
655 // derive rather than a scattered per-consumer rewrite. The
656 // partition invariant is pinned by
657 // [`tests::upgrade_instruction_is_load_module_predicate_partitions_the_arm_set`]
658 // and the byte-identity of this dispatch against the pre-lift
659 // `matches!` pattern by
660 // [`tests::validate_purge_ordering_routes_through_is_load_module_predicate`].
661 if instr.is_load_module() {
662 loaded = true;
663 } else if instr.is_cleanup() && !loaded {
664 return Err(UpgradeError::PurgeWithoutPriorLoad {
665 from: self.prior_versao().to_string(),
666 kind: instr.lisp_form(),
667 module: instr
668 .declared_module()
669 .expect("is_cleanup() implies declared_module() is Some")
670 .to_string(),
671 });
672 }
673 }
674 Ok(())
675 }
676
677 /// Reject an entry whose `(:state-change …)` appears after any
678 /// `(:soft-purge …)` / `(:purge …)` in the same `:instructions`
679 /// list — completing the canonical OTP appup `code:load_module/1`
680 /// → `gen_server:code_change/3` → `code:soft_purge/1` ordering
681 /// chain on the typed `:upgrade-from` slot.
682 ///
683 /// `StateChange` is the `gen_server:code_change/3` analog
684 /// ([`UpgradeInstruction::StateChange`] doc; INSPIRATIONS §II.4
685 /// verbatim: "State migration uses `gen_server:code_change/3` …
686 /// migrate state from v0.1.0 shape to current shape"). The
687 /// callback's input is the *prior* version's state shape, which
688 /// only exists while the prior code is still resident — the running
689 /// `gen_server` processes hold the v0.1.0 state, and the operator's
690 /// dispatch invokes `code_change/3` to fold that state into the
691 /// current shape. `SoftPurge` / `Purge` are the `code:soft_purge/1`
692 /// / `code:purge/1` analogs ([`UpgradeInstruction::SoftPurge`] /
693 /// [`UpgradeInstruction::Purge`] docs): they drain or discard the
694 /// *old* module after the new one is resident. The operator runs
695 /// instructions in declared order (module doc), so a cleanup ahead
696 /// of a state-change discards the prior code before the migration
697 /// fold runs against the state it held — the canonical OTP error
698 /// mode "`code_change/3` invoked on a purged module" the
699 /// `release_handler` enforces by always emitting the migration
700 /// callback before the soft-purge step.
701 ///
702 /// `systools`-generated `.relup` files always emit `code_change`
703 /// before `soft_purge` for this reason; the appup cookbook's
704 /// canonical pattern (`[{load_module, m}, {update, m, soft},
705 /// {soft_purge, m}]`) places the migration-triggering `update`
706 /// strictly between the load and the cleanup. The caixa module
707 /// doc pins the same canonical order verbatim — `(:load-module
708 /// …) (:state-change …) (:soft-purge …)` — and this gate makes
709 /// that ordering a structural property at build time. Three
710 /// authoring footguns close here:
711 ///
712 /// - `((:load-module "x") (:soft-purge "x-old") (:state-change
713 /// "lib/m.lisp"))` — the right-instructions-wrong-order
714 /// footgun on the migrate ↔ cleanup axis. Because the operator
715 /// executes in declared order, the cleanup drains the v0.1.0
716 /// module to nothing before the migration callback runs, and
717 /// the script either no-ops (no v0.1.0 state left to fold) or
718 /// crashes (`code_change/3` invoked on an unloaded version).
719 /// The canonical order is `(:load-module …) (:state-change
720 /// …) (:soft-purge …)` (module doc example).
721 /// - `((:load-module "x") (:purge "x-old") (:state-change
722 /// "lib/m.lisp"))` — same shape on the more catastrophic
723 /// `:purge` variant. The immediate-discard semantic destroys
724 /// v0.1.0 state mid-request; the trailing migration script
725 /// has nothing to fold from and the `gen_server` processes that
726 /// held v0.1.0 state were killed by the `:purge`.
727 /// - `((:load-module "x") (:soft-purge "x-old") (:state-change
728 /// "lib/m1.lisp") (:soft-purge "y-old"))` — the "migration
729 /// sandwiched between two cleanups" footgun. The first
730 /// cleanup discards v0.1.0; the migration runs against
731 /// drained state; the second cleanup is irrelevant. The first
732 /// cleanup → state-change boundary is the load-bearing defect
733 /// surfaced.
734 ///
735 /// Same within-entry cross-instruction discipline as
736 /// [`Self::validate_state_change_ordering`] (the load → state-
737 /// change ordering gate it runs after) and
738 /// [`Self::validate_purge_ordering`] (the load → cleanup ordering
739 /// gate it runs after): all three close one boundary of the OTP
740 /// canonical sequence `code:load_module/1` →
741 /// `gen_server:code_change/3` → `code:soft_purge/1`. The
742 /// state-change-ordering gate closes the load → migrate boundary;
743 /// the purge-ordering gate closes the load → cleanup boundary;
744 /// this gate closes the migrate → cleanup boundary, completing
745 /// the typed coverage of the canonical sequence. Runs *after*
746 /// [`Self::validate_purge_ordering`] (and therefore after
747 /// [`Self::validate_state_change_ordering`]) so an entry like
748 /// `((:soft-purge "x-old") (:state-change "lib/m.lisp"))` —
749 /// which violates *both* the purge-without-load gate and this
750 /// state-change-after-cleanup gate — surfaces the more-
751 /// fundamental `PurgeWithoutPriorLoad` first (the missing-load
752 /// defect is load-bearing; once a coherent `(:load-module …)`
753 /// precedes both, the migrate ↔ cleanup ordering becomes the
754 /// next live defect). Runs *before* the per-instruction-class
755 /// singularity gates ([`Self::validate_load_singularity`],
756 /// [`Self::validate_state_change_singularity`],
757 /// [`Self::validate_cleanup_singularity`]) so an entry like
758 /// `((:load-module "x") (:soft-purge "x-old") (:state-change
759 /// "lib/m.lisp") (:state-change "lib/m.lisp"))` — which violates
760 /// *both* this ordering gate and the state-change-singularity
761 /// gate — surfaces the ordering defect first; the canonical
762 /// "ordering before singularity" precedence the peer
763 /// `validate_state_change_ordering` / `validate_purge_ordering`
764 /// gates already establish.
765 ///
766 /// Detection: linear scan of the instructions list with a
767 /// `prior_cleanup: Option<(module, kind)>` sticky-once latch
768 /// recording the first cleanup encountered; on any subsequent
769 /// `StateChange` the gate fires with the script + the prior
770 /// cleanup's kind/module. Diagnostic-order pin: the first
771 /// colliding state-change-after-cleanup pair surfaces, not the
772 /// last — mirrors every peer ordering gate's first-collision
773 /// posture ([`Self::validate_state_change_ordering`] returns on
774 /// the first `StateChange` without prior load,
775 /// [`Self::validate_purge_ordering`] on the first cleanup
776 /// without prior load).
777 fn validate_state_change_before_cleanup(&self) -> Result<(), UpgradeError> {
778 let mut prior_cleanup: Option<(&str, &'static str)> = None;
779 for instr in self.instructions() {
780 // Route the per-instruction cleanup-family arm-discriminator
781 // through the lifted [`UpgradeInstruction::is_cleanup`] typed
782 // predicate rather than the raw
783 // `UpgradeInstruction::SoftPurge { module } |
784 // UpgradeInstruction::Purge { module }` open-coded per-arm
785 // union pattern-match — the second of three within-entry
786 // cross-instruction cleanup-facing gates the peer
787 // [`Self::validate_purge_ordering`] routing already lifted;
788 // both now key off exactly one typed dispatch on the substrate
789 // primitive so the "which arms belong to the cleanup family"
790 // question resolves at exactly one caixa-core edit. The
791 // sticky-once latch's `:module` scalar is routed through the
792 // sibling [`UpgradeInstruction::declared_module`] accessor
793 // rather than the raw pattern-bound `module.as_str()`
794 // projection, with the `is_cleanup`-implies-`declared_module`-
795 // is-`Some` composition pin at
796 // [`tests::upgrade_instruction_is_cleanup_implies_declared_module_is_some`]
797 // making the `.expect(…)` structurally infallible at build
798 // time.
799 if instr.is_cleanup() && prior_cleanup.is_none() {
800 prior_cleanup = Some((
801 instr
802 .declared_module()
803 .expect("is_cleanup() implies declared_module() is Some"),
804 instr.lisp_form(),
805 ));
806 } else if let Some(script) = instr.declared_path()
807 && let Some((prior_module, prior_kind)) = prior_cleanup
808 {
809 // Route the per-instruction `StateChange`-arm script-path
810 // projection through the sibling lifted
811 // [`UpgradeInstruction::declared_path`] `Option<&PathBuf>`
812 // accessor rather than the raw
813 // `if let UpgradeInstruction::StateChange { script } = instr`
814 // open-coded pattern-match — the last unlifted per-
815 // `UpgradeInstruction` `PathBuf`-carrying-axis consumer
816 // inside `impl UpgradeFromEntry`, sibling to the four peer
817 // per-`UpgradeInstruction` consumers already routed through
818 // the accessor: [`UpgradeInstruction::validate`]'s per-
819 // `StateChange` sandbox-path fan-out, the layout-side per-
820 // `StateChange` script-existence fan-out at
821 // [`crate::layout::StandardLayout::verify`]
822 // (caixa-core/src/layout.rs:1058), the within-entry
823 // [`UpgradeFromEntry::validate_state_change_singularity`]
824 // per-`StateChange` script-projection fan-out, and the
825 // cross-slot
826 // [`validate_upgrade_from_against_behavior`]
827 // per-`StateChange` detection loop. Byte-equal today
828 // (`declared_path` returns `Some(script)` iff the
829 // instruction is [`UpgradeInstruction::StateChange`], per
830 // the sibling `declared_path_only_for_state_change` pin),
831 // so a state-change-after-cleanup surfaces
832 // `StateChangeAfterCleanup` byte-identical to the pattern-
833 // match shape. Any future accessor extension that promotes
834 // an additional variant onto the `PathBuf`-carrying axis
835 // reaches this gate through one caixa-core edit rather
836 // than a coordinated rewrite of five call sites — the
837 // migrate→cleanup ordering discipline extends to the
838 // promoted variant by construction. Same "one typed
839 // dispatch on the substrate primitive, thin projections at
840 // each consumer" trajectory the sibling
841 // [`UpgradeInstruction::declared_module`] `String`-axis
842 // per-variant unifier already established.
843 return Err(UpgradeError::StateChangeAfterCleanup {
844 from: self.prior_versao().to_string(),
845 script: script.clone(),
846 prior_cleanup_kind: prior_kind,
847 prior_cleanup_module: prior_module.to_string(),
848 });
849 }
850 }
851 Ok(())
852 }
853
854 /// Reject an entry whose `:instructions` list names the same module
855 /// as the target of more than one cleanup instruction (`:soft-purge`
856 /// or `:purge`) in total — set-not-multiset on the (cleanup-class,
857 /// module) axis, narrowed to the cleanup class.
858 ///
859 /// `SoftPurge` and `Purge` are the `code:soft_purge/1` /
860 /// `code:purge/1` analogs (INSPIRATIONS §II.4 verbatim: "1.
861 /// `code:load_module/1` — load v2 alongside v1 … 2.
862 /// `code:soft_purge/1` — wait until no process is running v1, then
863 /// discard. (`code:purge/1` kills v1 immediately if you don't
864 /// care.)"). The author picks *one* cleanup semantic per old
865 /// module — `:soft-purge` (preferred: waits for in-flight callers
866 /// to drain) or `:purge` (when the drain isn't possible) — and the
867 /// operator runs that one in declared order alongside any other
868 /// distinct-module cleanups. systools-generated `.relup` files
869 /// always emit at most one purge per module for this reason; any
870 /// retry / fallback decision is the operator's job on
871 /// instruction failure, not authored into the entry. Three
872 /// authoring footguns close here:
873 ///
874 /// - `((:load-module "x") (:soft-purge "x-old") (:soft-purge "x-old"))`
875 /// — the "I copy-pasted the cleanup line twice" footgun. The
876 /// second `:soft-purge` is a no-op (the module is already gone
877 /// after the first drain-and-discard) or undefined depending
878 /// on the operator's handling of a non-resident-module purge
879 /// request; either way the second instruction carries no
880 /// observable semantic, far from the source caixa.lisp.
881 /// - `((:load-module "x") (:soft-purge "x-old") (:purge "x-old"))`
882 /// — the "soft-then-hard fallback" footgun. The author wrote
883 /// "drain, and if drain didn't clean it up, force-discard",
884 /// but the operator runs instructions unconditionally in
885 /// declared order — the `:purge` fires whether the
886 /// `:soft-purge` already discarded the module or not, so the
887 /// fallback semantic the author imagined is missing; the
888 /// pair is incoherent (drain *and* force-discard semantics
889 /// on one module is two contradictory dispositions). The
890 /// operator's failure-handling surface is its own
891 /// responsibility: if `:soft-purge` doesn't drain within its
892 /// cooldown the operator escalates, not the author's entry.
893 /// - `((:load-module "x") (:purge "x-old") (:soft-purge "x-old"))`
894 /// — same shape on the reversed ordering. The `:purge`
895 /// discards immediately; the trailing `:soft-purge` has no
896 /// module to drain.
897 ///
898 /// Same within-entry exclusivity discipline as
899 /// [`Self::validate_restart_exclusive`] (the `(:restart)` terminal-
900 /// exclusivity gate it joins on the per-module cleanup axis): both
901 /// reject an `:instructions` list whose instructions are
902 /// individually well-shaped but jointly incoherent on a chosen
903 /// semantic axis (restart-fallback for the whole entry there;
904 /// cleanup-semantic for one module here), at the typed build
905 /// surface rather than as a runtime surprise. Runs *after*
906 /// [`Self::validate_purge_ordering`] (the load-before-cleanup
907 /// ordering gate) so an entry like `((:soft-purge "x-old")
908 /// (:soft-purge "x-old"))` surfaces the more-fundamental
909 /// `PurgeWithoutPriorLoad` first (both cleanups are load-less, and
910 /// the missing-load defect is the load-bearing one — the duplicate
911 /// is meaningless either way without the preceding load).
912 ///
913 /// Same set-not-multiset discipline applied to every peer
914 /// duplicate-target axis: `:children :caixa` (dbf50a9 —
915 /// `SupervisorError::DuplicateChildCaixa`), `:membros :caixa`
916 /// (4bb3f3d — `AplicacaoError::MembroDuplicate`), `:contratos`
917 /// (5dbcfaf — `AplicacaoError::ContratoDuplicate`), `:placement
918 /// :clusters` (c7c7799 — `AplicacaoError::PlacementClusterDuplicate`),
919 /// `:entrada :paths` (eb3456d — `AplicacaoError::EntradaPathDuplicate`),
920 /// and `:upgrade-from :from` ([`UpgradeError::DuplicateFrom`]).
921 /// Each closes the same authoring footgun: a Vec authoring surface
922 /// that silently accepts duplicate entries and renders the "second
923 /// wins" (or "operator processes both, second is a no-op or
924 /// errors") shape downstream, far from the source caixa.lisp.
925 /// This gate extends the discipline onto the within-entry
926 /// instruction-target axis — duplicate cleanup targets *within*
927 /// one `:upgrade-from` entry — the peer of the cross-entry
928 /// duplicate-`:from` axis at one level of nesting deeper.
929 ///
930 /// Detection: linear scan of the instructions list collecting
931 /// the (module, kind) pair from every `SoftPurge` / `Purge`
932 /// encountered; on the second occurrence of any module the gate
933 /// fires with the prior kind and the colliding kind in declaration
934 /// order. Diagnostic-order pin: the first colliding pair surfaces,
935 /// not the last — mirrors
936 /// [`validate_upgrade_from`]'s
937 /// `validate_upgrade_from_duplicate_diagnostic_names_second_collision`
938 /// posture (the first detected collision wins) and every peer
939 /// duplicate gate's first-collision discipline.
940 fn validate_cleanup_singularity(&self) -> Result<(), UpgradeError> {
941 let mut seen: Vec<(&str, &'static str)> = Vec::new();
942 for instr in self.instructions() {
943 // Route the per-instruction cleanup-family arm-discriminator
944 // through the lifted [`UpgradeInstruction::is_cleanup`] typed
945 // predicate rather than the raw two-arm
946 // `UpgradeInstruction::SoftPurge { module } => (module.as_str(),
947 // M2_UPGRADE_INSTRUCTION_KIND_SOFT_PURGE)` /
948 // `UpgradeInstruction::Purge { module } => (module.as_str(),
949 // M2_UPGRADE_INSTRUCTION_KIND_PURGE)` / `_ => continue`
950 // per-arm dispatch — the third of three within-entry cross-
951 // instruction cleanup-facing gates the peer
952 // [`Self::validate_purge_ordering`] +
953 // [`Self::validate_state_change_before_cleanup`] routing
954 // already lifted; all three now key off exactly one typed
955 // dispatch on the substrate primitive, structurally. The
956 // cleanup-target `(module, kind)` pair is projected through
957 // the peer [`UpgradeInstruction::declared_module`] /
958 // [`UpgradeInstruction::lisp_form`] accessors rather than
959 // the per-arm-hand-rolled scalar-value + kind-const pair,
960 // with the `is_cleanup`-implies-`declared_module`-is-`Some`
961 // composition pin at
962 // [`tests::upgrade_instruction_is_cleanup_implies_declared_module_is_some`]
963 // making the `.expect(…)` structurally infallible at build
964 // time. Any future fifth cleanup-shaped variant added under
965 // the `is_cleanup` predicate + registered through the peer
966 // `lisp_form` per-arm kebab-case-const dispatch reaches this
967 // dedup gate through the accessor's one body rather than a
968 // fourth per-arm-hand-rolled scalar/kind projection here.
969 if !instr.is_cleanup() {
970 continue;
971 }
972 let module = instr
973 .declared_module()
974 .expect("is_cleanup() implies declared_module() is Some");
975 let kind = instr.lisp_form();
976 if let Some(prior_idx) = seen.iter().position(|(m, _)| *m == module) {
977 let prior_kind = seen[prior_idx].1;
978 return Err(UpgradeError::DuplicateCleanup {
979 from: self.prior_versao().to_string(),
980 module: module.to_string(),
981 kinds: vec![prior_kind, kind],
982 });
983 }
984 seen.push((module, kind));
985 }
986 Ok(())
987 }
988
989 /// Reject an entry whose `:instructions` list names the same module
990 /// as the target of more than one `(:load-module …)` instruction —
991 /// set-not-multiset on the `LoadModule` axis.
992 ///
993 /// `LoadModule` is the `code:load_module/1` analog (INSPIRATIONS
994 /// §II.4 verbatim: "1. `code:load_module/1` — load v2 alongside v1;
995 /// new code is 'current', old code is 'old'."). The instruction
996 /// brings the new wasm component up resident alongside the old
997 /// one so the operator can route new traffic to the new code
998 /// while in-flight callers drain on the old — and the operator's
999 /// dispatch table reads the module *name* (a caixa name) to bind
1000 /// the component, so two `(:load-module "x")` instructions in one
1001 /// entry ask the operator to re-bind the same component twice.
1002 /// `systools`-generated `.relup` files emit at most one
1003 /// `load_module` per module per upgrade step for this reason; the
1004 /// second load has no observable semantic relative to the first
1005 /// (the component is already resident). Three authoring footguns
1006 /// close here:
1007 ///
1008 /// - `((:load-module "x") (:load-module "x"))` — the "I
1009 /// copy-pasted the load line twice" footgun. The second
1010 /// `:load-module` re-reads the same module name and re-binds
1011 /// the same wasm component — a no-op in both directions
1012 /// (no new code becomes resident; no old code is purged) —
1013 /// and any cleanup / migration the author intended for a
1014 /// *distinct* module is silently absent from the entry.
1015 /// - `((:load-module "x") (:load-module "x") (:state-change …))`
1016 /// — the "I meant to load two distinct modules" typo. The
1017 /// author intended `((:load-module "x") (:load-module "y"))`
1018 /// but renamed both to "x" (or copied the first line and
1019 /// forgot to change the module). The migration runs against
1020 /// code that's resident only on one module name, and the
1021 /// second module the author imagined was being loaded never
1022 /// comes up at all — far from the source caixa.lisp.
1023 /// - `((:load-module "x") (:load-module "x") (:soft-purge "x-old"))`
1024 /// — same shape with a trailing cleanup. The duplicate load
1025 /// is dead code; the cleanup still fires correctly, masking
1026 /// the load-side duplication as a silently-passing entry.
1027 ///
1028 /// Same within-entry exclusivity discipline as
1029 /// [`Self::validate_cleanup_singularity`] (the per-module cleanup-
1030 /// singularity gate this runs beside) on the sibling
1031 /// `LoadModule` axis: both reject an `:instructions` list whose
1032 /// instructions are individually well-shaped but jointly
1033 /// incoherent on a per-module-per-class basis (load-once for the
1034 /// load axis here; cleanup-once for the cleanup axis there), at
1035 /// the typed build surface rather than as a runtime surprise.
1036 /// Runs *after* [`Self::validate_purge_ordering`] (the load-
1037 /// before-cleanup ordering gate) so an entry like
1038 /// `((:state-change "m.lisp") (:load-module "x") (:load-module "x"))`
1039 /// surfaces the more-fundamental `StateChangeWithoutPriorLoad`
1040 /// first (the missing-load defect is load-bearing — the migration
1041 /// runs against unloaded code; the duplicate is meaningless either
1042 /// way without the preceding load). Runs *before*
1043 /// [`Self::validate_cleanup_singularity`] so an entry like
1044 /// `((:load-module "x") (:load-module "x") (:soft-purge "y-old")
1045 /// (:soft-purge "y-old"))` surfaces `DuplicateLoadModule` first —
1046 /// the load axis precedes the cleanup axis in the canonical OTP
1047 /// sequence (`code:load_module/1` then `code:soft_purge/1`) and
1048 /// in [`UpgradeInstruction`] declaration order (`LoadModule`
1049 /// before `SoftPurge`/`Purge`), so the load-side singularity is
1050 /// the load-bearing diagnostic when both fire.
1051 ///
1052 /// Same set-not-multiset discipline applied to every peer
1053 /// duplicate-target axis: `:children :caixa` (dbf50a9 —
1054 /// `SupervisorError::DuplicateChildCaixa`), `:membros :caixa`
1055 /// (4bb3f3d — `AplicacaoError::MembroDuplicate`), `:contratos`
1056 /// (5dbcfaf — `AplicacaoError::ContratoDuplicate`), `:placement
1057 /// :clusters` (c7c7799 — `AplicacaoError::PlacementClusterDuplicate`),
1058 /// `:entrada :paths` (eb3456d — `AplicacaoError::EntradaPathDuplicate`),
1059 /// `:upgrade-from :from` ([`UpgradeError::DuplicateFrom`]), and
1060 /// the per-module cleanup-target axis (9cedd8b —
1061 /// [`UpgradeError::DuplicateCleanup`]). This gate extends the
1062 /// discipline onto the within-entry `LoadModule` instruction-target
1063 /// axis — the third within-entry per-module singularity completing
1064 /// the load+cleanup pair across the OTP two-phase code-load
1065 /// contract.
1066 ///
1067 /// Detection: linear scan of the instructions list collecting the
1068 /// module name from every `LoadModule` encountered; on the second
1069 /// occurrence of any module the gate fires. Diagnostic-order pin:
1070 /// the first colliding occurrence surfaces, not the last — mirrors
1071 /// [`Self::validate_cleanup_singularity`]'s first-collision posture
1072 /// and every peer duplicate gate's first-collision discipline.
1073 fn validate_load_singularity(&self) -> Result<(), UpgradeError> {
1074 let mut seen: Vec<&str> = Vec::new();
1075 for instr in self.instructions() {
1076 // Route the per-instruction load-family arm-discriminator
1077 // through the `gen_platform::IsVariant`-derive-generated
1078 // [`UpgradeInstruction::is_load_module`] predicate rather
1079 // than the raw single-arm `match instr {
1080 // UpgradeInstruction::LoadModule { module } =>
1081 // module.as_str(), _ => continue }` open-coded pattern-
1082 // match — closes the last unlifted `matches!`-shaped
1083 // per-arm-hand-rolled scalar-value + arm-discriminator
1084 // pair inside `impl UpgradeFromEntry`, sibling of the
1085 // peer [`Self::validate_cleanup_singularity`] (0bc469f)
1086 // routing already lifted onto the two-arm cleanup-family
1087 // axis's per-arm arm-discriminator + `:module` projection
1088 // dispatch. The load-target `:module` scalar is projected
1089 // through the sibling [`UpgradeInstruction::declared_module`]
1090 // accessor rather than the per-arm-hand-rolled scalar-
1091 // value binding, with the
1092 // `is_load_module`-implies-`declared_module`-is-`Some`
1093 // composition pin at
1094 // [`tests::upgrade_instruction_is_load_module_implies_declared_module_is_some`]
1095 // making the `.expect(…)` structurally infallible at
1096 // build time. Every arm-family partition the three
1097 // within-entry per-instruction-class singularity gates
1098 // key off — load-family
1099 // ([`UpgradeInstruction::LoadModule`]), cleanup-family
1100 // ([`UpgradeInstruction::SoftPurge`] |
1101 // [`UpgradeInstruction::Purge`]), migration-family
1102 // ([`UpgradeInstruction::StateChange`]) — now consults
1103 // exactly one typed dispatch on the substrate primitive
1104 // (`is_load_module()` here, `is_cleanup()` at
1105 // [`Self::validate_cleanup_singularity`],
1106 // `declared_path()` at
1107 // [`Self::validate_state_change_singularity`]), so a
1108 // future sixth arm added to [`UpgradeInstruction`] (an
1109 // `AwaitReadiness` gate, a `Downgrade` reverse-axis
1110 // variant OTP's `relup` acknowledges, a `CanaryTraffic`
1111 // split-traffic variant the M4 CR materializer could
1112 // resolve per-CR — INSPIRATIONS §II.4) migrates as a
1113 // single enum-declaration edit through the derive rather
1114 // than a scattered per-consumer rewrite. Byte-identity of
1115 // this dispatch against the pre-lift match-pattern is
1116 // pinned by
1117 // [`tests::validate_load_singularity_projects_modules_through_is_load_module_and_declared_module_accessors`].
1118 if !instr.is_load_module() {
1119 continue;
1120 }
1121 let module = instr
1122 .declared_module()
1123 .expect("is_load_module() implies declared_module() is Some");
1124 if seen.contains(&module) {
1125 return Err(UpgradeError::DuplicateLoadModule {
1126 from: self.prior_versao().to_string(),
1127 module: module.to_string(),
1128 });
1129 }
1130 seen.push(module);
1131 }
1132 Ok(())
1133 }
1134
1135 /// Reject an entry whose `:instructions` list names the same script
1136 /// as the target of more than one `(:state-change …)` instruction —
1137 /// set-not-multiset on the `StateChange` axis.
1138 ///
1139 /// `StateChange` is the `gen_server:code_change/3` analog
1140 /// (INSPIRATIONS §II.4: "State migration uses
1141 /// `gen_server:code_change/3`"). The instruction folds the *old*
1142 /// state into the shape the *new* code expects — a one-shot
1143 /// transition from one declared state representation to another.
1144 /// OTP's `release_handler:install_release/1` invokes `code_change/3`
1145 /// exactly once per upgrade per `gen_server`; `systools`-generated
1146 /// `.relup` files emit at most one `code_change` per `gen_server` per
1147 /// upgrade step for this reason. A second `(:state-change "m.lisp")`
1148 /// instruction targeting the same script in one entry re-runs the
1149 /// migration fold — at best a no-op (idempotent script masking a
1150 /// typo where the author intended two distinct scripts) and at
1151 /// worst silent state corruption (non-idempotent fold double-
1152 /// applied: an `add column` migration that runs twice, an
1153 /// `increment counter` that double-bumps, a `rename field` that
1154 /// renames-then-fails the second time). Three authoring footguns
1155 /// close here:
1156 ///
1157 /// - `((:load-module "x") (:state-change "lib/m.lisp")
1158 /// (:state-change "lib/m.lisp"))` — the "I copy-pasted the
1159 /// migration line twice" footgun. The second `:state-change`
1160 /// re-runs the same fold on the already-migrated state — a
1161 /// no-op if the script is idempotent (dead code masking the
1162 /// duplication) or state corruption if not (the migration's
1163 /// pre-condition no longer holds because the post-condition is
1164 /// already in place).
1165 /// - `((:load-module "x") (:state-change "lib/m.lisp")
1166 /// (:state-change "lib/m.lisp") (:soft-purge "x-old"))` — the
1167 /// "duplicate migrate masked by trailing cleanup" footgun. The
1168 /// cleanup still fires correctly, masking the migration-side
1169 /// duplication as a silently-passing entry.
1170 /// - `((:load-module "x") (:state-change "lib/m1.lisp")
1171 /// (:state-change "lib/m1.lisp"))` — the "I meant to migrate
1172 /// two distinct modules" typo. The author intended
1173 /// `(:state-change "lib/m1.lisp") (:state-change "lib/m2.lisp")`
1174 /// but renamed both to `m1.lisp` (or copy-pasted the first line
1175 /// and forgot to change the script). The migration that should
1176 /// have folded the second module's state never runs, far from
1177 /// the source caixa.lisp.
1178 ///
1179 /// Same within-entry exclusivity discipline as
1180 /// [`Self::validate_load_singularity`] (the per-module load-
1181 /// singularity gate it runs after) and
1182 /// [`Self::validate_cleanup_singularity`] (the per-module cleanup-
1183 /// singularity gate it runs before) on the sibling `StateChange`
1184 /// axis: each rejects an `:instructions` list whose instructions
1185 /// are individually well-shaped but jointly incoherent on a per-
1186 /// instruction-class basis (load-once per module for the load
1187 /// axis; migrate-once per script for the migration axis here;
1188 /// cleanup-once per module for the cleanup axis), at the typed
1189 /// build surface rather than as a runtime surprise. Runs *after*
1190 /// [`Self::validate_load_singularity`] so an entry like
1191 /// `((:load-module "x") (:load-module "x") (:state-change
1192 /// "lib/m.lisp") (:state-change "lib/m.lisp"))` surfaces
1193 /// `DuplicateLoadModule` first — the load axis precedes the
1194 /// migration axis in the canonical OTP sequence
1195 /// (`code:load_module/1` then `gen_server:code_change/3`) and in
1196 /// [`UpgradeInstruction`] declaration order (`LoadModule` before
1197 /// `StateChange`), so the load-side singularity is the load-
1198 /// bearing diagnostic when both fire. Runs *before*
1199 /// [`Self::validate_cleanup_singularity`] so an entry like
1200 /// `((:load-module "x") (:state-change "lib/m.lisp") (:state-change
1201 /// "lib/m.lisp") (:soft-purge "y-old") (:soft-purge "y-old"))`
1202 /// surfaces `DuplicateStateChange` first — the migration axis
1203 /// precedes the cleanup axis in the canonical OTP sequence
1204 /// (`code:code_change/3` then `code:soft_purge/1`) and in
1205 /// [`UpgradeInstruction`] declaration order (`StateChange` before
1206 /// `SoftPurge`/`Purge`).
1207 ///
1208 /// Same set-not-multiset discipline applied to every peer
1209 /// duplicate-target axis: `:children :caixa` (dbf50a9 —
1210 /// `SupervisorError::DuplicateChildCaixa`), `:membros :caixa`
1211 /// (4bb3f3d — `AplicacaoError::MembroDuplicate`), `:contratos`
1212 /// (5dbcfaf — `AplicacaoError::ContratoDuplicate`), `:placement
1213 /// :clusters` (c7c7799 — `AplicacaoError::PlacementClusterDuplicate`),
1214 /// `:entrada :paths` (eb3456d — `AplicacaoError::EntradaPathDuplicate`),
1215 /// `:upgrade-from :from` ([`UpgradeError::DuplicateFrom`]), the
1216 /// per-module cleanup-target axis (9cedd8b —
1217 /// [`UpgradeError::DuplicateCleanup`]), and the per-module load-
1218 /// target axis (a503978 — [`UpgradeError::DuplicateLoadModule`]).
1219 /// This gate extends the discipline onto the within-entry
1220 /// `StateChange` instruction-target axis — the third within-entry
1221 /// per-instruction-class singularity, completing the OTP two-phase
1222 /// code-load + state-migration coverage triad
1223 /// (`code:load_module/1` → `gen_server:code_change/3` →
1224 /// `code:soft_purge/1`).
1225 ///
1226 /// Detection: linear scan of the instructions list collecting the
1227 /// script path from every `StateChange` encountered; on the second
1228 /// occurrence of any script the gate fires. Diagnostic-order pin:
1229 /// the first colliding occurrence surfaces, not the last — mirrors
1230 /// [`Self::validate_load_singularity`]'s and
1231 /// [`Self::validate_cleanup_singularity`]'s first-collision posture
1232 /// and every peer duplicate gate's first-collision discipline.
1233 fn validate_state_change_singularity(&self) -> Result<(), UpgradeError> {
1234 // Route the per-instruction `StateChange`-arm script-path
1235 // projection through the sibling lifted
1236 // [`UpgradeInstruction::declared_path`] `Option<&PathBuf>`
1237 // accessor rather than the raw
1238 // `match instr { UpgradeInstruction::StateChange { script } =>
1239 // script.as_path(), _ => continue }` open-coded pattern-match —
1240 // the third within-entry singularity gate's per-instruction
1241 // script-projection site now keys off exactly one typed
1242 // dispatch on the substrate primitive's `PathBuf`-carrying
1243 // axis, sibling to the four peer per-`UpgradeInstruction`
1244 // consumers ([`Self::validate`]'s per-`StateChange`
1245 // sandbox-path fan-out, the layout-side per-`StateChange`
1246 // script-existence fan-out at
1247 // `caixa-core/src/layout.rs:1017`, the cross-slot
1248 // [`validate_upgrade_from_against_behavior`] gate's
1249 // per-`StateChange` detection loop, the future wasm-operator's
1250 // per-`StateChange` runtime hook-dispatch) that already route
1251 // through `declared_path` / `declared_module`. Byte-equal
1252 // today (`declared_path` returns `Some(script)` iff the
1253 // instruction is [`UpgradeInstruction::StateChange`], per the
1254 // sibling `declared_path_only_for_state_change` pin), so a
1255 // duplicate `:state-change` script surfaces
1256 // `DuplicateStateChange` byte-identical to the pattern-match
1257 // shape. Same "one typed dispatch on the substrate primitive,
1258 // thin projections at each consumer" discipline the sibling
1259 // [`UpgradeInstruction::declared_module`] accessor established
1260 // (b13c4f9) on the peer `String`-carrying axis's per-variant
1261 // consumers, extended here onto the last unlifted
1262 // pattern-match on the `PathBuf`-carrying axis inside
1263 // `impl UpgradeFromEntry`.
1264 let mut seen: Vec<&std::path::Path> = Vec::new();
1265 for instr in self.instructions() {
1266 let Some(script) = instr.declared_path() else {
1267 continue;
1268 };
1269 let script = script.as_path();
1270 if seen.contains(&script) {
1271 return Err(UpgradeError::DuplicateStateChange {
1272 from: self.prior_versao().to_string(),
1273 script: script.to_path_buf(),
1274 });
1275 }
1276 seen.push(script);
1277 }
1278 Ok(())
1279 }
1280}
1281
1282/// Validate a whole `:upgrade-from` list: per-entry typed shape via
1283/// [`UpgradeFromEntry::validate`] *and* the cross-entry graph-edge-set
1284/// invariant — at most one `(:from <prior>)` block per parsed semver.
1285///
1286/// OTP's appup picks at most one matching block to apply to the running
1287/// release (`release_handler:install_release/1` matches the loaded
1288/// `:from` against the currently-running version and executes the
1289/// associated instruction sequence; the wasm-operator picks the matching
1290/// block at upgrade time, per `upgrade.rs` module doc). Two blocks with
1291/// the same parsed-semver `:from` are an ambiguous edge in the typed
1292/// upgrade graph — the operator can pick either set deterministically,
1293/// but each set may carry different `LoadModule | StateChange |
1294/// SoftPurge | Purge | Restart` instructions, so the *chosen* path is
1295/// non-deterministic relative to the source caixa.lisp. The author's
1296/// intent is one path per prior version; the typed graph must enforce
1297/// that shape.
1298///
1299/// Same set-not-multiset discipline already applied to every peer
1300/// typed-graph axis: `:children :caixa` (dbf50a9 —
1301/// `SupervisorError::DuplicateChildCaixa`, `child_spec.id` is required-
1302/// unique per supervisor in OTP), `:membros :caixa` (4bb3f3d —
1303/// `AplicacaoError::MembroDuplicate`), `:contratos`
1304/// (5dbcfaf — `AplicacaoError::ContratoDuplicate`), `:placement
1305/// :clusters` (c7c7799 — `AplicacaoError::PlacementClusterDuplicate`),
1306/// and `:entrada :paths` (eb3456d — `AplicacaoError::EntradaPathDuplicate`).
1307/// Each closes the same authoring footgun: a Vec authoring surface that
1308/// silently accepts duplicate entries and renders the "second wins"
1309/// (or "operator picks arbitrarily") shape downstream, far from the
1310/// source caixa.lisp.
1311///
1312/// Duplicates are detected by [`semver::Version`] equality (the
1313/// crate's `PartialEq` compares the full identity — major.minor.patch +
1314/// pre-release + build metadata — so `1.0.0` and `1.0.0-rc.1` and
1315/// `1.0.0+build1` and `1.0.0+build2` are all distinct upgrade paths).
1316/// The conservative choice mirrors what the wasm-operator's
1317/// `:from`-match dispatch can see; collapsing build metadata to catch
1318/// a wider net of duplicates is a future tightening that requires
1319/// coordinating with the operator's match step.
1320///
1321/// Per-entry shape errors fire before the duplicate gate so the
1322/// diagnostic names the malformed slot (`FromInvalid`, `EmptyScript`,
1323/// `ModuleInvalid`, …) rather than collapsing two unrelated authoring
1324/// errors into a single duplicate diagnostic. Mirrors the
1325/// `*_invalid_fires_before_duplicate_check` order pins on every peer
1326/// axis ([`crate::SupervisorSpec::validate`],
1327/// [`crate::AplicacaoSpec::validate_membros`],
1328/// [`crate::AplicacaoSpec::validate_placement`]).
1329pub fn validate_upgrade_from(entries: &[UpgradeFromEntry]) -> Result<(), UpgradeError> {
1330 use semver::Version;
1331 let mut seen: Vec<Version> = Vec::with_capacity(entries.len());
1332 for entry in entries {
1333 entry.validate()?;
1334 // `entry.validate()` accepted this `:from`, so parse cannot
1335 // fail here — the FromInvalid arm above is the only gate
1336 // and both call `Version::parse(entry.prior_versao())`.
1337 let parsed = Version::parse(entry.prior_versao()).expect(
1338 "UpgradeFromEntry::validate must accept `:from` iff Version::parse does — keep the \
1339 two gates aligned",
1340 );
1341 if seen.contains(&parsed) {
1342 return Err(UpgradeError::DuplicateFrom {
1343 from: entry.prior_versao().to_string(),
1344 });
1345 }
1346 seen.push(parsed);
1347 }
1348 Ok(())
1349}
1350
1351/// Reject `:upgrade-from` entries whose `:from` is not strictly less
1352/// than the caixa's current `:versao` (under SemVer-2 precedence — the
1353/// same ordering [`semver::Version::cmp`] implements, with build
1354/// metadata ignored per [SemVer §11][semver-11]).
1355///
1356/// The whole point of an `:upgrade-from :from "<prior>"` block is the
1357/// declarative answer to "given the wasm-operator is loading a node
1358/// running `<prior>`, how do I upgrade it to the *current* `:versao`?"
1359/// (`upgrade.rs` module doc, OTP appup `release_handler:install_release/1`
1360/// semantic). The operator's `:from`-match dispatch loads the
1361/// current `:versao` and matches the *running* version against each
1362/// entry's `:from`; an entry whose `:from >= :versao` is structurally
1363/// unreachable — the operator never runs a version greater than or
1364/// equal to the current `:versao` that it could then "upgrade *to*"
1365/// the current `:versao`. Two authoring footguns close here:
1366///
1367/// - `:from > :versao` (downgrade-shaped) — the canonical
1368/// "I copy-pasted from the next minor version and forgot to bump
1369/// `:versao`" / "I bumped `:versao` then reverted but left the
1370/// `:upgrade-from` entry behind" footgun. Until this gate landed
1371/// `(defcaixa :versao "0.1.5" :upgrade-from ((:from "0.2.0" …)))`
1372/// silently passed `feira build` and the wasm-operator's
1373/// `:from`-match dispatch would never fire on the entry — the
1374/// instructions sat dormant in the caixa.lisp forever, the
1375/// author's intent ("upgrade users coming from 0.2.0") permanently
1376/// unreached because they actually meant to bump `:versao`.
1377///
1378/// - `:from == :versao` (precedence-equal self-upgrade) — the
1379/// "I declared an upgrade from myself to myself" no-op the
1380/// operator's dispatch would either skip silently (no semantic
1381/// transition) or attempt and trivially "succeed" with no
1382/// observable state change. Includes the build-metadata-only
1383/// difference case (`:versao "0.2.0"`, `:from "0.2.0+build.1"`):
1384/// SemVer-2 precedence ignores build metadata so they compare
1385/// equal under [`semver::Version::cmp`] — the gate rejects this
1386/// even though [`UpgradeError::DuplicateFrom`] doesn't (the peer
1387/// gate uses derived `PartialEq` which keeps them distinct;
1388/// they're distinct dispatch keys but the same "from" version
1389/// for our purposes here).
1390///
1391/// Same cross-slot value-shape discipline as
1392/// [`crate::AplicacaoSpec::validate_placement`]'s strategy ↔ shard-key
1393/// partition (934bc58 — the typed partition between two declared
1394/// slots): one slot's value constrains the valid set of another's,
1395/// and the constraint is a structural property visible at validate
1396/// time. The validated set after this gate satisfies
1397/// `entry.from.parse::<Version>().unwrap() < versao.parse::<Version>().unwrap()`
1398/// for every entry, so the future operator-side hot-upgrade dispatch
1399/// step can reach for `entry.from` knowing the precedence relation
1400/// holds without re-deriving it from inline checks.
1401///
1402/// Silent-pass semantics on malformed inputs:
1403///
1404/// - When `versao` itself doesn't parse as semver, this gate
1405/// returns `Ok(())` silently — the narrower
1406/// [`crate::ManifestError::VersaoInvalid`] / [`UpgradeError::FromInvalid`]
1407/// diagnostics are the load-bearing surfaces for those failure
1408/// modes, and surfacing a `FromNotBeforeVersao` over an
1409/// unparseable `:versao` would mask the more actionable root
1410/// cause.
1411/// - Likewise, an entry whose `:from` itself doesn't parse falls
1412/// through to its narrower diagnostic surface
1413/// ([`UpgradeError::FromInvalid`]), which is expected to fire
1414/// via [`validate_upgrade_from`] *before* this gate runs at the
1415/// [`crate::LayoutInvariants`] call site.
1416///
1417/// [semver-11]: https://semver.org/#spec-item-11
1418pub fn validate_upgrade_from_against_versao(
1419 entries: &[UpgradeFromEntry],
1420 versao: &str,
1421) -> Result<(), UpgradeError> {
1422 use semver::Version;
1423 let Ok(current) = Version::parse(versao) else {
1424 // Malformed `:versao` is a separate gate (ManifestError::VersaoInvalid);
1425 // surfacing a precedence-relation diagnostic over an unparseable
1426 // top-level version would mask the more actionable root cause.
1427 return Ok(());
1428 };
1429 for entry in entries {
1430 // Per-entry shape — including a malformed `:from` — is gated
1431 // by [`validate_upgrade_from`] / [`UpgradeFromEntry::validate`]
1432 // upstream at the LayoutInvariants call site; an unparseable
1433 // `:from` here falls through silently to keep the
1434 // FromInvalid diagnostic load-bearing. Same fall-through
1435 // posture as the `versao` arm above.
1436 let Ok(prior) = Version::parse(entry.prior_versao()) else {
1437 continue;
1438 };
1439 if prior >= current {
1440 return Err(UpgradeError::FromNotBeforeVersao {
1441 from: entry.prior_versao().to_string(),
1442 versao: versao.to_string(),
1443 });
1444 }
1445 }
1446 Ok(())
1447}
1448
1449/// Reject `:upgrade-from` entries whose `:instructions` list carries any
1450/// `(:state-change <script>)` instruction unless the caixa also declares
1451/// `:behavior :on-state-change` — the runtime callback the per-version
1452/// migration script is delivered through during hot upgrade.
1453///
1454/// The module doc on [`crate::upgrade`] pins the composition verbatim:
1455/// the `:upgrade-from` slot "Composes with the `:behavior :on-state-change`
1456/// callback to deliver state migration during hot upgrades." The peer
1457/// module doc on [`crate::BehaviorSpec::on_state_change`] mirrors the
1458/// promise from the callback side: the slot is the
1459/// `gen_server:code_change/3` analog — "receives old state + version,
1460/// returns new state. Composes with the `:upgrade-from` slot declared at
1461/// the Caixa root." OTP's `release_handler:install_release/1` realizes
1462/// the composition by invoking the running `gen_server`'s
1463/// `code_change/3` callback during the appup's `code_change` /
1464/// `update, m, soft` step — the appup's instruction triggers the
1465/// callback, the callback folds the prior-version state shape into the
1466/// current-version shape, and the operator advances to the next
1467/// instruction only after the callback returns successfully. caixa
1468/// decomposes the same composition into two typed slots: the per-version
1469/// migration logic lives in the `(:state-change "lib/migrations/v01-to-v02.lisp")`
1470/// instruction's `:script` (the `:upgrade-from` author surface), and the
1471/// runtime hook the operator dispatches the migration through lives in
1472/// the `:behavior :on-state-change` callback (the `:behavior` author
1473/// surface). A `:state-change` instruction declared without the callback
1474/// is half the composition: the per-version script the author wrote has
1475/// no runtime delivery path, and the operator's hot-upgrade dispatch
1476/// reaches for `caixa.behavior.on_state_change` at the migration step,
1477/// finds `None`, and either fails the upgrade mid-flight (the
1478/// transactional rollback the module doc names — "On any failure, the
1479/// current version stays load-bearing — a typed atomic upgrade") or
1480/// silently skips the migration depending on the operator's handling of
1481/// a missing callback, both far from the source caixa.lisp.
1482///
1483/// Two authoring footguns close here:
1484///
1485/// - `(:behavior ((:on-init …)))` + `(:upgrade-from ((:from "0.1.0"
1486/// :instructions ((:load-module "x") (:state-change "lib/m.lisp")
1487/// (:soft-purge "x-old")))))` — the "I declared the migration script
1488/// but forgot the callback" footgun. The author wrote the per-version
1489/// fold against the prior state shape, the typed `:upgrade-from`
1490/// slot validated every per-instruction shape + ordering + singularity
1491/// gate, and the missing callback only surfaces at upgrade time as
1492/// either a transactional rollback to the prior version (no progress
1493/// across the upgrade) or as a silently-skipped migration that leaves
1494/// v0.2.0 code running against unmigrated v0.1.0 state (corrupted
1495/// state shape).
1496/// - `:behavior` absent entirely + `:upgrade-from` carrying any
1497/// `:state-change` — the "I added the upgrade path but never declared
1498/// `:behavior`" footgun. `:behavior` is optional at the typed root
1499/// ([`crate::Caixa::behavior: Option<BehaviorSpec>`]) so the typed
1500/// `:upgrade-from` slot validates on its own merits, but a `Caixa`
1501/// with `behavior: None` and a `:state-change` instruction is the
1502/// same missing-callback shape — the operator's dispatch can't reach
1503/// a callback that doesn't exist.
1504///
1505/// Same cross-slot composition discipline as
1506/// [`validate_upgrade_from_against_versao`] (the `:from` ↔ `:versao`
1507/// precedence gate at the peer wire-up site): one slot's value
1508/// (`:from` < `:versao` there; `:state-change` declared here) constrains
1509/// the valid set of another's (the entry must be dispatchable there; the
1510/// callback must be declared here), and the constraint is a structural
1511/// property visible at validate time. The validated set after this gate
1512/// satisfies the documented composition: every `:state-change`
1513/// instruction the operator iterates at hot-upgrade time has a
1514/// corresponding `:on-state-change` callback declared on the same caixa,
1515/// so the future wasm-operator's hot-upgrade dispatch (the OTP
1516/// `release_handler` canonical-sequence loop) can reach for
1517/// `behavior.on_state_change` at the migration step knowing the
1518/// `Option<PathBuf>` is `Some(_)` without re-deriving the precondition
1519/// from inline checks.
1520///
1521/// Diagnostic-precedence:
1522///
1523/// - Runs *after* [`UpgradeFromEntry::validate`] (per-instruction
1524/// shape + the within-entry ordering / singularity gates) and
1525/// [`validate_upgrade_from`] (the cross-entry duplicate-`:from`
1526/// gate), so a malformed `:state-change` (`EmptyScript`,
1527/// `AbsoluteScript`, `ParentEscapeScript`) or an ill-ordered entry
1528/// (`StateChangeWithoutPriorLoad`, `StateChangeAfterCleanup`) or a
1529/// duplicate `:from` (`DuplicateFrom`) surfaces its narrower
1530/// self-locating diagnostic first — the canonical "per-instr-shape +
1531/// within-entry ordering + cross-entry uniqueness before
1532/// cross-slot composition" precedence the peer
1533/// `validate_upgrade_from_against_versao` gate establishes at the
1534/// same wire-up site. Without this precedence pin a malformed
1535/// `:state-change` instruction would surface this gate's
1536/// missing-callback diagnostic over the narrower
1537/// `EmptyScript` / `StateChangeWithoutPriorLoad`, masking the
1538/// load-bearing per-instruction defect with a cross-slot composition
1539/// diagnostic.
1540/// - Within the entries, walks the list in declaration order and
1541/// surfaces the *first* `:state-change` instruction encountered —
1542/// mirrors every peer first-collision diagnostic posture on this
1543/// module (`validate_state_change_ordering` returns on the first
1544/// `StateChange` without prior load,
1545/// `validate_load_singularity` returns on the second matching
1546/// module, etc.). A future entry's later `:state-change` doesn't
1547/// surface a different diagnostic — the missing callback is the same
1548/// defect regardless of which entry's `:state-change` exposes it.
1549///
1550/// Silent-pass semantics:
1551///
1552/// - Entries carrying no `:state-change` instruction (load-only,
1553/// cleanup-only, restart-only, or empty `:instructions`) leave the
1554/// gate vacuous — no per-version migration means no callback to
1555/// dispatch through, so the absence of `:on-state-change` is
1556/// coherent. Pins the gate's identity element on the empty-set side
1557/// of the composition.
1558/// - `behavior: None` is *not* a free pass when a `:state-change`
1559/// instruction is present — the same missing-callback shape as
1560/// `behavior: Some(_)` with `on_state_change: None`. The gate reads
1561/// `behavior.and_then(BehaviorSpec::on_state_change)` so both shapes
1562/// surface the same diagnostic.
1563pub fn validate_upgrade_from_against_behavior(
1564 entries: &[UpgradeFromEntry],
1565 behavior: Option<&crate::BehaviorSpec>,
1566) -> Result<(), UpgradeError> {
1567 if behavior
1568 .and_then(crate::BehaviorSpec::on_state_change)
1569 .is_some()
1570 {
1571 return Ok(());
1572 }
1573 for entry in entries {
1574 // Route the per-instruction `StateChange`-arm script-path
1575 // projection through the sibling lifted
1576 // [`UpgradeInstruction::declared_path`] `Option<&PathBuf>`
1577 // accessor rather than the raw
1578 // `if let UpgradeInstruction::StateChange { script } = instr`
1579 // open-coded pattern-match — the cross-slot
1580 // `:upgrade-from ↔ :behavior` composition gate's per-instruction
1581 // script-projection site now keys off exactly one typed dispatch
1582 // on the substrate primitive's `PathBuf`-carrying axis, sibling
1583 // to the four peer per-`UpgradeInstruction` consumers
1584 // ([`UpgradeInstruction::validate`]'s per-`StateChange`
1585 // sandbox-path fan-out, the layout-side per-`StateChange`
1586 // script-existence fan-out at
1587 // [`crate::layout::StandardLayout::verify`] (caixa-core/src/layout.rs:1058),
1588 // the within-entry [`UpgradeFromEntry::validate_state_change_singularity`]
1589 // (2bf3ce5) per-`StateChange` script-projection fan-out, the
1590 // peer [`UpgradeInstruction::declared_module`] `String`-axis
1591 // per-variant unifier) that already route through
1592 // `declared_path` / `declared_module`. Byte-equal today
1593 // (`declared_path` returns `Some(script)` iff the instruction is
1594 // [`UpgradeInstruction::StateChange`], per the sibling
1595 // `declared_path_only_for_state_change` pin), so a
1596 // `:state-change`-without-`:on-state-change`-callback
1597 // composition surfaces `StateChangeWithoutOnStateChangeCallback`
1598 // byte-identical to the pattern-match shape. Fourth (and last)
1599 // per-`UpgradeInstruction`-consumer of the `PathBuf`-carrying
1600 // axis now routed through the accessor — closes the last
1601 // unlifted `if let UpgradeInstruction::StateChange { script } = instr`
1602 // site outside `impl UpgradeFromEntry`, so the peer four
1603 // consumer set named in the sibling
1604 // `validate_state_change_singularity_projects_scripts_through_declared_path_accessor`
1605 // pin (caixa-core/src/upgrade.rs:4598) is now structurally
1606 // closed.
1607 for instr in entry.instructions() {
1608 if let Some(script) = instr.declared_path() {
1609 return Err(UpgradeError::StateChangeWithoutOnStateChangeCallback {
1610 from: entry.prior_versao().to_string(),
1611 script: script.clone(),
1612 });
1613 }
1614 }
1615 }
1616 Ok(())
1617}
1618
1619impl UpgradeInstruction {
1620 /// Kebab-case lisp form name for this instruction, used as the
1621 /// `:kind` tag in [`UpgradeError::ModuleEmpty`] /
1622 /// [`UpgradeError::ModuleInvalid`] diagnostics so the author can
1623 /// grep their caixa.lisp for `(:load-module …)` / `(:soft-purge …)`
1624 /// / `(:purge …)` and fix it in one edit. Mirrors the kebab-case
1625 /// slot tags `BehaviorError::EmptyPath` (b0c8389) and
1626 /// `UpgradeFromEntry`'s `:from` field already carry.
1627 #[must_use]
1628 const fn lisp_form(&self) -> &'static str {
1629 match self {
1630 Self::LoadModule { .. } => crate::render::M2_UPGRADE_INSTRUCTION_KIND_LOAD_MODULE,
1631 Self::StateChange { .. } => crate::render::M2_UPGRADE_INSTRUCTION_KIND_STATE_CHANGE,
1632 Self::SoftPurge { .. } => crate::render::M2_UPGRADE_INSTRUCTION_KIND_SOFT_PURGE,
1633 Self::Purge { .. } => crate::render::M2_UPGRADE_INSTRUCTION_KIND_PURGE,
1634 Self::Restart => crate::render::M2_UPGRADE_INSTRUCTION_KIND_RESTART,
1635 }
1636 }
1637
1638 /// Validate the instruction's typed shape. Path existence is
1639 /// checked separately by [`crate::layout::StandardLayout`].
1640 ///
1641 /// The per-variant scalar the value-shape gates fire against is
1642 /// read through this method's two sibling accessors — the
1643 /// `String`-carrying axis via [`Self::declared_module`] (the
1644 /// `LoadModule` / `SoftPurge` / `Purge` variants unifying on their
1645 /// K8s DNS-1123-label `:module` reference) and the `PathBuf`-
1646 /// carrying axis via [`Self::declared_path`] (the `StateChange`
1647 /// variant's tatara-lisp `:script`) — rather than the per-arm
1648 /// `Self::LoadModule { module } | Self::SoftPurge { module } |
1649 /// Self::Purge { module }` pattern the module-axis previously
1650 /// open-coded and the per-arm `Self::StateChange { script }` the
1651 /// script-axis previously open-coded. Every scalar this enum
1652 /// carries now flows through one of the two `Option<&…>`
1653 /// accessors, so a future extension of either axis (a fifth
1654 /// module-bearing variant, an operator-side pre-parsed scalar
1655 /// cache the accessors materialize behind the same return
1656 /// contract, an M4 typed sub-slot the accessors could route
1657 /// alongside the existing scalar) migrates as a single edit on
1658 /// the accessor rather than a coordinated rewrite of every
1659 /// downstream value-shape gate. `Restart` (the only variant that
1660 /// carries neither scalar) falls through both `Option` checks and
1661 /// returns `Ok(())` — the terminal-fallback shape the
1662 /// [`Self::Restart`] variant doc pins.
1663 pub fn validate(&self) -> Result<(), UpgradeError> {
1664 if let Some(module) = self.declared_module() {
1665 return validate_module(self.lisp_form(), module);
1666 }
1667 if let Some(script) = self.declared_path() {
1668 // Delegate the four-arm cascade (empty / absolute /
1669 // parent-escape / non-`.lisp`-extension) to the lifted
1670 // [`crate::render::require_sandboxed_lisp_path`] helper —
1671 // same `Empty → Absolute → ParentEscape → NonLispExtension`
1672 // arm-ordering this method previously inlined verbatim,
1673 // now shared with [`crate::BehaviorSpec::validate`]'s
1674 // per-`:on-*`-callback gate so every author-supplied
1675 // tatara-lisp source path on every M2 typed slot consults
1676 // one gate, not two-and-counting verbatim copies of the
1677 // same four-arm cascade. Each closure wraps the tag in
1678 // the same `*Script` variant the original inline code
1679 // raised, so the diagnostic shape every caller depends
1680 // on (the `:state-change :script` self-locating error)
1681 // is preserved by construction. See
1682 // [`crate::render::require_sandboxed_lisp_path`] for the
1683 // smallest-scope-arm-fires-last ordering rationale.
1684 crate::render::require_sandboxed_lisp_path(
1685 script,
1686 || UpgradeError::EmptyScript,
1687 || UpgradeError::AbsoluteScript {
1688 script: script.clone(),
1689 },
1690 || UpgradeError::ParentEscapeScript {
1691 script: script.clone(),
1692 },
1693 || UpgradeError::NonLispExtensionScript {
1694 script: script.clone(),
1695 },
1696 )?;
1697 }
1698 // `Restart` (the only variant with no `Option<&…>`-carrying
1699 // scalar) falls through both accessor gates and returns
1700 // `Ok(())` — the terminal-fallback shape.
1701 Ok(())
1702 }
1703
1704 /// The `:module` scalar carried by this instruction — the
1705 /// K8s DNS-1123-label OTP-appup caixa-name reference every
1706 /// [`Self::LoadModule`] / [`Self::SoftPurge`] / [`Self::Purge`]
1707 /// variant declares against, and every author expects `feira lint`
1708 /// to name verbatim in per-instruction diagnostics. Returns `None`
1709 /// on [`Self::StateChange`] (which carries a `:script` — closed by
1710 /// the sibling [`Self::declared_path`]) and on [`Self::Restart`]
1711 /// (which carries no data at all, the OTP terminal-fallback
1712 /// shape).
1713 ///
1714 /// Sibling in shape to [`Self::declared_path`] on the second and
1715 /// final scalar-carrying axis of [`UpgradeInstruction`]:
1716 /// `declared_path` closes the `PathBuf`-carrying arm
1717 /// (`StateChange`); `declared_module` closes the `String`-carrying
1718 /// arms (`LoadModule` / `SoftPurge` / `Purge`). Every scalar the
1719 /// enum carries now routes through one of the two `Option<&…>`
1720 /// accessors — a caller that doesn't care which variant declared
1721 /// the scalar reads through one `if let Some(…)` rather than a
1722 /// per-variant pattern match. The pair is the enum-variant-
1723 /// unifying peer of the per-mesh-slot-atom scalar-accessor family
1724 /// on the M3 side ([`crate::WitContract::source`] /
1725 /// [`crate::WitContract::destination`] /
1726 /// [`crate::WitContract::world_ref`] closing `:contratos`;
1727 /// [`crate::Entrada::hostname`] / [`crate::Entrada::destination`]
1728 /// closing `:entrada`; [`crate::Membro::nome`] /
1729 /// [`crate::Membro::versao_requirement`] closing `:membros`) and
1730 /// on the M2 side ([`crate::UpgradeFromEntry::prior_versao`]
1731 /// closing per-entry `:from`; the [`crate::LimitsSpec`] /
1732 /// [`crate::BehaviorSpec`] closed families; the [`crate::ChildSpec`]
1733 /// closed OTP-shape supervisor family) — those peer accessors
1734 /// return a struct field verbatim; this pair unifies enum-
1735 /// variant-carried scalars into one accessor per typed axis.
1736 ///
1737 /// Byte-for-byte from the typed variant's own `String` storage;
1738 /// no cloning, no re-parsing. A future extension of the axis (an
1739 /// M4 typed sub-slot the module string is derived from, an
1740 /// operator-side pre-parsed caixa-name cache the accessor could
1741 /// materialize behind the same `&str` return contract, a fifth
1742 /// module-bearing OTP-appup variant the enum grows) migrates as
1743 /// a single caixa-core edit rather than a coordinated rewrite
1744 /// of every downstream module-axis consumer (currently
1745 /// [`Self::validate`]'s DNS-1123-label gate through
1746 /// [`validate_module`]; extensible to future consumers on the
1747 /// same axis without further per-variant match sites).
1748 #[must_use]
1749 pub fn declared_module(&self) -> Option<&str> {
1750 match self {
1751 Self::LoadModule { module } | Self::SoftPurge { module } | Self::Purge { module } => {
1752 Some(module.as_str())
1753 }
1754 Self::StateChange { .. } | Self::Restart => None,
1755 }
1756 }
1757
1758 /// If the instruction references an on-disk path, return it —
1759 /// used by the layout checker to verify the path resolves.
1760 ///
1761 /// Sibling on the `PathBuf`-carrying axis to [`Self::declared_module`]
1762 /// on the `String`-carrying axis: `declared_path` closes the
1763 /// `StateChange` arm's `:script`; `declared_module` closes the
1764 /// `LoadModule` / `SoftPurge` / `Purge` arms' `:module`. Together
1765 /// they route every scalar this enum carries through one of two
1766 /// `Option<&…>` accessors, so [`Self::validate`]'s value-shape
1767 /// gates dispatch on the accessor return rather than a per-variant
1768 /// pattern match on the enum shape itself.
1769 ///
1770 /// Four per-`UpgradeInstruction` consumers now key off this
1771 /// accessor's `PathBuf`-carrying axis:
1772 /// [`Self::validate`]'s per-`StateChange` sandbox-path fan-out,
1773 /// [`crate::layout::StandardLayout::verify`]'s per-`StateChange`
1774 /// script-existence fan-out at `caixa-core/src/layout.rs:1058`, the
1775 /// within-entry
1776 /// [`UpgradeFromEntry::validate_state_change_singularity`] (2bf3ce5)
1777 /// per-`StateChange` script-projection fan-out, and the cross-slot
1778 /// [`validate_upgrade_from_against_behavior`] `:upgrade-from ↔
1779 /// :behavior` composition gate's per-`StateChange` detection loop
1780 /// — every downstream consumer of the `PathBuf`-carrying axis
1781 /// reaches through this one dispatch, so a future accessor
1782 /// extension (an M4 typed sub-slot the script path is derived from,
1783 /// an operator-side pre-resolved-path cache the accessor
1784 /// materializes behind the same `Option<&PathBuf>` return contract,
1785 /// a fifth `PathBuf`-bearing OTP-appup variant the enum grows)
1786 /// migrates as a single caixa-core edit rather than a coordinated
1787 /// rewrite of four call sites.
1788 #[must_use]
1789 pub fn declared_path(&self) -> Option<&PathBuf> {
1790 match self {
1791 Self::StateChange { script } => Some(script),
1792 _ => None,
1793 }
1794 }
1795
1796 /// Substrate-canonical per-`UpgradeInstruction` OTP-appup cleanup-
1797 /// family arm-discriminator predicate every within-entry cross-
1798 /// instruction cleanup-facing gate keys off — true iff `self` is
1799 /// [`Self::SoftPurge`] (`code:soft_purge/1` analog: drain the
1800 /// named module until no process is running it, then GC) or
1801 /// [`Self::Purge`] (`code:purge/1` analog: discard the named
1802 /// module immediately, without waiting for drain), the two OTP
1803 /// two-phase-code-load cleanup arms the closed-set enum's
1804 /// non-terminal / non-migration / non-load variants exhaust.
1805 /// Every non-cleanup arm ([`Self::LoadModule`] on the paired
1806 /// two-phase-load half, [`Self::StateChange`] on the
1807 /// `gen_server:code_change/3`-analog migration axis,
1808 /// [`Self::Restart`] on the OTP terminal-fallback shape)
1809 /// returns `false`.
1810 ///
1811 /// Prior to this lift the `Self::SoftPurge { module } |
1812 /// Self::Purge { module }` two-arm cleanup-family pattern-
1813 /// match sat inline at three within-entry cross-instruction
1814 /// gate sites, each hand-rolling its own copy of the union
1815 /// with no compile-time link back to the substrate primitive's
1816 /// closed-set arm-family: [`UpgradeFromEntry::validate_purge_ordering`]
1817 /// at caixa-core/src/upgrade.rs:570 (guarded arm firing
1818 /// [`UpgradeError::PurgeWithoutPriorLoad`] on any cleanup
1819 /// arriving before a preceding [`Self::LoadModule`]),
1820 /// [`UpgradeFromEntry::validate_state_change_before_cleanup`]
1821 /// at caixa-core/src/upgrade.rs:689 (sticky-once latch
1822 /// recording the first-encountered cleanup so a subsequent
1823 /// [`Self::StateChange`] fires [`UpgradeError::StateChangeAfterCleanup`]),
1824 /// and [`UpgradeFromEntry::validate_cleanup_singularity`] at
1825 /// caixa-core/src/upgrade.rs:800 (per-module cleanup-target
1826 /// dedup ejecting [`UpgradeError::DuplicateCleanup`] on the
1827 /// second cleanup targeting the same `:module`). Three open-
1828 /// coded per-arm-union pattern-matches that expressed no
1829 /// compile-time link back to the substrate primitive. A future
1830 /// fifth cleanup-shaped variant (a `Discard` variant the
1831 /// `code:delete/1` peer inspires that folds under the same
1832 /// two-phase-load cleanup partition, an M4 `SoftPurge` split
1833 /// into `SoftPurgeCoop` / `SoftPurgeForce` peers as the drain-
1834 /// cool-down policy grows a two-arm shape, an operator-side
1835 /// pre-resolved cleanup-decision cache the predicate could
1836 /// route through the same `bool` return contract) would have
1837 /// had to be threaded through every open-coded per-arm-union
1838 /// pattern-match in lockstep or one gate would silently
1839 /// classify the new arm outside the cleanup family while the
1840 /// peer gates classified it in (or vice versa) — a
1841 /// classification split across the three within-entry cross-
1842 /// instruction gates at build time that lands far from the
1843 /// source [`UpgradeInstruction`] declaration with no field
1844 /// naming which gate carries the drifted arm-set. Lifting the
1845 /// resolution to a typed predicate on the substrate primitive
1846 /// means every downstream cleanup-facing consumer of the
1847 /// [`UpgradeInstruction`] closed-set enum reaches for exactly
1848 /// one typed dispatch — the resolver's arm-set migrates as a
1849 /// unit on any future arm addition composing under this
1850 /// predicate's `||` chain.
1851 ///
1852 /// Sibling in shape to the peer [`gen_platform::IsVariant`]-
1853 /// derive-generated [`Self::is_restart`] terminal-fallback
1854 /// arm-discriminator predicate on the same closed-set
1855 /// [`UpgradeInstruction`] enum (each names an OTP-appup arm-
1856 /// family partition as one typed dispatch on the substrate
1857 /// primitive; `is_restart` on the single-arm terminal-
1858 /// fallback family, `is_cleanup` on the two-arm cleanup
1859 /// family), extended here from the single-arm case onto the
1860 /// two-arm arm-family union case. Composes through the
1861 /// [`gen_platform::IsVariant`]-derive-generated
1862 /// [`Self::is_soft_purge`] / [`Self::is_purge`] per-variant
1863 /// predicates rather than an open-coded raw `matches!`
1864 /// pattern-match, so a future rebrand on either underlying
1865 /// per-arm classifier flows through this predicate's one
1866 /// body without a coordinated per-consumer rewrite across
1867 /// the three within-entry cross-instruction gates that route
1868 /// through it. Peer of the sibling per-`:contratos`
1869 /// shape-family union predicates [`crate::WitContract::is_http`] /
1870 /// [`crate::WitContract::is_pubsub`] / [`crate::WitContract::is_store`]
1871 /// on the M3 mesh-slot per-`:wit` world-ref axis (each unions a
1872 /// per-shape WIT-prefix rule the substrate primitive's arm-
1873 /// family partition names as one typed dispatch) — the same
1874 /// "one typed dispatch on the substrate primitive, thin
1875 /// projections at each consumer" discipline extended onto the
1876 /// M2 `:upgrade-from :instructions` per-`UpgradeInstruction`
1877 /// cleanup-family axis.
1878 ///
1879 /// The name `is_cleanup` maps directly onto the canonical
1880 /// OTP-appup vocabulary (INSPIRATIONS §II.4 verbatim: "2.
1881 /// `code:soft_purge/1` — wait until no process is running v1,
1882 /// then discard. (`code:purge/1` kills v1 immediately if you
1883 /// don't care.)" — the two `code:*_purge/1` operations are
1884 /// the two-phase-load contract's cleanup half, paired under
1885 /// one concept), and the peer [`Self::validate_cleanup_singularity`]
1886 /// / [`UpgradeError::DuplicateCleanup`] / [`UpgradeError::PurgeWithoutPriorLoad`]
1887 /// / [`UpgradeError::StateChangeAfterCleanup`] surface already
1888 /// reaches for the same "cleanup" vocabulary in identifier +
1889 /// diagnostic form.
1890 #[must_use]
1891 pub const fn is_cleanup(&self) -> bool {
1892 self.is_soft_purge() || self.is_purge()
1893 }
1894}
1895
1896/// Reject upgrade instruction `:module` values that aren't K8s
1897/// DNS-1123 labels. Thin wrapper around
1898/// [`crate::render::is_dns_1123_label`] that maps the shared
1899/// parser-shaped reason into the kind-tagged
1900/// [`UpgradeError::ModuleEmpty`] / [`UpgradeError::ModuleInvalid`]
1901/// diagnostics, so the author can grep their caixa.lisp for the
1902/// offending `(:<kind> <module>)` form and fix it in one edit.
1903///
1904/// The contract — the same DNS-1123 label rule the K8s apiserver
1905/// enforces on every `metadata.name` / Service name / label value the
1906/// module name lands in. Each upgrade instruction's `:module` is a
1907/// reference to a caixa name (the wasm-engine resolves it through the
1908/// same `ComputeUnit` registry the operator manages), so the value must
1909/// match every downstream apiserver-side schema: the per-Servico
1910/// `wasm.pleme.io/v1alpha1/ComputeUnit.metadata.name` the operator
1911/// creates, the `LABEL_PROGRAM` label value the wasm-engine matches
1912/// against the loaded-module table at hot-upgrade dispatch, and the
1913/// future `:upgrade-from`-driven `app-operator` rolling-load CR's
1914/// per-module reference axis. Same trajectory as `:children :caixa`
1915/// (31bfa43), `:membros :caixa` (3f9d7a0), and `:placement :clusters`
1916/// (6cbb900) onto the fourth DNS-1123-label-shaped identifier axis —
1917/// appup's `LoadModule | SoftPurge | Purge` `:module` references.
1918///
1919/// Empty input is rejected via the narrower [`UpgradeError::ModuleEmpty`]
1920/// variant before this predicate is consulted, mirroring
1921/// `validate_membro_caixa`'s empty-first cascade.
1922fn validate_module(kind: &'static str, module: &str) -> Result<(), UpgradeError> {
1923 // Routes through the shared
1924 // [`crate::render::require_valid_dns_1123_label`] gate the peer
1925 // name axes each land on. The `kind: &'static str` field flows
1926 // through both error variants so the diagnostic names which
1927 // per-instruction slot (`LoadModule` / `SoftPurge` / `Purge`) the
1928 // offending value came from.
1929 crate::render::require_valid_dns_1123_label(
1930 module,
1931 || UpgradeError::ModuleEmpty { kind },
1932 |reason| UpgradeError::ModuleInvalid {
1933 kind,
1934 module: module.to_string(),
1935 reason,
1936 },
1937 )
1938}
1939
1940#[derive(Debug, Error, PartialEq, Eq)]
1941pub enum UpgradeError {
1942 #[error(
1943 ":upgrade-from :from {from:?} is not a valid SemVer-2 version: {reason} (the substrate \
1944 consumes this string as `semver::Version` — three-part `MAJOR.MINOR.PATCH` with optional \
1945 `-prerelease` and `+build`, the same shape every top-level `:versao` carries — across \
1946 every artifact derived from `:from`: the wasm-operator's `:from`-match dispatch loads \
1947 the running version through `semver::Version::parse` and matches it against each entry's \
1948 `:from`, so a malformed `:from` is structurally unreachable at dispatch time; use a \
1949 SemVer-2 literal like `\"0.1.0\"`, `\"0.2.0-rc.1\"`, or `\"1.0.0+build.42\"` — not a \
1950 git-tag-shape like `\"v0.1.0\"`, a docker-tag-shape like `\"latest\"`, a \
1951 requirement-shape like `\"^0.1\"`, or a four-part `\"0.1.0.0\"`)"
1952 )]
1953 FromInvalid { from: String, reason: String },
1954 #[error(
1955 "upgrade instruction `{kind}` :module is empty (every appup module reference \
1956 must name a caixa; use a non-empty caixa name like `\"hello-rio\"` or omit \
1957 the instruction entirely)"
1958 )]
1959 ModuleEmpty { kind: &'static str },
1960 #[error(
1961 "upgrade instruction `{kind}` :module {module:?} is not a valid DNS-1123 label: \
1962 {reason} (every appup module reference resolves to a caixa name, which lands \
1963 verbatim as a K8s `metadata.name` on the per-Servico ComputeUnit the operator \
1964 creates, the `LABEL_PROGRAM` label value the wasm-engine matches at hot-upgrade \
1965 dispatch, and every future `app-operator` rolling-load CR's per-module reference \
1966 axis; use a lowercase alphanumeric + hyphen identifier like `\"hello-rio\"` or \
1967 `\"cache-v2\"`)"
1968 )]
1969 ModuleInvalid {
1970 kind: &'static str,
1971 module: String,
1972 reason: String,
1973 },
1974 #[error("instruction's :script is empty")]
1975 EmptyScript,
1976 #[error(
1977 "instruction's :script {} is absolute — upgrade scripts must be relative to the caixa \
1978 root (Path::join would otherwise escape the project sandbox)",
1979 script.display()
1980 )]
1981 AbsoluteScript { script: PathBuf },
1982 #[error(
1983 "instruction's :script {} contains a `..` component — upgrade scripts must not traverse \
1984 above the caixa root",
1985 script.display()
1986 )]
1987 ParentEscapeScript { script: PathBuf },
1988 #[error(
1989 ":upgrade-from (:state-change {}) does not terminate in the `.lisp` extension — the M2.5 \
1990 wasm-engine instantiator reads every migration script as tatara-lisp source through \
1991 `tatara_lisp::read` at hot-upgrade migration time (the same downstream consumer the \
1992 peer `:behavior :on-*` axis routes through at instance-start time, c97815a), so any \
1993 other extension (`.txt`, `.rs`, `.lisp.bak`) or no-extension shape is structurally a \
1994 parser error far from the source caixa.lisp, with no field naming the offending \
1995 `(:state-change …)` instruction. Pin a relative path under the caixa root whose \
1996 terminating extension is lowercase-`.lisp` (e.g. `\"lib/migrations.lisp\"`, \
1997 `\"lib/migrations/v01-to-v02.lisp\"`).",
1998 script.display()
1999 )]
2000 NonLispExtensionScript { script: PathBuf },
2001 #[error(
2002 ":upgrade-from carries more than one `(:from {from:?})` entry — OTP appup picks at most \
2003 one matching block per running version (`release_handler:install_release/1` dispatches \
2004 on the loaded `:from` against the currently-running release), so two entries with the \
2005 same parsed semver are an ambiguous edge in the typed upgrade graph (the operator would \
2006 pick either set non-deterministically). Author one path per prior version; if two \
2007 distinct instruction sequences are needed, fold them into one ordered list under the \
2008 single matching `(:from {from:?} :instructions (…))` block."
2009 )]
2010 DuplicateFrom { from: String },
2011 #[error(
2012 ":upgrade-from `(:from {from:?})` is not strictly less than the caixa's current \
2013 `:versao {versao:?}` under SemVer-2 precedence — an upgrade block whose `:from` is \
2014 greater than or equal to the caixa's own version is structurally unreachable \
2015 (the wasm-operator's `:from`-match dispatch loads the current `:versao` and matches \
2016 the running version against each entry's `:from`; an entry whose `:from >= :versao` \
2017 is never reached because the operator never runs a version greater than or equal to \
2018 the current one that it could then upgrade *to* the current one). Bump the caixa's \
2019 `:versao` past {from:?} (the typical fix — you added the entry intending to upgrade \
2020 *to* a new version but forgot to bump `:versao`), drop the entry (if it's a stale \
2021 reference left over from a reverted `:versao` bump), or correct `:from` to a prior \
2022 version (if it's a typo). Pre-release values like `\"0.2.0-rc.1\"` are strictly less \
2023 than the corresponding release `\"0.2.0\"` under SemVer §11 precedence; build-metadata \
2024 values like `\"0.2.0+build.1\"` are equal to `\"0.2.0\"` under precedence and rejected \
2025 here as a self-upgrade no-op."
2026 )]
2027 FromNotBeforeVersao { from: String, versao: String },
2028 #[error(
2029 ":upgrade-from `(:from {from:?})` :instructions list violates the `(:restart)` \
2030 exclusivity invariant — an entry containing `(:restart)` must contain exactly one \
2031 `(:restart)` and nothing else (found {restart_count} `(:restart)` plus other \
2032 instruction(s): {other_kinds:?}). Per the UpgradeInstruction::Restart doc comment, \
2033 `(:restart)` is the fallback for an entry whose typed upgrade is impossible (wasm \
2034 component-model world incompatibility, irreversible state shape change), and the \
2035 fallback is terminal by construction (the operator restarts the pod and the new \
2036 version comes up fresh). Mixing the fallback with the typed sequence is dead code \
2037 in both directions: if the typed instructions would succeed, `(:restart)` is \
2038 unreached; if they wouldn't, the typed instructions are dead because the operator \
2039 restarts anyway. Author *either* a typed sequence (`(:load-module …) \
2040 (:state-change …) (:soft-purge …)`) *or* a single `((:restart))` — never both, \
2041 never repeated. If two distinct upgrade strategies are needed for the same prior \
2042 version, that is itself a typed-graph ambiguity (the operator's `:from`-match \
2043 dispatch picks exactly one block per running version) — keep the typed sequence; \
2044 the fallback restart is what the operator does on any typed-sequence failure \
2045 already."
2046 )]
2047 RestartNotExclusive {
2048 from: String,
2049 restart_count: usize,
2050 other_kinds: Vec<&'static str>,
2051 },
2052 #[error(
2053 ":upgrade-from `(:from {from:?})` runs `(:state-change {})` before any \
2054 `(:load-module …)` in its :instructions list — a state migration is the \
2055 gen_server:code_change/3 analog and must run in the context of the newly-loaded \
2056 code, but the operator executes instructions in declared order, so this migration \
2057 runs while the only resident version is still the prior one (which expects the \
2058 pre-migration state shape). Load the new module first: author the canonical \
2059 `(:load-module …) (:state-change {}) (:soft-purge …)` order so the new code is \
2060 resident before its state migration runs.",
2061 script.display(),
2062 script.display()
2063 )]
2064 StateChangeWithoutPriorLoad { from: String, script: PathBuf },
2065 #[error(
2066 ":upgrade-from `(:from {from:?})` runs `({kind} {module:?})` before any \
2067 `(:load-module …)` in its :instructions list — `:soft-purge` and `:purge` are the \
2068 code:soft_purge/1 / code:purge/1 analogs and must run after the new code is \
2069 resident alongside the old (OTP's two-phase code load: `code:load_module/1` \
2070 then `code:soft_purge/1`), but the operator executes instructions in declared \
2071 order, so this cleanup runs while the only resident version is still the same \
2072 old code (`:soft-purge` drains it to nothing; `:purge` discards it outright \
2073 mid-request), leaving no replacement to route in-flight or future requests \
2074 to. Load the new module first: author the canonical `(:load-module …) \
2075 (:state-change …) ({kind} {module:?})` order so the new code is resident \
2076 before the old code is drained or discarded."
2077 )]
2078 PurgeWithoutPriorLoad {
2079 from: String,
2080 kind: &'static str,
2081 module: String,
2082 },
2083 #[error(
2084 ":upgrade-from `(:from {from:?})` :instructions list targets module {module:?} with \
2085 more than one cleanup instruction ({kinds:?}) — `:soft-purge` and `:purge` are the \
2086 code:soft_purge/1 / code:purge/1 analogs (INSPIRATIONS §II.4: \"`code:soft_purge/1` — \
2087 wait until no process is running v1, then discard. (`code:purge/1` kills v1 immediately \
2088 if you don't care.)\"), and each module's old version is cleaned up by exactly one of \
2089 them: either drain-then-discard (`:soft-purge`) or immediate-discard (`:purge`), never \
2090 both, never repeated. systools-generated `.relup` files emit at most one purge per \
2091 module for this reason. A second cleanup on the same module is at best redundant (the \
2092 module is already gone after the first cleanup, so the second is a no-op or undefined \
2093 depending on the operator's handling of a non-resident-module purge request) and at \
2094 worst incoherent (mixing drain and discard semantics on one module suggests the author \
2095 wanted a fallback, but the operator runs declared instructions unconditionally — \
2096 fallback on cleanup failure is the operator's job, not authored into the entry). \
2097 Author one cleanup per module: prefer `(:soft-purge {module:?})` (waits for in-flight \
2098 callers to drain before GC); fall back to `(:purge {module:?})` only when the drain \
2099 can't complete (cron / oneShot / stuck callers). If two distinct old versions need \
2100 cleanup, name them distinctly (e.g. `(:soft-purge {module:?}) (:soft-purge \"…-older\")`)."
2101 )]
2102 DuplicateCleanup {
2103 from: String,
2104 module: String,
2105 kinds: Vec<&'static str>,
2106 },
2107 #[error(
2108 ":upgrade-from `(:from {from:?})` :instructions list loads module {module:?} more than \
2109 once — `:load-module` is the code:load_module/1 analog (INSPIRATIONS §II.4: \"1. \
2110 `code:load_module/1` — load v2 alongside v1; new code is 'current', old code is \
2111 'old'.\"), and the instruction binds the named wasm component once: the operator's \
2112 dispatch table reads the module name and brings up the corresponding component \
2113 alongside the running version. systools-generated `.relup` files emit at most one \
2114 `load_module` per module per upgrade step for this reason. A second `(:load-module \
2115 {module:?})` instruction has no observable semantic relative to the first (the \
2116 component is already resident) — either dead code (copy-pasted load line) or a typo \
2117 masking a distinct module the author intended to load alongside (renamed both to \
2118 {module:?} by mistake), leaving the second module silently absent from the entry. \
2119 Author one `(:load-module {module:?})` per old module per entry; if two distinct old \
2120 versions need loading alongside the running one, name them distinctly (e.g. \
2121 `(:load-module {module:?}) (:load-module \"…-v2\")`)."
2122 )]
2123 DuplicateLoadModule { from: String, module: String },
2124 #[error(
2125 ":upgrade-from `(:from {from:?})` :instructions list runs state migration {} more than \
2126 once — `:state-change` is the gen_server:code_change/3 analog (INSPIRATIONS §II.4: \
2127 \"State migration uses gen_server:code_change/3\"), and the script folds the prior-version \
2128 state shape into the current-version shape: a one-shot transition, not a step that \
2129 composes with itself. systools-generated `.relup` files emit at most one `code_change` \
2130 per gen_server per upgrade step for this reason; OTP's release_handler invokes the \
2131 callback exactly once. A second `(:state-change {})` instruction re-runs the same fold on \
2132 the already-migrated state — at best a no-op (idempotent script masking a typo where the \
2133 author intended two distinct migration scripts) and at worst silent state corruption \
2134 (non-idempotent fold double-applied: an `add column` that runs twice, an `increment \
2135 counter` that double-bumps, a `rename field` that renames-then-fails the second time). \
2136 Author one `(:state-change {})` per migration script per entry; if two distinct state \
2137 transitions are needed (e.g. one module's schema *and* another module's projection), \
2138 name them distinctly (e.g. `(:state-change {}) (:state-change \"lib/migrations/v01-to-v02-projection.lisp\")`).",
2139 script.display(),
2140 script.display(),
2141 script.display(),
2142 script.display()
2143 )]
2144 DuplicateStateChange { from: String, script: PathBuf },
2145 #[error(
2146 ":upgrade-from `(:from {from:?})` runs `(:state-change {})` after `({prior_cleanup_kind} \
2147 {prior_cleanup_module:?})` in its :instructions list — `:state-change` is the \
2148 gen_server:code_change/3 analog and folds the prior-version state shape into the \
2149 current shape, but the prior version's state only exists while the prior code is \
2150 still resident; `:soft-purge` and `:purge` are the code:soft_purge/1 / code:purge/1 \
2151 analogs and drain or discard that prior code. The operator executes instructions in \
2152 declared order, so a cleanup ahead of a state-change has already drained the prior \
2153 module to nothing (`:soft-purge`) or discarded it mid-request (`:purge`) by the time \
2154 the migration script runs, leaving the script either no-op (no prior-version state \
2155 left to fold) or crashing (`code_change/3` invoked on an unloaded version). The OTP \
2156 canonical sequence is `code:load_module/1` → `gen_server:code_change/3` → \
2157 `code:soft_purge/1`; the appup cookbook's recommended pattern is `[{{load_module, m}}, \
2158 {{update, m, soft}}, {{soft_purge, m}}]` with the migration-triggering `update` \
2159 strictly between load and cleanup. Author the canonical `(:load-module …) \
2160 (:state-change {}) ({prior_cleanup_kind} {prior_cleanup_module:?})` order so the \
2161 migration runs against the prior-version state before the cleanup drains it.",
2162 script.display(),
2163 script.display()
2164 )]
2165 StateChangeAfterCleanup {
2166 from: String,
2167 script: PathBuf,
2168 prior_cleanup_kind: &'static str,
2169 prior_cleanup_module: String,
2170 },
2171 #[error(
2172 ":upgrade-from `(:from {from:?})` declares `(:state-change {})` but the caixa does not \
2173 declare `:behavior :on-state-change` — the per-version migration script is the \
2174 gen_server:code_change/3 analog and the runtime hook it is delivered through during \
2175 hot upgrade is the `:on-state-change` callback. OTP's release_handler:install_release/1 \
2176 realizes the composition by invoking the running gen_server's code_change/3 callback \
2177 during the appup's `code_change` / `update, m, soft` step; caixa decomposes the same \
2178 composition into two typed slots, the per-version migration logic in this \
2179 `(:state-change …)` instruction's `:script` and the runtime dispatch hook in the \
2180 `:behavior :on-state-change` callback (the upgrade.rs module doc pins the composition \
2181 verbatim: \"Composes with the `:behavior :on-state-change` callback to deliver state \
2182 migration during hot upgrades\"). The missing callback leaves the per-version script \
2183 with no runtime delivery path: the operator's hot-upgrade dispatch reaches for the \
2184 callback at the migration step, finds it absent, and either fails the upgrade \
2185 mid-flight (the transactional rollback the module doc names — \"On any failure, the \
2186 current version stays load-bearing\") or silently skips the migration leaving the \
2187 new code running against unmigrated prior-version state. Add the callback: \
2188 `(:behavior ((:on-state-change \"lib/migrations.lisp\") …))` (the runtime delivery \
2189 path) alongside the existing `(:state-change {})` instruction (the per-version \
2190 script). If the upgrade truly carries no state migration, drop the `(:state-change \
2191 …)` instruction from the entry (a metadata-only upgrade — load + cleanup, no \
2192 migration — is the canonical shape).",
2193 script.display(),
2194 script.display()
2195 )]
2196 StateChangeWithoutOnStateChangeCallback { from: String, script: PathBuf },
2197}
2198
2199#[cfg(test)]
2200mod tests {
2201 use std::path::Path;
2202
2203 use super::*;
2204
2205 fn entry(from: &str, instrs: Vec<UpgradeInstruction>) -> UpgradeFromEntry {
2206 UpgradeFromEntry {
2207 from: from.into(),
2208 instructions: instrs,
2209 }
2210 }
2211
2212 #[test]
2213 fn upgrade_from_entry_prior_versao_accessor_is_const_fn() {
2214 // Fail-before-pass-after pin on
2215 // [`UpgradeFromEntry::prior_versao`]'s `const`-eval-surface
2216 // posture. The accessor projects the per-`:upgrade-from :from`
2217 // [`String`] storage through the `pub const fn`
2218 // [`String::as_str`] (const-stable since Rust 1.87, well within
2219 // the workspace MSRV) — any future accidental downgrade to
2220 // non-`const` fails `prior_versao_via_const_fn` at caixa-core
2221 // build time with E0015 (`cannot call non-const method`),
2222 // strictly stronger than a runtime `assert!`. Sibling of the
2223 // peer M2/M3 slot family pins on the sibling `const`-eval-
2224 // surface passes ([`crate::Caixa::nome`] /
2225 // [`crate::Caixa::versao`], [`crate::CaixaVersion::as_str`],
2226 // [`crate::aplicacao::Membro::nome`] /
2227 // [`crate::aplicacao::Membro::versao_requirement`],
2228 // [`crate::aplicacao::Entrada::hostname`] /
2229 // [`crate::aplicacao::Entrada::destination`],
2230 // [`crate::supervisor::ChildSpec::nome`] /
2231 // [`crate::supervisor::ChildSpec::versao_requirement`],
2232 // [`crate::dep::Dep::nome`] /
2233 // [`crate::dep::Dep::versao_requirement`], and the
2234 // per-`:contratos`
2235 // [`crate::aplicacao::WitContract::source`] /
2236 // [`crate::aplicacao::WitContract::destination`] /
2237 // [`crate::aplicacao::WitContract::world_ref`] trio the
2238 // sibling pin at 279823b already anchors).
2239 const fn prior_versao_via_const_fn(e: &UpgradeFromEntry) -> &str {
2240 e.prior_versao()
2241 }
2242 for from in ["0.1.0", "1.2.3-alpha.1", "0.0.0"] {
2243 let e = entry(from, vec![]);
2244 assert_eq!(prior_versao_via_const_fn(&e), e.prior_versao());
2245 assert_eq!(e.prior_versao(), from);
2246 }
2247 }
2248
2249 #[test]
2250 fn upgrade_from_entry_instructions_slice_return_accessor_is_const_fn() {
2251 // Fail-before-pass-after pin on
2252 // [`UpgradeFromEntry::instructions`]'s `const`-eval-surface
2253 // posture. The accessor destructures the per-`:upgrade-from
2254 // :instructions` `Vec<UpgradeInstruction>` storage through the
2255 // `pub const fn` [`Vec::as_slice`] (const-stable since Rust
2256 // 1.66, well within the workspace MSRV) — any future
2257 // accidental downgrade to non-`const` fails
2258 // `instructions_via_const_fn` at caixa-core build time with
2259 // E0015 (`cannot call non-const method`), strictly stronger
2260 // than a runtime `assert!`. Sibling of the peer per-M3-mesh-
2261 // slot `Vec → &[T]` slice-return accessor family pin
2262 // [`crate::aplicacao::tests::m3_reference_return_accessor_family_is_const_fn`]
2263 // on the M3 mesh-slot per-`:clusters` / per-`:paths` /
2264 // per-`:membros` / per-`:contratos` slice-return axes, and of
2265 // the peer M2 supervisor-tree axis pin
2266 // [`crate::supervisor::tests::supervisor_children_slice_return_accessor_is_const_fn`]
2267 // on the per-`:children` slice-return axis.
2268 const fn instructions_via_const_fn(e: &UpgradeFromEntry) -> &[UpgradeInstruction] {
2269 e.instructions()
2270 }
2271 // Sweep both the empty-instructions arm (author-declared
2272 // per-`:from` entry with no migration steps — the degenerate
2273 // shape the appup `restart`-only path folds through) and the
2274 // populated-instructions arm (the canonical OTP-appup shape
2275 // carrying a `LoadModule` + `StateChange` + `SoftPurge`
2276 // chain) so the accessor carries a const-dispatch pin on
2277 // both arms.
2278 let e_empty = entry("0.1.0", vec![]);
2279 assert!(instructions_via_const_fn(&e_empty).is_empty());
2280 assert_eq!(instructions_via_const_fn(&e_empty), e_empty.instructions());
2281 let e_full = entry(
2282 "0.1.0",
2283 vec![
2284 UpgradeInstruction::LoadModule {
2285 module: "hello-rio".into(),
2286 },
2287 UpgradeInstruction::StateChange {
2288 script: PathBuf::from("lib/migrations/v01-to-v02.lisp"),
2289 },
2290 UpgradeInstruction::SoftPurge {
2291 module: "hello-rio-old".into(),
2292 },
2293 ],
2294 );
2295 assert_eq!(instructions_via_const_fn(&e_full).len(), 3);
2296 assert_eq!(instructions_via_const_fn(&e_full), e_full.instructions());
2297 }
2298
2299 #[test]
2300 fn round_trip_load_module() {
2301 let i = UpgradeInstruction::LoadModule {
2302 module: "hello-rio".into(),
2303 };
2304 let json = serde_json::to_string(&i).unwrap();
2305 assert!(json.contains("\"kind\":\"load-module\""));
2306 let back: UpgradeInstruction = serde_json::from_str(&json).unwrap();
2307 assert_eq!(i, back);
2308 }
2309
2310 #[test]
2311 fn round_trip_all_variants() {
2312 let cases = vec![
2313 UpgradeInstruction::LoadModule { module: "x".into() },
2314 UpgradeInstruction::StateChange {
2315 script: PathBuf::from("lib/migrations.lisp"),
2316 },
2317 UpgradeInstruction::SoftPurge {
2318 module: "x-old".into(),
2319 },
2320 UpgradeInstruction::Purge {
2321 module: "x-old".into(),
2322 },
2323 UpgradeInstruction::Restart,
2324 ];
2325 for c in cases {
2326 let json = serde_json::to_string(&c).unwrap();
2327 let back: UpgradeInstruction = serde_json::from_str(&json).unwrap();
2328 assert_eq!(c, back);
2329 }
2330 }
2331
2332 #[test]
2333 fn validate_accepts_well_formed() {
2334 let e = entry(
2335 "0.1.0",
2336 vec![
2337 UpgradeInstruction::LoadModule {
2338 module: "hello-rio".into(),
2339 },
2340 UpgradeInstruction::StateChange {
2341 script: PathBuf::from("lib/migrations/v01-to-v02.lisp"),
2342 },
2343 UpgradeInstruction::SoftPurge {
2344 module: "hello-rio-old".into(),
2345 },
2346 ],
2347 );
2348 e.validate().unwrap();
2349 }
2350
2351 #[test]
2352 fn validate_rejects_non_semver_from() {
2353 let e = entry("not-a-semver", vec![]);
2354 let err = e.validate().unwrap_err();
2355 assert!(
2356 matches!(err, UpgradeError::FromInvalid { ref from, .. } if from == "not-a-semver")
2357 );
2358 }
2359
2360 #[test]
2361 fn from_invalid_diagnostic_carries_offending_from_and_reason() {
2362 // Diagnostic-shape pin: the error names the offending
2363 // `:upgrade-from :from` verbatim with a non-empty parser-shaped
2364 // reason, so a `feira lint` run can render the diagnostic
2365 // without re-parsing — the author can grep their caixa.lisp for
2366 // `:from "<value>"` and fix it in one edit. Mirrors the peer
2367 // `versao_invalid_diagnostic_carries_offending_versao` pin on
2368 // the sibling SemVer-2 axis (the top-level `:versao`), the
2369 // peer `membro_versao_invalid_diagnostic_carries_offending_value`
2370 // pin on `:membros :versao`, and the peer
2371 // `deps_invalid_diagnostic_carries_offending_value` pin on
2372 // `:deps :versao` — every SemVer-2-parsing slot's invalid
2373 // diagnostic is now structurally equivalent.
2374 let e = entry("v0.1.0", vec![]);
2375 let err = e.validate().unwrap_err();
2376 let UpgradeError::FromInvalid { from, reason } = err else {
2377 panic!("expected FromInvalid variant, got {err:?}");
2378 };
2379 assert_eq!(from, "v0.1.0");
2380 assert!(
2381 !reason.is_empty(),
2382 "FromInvalid `reason` must carry the parser's wording verbatim"
2383 );
2384 }
2385
2386 #[test]
2387 fn prior_versao_returns_from_byte_equal_across_permutations() {
2388 // Byte-identity pin on the lifted `UpgradeFromEntry::prior_versao`
2389 // accessor across the SemVer-2 shape lattice every consumer
2390 // reaches through it — the numeric-triad canonical shape, a
2391 // pre-release build with a dotted identifier chain, a full-
2392 // metadata build, a large-magnitude triad, and the empty
2393 // string (which reaches this accessor unchanged before any
2394 // validate gate rejects it). Sibling to the peer
2395 // `membro_versao_requirement_returns_versao_byte_equal_across_permutations`
2396 // (a40b0e3) / `membro_nome_returns_caixa_byte_equal_across_permutations`
2397 // (4a32abf) pins on the sibling M3 mesh-slot scalar-accessor
2398 // family — extended here onto the first M2 slot scalar-value
2399 // axis. Any silent detour on the accessor (a `.to_string()`
2400 // + retained ownership shape, a canonicalization pass, a
2401 // trim-whitespace on the return path) surfaces as a byte-
2402 // inequality failure here rather than as a downstream error-
2403 // diagnostic drift.
2404 let cases = ["0.1.0", "0.2.0-rc.1", "1.0.0+build.42", "10.20.30", ""];
2405 for from in cases {
2406 let e = entry(from, vec![]);
2407 assert_eq!(
2408 e.prior_versao(),
2409 from,
2410 "prior_versao() must return the `:from` field byte-for-byte for {from:?}",
2411 );
2412 assert_eq!(
2413 e.prior_versao().len(),
2414 from.len(),
2415 "prior_versao() byte-length must equal the `:from` field's for {from:?}",
2416 );
2417 }
2418 }
2419
2420 #[test]
2421 fn prior_versao_borrows_from_from_storage() {
2422 // Same-address pin: `UpgradeFromEntry::prior_versao` returns
2423 // a borrow into `self.from`'s heap allocation, never a fresh
2424 // owned copy. Guards against a future silent detour where
2425 // the accessor materializes a `Cow<'_, str>` / `String` /
2426 // `Rc<str>` intermediate — the return path stays zero-cost
2427 // even under a refactor that reshapes the storage. Sibling
2428 // to the peer `membro_versao_requirement_borrows_from_versao_storage`
2429 // (a40b0e3) / `membro_nome_borrows_from_caixa_storage`
2430 // (4a32abf) pins — extended onto the M2 slot's first
2431 // scalar-value axis.
2432 let e = entry("0.1.0", vec![]);
2433 assert!(
2434 std::ptr::eq(e.prior_versao().as_ptr(), e.from.as_ptr()),
2435 "prior_versao() must borrow from `self.from`'s storage, not allocate a fresh copy",
2436 );
2437 }
2438
2439 #[test]
2440 fn validate_parses_prior_versao_through_lifted_accessor() {
2441 // Coherence pin between the accessor and the SemVer-2 parse
2442 // gate: every `:upgrade-from :from` value the validator
2443 // accepts (resp. rejects) must be identical to what
2444 // `Version::parse(entry.prior_versao())` accepts (resp.
2445 // rejects) — the two must remain in lockstep across the
2446 // shape lattice so `validate_upgrade_from`'s
2447 // `Version::parse(entry.prior_versao()).expect(...)` re-parse
2448 // assertion holds by construction. If a future extension of
2449 // `prior_versao` reshapes the return (a canonicalization
2450 // pass, a leading/trailing whitespace trim, an empty-to-
2451 // "0.0.0" fallback) it would either loosen the validator
2452 // (silently accepting shapes the parser rejects) or
2453 // tighten the parser's re-parse (silently panicking on
2454 // shapes the validator accepts) — this pin catches either
2455 // shift at caixa-core build time.
2456 let accepted = ["0.1.0", "0.2.0-rc.1", "1.0.0+build.42", "10.20.30"];
2457 for from in accepted {
2458 let e = entry(from, vec![]);
2459 e.validate().unwrap_or_else(|err| {
2460 panic!("validate() must accept {from:?} that Version::parse accepts, got {err:?}");
2461 });
2462 semver::Version::parse(e.prior_versao()).unwrap_or_else(|err| {
2463 panic!(
2464 "Version::parse(prior_versao()) must accept {from:?} that validate() accepts, \
2465 got {err:?}",
2466 );
2467 });
2468 }
2469 let rejected = ["", "v0.1.0", "0.1", "not-a-semver", "0.1.0.0"];
2470 for from in rejected {
2471 let e = entry(from, vec![]);
2472 assert!(
2473 matches!(e.validate(), Err(UpgradeError::FromInvalid { .. })),
2474 "validate() must reject {from:?} that Version::parse rejects",
2475 );
2476 assert!(
2477 semver::Version::parse(e.prior_versao()).is_err(),
2478 "Version::parse(prior_versao()) must reject {from:?} that validate() rejects",
2479 );
2480 }
2481 }
2482
2483 #[test]
2484 fn validate_rejects_empty_module() {
2485 // Per-arm coverage: every Module-bearing variant surfaces the
2486 // kind-tagged `ModuleEmpty` diagnostic naming its lisp-form,
2487 // so the author can grep their caixa.lisp for `(:load-module
2488 // …)` / `(:soft-purge …)` / `(:purge …)` and fix it in one
2489 // edit — same self-locating shape `BehaviorError::EmptyPath`
2490 // (b0c8389) carries on the peer M2 typed slot.
2491 let cases: &[(UpgradeInstruction, &'static str)] = &[
2492 (
2493 UpgradeInstruction::LoadModule {
2494 module: String::new(),
2495 },
2496 crate::render::M2_UPGRADE_INSTRUCTION_KIND_LOAD_MODULE,
2497 ),
2498 (
2499 UpgradeInstruction::SoftPurge {
2500 module: String::new(),
2501 },
2502 crate::render::M2_UPGRADE_INSTRUCTION_KIND_SOFT_PURGE,
2503 ),
2504 (
2505 UpgradeInstruction::Purge {
2506 module: String::new(),
2507 },
2508 crate::render::M2_UPGRADE_INSTRUCTION_KIND_PURGE,
2509 ),
2510 ];
2511 for (instr, expected_kind) in cases {
2512 assert_eq!(
2513 instr.validate().unwrap_err(),
2514 UpgradeError::ModuleEmpty {
2515 kind: expected_kind
2516 },
2517 "empty :module on {instr:?} must surface as ModuleEmpty {{ kind: {expected_kind:?} }}"
2518 );
2519 }
2520 }
2521
2522 #[test]
2523 fn validate_rejects_non_dns_1123_module() {
2524 // Every appup `:module` reference is a caixa name (the
2525 // wasm-engine resolves it through the same ComputeUnit
2526 // registry the operator manages), so the value-shape gate
2527 // matches the K8s apiserver-side DNS-1123 label rule. Sweep
2528 // the canonical authoring footguns — uppercase letters, `_`
2529 // separator, embedded `.`, leading/trailing `-`, an embedded
2530 // whitespace byte, the >63-byte UUID-shaped slug — across
2531 // every Module-bearing variant; each must surface as
2532 // `ModuleInvalid { kind, module, reason }` carrying the
2533 // offending value verbatim and the parser-shaped reason.
2534 type Build = fn(String) -> UpgradeInstruction;
2535 let footguns: &[&str] = &[
2536 "Hello-Rio",
2537 "hello_rio",
2538 "hello.rio",
2539 "-hello",
2540 "hello-",
2541 "hello rio",
2542 &"x".repeat(crate::render::DNS_1123_LABEL_MAX_LEN + 1),
2543 ];
2544 let variants: &[(Build, &'static str)] = &[
2545 (
2546 |m| UpgradeInstruction::LoadModule { module: m },
2547 crate::render::M2_UPGRADE_INSTRUCTION_KIND_LOAD_MODULE,
2548 ),
2549 (
2550 |m| UpgradeInstruction::SoftPurge { module: m },
2551 crate::render::M2_UPGRADE_INSTRUCTION_KIND_SOFT_PURGE,
2552 ),
2553 (
2554 |m| UpgradeInstruction::Purge { module: m },
2555 crate::render::M2_UPGRADE_INSTRUCTION_KIND_PURGE,
2556 ),
2557 ];
2558 for (build, expected_kind) in variants {
2559 for module in footguns {
2560 let instr = build((*module).to_string());
2561 let err = instr.validate().unwrap_err();
2562 match err {
2563 UpgradeError::ModuleInvalid {
2564 kind,
2565 module: m,
2566 reason,
2567 } => {
2568 assert_eq!(
2569 kind, *expected_kind,
2570 ":module footgun on {instr:?} must tag the lisp-form"
2571 );
2572 assert_eq!(
2573 m, *module,
2574 "ModuleInvalid must carry the offending value verbatim"
2575 );
2576 assert!(
2577 !reason.is_empty(),
2578 "ModuleInvalid reason must name the specific violation \
2579 (the predicate's parser-shaped wording from \
2580 `is_dns_1123_label`), got empty"
2581 );
2582 }
2583 other => panic!("expected ModuleInvalid on {instr:?}, got {other:?}"),
2584 }
2585 }
2586 }
2587 }
2588
2589 #[test]
2590 fn validate_accepts_canonical_module_names() {
2591 // Positive control: every documented authoring shape — bare
2592 // identifier, with hyphens, with digits, the
2593 // suffix-versioned alias `<nome>-old` `SoftPurge` typically
2594 // references — passes the gate. Drift here = a future
2595 // tighten that rejects any of these surfaces as a
2596 // test-failure at the predicate boundary, not piecemeal
2597 // across per-instruction call sites.
2598 let canonical: &[&str] = &[
2599 "hello-rio",
2600 "hello-rio-old",
2601 "cache",
2602 "cache-v2",
2603 "x",
2604 "a1",
2605 "0a",
2606 "abc-123-def",
2607 ];
2608 for module in canonical {
2609 UpgradeInstruction::LoadModule {
2610 module: (*module).to_string(),
2611 }
2612 .validate()
2613 .unwrap_or_else(|e| panic!("LoadModule {module:?} must pass, got {e:?}"));
2614 UpgradeInstruction::SoftPurge {
2615 module: (*module).to_string(),
2616 }
2617 .validate()
2618 .unwrap_or_else(|e| panic!("SoftPurge {module:?} must pass, got {e:?}"));
2619 UpgradeInstruction::Purge {
2620 module: (*module).to_string(),
2621 }
2622 .validate()
2623 .unwrap_or_else(|e| panic!("Purge {module:?} must pass, got {e:?}"));
2624 }
2625 }
2626
2627 #[test]
2628 fn validate_empty_takes_precedence_over_invalid() {
2629 // Empty input is rejected via the narrower `ModuleEmpty`
2630 // diagnostic before the DNS-1123 predicate is consulted, so
2631 // a future tighten that adds another stage between the two
2632 // doesn't accidentally reorder the diagnostic precedence.
2633 // Mirrors the empty-first cascade on every peer DNS-1123
2634 // gate (`validate_membro_caixa`, `validate_placement_cluster`,
2635 // `SupervisorSpec::validate`'s child-name arm).
2636 let err = UpgradeInstruction::LoadModule {
2637 module: String::new(),
2638 }
2639 .validate()
2640 .unwrap_err();
2641 assert_eq!(
2642 err,
2643 UpgradeError::ModuleEmpty {
2644 kind: crate::render::M2_UPGRADE_INSTRUCTION_KIND_LOAD_MODULE
2645 }
2646 );
2647 }
2648
2649 #[test]
2650 fn validate_rejects_empty_script() {
2651 let i = UpgradeInstruction::StateChange {
2652 script: PathBuf::new(),
2653 };
2654 assert_eq!(i.validate().unwrap_err(), UpgradeError::EmptyScript);
2655 }
2656
2657 #[test]
2658 fn validate_rejects_absolute_script() {
2659 let i = UpgradeInstruction::StateChange {
2660 script: PathBuf::from("/etc/migrations.lisp"),
2661 };
2662 assert!(matches!(
2663 i.validate().unwrap_err(),
2664 UpgradeError::AbsoluteScript { .. }
2665 ));
2666 }
2667
2668 #[test]
2669 fn validate_rejects_parent_escape_script() {
2670 let i = UpgradeInstruction::StateChange {
2671 script: PathBuf::from("../sibling/migrations.lisp"),
2672 };
2673 assert!(matches!(
2674 i.validate().unwrap_err(),
2675 UpgradeError::ParentEscapeScript { .. }
2676 ));
2677 // mid-path `..` is also caught
2678 let i2 = UpgradeInstruction::StateChange {
2679 script: PathBuf::from("lib/../../escaped.lisp"),
2680 };
2681 assert!(matches!(
2682 i2.validate().unwrap_err(),
2683 UpgradeError::ParentEscapeScript { .. }
2684 ));
2685 }
2686
2687 // ── :upgrade-from :state-change :script `.lisp` extension gate ─
2688 // Mirrors the c97815a `BehaviorError::NonLispExtension` arm on
2689 // the peer `:behavior :on-*` tatara-lisp-source-path axis. Both
2690 // axes route through the same M2.5 wasm-engine `tatara_lisp::read`
2691 // consumer; the file-type contract is identical, so the per-axis
2692 // test grid is mirrored leg-for-leg.
2693
2694 #[test]
2695 fn validate_rejects_no_extension_script() {
2696 // Fail-before-pass-after: the canonical "I declared the
2697 // migration script but forgot the `.lisp` extension"
2698 // authoring footgun (e.g. `(:state-change "lib/migrations")`).
2699 // The wasm-engine's `tatara_lisp::read` consumer needs a
2700 // file-type contract beyond the structural-shape gate; a
2701 // no-extension path past `is_sandboxed_relative_path` would
2702 // surface a parser-shaped diagnostic at hot-upgrade migration
2703 // time far from the source caixa.lisp.
2704 for relpath in ["lib/migrations", "migrations", "lib/handlers/migrate"] {
2705 let i = UpgradeInstruction::StateChange {
2706 script: PathBuf::from(relpath),
2707 };
2708 let err = i.validate().unwrap_err();
2709 assert!(
2710 matches!(&err, UpgradeError::NonLispExtensionScript { script: s }
2711 if s == Path::new(relpath)),
2712 "no-extension script {relpath:?} must surface as NonLispExtensionScript \
2713 carrying the offending path verbatim, got {err:?}"
2714 );
2715 }
2716 }
2717
2718 #[test]
2719 fn validate_rejects_non_lisp_extension_script() {
2720 // Wrong-extension sweep across common authoring footguns: the
2721 // `.txt` / `.md` / `.json` / `.yaml` shapes an author might
2722 // drag in from the workspace tree, the `.rs` shape that an
2723 // IDE auto-complete might propose, the `.lisp.bak` shape an
2724 // editor might leave behind, and the `.lispx` near-miss that
2725 // a typo would produce. Each must surface as
2726 // `NonLispExtensionScript` carrying the offending path
2727 // verbatim — the wasm-engine's `tatara_lisp::read` consumer
2728 // rejects all of these at hot-upgrade migration time, and
2729 // the gate lifts that contract to validate time. Mirrors the
2730 // peer `BehaviorError::NonLispExtension` sweep (c97815a) on
2731 // the `:behavior :on-*` axis leg-for-leg — same downstream
2732 // consumer, same accepted set, same per-axis test grid.
2733 let footguns: &[&str] = &[
2734 "lib/migrations.rs",
2735 "lib/migrations.txt",
2736 "lib/migrations.md",
2737 "lib/migrations.json",
2738 "lib/migrations.yaml",
2739 "lib/migrations.toml",
2740 "lib/migrations.lisp.bak",
2741 "lib/migrations.lispx",
2742 "lib/migrations.lis",
2743 ];
2744 for relpath in footguns {
2745 let i = UpgradeInstruction::StateChange {
2746 script: PathBuf::from(relpath),
2747 };
2748 let err = i.validate().unwrap_err();
2749 assert!(
2750 matches!(&err, UpgradeError::NonLispExtensionScript { script: s }
2751 if s == Path::new(relpath)),
2752 "wrong-extension script {relpath:?} must surface as NonLispExtensionScript \
2753 carrying the offending path verbatim, got {err:?}"
2754 );
2755 }
2756 }
2757
2758 #[test]
2759 fn validate_rejects_uppercase_lisp_extension_script() {
2760 // Strict lowercase: `.LISP` / `.Lisp` / `.LiSp` are
2761 // case-folded shapes a case-insensitive volume's existence
2762 // check would match the on-disk file — but the
2763 // canonical-form codec emits lowercase `.lisp` verbatim, so
2764 // a case-folded shape mismatches the round-trip-stable
2765 // canonical form (THEORY.md §V.2.7 render-determinism).
2766 // Same case-sensitive discipline the byte-size / duration
2767 // codecs use on unit suffixes (`MiB`, `ms`, `s`, `m`, `h`)
2768 // and every other shape-gate predicate in `render.rs` (label
2769 // / scheme / unit boundaries). Mirrors the peer
2770 // `BehaviorError::NonLispExtension` case-fold sweep (c97815a).
2771 for relpath in [
2772 "lib/migrations.LISP",
2773 "lib/migrations.Lisp",
2774 "lib/migrations.LiSp",
2775 "lib/migrations.lISP",
2776 ] {
2777 let i = UpgradeInstruction::StateChange {
2778 script: PathBuf::from(relpath),
2779 };
2780 let err = i.validate().unwrap_err();
2781 assert!(
2782 matches!(&err, UpgradeError::NonLispExtensionScript { script: s }
2783 if s == Path::new(relpath)),
2784 "case-folded `.lisp` extension {relpath:?} must surface as \
2785 NonLispExtensionScript (strict lowercase, canonical-form \
2786 round-trip pin), got {err:?}"
2787 );
2788 }
2789 }
2790
2791 #[test]
2792 fn validate_accepts_canonical_lisp_extension_scripts() {
2793 // Positive-control sweep across every canonical in-tree
2794 // authoring shape: bare filename, standard `lib/`
2795 // subdirectory, deeply-nested migrations subdirectory,
2796 // explicit current-dir-relative prefix, mid-path `./`
2797 // segment, multi-dot stem (the version-suffix shape
2798 // `lib/migrations/v.0.1.lisp` an author might use to encode
2799 // the migration's `:from` version into the filename). Drift
2800 // here = a future tightening that rejects any of these
2801 // surfaces as a test-failure at the per-axis validator
2802 // boundary, not piecemeal across renderer / layout-checker
2803 // call sites. Mirrors the peer `BehaviorSpec` positive-set
2804 // sweep (c97815a).
2805 let canonical: &[&str] = &[
2806 "lib/migrations.lisp",
2807 "lib/migrations/v01-to-v02.lisp",
2808 "migrations.lisp",
2809 "a.lisp",
2810 "./lib/migrations.lisp",
2811 "lib/./migrations.lisp",
2812 "lib/migrations/v.0.1.lisp",
2813 ];
2814 for relpath in canonical {
2815 UpgradeInstruction::StateChange {
2816 script: PathBuf::from(relpath),
2817 }
2818 .validate()
2819 .unwrap_or_else(|e| {
2820 panic!("canonical `.lisp` script {relpath:?} must pass, got {e:?}")
2821 });
2822 }
2823 }
2824
2825 #[test]
2826 fn validate_sandbox_shape_takes_precedence_over_lisp_extension() {
2827 // Cross-arm precedence pin: a script that is *both*
2828 // sandbox-escaping (Empty / Absolute / ParentEscape) and
2829 // non-`.lisp` must surface the more-fundamental
2830 // sandbox-shape diagnostic first — the canonical fix
2831 // collapses both into "pin a relative `.lisp` path under the
2832 // caixa root", and the `.lisp` remediation would be
2833 // misleading when the offending path can never resolve under
2834 // the caixa root anyway. Mirrors the peer
2835 // `BehaviorError` cross-arm precedence (c97815a) and the
2836 // sibling `LimitsError`
2837 // (`MemoryZero` → `MemoryBelowWasm32Page` →
2838 // `MemoryExceedsWasm32Cap` → `MemoryNotPageMultiple`)
2839 // smallest-scope-arm-fires-last posture.
2840 let i_empty = UpgradeInstruction::StateChange {
2841 script: PathBuf::new(),
2842 };
2843 assert_eq!(i_empty.validate().unwrap_err(), UpgradeError::EmptyScript);
2844 let i_abs = UpgradeInstruction::StateChange {
2845 script: PathBuf::from("/etc/migrations.txt"),
2846 };
2847 assert!(
2848 matches!(
2849 i_abs.validate().unwrap_err(),
2850 UpgradeError::AbsoluteScript { .. }
2851 ),
2852 "absolute + non-`.lisp` must surface AbsoluteScript first"
2853 );
2854 let i_esc = UpgradeInstruction::StateChange {
2855 script: PathBuf::from("../sibling/migrations.rs"),
2856 };
2857 assert!(
2858 matches!(
2859 i_esc.validate().unwrap_err(),
2860 UpgradeError::ParentEscapeScript { .. }
2861 ),
2862 "parent-escape + non-`.lisp` must surface ParentEscapeScript first"
2863 );
2864 }
2865
2866 #[test]
2867 fn non_lisp_extension_script_diagnostic_carries_offending_path() {
2868 // Diagnostic-shape pin: the surfaced error message names the
2869 // offending path verbatim (so the author can grep their
2870 // caixa.lisp for the literal value), the `.lisp` extension
2871 // is named in the remediation, and the downstream consumer
2872 // (`tatara_lisp::read` at hot-upgrade migration time) is
2873 // named so the author can trace the contract back to its
2874 // source. Same self-locating shape every per-axis variant
2875 // carries (`BehaviorError::NonLispExtension`, c97815a;
2876 // `LimitsError::MemoryNotPageMultiple`, ec266d8).
2877 let bad = PathBuf::from("lib/migrations.txt");
2878 let err = UpgradeInstruction::StateChange {
2879 script: bad.clone(),
2880 }
2881 .validate()
2882 .unwrap_err();
2883 let msg = err.to_string();
2884 assert!(
2885 msg.contains("lib/migrations.txt"),
2886 "diagnostic must name the offending path verbatim, got {msg:?}"
2887 );
2888 assert!(
2889 msg.contains(".lisp"),
2890 "diagnostic must name the expected `.lisp` extension, got {msg:?}"
2891 );
2892 assert!(
2893 msg.contains(crate::render::M2_UPGRADE_INSTRUCTION_KIND_STATE_CHANGE),
2894 "diagnostic must name the offending `:state-change` instruction, got {msg:?}"
2895 );
2896 match err {
2897 UpgradeError::NonLispExtensionScript { script } => {
2898 assert_eq!(
2899 script, bad,
2900 "variant must carry the offending path verbatim"
2901 );
2902 }
2903 other => panic!("expected NonLispExtensionScript, got {other:?}"),
2904 }
2905 }
2906
2907 #[test]
2908 fn declared_path_only_for_state_change() {
2909 let load = UpgradeInstruction::LoadModule { module: "x".into() };
2910 assert!(load.declared_path().is_none());
2911 let mig = UpgradeInstruction::StateChange {
2912 script: PathBuf::from("lib/m.lisp"),
2913 };
2914 assert_eq!(mig.declared_path(), Some(&PathBuf::from("lib/m.lisp")));
2915 }
2916
2917 #[test]
2918 fn upgrade_instruction_is_restart_predicate_partitions_the_arm_set() {
2919 // The fail-before-pass-after pin on the `gen_platform::IsVariant`
2920 // derive's [`UpgradeInstruction::is_restart`] arm-discriminator
2921 // predicate: [`UpgradeInstruction::Restart`] is the only variant
2922 // that satisfies `.is_restart()`; every module-bearing arm
2923 // (`LoadModule` / `SoftPurge` / `Purge`) and the script-carrying
2924 // `StateChange` arm all return `false`. This pin makes the
2925 // partition invariant load-bearing at caixa-core test time so a
2926 // future derive regression (a hole that returns `false` for
2927 // `Restart` too, or a byte-collision that flips a second variant
2928 // to `true`) trips here rather than laundering the arm at
2929 // [`Self::validate_restart_exclusive`]'s paired positive /
2930 // negated filter sites (a hole flips restart-count to 0 →
2931 // vacuous OK; a collision flips restart-count > 1 → false
2932 // `RestartNotExclusive` on an entry the author declared without
2933 // any `(:restart)`). Peer of the sibling
2934 // [`crate::kind::tests::caixa_kind_is_variant_predicates_partition_the_arm_set`]
2935 // pin on the M0 `CaixaKind` axis.
2936 let cases: &[(UpgradeInstruction, bool)] = &[
2937 (UpgradeInstruction::LoadModule { module: "a".into() }, false),
2938 (UpgradeInstruction::SoftPurge { module: "b".into() }, false),
2939 (UpgradeInstruction::Purge { module: "c".into() }, false),
2940 (
2941 UpgradeInstruction::StateChange {
2942 script: PathBuf::from("lib/m.lisp"),
2943 },
2944 false,
2945 ),
2946 (UpgradeInstruction::Restart, true),
2947 ];
2948 for (variant, expected) in cases {
2949 assert_eq!(
2950 variant.is_restart(),
2951 *expected,
2952 "UpgradeInstruction::{variant:?}.is_restart() must \
2953 return {expected} (partition invariant on the \
2954 IsVariant-derived arm-discriminator predicate)"
2955 );
2956 }
2957 }
2958
2959 #[test]
2960 fn validate_restart_exclusive_routes_through_is_restart_predicate() {
2961 // Byte-identity pin on the paired positive / negated
2962 // `.is_restart()` filters at
2963 // [`Self::validate_restart_exclusive`] against the pre-lift
2964 // `matches!(i, UpgradeInstruction::Restart)` /
2965 // `!matches!(i, UpgradeInstruction::Restart)` predicates every
2966 // consumer of the gate previously coupled to inline. Asserts
2967 // the two projections agree byte-for-byte on every arm of the
2968 // enum, so a future derive regression that flipped either
2969 // predicate's arm-set would surface here at caixa-core test
2970 // time rather than at
2971 // [`Self::validate_restart_exclusive`]'s per-entry restart-
2972 // count / other-kinds tabulation far from the derive site.
2973 // Same peer-shape pin every sibling
2974 // `IsVariant`-derive-routed gate carries on the substrate's
2975 // closed-set typed-enum surface.
2976 let cases: Vec<UpgradeInstruction> = vec![
2977 UpgradeInstruction::LoadModule { module: "a".into() },
2978 UpgradeInstruction::SoftPurge { module: "b".into() },
2979 UpgradeInstruction::Purge { module: "c".into() },
2980 UpgradeInstruction::StateChange {
2981 script: PathBuf::from("lib/m.lisp"),
2982 },
2983 UpgradeInstruction::Restart,
2984 ];
2985 for instr in &cases {
2986 let via_predicate = instr.is_restart();
2987 let via_matches = matches!(instr, UpgradeInstruction::Restart);
2988 assert_eq!(
2989 via_predicate, via_matches,
2990 "UpgradeInstruction::{instr:?}: is_restart() must \
2991 byte-equal matches!(_, UpgradeInstruction::Restart) — \
2992 the pre-lift open-coded pattern and the \
2993 IsVariant-derived predicate are the same axis, \
2994 one typed dispatch"
2995 );
2996 }
2997 }
2998
2999 #[test]
3000 fn upgrade_instruction_is_cleanup_predicate_partitions_the_arm_set() {
3001 // The fail-before-pass-after pin on the lifted
3002 // [`UpgradeInstruction::is_cleanup`] two-arm cleanup-family
3003 // arm-discriminator predicate:
3004 // [`UpgradeInstruction::SoftPurge`] and
3005 // [`UpgradeInstruction::Purge`] are the two OTP-appup two-
3006 // phase-code-load cleanup arms that satisfy `.is_cleanup()`;
3007 // every non-cleanup arm ([`UpgradeInstruction::LoadModule`]
3008 // on the paired two-phase-load half,
3009 // [`UpgradeInstruction::StateChange`] on the
3010 // `gen_server:code_change/3`-analog migration axis,
3011 // [`UpgradeInstruction::Restart`] on the OTP terminal-
3012 // fallback shape) returns `false`. This pin makes the
3013 // partition invariant load-bearing at caixa-core test time
3014 // so a future accessor regression (a hole that returns
3015 // `false` for `SoftPurge` or `Purge`, or a byte-collision
3016 // that flips `LoadModule` / `StateChange` / `Restart` to
3017 // `true`) trips here rather than laundering the arm at the
3018 // three within-entry cross-instruction cleanup-facing gates
3019 // ([`UpgradeFromEntry::validate_purge_ordering`],
3020 // [`UpgradeFromEntry::validate_state_change_before_cleanup`],
3021 // [`UpgradeFromEntry::validate_cleanup_singularity`]) — a
3022 // hole would silently accept a cleanup-shaped entry the
3023 // three gates should refuse; a collision would fire a
3024 // `PurgeWithoutPriorLoad` / `StateChangeAfterCleanup` /
3025 // `DuplicateCleanup` refusal on a well-shaped
3026 // [`UpgradeInstruction::LoadModule`] / `StateChange` /
3027 // `Restart` arm the three gates should pass through. Peer
3028 // of the sibling
3029 // [`upgrade_instruction_is_restart_predicate_partitions_the_arm_set`]
3030 // pin on the single-arm terminal-fallback partition —
3031 // extended here from the single-arm case onto the two-arm
3032 // cleanup-family union case.
3033 let cases: &[(UpgradeInstruction, bool)] = &[
3034 (UpgradeInstruction::LoadModule { module: "a".into() }, false),
3035 (UpgradeInstruction::SoftPurge { module: "b".into() }, true),
3036 (UpgradeInstruction::Purge { module: "c".into() }, true),
3037 (
3038 UpgradeInstruction::StateChange {
3039 script: PathBuf::from("lib/m.lisp"),
3040 },
3041 false,
3042 ),
3043 (UpgradeInstruction::Restart, false),
3044 ];
3045 for (variant, expected) in cases {
3046 assert_eq!(
3047 variant.is_cleanup(),
3048 *expected,
3049 "UpgradeInstruction::{variant:?}.is_cleanup() must \
3050 return {expected} (partition invariant on the \
3051 lifted OTP-appup two-arm cleanup-family arm-\
3052 discriminator predicate)"
3053 );
3054 }
3055 }
3056
3057 #[test]
3058 fn upgrade_instruction_is_cleanup_composes_through_is_soft_purge_or_is_purge() {
3059 // Byte-identity pin on the [`UpgradeInstruction::is_cleanup`]
3060 // composition against the two [`gen_platform::IsVariant`]-
3061 // derive-generated per-variant classifiers it routes through
3062 // — the accessor's one body must byte-equal
3063 // `self.is_soft_purge() || self.is_purge()` across every arm
3064 // of the closed-set enum, so a future silent detour that
3065 // reintroduced a raw `matches!` pattern or that stopped
3066 // composing through the derive-generated per-variant
3067 // predicates (an accidental `self.is_soft_purge()` on its
3068 // own — silently dropping the `Purge` arm; an accidental
3069 // `self.is_purge() || self.is_state_change()` — silently
3070 // folding the migration arm into the cleanup family; a
3071 // typo `&&` for the union `||` — silently classifying no
3072 // arm as cleanup) trips here at caixa-core test time
3073 // rather than laundering the arm at the three within-entry
3074 // cross-instruction cleanup-facing gates. Same peer-shape
3075 // pin the sibling
3076 // [`validate_restart_exclusive_routes_through_is_restart_predicate`]
3077 // carries on the paired terminal-fallback axis.
3078 let cases: Vec<UpgradeInstruction> = vec![
3079 UpgradeInstruction::LoadModule { module: "a".into() },
3080 UpgradeInstruction::SoftPurge { module: "b".into() },
3081 UpgradeInstruction::Purge { module: "c".into() },
3082 UpgradeInstruction::StateChange {
3083 script: PathBuf::from("lib/m.lisp"),
3084 },
3085 UpgradeInstruction::Restart,
3086 ];
3087 for instr in &cases {
3088 let via_predicate = instr.is_cleanup();
3089 let via_composition = instr.is_soft_purge() || instr.is_purge();
3090 assert_eq!(
3091 via_predicate, via_composition,
3092 "UpgradeInstruction::{instr:?}: is_cleanup() must \
3093 byte-equal is_soft_purge() || is_purge() — the \
3094 lifted union predicate and its per-variant \
3095 composition are the same axis, one typed dispatch"
3096 );
3097 }
3098 }
3099
3100 #[test]
3101 fn upgrade_instruction_is_cleanup_implies_declared_module_is_some() {
3102 // Composition-pin the load-bearing invariant every consumer
3103 // that routes through `is_cleanup()` + `declared_module()`
3104 // relies on: any [`UpgradeInstruction`] value whose
3105 // `.is_cleanup()` returns `true` must have a `Some(_)`
3106 // `.declared_module()`. This makes the three within-entry
3107 // cross-instruction cleanup-facing gates' `.expect("is_cleanup()
3108 // implies declared_module() is Some")` structurally
3109 // infallible at build time — a future refactor that added
3110 // a cleanup-shaped variant carrying no `:module` would trip
3111 // here rather than panic at
3112 // [`UpgradeFromEntry::validate_purge_ordering`] /
3113 // [`UpgradeFromEntry::validate_state_change_before_cleanup`] /
3114 // [`UpgradeFromEntry::validate_cleanup_singularity`] at
3115 // runtime on the offending author's caixa.lisp.
3116 let cases: Vec<UpgradeInstruction> = vec![
3117 UpgradeInstruction::LoadModule { module: "a".into() },
3118 UpgradeInstruction::SoftPurge { module: "b".into() },
3119 UpgradeInstruction::Purge { module: "c".into() },
3120 UpgradeInstruction::StateChange {
3121 script: PathBuf::from("lib/m.lisp"),
3122 },
3123 UpgradeInstruction::Restart,
3124 ];
3125 for instr in &cases {
3126 if instr.is_cleanup() {
3127 assert!(
3128 instr.declared_module().is_some(),
3129 "UpgradeInstruction::{instr:?}: is_cleanup() \
3130 must imply declared_module().is_some() — the \
3131 three within-entry cross-instruction cleanup-\
3132 facing gates rely on this invariant to route \
3133 the cleanup-target :module scalar through the \
3134 sibling declared_module accessor without a \
3135 pattern-bound `module` binding"
3136 );
3137 }
3138 }
3139 }
3140
3141 #[test]
3142 fn upgrade_instruction_is_load_module_implies_declared_module_is_some() {
3143 // Composition-pin the load-bearing invariant
3144 // [`UpgradeFromEntry::validate_load_singularity`] relies on
3145 // when routing the per-instruction load-family arm-discriminator
3146 // through the sibling
3147 // [`UpgradeInstruction::is_load_module`] +
3148 // [`UpgradeInstruction::declared_module`] accessor pair: any
3149 // [`UpgradeInstruction`] value whose `.is_load_module()`
3150 // returns `true` must have a `Some(_)` `.declared_module()`.
3151 // This makes the gate's `.expect("is_load_module() implies
3152 // declared_module() is Some")` structurally infallible at
3153 // build time — a future refactor that added a load-shaped
3154 // variant carrying no `:module` would trip here rather than
3155 // panic at [`UpgradeFromEntry::validate_load_singularity`]
3156 // at runtime on the offending author's caixa.lisp. Sibling
3157 // of the peer
3158 // [`upgrade_instruction_is_cleanup_implies_declared_module_is_some`]
3159 // composition pin on the two-arm cleanup-family axis — same
3160 // "predicate implies accessor" discipline extended onto the
3161 // single-arm load-family axis, closes the load-vs-cleanup
3162 // pair on the substrate primitive's typed dispatch discipline.
3163 let cases: Vec<UpgradeInstruction> = vec![
3164 UpgradeInstruction::LoadModule { module: "a".into() },
3165 UpgradeInstruction::SoftPurge { module: "b".into() },
3166 UpgradeInstruction::Purge { module: "c".into() },
3167 UpgradeInstruction::StateChange {
3168 script: PathBuf::from("lib/m.lisp"),
3169 },
3170 UpgradeInstruction::Restart,
3171 ];
3172 for instr in &cases {
3173 if instr.is_load_module() {
3174 assert!(
3175 instr.declared_module().is_some(),
3176 "UpgradeInstruction::{instr:?}: is_load_module() \
3177 must imply declared_module().is_some() — the \
3178 within-entry load-singularity gate relies on this \
3179 invariant to route the load-target :module scalar \
3180 through the sibling declared_module accessor \
3181 without a pattern-bound `module` binding"
3182 );
3183 }
3184 }
3185 }
3186
3187 #[test]
3188 fn validate_load_singularity_projects_modules_through_is_load_module_and_declared_module_accessors()
3189 {
3190 // Byte-identity pin on the
3191 // [`UpgradeFromEntry::validate_load_singularity`] load-family
3192 // dispatch against the pre-lift
3193 // `match instr { UpgradeInstruction::LoadModule { module } =>
3194 // module.as_str(), _ => continue }` open-coded pattern-match
3195 // the site previously carried. Asserts the two projections
3196 // agree byte-for-byte on every arm of the enum — the
3197 // arm-discriminator via `is_load_module()` and the `:module`
3198 // scalar via `declared_module()` — so a future derive
3199 // regression that flipped the predicate's arm-set (a hole
3200 // returning `false` for [`UpgradeInstruction::LoadModule`], a
3201 // byte-collision flipping a second variant to `true`) or an
3202 // accessor extension that promoted an additional variant onto
3203 // the `String`-carrying axis would trip here at caixa-core
3204 // test time rather than laundering the arm at the gate's
3205 // per-entry load-singularity scan far from the derive site.
3206 // Peer of the sibling
3207 // [`validate_purge_ordering_routes_through_is_load_module_predicate`]
3208 // byte-identity pin on the paired ordering-side load-family
3209 // sticky-latch dispatch (both consumers now agree on one
3210 // typed dispatch for the load-family axis) and the peer
3211 // [`validate_state_change_singularity_projects_scripts_through_declared_path_accessor`]
3212 // pin on the migration-family script-projection axis — the
3213 // three within-entry per-instruction-class singularity gates
3214 // now share one byte-identity pin apiece against their
3215 // respective substrate-primitive typed dispatches.
3216 //
3217 // Three-arm projective coverage:
3218 // (a) `LoadModule` modules project through
3219 // `declared_module()` byte-equal to the raw
3220 // `module.as_str()` field access;
3221 // (b) a duplicate-`LoadModule` input trips the gate on the
3222 // second occurrence with `DuplicateLoadModule` carrying
3223 // the offending module verbatim;
3224 // (c) a non-`LoadModule`-only input (`SoftPurge` / `Purge` /
3225 // `StateChange` / `Restart`) leaves the gate vacuous
3226 // with `Ok(())` — the `!instr.is_load_module()`
3227 // `continue` fall-through pins.
3228 //
3229 // Fail-before-pass-after verified locally: swapping the
3230 // production `if !instr.is_load_module() { continue; } let
3231 // module = instr.declared_module().expect(…);` back to `let
3232 // module = match instr { UpgradeInstruction::LoadModule
3233 // { module } => module.as_str(), _ => continue, };` keeps
3234 // arms (a)-(c) passing but silently detaches the gate from
3235 // the accessor's typed dispatch — any future
3236 // `is_load_module` / `declared_module` extension (a hole in
3237 // either predicate, a promotion of an additional variant
3238 // onto the `String`-carrying axis, an operator-side
3239 // pre-parsed caixa-name cache the accessor materializes)
3240 // would then silently disagree between this gate's raw
3241 // pattern-match and the peer per-`UpgradeInstruction`
3242 // consumers that route through the accessor pair.
3243
3244 // (a) LoadModule projection byte-equal via
3245 // is_load_module() + declared_module().
3246 let lm = UpgradeInstruction::LoadModule {
3247 module: "hello-rio".into(),
3248 };
3249 assert!(
3250 lm.is_load_module(),
3251 "LoadModule must satisfy is_load_module() — the gate's \
3252 load-family arm-discriminator relies on this partition"
3253 );
3254 assert_eq!(
3255 lm.declared_module(),
3256 Some("hello-rio"),
3257 "declared_module() must project the LoadModule :module \
3258 byte-equal to the raw field access — accessor divergence \
3259 would silently detach the gate from the projection every \
3260 peer per-`UpgradeInstruction` consumer routes through"
3261 );
3262
3263 // (b) Duplicate-LoadModule input trips the gate.
3264 let dup = entry(
3265 "0.1.0",
3266 vec![
3267 UpgradeInstruction::LoadModule { module: "x".into() },
3268 UpgradeInstruction::LoadModule { module: "x".into() },
3269 ],
3270 );
3271 assert_eq!(
3272 dup.validate_load_singularity(),
3273 Err(UpgradeError::DuplicateLoadModule {
3274 from: "0.1.0".into(),
3275 module: "x".into(),
3276 }),
3277 "duplicate LoadModule modules within one entry must fire \
3278 DuplicateLoadModule byte-identical to the pre-lift \
3279 pattern-match shape"
3280 );
3281
3282 // (c) Non-LoadModule-only input leaves the gate vacuous.
3283 let no_load = entry(
3284 "0.1.0",
3285 vec![
3286 UpgradeInstruction::StateChange {
3287 script: PathBuf::from("lib/m.lisp"),
3288 },
3289 UpgradeInstruction::Restart,
3290 ],
3291 );
3292 assert_eq!(
3293 no_load.validate_load_singularity(),
3294 Ok(()),
3295 "non-LoadModule-only entries must leave the load-\
3296 singularity gate vacuous — the `!is_load_module()` \
3297 continue fall-through pins"
3298 );
3299 }
3300
3301 #[test]
3302 fn upgrade_instruction_is_load_module_predicate_partitions_the_arm_set() {
3303 // The fail-before-pass-after pin on the `gen_platform::IsVariant`
3304 // derive's [`UpgradeInstruction::is_load_module`] arm-discriminator
3305 // predicate: [`UpgradeInstruction::LoadModule`] is the only
3306 // variant that satisfies `.is_load_module()`; every cleanup arm
3307 // (`SoftPurge` / `Purge`), the migration arm (`StateChange`),
3308 // and the terminal-fallback arm (`Restart`) all return `false`.
3309 // This pin makes the partition invariant load-bearing at
3310 // caixa-core test time so a future derive regression (a hole
3311 // that returns `false` for `LoadModule` too, or a byte-collision
3312 // that flips a second variant to `true`) trips here rather than
3313 // laundering the arm at
3314 // [`Self::validate_purge_ordering`]'s load-family sticky-latch
3315 // dispatch — a hole would silently keep `loaded = false` through
3316 // a well-shaped [`UpgradeInstruction::LoadModule`] prefix and
3317 // false-fire `PurgeWithoutPriorLoad` on the trailing cleanup;
3318 // a collision would flip `loaded = true` on a well-shaped
3319 // cleanup-only entry and silently swallow the load-less
3320 // `PurgeWithoutPriorLoad` refusal. Peer of the sibling
3321 // [`upgrade_instruction_is_restart_predicate_partitions_the_arm_set`]
3322 // and
3323 // [`upgrade_instruction_is_cleanup_predicate_partitions_the_arm_set`]
3324 // pins on the paired terminal-fallback and cleanup-family
3325 // arm-discriminator axes — closes the last unlifted `matches!`-
3326 // based arm-discriminator axis on the OTP-appup closed-set
3327 // typed enum.
3328 let cases: &[(UpgradeInstruction, bool)] = &[
3329 (UpgradeInstruction::LoadModule { module: "a".into() }, true),
3330 (UpgradeInstruction::SoftPurge { module: "b".into() }, false),
3331 (UpgradeInstruction::Purge { module: "c".into() }, false),
3332 (
3333 UpgradeInstruction::StateChange {
3334 script: PathBuf::from("lib/m.lisp"),
3335 },
3336 false,
3337 ),
3338 (UpgradeInstruction::Restart, false),
3339 ];
3340 for (variant, expected) in cases {
3341 assert_eq!(
3342 variant.is_load_module(),
3343 *expected,
3344 "UpgradeInstruction::{variant:?}.is_load_module() must \
3345 return {expected} (partition invariant on the \
3346 IsVariant-derived arm-discriminator predicate)"
3347 );
3348 }
3349 }
3350
3351 #[test]
3352 fn validate_purge_ordering_routes_through_is_load_module_predicate() {
3353 // Byte-identity pin on the [`Self::validate_purge_ordering`]
3354 // load-family sticky-latch dispatch against the pre-lift
3355 // `matches!(instr, UpgradeInstruction::LoadModule { .. })`
3356 // predicate the site previously open-coded. Asserts the two
3357 // projections agree byte-for-byte on every arm of the enum, so
3358 // a future derive regression that flipped the predicate's
3359 // arm-set would surface here at caixa-core test time rather
3360 // than at [`Self::validate_purge_ordering`]'s per-entry
3361 // load-before-cleanup ordering scan far from the derive site.
3362 // Same peer-shape pin the sibling
3363 // [`validate_restart_exclusive_routes_through_is_restart_predicate`]
3364 // carries on the paired terminal-fallback axis and the
3365 // [`upgrade_instruction_is_cleanup_composes_through_is_soft_purge_or_is_purge`]
3366 // carries on the two-arm cleanup-family axis — the third and
3367 // final byte-identity pin closes the substrate primitive's
3368 // arm-discriminator dispatch discipline on the OTP-appup
3369 // closed-set typed enum.
3370 let cases: Vec<UpgradeInstruction> = vec![
3371 UpgradeInstruction::LoadModule { module: "a".into() },
3372 UpgradeInstruction::SoftPurge { module: "b".into() },
3373 UpgradeInstruction::Purge { module: "c".into() },
3374 UpgradeInstruction::StateChange {
3375 script: PathBuf::from("lib/m.lisp"),
3376 },
3377 UpgradeInstruction::Restart,
3378 ];
3379 for instr in &cases {
3380 let via_predicate = instr.is_load_module();
3381 let via_matches = matches!(instr, UpgradeInstruction::LoadModule { .. });
3382 assert_eq!(
3383 via_predicate, via_matches,
3384 "UpgradeInstruction::{instr:?}: is_load_module() must \
3385 byte-equal matches!(_, UpgradeInstruction::LoadModule \
3386 {{ .. }}) — the pre-lift open-coded pattern and the \
3387 IsVariant-derived predicate are the same axis, one \
3388 typed dispatch"
3389 );
3390 }
3391 }
3392
3393 #[test]
3394 fn declared_module_only_for_module_bearing_variants() {
3395 // Pinned partition of the `UpgradeInstruction` closed-set
3396 // variant space against the sibling of the peer
3397 // `declared_path` accessor: every OTP-appup module-bearing
3398 // variant (`LoadModule` / `SoftPurge` / `Purge`) surfaces its
3399 // `:module` string byte-for-byte through the lifted
3400 // `declared_module` accessor; every non-module-bearing variant
3401 // (`StateChange` on the peer `:script`-carrying axis;
3402 // `Restart` on the OTP terminal-fallback data-less axis)
3403 // returns `None`. Mirrors the peer
3404 // `declared_path_only_for_state_change` pin — the pair now
3405 // closes both scalar-carrying axes on the enum on one lifted
3406 // `Option<&…>` accessor apiece.
3407 let load = UpgradeInstruction::LoadModule {
3408 module: "hello-rio".into(),
3409 };
3410 assert_eq!(load.declared_module(), Some("hello-rio"));
3411 let soft = UpgradeInstruction::SoftPurge {
3412 module: "hello-rio-old".into(),
3413 };
3414 assert_eq!(soft.declared_module(), Some("hello-rio-old"));
3415 let hard = UpgradeInstruction::Purge {
3416 module: "hello-rio-ancient".into(),
3417 };
3418 assert_eq!(hard.declared_module(), Some("hello-rio-ancient"));
3419 let mig = UpgradeInstruction::StateChange {
3420 script: PathBuf::from("lib/m.lisp"),
3421 };
3422 assert!(mig.declared_module().is_none());
3423 assert!(UpgradeInstruction::Restart.declared_module().is_none());
3424 }
3425
3426 #[test]
3427 fn declared_module_and_declared_path_partition_the_enum_variant_space() {
3428 // Byte-identity pin on the two-accessor partition: every
3429 // `UpgradeInstruction` variant returns `Some` from *exactly
3430 // one* of {`declared_module`, `declared_path`} (the two
3431 // module-bearing / script-carrying axes) or from *neither*
3432 // (the OTP terminal-fallback `Restart` shape). No variant
3433 // returns `Some` from both — the two axes are disjoint by
3434 // construction, and this pin closes the disjointness at the
3435 // test surface so a future variant that leaks a scalar across
3436 // both axes fails at build time. Mirrors the peer
3437 // `declared_paths_iter_covers_each_declared_slot_exactly_once`
3438 // discipline on the `BehaviorSpec` per-slot family.
3439 let cases: Vec<UpgradeInstruction> = vec![
3440 UpgradeInstruction::LoadModule { module: "a".into() },
3441 UpgradeInstruction::SoftPurge { module: "b".into() },
3442 UpgradeInstruction::Purge { module: "c".into() },
3443 UpgradeInstruction::StateChange {
3444 script: PathBuf::from("lib/m.lisp"),
3445 },
3446 UpgradeInstruction::Restart,
3447 ];
3448 for instr in &cases {
3449 let has_module = instr.declared_module().is_some();
3450 let has_path = instr.declared_path().is_some();
3451 assert!(
3452 !(has_module && has_path),
3453 "no variant may declare both a module and a path — offending: {instr:?}"
3454 );
3455 match instr {
3456 UpgradeInstruction::LoadModule { .. }
3457 | UpgradeInstruction::SoftPurge { .. }
3458 | UpgradeInstruction::Purge { .. } => {
3459 assert!(has_module && !has_path, "module axis: {instr:?}");
3460 }
3461 UpgradeInstruction::StateChange { .. } => {
3462 assert!(!has_module && has_path, "script axis: {instr:?}");
3463 }
3464 UpgradeInstruction::Restart => {
3465 assert!(!has_module && !has_path, "data-less axis: {instr:?}");
3466 }
3467 }
3468 }
3469 }
3470
3471 #[test]
3472 fn entry_with_chain_of_versions() {
3473 // Middle entry pairs a `:load-module` with the trailing
3474 // `:soft-purge` so it satisfies the within-entry purge-ordering
3475 // gate (`PurgeWithoutPriorLoad` rejects `:soft-purge` without a
3476 // preceding `:load-module`, mirroring the state-change-ordering
3477 // gate's `StateChangeWithoutPriorLoad`). The chain shape under
3478 // test is *cross-entry* `:from` values; the within-entry shape
3479 // is incidental — keeping it canonical (`:load-module` before
3480 // `:soft-purge`) leaves the chain assertion load-bearing.
3481 let entries = vec![
3482 entry(
3483 "0.1.0",
3484 vec![UpgradeInstruction::LoadModule { module: "x".into() }],
3485 ),
3486 entry(
3487 "0.1.5",
3488 vec![
3489 UpgradeInstruction::LoadModule { module: "x".into() },
3490 UpgradeInstruction::SoftPurge {
3491 module: "x-old".into(),
3492 },
3493 ],
3494 ),
3495 entry("0.2.0-rc.1", vec![UpgradeInstruction::Restart]),
3496 ];
3497 for e in &entries {
3498 e.validate().unwrap();
3499 }
3500 let json = serde_json::to_string(&entries).unwrap();
3501 let back: Vec<UpgradeFromEntry> = serde_json::from_str(&json).unwrap();
3502 assert_eq!(entries, back);
3503 }
3504
3505 #[test]
3506 fn empty_instructions_list_is_valid() {
3507 let e = entry("0.1.0", vec![]);
3508 e.validate().unwrap();
3509 }
3510
3511 #[test]
3512 fn json_uses_kebab_case_kind_tags() {
3513 let i = UpgradeInstruction::SoftPurge {
3514 module: "x-old".into(),
3515 };
3516 let json = serde_json::to_string(&i).unwrap();
3517 assert!(json.contains("\"kind\":\"soft-purge\""));
3518 let i2 = UpgradeInstruction::StateChange {
3519 script: PathBuf::from("m.lisp"),
3520 };
3521 let json2 = serde_json::to_string(&i2).unwrap();
3522 assert!(json2.contains("\"kind\":\"state-change\""));
3523 }
3524
3525 // ── validate_upgrade_from: cross-entry graph-edge-set invariant ────
3526
3527 #[test]
3528 fn validate_upgrade_from_accepts_disjoint_versions() {
3529 // Positive control: the canonical "chain v0.1.0 → 0.1.5 →
3530 // 0.2.0-rc.1" authoring shape from ABSORPTION-ROADMAP §M2.3
3531 // (and `entry_with_chain_of_versions` above) passes the cross-
3532 // entry gate. Different `:from` per entry is the intended
3533 // shape; the gate must not regress this baseline. Middle entry
3534 // pairs `:load-module` with `:soft-purge` to satisfy the
3535 // within-entry purge-ordering gate (see
3536 // `entry_with_chain_of_versions` for the same shape).
3537 let entries = vec![
3538 entry(
3539 "0.1.0",
3540 vec![UpgradeInstruction::LoadModule { module: "x".into() }],
3541 ),
3542 entry(
3543 "0.1.5",
3544 vec![
3545 UpgradeInstruction::LoadModule { module: "x".into() },
3546 UpgradeInstruction::SoftPurge {
3547 module: "x-old".into(),
3548 },
3549 ],
3550 ),
3551 entry("0.2.0-rc.1", vec![UpgradeInstruction::Restart]),
3552 ];
3553 validate_upgrade_from(&entries).unwrap();
3554 }
3555
3556 #[test]
3557 fn validate_upgrade_from_accepts_empty_list() {
3558 // Absent `:upgrade-from` (the bare `feira init` shape) — the
3559 // gate must trivially pass an empty list. Mirrors the per-axis
3560 // "empty list passes" positive control on every peer typed-
3561 // graph gate (`validate_membros` empty list, `validate_placement`
3562 // requires non-empty clusters but only after a `Placement`
3563 // exists, etc.).
3564 validate_upgrade_from(&[]).unwrap();
3565 }
3566
3567 #[test]
3568 fn validate_upgrade_from_rejects_duplicate_from() {
3569 // Fail-before-pass-after pin: two entries with the same parsed-
3570 // semver `:from` are an ambiguous edge in the typed upgrade
3571 // graph (OTP appup picks at most one matching block per running
3572 // version; with two matching blocks the operator picks either
3573 // set non-deterministically — author intent is one path per
3574 // prior version). Same set-not-multiset discipline as
3575 // `:children :caixa` (dbf50a9), `:membros :caixa` (4bb3f3d),
3576 // `:contratos` (5dbcfaf), `:placement :clusters` (c7c7799),
3577 // `:entrada :paths` (eb3456d) — now extended onto the fifth
3578 // typed-graph axis.
3579 let entries = vec![
3580 entry(
3581 "0.1.0",
3582 vec![UpgradeInstruction::LoadModule { module: "x".into() }],
3583 ),
3584 entry(
3585 "0.1.0",
3586 vec![
3587 UpgradeInstruction::LoadModule { module: "x".into() },
3588 UpgradeInstruction::SoftPurge {
3589 module: "x-old".into(),
3590 },
3591 ],
3592 ),
3593 ];
3594 let err = validate_upgrade_from(&entries).unwrap_err();
3595 assert_eq!(
3596 err,
3597 UpgradeError::DuplicateFrom {
3598 from: "0.1.0".into()
3599 },
3600 "two entries with `:from \"0.1.0\"` must surface as DuplicateFrom carrying the \
3601 offending value verbatim"
3602 );
3603 }
3604
3605 #[test]
3606 fn validate_upgrade_from_treats_pre_release_as_distinct() {
3607 // Negative-of-positive: `1.0.0` and `1.0.0-rc.1` are *not*
3608 // equal under semver (pre-release version is part of the
3609 // identity), so they're distinct upgrade paths and must not
3610 // collide. A future tightening that collapses pre-release into
3611 // the release version surfaces here.
3612 let entries = vec![
3613 entry("1.0.0", vec![UpgradeInstruction::Restart]),
3614 entry("1.0.0-rc.1", vec![UpgradeInstruction::Restart]),
3615 ];
3616 validate_upgrade_from(&entries).unwrap();
3617 }
3618
3619 #[test]
3620 fn validate_upgrade_from_treats_build_metadata_as_distinct() {
3621 // Conservative-by-design: [`semver::Version`]'s `PartialEq`
3622 // compares build metadata (it derives equality across all
3623 // fields including `pre` + `build`), so `1.0.0+build1` and
3624 // `1.0.0+build2` are *not* duplicates from the gate's
3625 // perspective — the operator may treat the build-metadata
3626 // suffix as a tiebreaker even though the semver spec says
3627 // build metadata is ignored for precedence
3628 // (https://semver.org/#spec-item-10). Pin the conservative
3629 // behavior here so a future switch to a build-metadata-
3630 // stripping comparator surfaces as a test failure first; that
3631 // change would require coordinating with the wasm-operator's
3632 // `:from`-match dispatch step, which is the load-bearing
3633 // semantic we'd be mirroring.
3634 let entries = vec![
3635 entry("1.0.0+build1", vec![UpgradeInstruction::Restart]),
3636 entry("1.0.0+build2", vec![UpgradeInstruction::Restart]),
3637 ];
3638 validate_upgrade_from(&entries).unwrap();
3639 }
3640
3641 #[test]
3642 fn validate_upgrade_from_per_entry_shape_fires_before_duplicate() {
3643 // Order pin: a malformed `:from` on the second entry surfaces
3644 // its `FromInvalid` diagnostic, not a (less-useful)
3645 // `DuplicateFrom`. The per-entry shape pass runs *inline*
3646 // before the duplicate-key insert — parallel to
3647 // `child_versao_invalid_fires_before_duplicate_check`
3648 // (b38ff3a) and `membro_versao_invalid_fires_before_duplicate_check`
3649 // (9888b13). Without this pin a future shortcut that runs the
3650 // cross-entry gate first would surface a duplicate diagnostic
3651 // on a string that isn't even parsable as a version.
3652 let entries = vec![
3653 entry("0.1.0", vec![UpgradeInstruction::Restart]),
3654 entry("not-a-semver", vec![UpgradeInstruction::Restart]),
3655 ];
3656 let err = validate_upgrade_from(&entries).unwrap_err();
3657 assert!(
3658 matches!(err, UpgradeError::FromInvalid { ref from, .. } if from == "not-a-semver"),
3659 "malformed `:from` on a non-duplicate entry must surface as FromInvalid, got {err:?}"
3660 );
3661 }
3662
3663 #[test]
3664 fn validate_upgrade_from_per_entry_shape_fires_before_duplicate_on_first_entry() {
3665 // Symmetric arm: a malformed shape on the *first* entry of a
3666 // duplicate pair surfaces its per-entry diagnostic too (not
3667 // the duplicate diagnostic that would otherwise fire on the
3668 // second entry). Pinned separately so a future shortcut that
3669 // walks the duplicate-check ahead of the per-entry pass for the
3670 // first entry only — easy regression to introduce — surfaces
3671 // here.
3672 let entries = vec![
3673 entry(
3674 "0.1.0",
3675 vec![UpgradeInstruction::LoadModule {
3676 module: String::new(),
3677 }],
3678 ),
3679 entry("0.1.0", vec![UpgradeInstruction::Restart]),
3680 ];
3681 let err = validate_upgrade_from(&entries).unwrap_err();
3682 assert_eq!(
3683 err,
3684 UpgradeError::ModuleEmpty {
3685 kind: crate::render::M2_UPGRADE_INSTRUCTION_KIND_LOAD_MODULE
3686 },
3687 "malformed instruction on the first entry of a duplicate pair must surface its \
3688 per-entry diagnostic before the duplicate gate fires, got {err:?}"
3689 );
3690 }
3691
3692 #[test]
3693 fn validate_upgrade_from_duplicate_diagnostic_names_second_collision() {
3694 // Diagnostic-shape pin: when three entries carry the same
3695 // `:from`, the gate reports the *first* collision (the second
3696 // entry) and stops — the third entry's duplicate is masked by
3697 // the first surfaced one. Mirrors
3698 // `validate_duplicate_child_diagnostic_names_first_collision`
3699 // (dbf50a9) on the supervisor axis.
3700 let entries = vec![
3701 entry("0.1.0", vec![UpgradeInstruction::Restart]),
3702 entry("0.1.0", vec![UpgradeInstruction::Restart]),
3703 entry("0.1.0", vec![UpgradeInstruction::Restart]),
3704 ];
3705 let err = validate_upgrade_from(&entries).unwrap_err();
3706 assert_eq!(
3707 err,
3708 UpgradeError::DuplicateFrom {
3709 from: "0.1.0".into()
3710 }
3711 );
3712 }
3713
3714 #[test]
3715 fn validate_upgrade_from_single_entry_never_duplicates() {
3716 // Boundary control: a list of one entry can never produce a
3717 // duplicate, regardless of `:from` value (any single-element
3718 // set is trivially without duplicates). Pin this so a future
3719 // off-by-one in the seen-set insert doesn't accidentally flag
3720 // a single entry as duplicating itself.
3721 let entries = vec![entry("0.1.0", vec![UpgradeInstruction::Restart])];
3722 validate_upgrade_from(&entries).unwrap();
3723 }
3724
3725 // ── validate_upgrade_from_against_versao: cross-slot precedence gate ─
3726
3727 #[test]
3728 fn versao_gate_accepts_strict_upgrade() {
3729 // Positive control: the canonical "chain prior versions →
3730 // current" authoring shape from ABSORPTION-ROADMAP §M2.3 — each
3731 // `:from` strictly less than the current `:versao` under
3732 // SemVer-2 precedence. The gate must not regress this baseline.
3733 let entries = vec![
3734 entry("0.1.0", vec![UpgradeInstruction::Restart]),
3735 entry("0.1.5", vec![UpgradeInstruction::Restart]),
3736 entry("0.1.9", vec![UpgradeInstruction::Restart]),
3737 ];
3738 validate_upgrade_from_against_versao(&entries, "0.2.0").unwrap();
3739 }
3740
3741 #[test]
3742 fn versao_gate_accepts_empty_entries() {
3743 // Bare `feira init` shape (no `:upgrade-from`) trivially passes;
3744 // the gate is a no-op when the entries list is empty. Mirrors
3745 // `validate_upgrade_from_accepts_empty_list` on the peer gate.
3746 validate_upgrade_from_against_versao(&[], "0.1.0").unwrap();
3747 }
3748
3749 #[test]
3750 fn versao_gate_rejects_equal_from() {
3751 // Self-upgrade no-op: declaring `:from "0.2.0"` while
3752 // `:versao "0.2.0"` means "upgrade from myself to myself" —
3753 // the operator's dispatch either skips silently or
3754 // trivially "succeeds" with no observable state change.
3755 // Reject as the canonical "I forgot to bump :versao when
3756 // adding this entry" footgun.
3757 let entries = vec![entry("0.2.0", vec![UpgradeInstruction::Restart])];
3758 let err = validate_upgrade_from_against_versao(&entries, "0.2.0").unwrap_err();
3759 assert_eq!(
3760 err,
3761 UpgradeError::FromNotBeforeVersao {
3762 from: "0.2.0".into(),
3763 versao: "0.2.0".into(),
3764 },
3765 ":from == :versao under precedence must surface as FromNotBeforeVersao naming both \
3766 values verbatim, got {err:?}"
3767 );
3768 }
3769
3770 #[test]
3771 fn versao_gate_rejects_downgrade_from() {
3772 // Downgrade-shaped: `:from "0.3.0"` while `:versao "0.2.0"`
3773 // means "upgrade nodes coming from 0.3.0 to 0.2.0", which
3774 // the operator's `:from`-match dispatch can never reach (it
3775 // never runs a version >= the current one). Reject as the
3776 // canonical "I copy-pasted from the next minor version and
3777 // forgot to bump :versao" footgun.
3778 let entries = vec![entry("0.3.0", vec![UpgradeInstruction::Restart])];
3779 let err = validate_upgrade_from_against_versao(&entries, "0.2.0").unwrap_err();
3780 assert_eq!(
3781 err,
3782 UpgradeError::FromNotBeforeVersao {
3783 from: "0.3.0".into(),
3784 versao: "0.2.0".into(),
3785 }
3786 );
3787 }
3788
3789 #[test]
3790 fn versao_gate_accepts_prerelease_before_release() {
3791 // SemVer §11 precedence: pre-release versions are *less than*
3792 // the corresponding release (`0.2.0-rc.1 < 0.2.0`). Upgrading
3793 // FROM an RC TO the GA release is the canonical authoring
3794 // shape — must pass. A regression that collapses pre-release
3795 // into the release version (treating them as equal) surfaces
3796 // here as a false-positive rejection.
3797 let entries = vec![entry("0.2.0-rc.1", vec![UpgradeInstruction::Restart])];
3798 validate_upgrade_from_against_versao(&entries, "0.2.0").unwrap();
3799 }
3800
3801 #[test]
3802 fn versao_gate_rejects_release_after_prerelease() {
3803 // Symmetric arm: with `:versao "0.2.0-rc.1"` and
3804 // `:from "0.2.0"`, precedence says `0.2.0 > 0.2.0-rc.1` —
3805 // the typical "I'm on an RC of a release that already
3806 // shipped" footgun. The gate names both values verbatim
3807 // so the author can grep for either side and fix in one
3808 // edit.
3809 let entries = vec![entry("0.2.0", vec![UpgradeInstruction::Restart])];
3810 let err = validate_upgrade_from_against_versao(&entries, "0.2.0-rc.1").unwrap_err();
3811 assert_eq!(
3812 err,
3813 UpgradeError::FromNotBeforeVersao {
3814 from: "0.2.0".into(),
3815 versao: "0.2.0-rc.1".into(),
3816 }
3817 );
3818 }
3819
3820 #[test]
3821 fn versao_gate_rejects_build_metadata_only_difference() {
3822 // SemVer §11 explicitly excludes build metadata from
3823 // precedence comparison: `0.2.0+build.1` and `0.2.0` are
3824 // *equal* under [`semver::Version::cmp`]. From the
3825 // operator's `:from`-match dispatch perspective this is a
3826 // self-upgrade no-op (no semantic transition between the
3827 // two), so the gate rejects it — *unlike* the peer
3828 // duplicate-`:from` gate which uses derived `PartialEq` and
3829 // treats build-metadata variants as distinct dispatch keys.
3830 // The two gates' different equality notions are deliberate:
3831 // duplicate-check is conservative (preserves operator-side
3832 // tiebreaking surface), precedence-check is permissive
3833 // (matches operator-side dispatch semantic).
3834 let entries = vec![entry("0.2.0+build.1", vec![UpgradeInstruction::Restart])];
3835 let err = validate_upgrade_from_against_versao(&entries, "0.2.0").unwrap_err();
3836 assert_eq!(
3837 err,
3838 UpgradeError::FromNotBeforeVersao {
3839 from: "0.2.0+build.1".into(),
3840 versao: "0.2.0".into(),
3841 }
3842 );
3843 }
3844
3845 #[test]
3846 fn versao_gate_silently_passes_on_unparseable_versao() {
3847 // Defensive arm: a malformed `:versao` (gated by the
3848 // narrower `ManifestError::VersaoInvalid` surface at the
3849 // load-bearing call site) must not regress into a
3850 // `FromNotBeforeVersao` diagnostic from this gate. Surfacing
3851 // the precedence error over an unparseable `:versao` would
3852 // mask the more actionable root cause (the author meant to
3853 // type `"0.2.0"`, not `"v0.2.0"`).
3854 let entries = vec![entry("0.1.0", vec![UpgradeInstruction::Restart])];
3855 validate_upgrade_from_against_versao(&entries, "not-a-semver").unwrap();
3856 }
3857
3858 #[test]
3859 fn versao_gate_silently_passes_on_unparseable_from() {
3860 // Symmetric defensive arm: a malformed `:from` is gated by
3861 // [`UpgradeFromEntry::validate`] / [`validate_upgrade_from`]
3862 // upstream at the LayoutInvariants call site. Surfacing the
3863 // precedence error over an unparseable `:from` from this
3864 // gate alone would mask the narrower `FromInvalid`
3865 // diagnostic that's expected to lead — same fall-through
3866 // posture as the unparseable-`:versao` arm above. The
3867 // wiring in `LayoutInvariants::verify` runs
3868 // `validate_upgrade_from` *before* this gate, so in practice
3869 // an unparseable `:from` surfaces as `FromInvalid` first
3870 // and this gate is never reached on that input.
3871 let entries = vec![entry("not-a-semver", vec![UpgradeInstruction::Restart])];
3872 validate_upgrade_from_against_versao(&entries, "0.2.0").unwrap();
3873 }
3874
3875 #[test]
3876 fn versao_gate_reports_first_offending_entry() {
3877 // Determinism pin: with multiple offending entries the gate
3878 // surfaces the *first* one in declaration order — same
3879 // posture as `validate_upgrade_from_duplicate_diagnostic_names_second_collision`
3880 // on the peer gate. Walks the entries in order; first
3881 // failing `:from >= :versao` short-circuits.
3882 let entries = vec![
3883 entry("0.1.0", vec![UpgradeInstruction::Restart]),
3884 entry("0.3.0", vec![UpgradeInstruction::Restart]),
3885 entry("0.4.0", vec![UpgradeInstruction::Restart]),
3886 ];
3887 let err = validate_upgrade_from_against_versao(&entries, "0.2.0").unwrap_err();
3888 assert_eq!(
3889 err,
3890 UpgradeError::FromNotBeforeVersao {
3891 from: "0.3.0".into(),
3892 versao: "0.2.0".into(),
3893 },
3894 "the first offending `:from` (0.3.0) must surface, not the later one (0.4.0)"
3895 );
3896 }
3897
3898 // ── UpgradeFromEntry::validate_restart_exclusive: within-entry gate ─
3899
3900 #[test]
3901 fn validate_rejects_restart_mixed_with_load_module() {
3902 // The "I'll try the typed path *then* restart anyway" footgun:
3903 // an instructions list with `(:restart)` plus `(:load-module …)`
3904 // is dead code in both directions (succeed → restart discards
3905 // the work that just succeeded, defeating the typed sequence's
3906 // whole point; fail → restart never reached because the entry
3907 // already failed). The gate names the offending entry's `:from`
3908 // verbatim plus the kebab-case lisp-form of every non-`:restart`
3909 // peer so the author can grep their caixa.lisp for either side
3910 // and fix in one edit.
3911 let e = entry(
3912 "0.1.0",
3913 vec![
3914 UpgradeInstruction::LoadModule {
3915 module: "hello-rio".into(),
3916 },
3917 UpgradeInstruction::Restart,
3918 ],
3919 );
3920 let err = e.validate().unwrap_err();
3921 assert_eq!(
3922 err,
3923 UpgradeError::RestartNotExclusive {
3924 from: "0.1.0".into(),
3925 restart_count: 1,
3926 other_kinds: vec![crate::render::M2_UPGRADE_INSTRUCTION_KIND_LOAD_MODULE],
3927 },
3928 "restart + load-module mix must surface as RestartNotExclusive naming the \
3929 offending `:from` + the non-:restart kinds verbatim, got {err:?}"
3930 );
3931 }
3932
3933 #[test]
3934 fn validate_rejects_restart_mixed_with_full_typed_sequence() {
3935 // Sweep the typed-sequence universe — every non-`:restart`
3936 // variant alongside `:restart` — and assert every typed
3937 // instruction's lisp-form appears in `other_kinds` in
3938 // declaration order. The author should be able to grep for
3939 // each verbatim (`:load-module`, `:state-change`, `:soft-purge`,
3940 // `:purge`) and resolve in one pass. Drift in the `lisp_form`
3941 // mapping surfaces here.
3942 let e = entry(
3943 "0.1.0",
3944 vec![
3945 UpgradeInstruction::LoadModule {
3946 module: "hello-rio".into(),
3947 },
3948 UpgradeInstruction::StateChange {
3949 script: PathBuf::from("lib/m.lisp"),
3950 },
3951 UpgradeInstruction::SoftPurge {
3952 module: "hello-rio-old".into(),
3953 },
3954 UpgradeInstruction::Purge {
3955 module: "hello-rio-old".into(),
3956 },
3957 UpgradeInstruction::Restart,
3958 ],
3959 );
3960 let err = e.validate().unwrap_err();
3961 assert_eq!(
3962 err,
3963 UpgradeError::RestartNotExclusive {
3964 from: "0.1.0".into(),
3965 restart_count: 1,
3966 other_kinds: vec![
3967 crate::render::M2_UPGRADE_INSTRUCTION_KIND_LOAD_MODULE,
3968 crate::render::M2_UPGRADE_INSTRUCTION_KIND_STATE_CHANGE,
3969 crate::render::M2_UPGRADE_INSTRUCTION_KIND_SOFT_PURGE,
3970 crate::render::M2_UPGRADE_INSTRUCTION_KIND_PURGE,
3971 ],
3972 },
3973 );
3974 }
3975
3976 #[test]
3977 fn validate_rejects_restart_duplicated() {
3978 // `((:restart) (:restart))` — multiple Restart variants in one
3979 // entry. The fallback is a single semantic (restart the pod;
3980 // the new version comes up fresh); repeating it is at best
3981 // redundant, at worst suggests the author thought the second
3982 // would re-trigger after the first. The gate reports
3983 // `restart_count: 2` so the diagnostic surfaces the duplication
3984 // mode unambiguously even when `other_kinds` is empty.
3985 let e = entry(
3986 "0.1.0",
3987 vec![UpgradeInstruction::Restart, UpgradeInstruction::Restart],
3988 );
3989 let err = e.validate().unwrap_err();
3990 assert_eq!(
3991 err,
3992 UpgradeError::RestartNotExclusive {
3993 from: "0.1.0".into(),
3994 restart_count: 2,
3995 other_kinds: vec![],
3996 },
3997 );
3998 }
3999
4000 #[test]
4001 fn validate_accepts_sole_restart() {
4002 // Positive control: the canonical "this prior version's typed
4003 // upgrade is impossible — restart" authoring shape from the
4004 // UpgradeInstruction::Restart doc comment. `((:restart))` alone
4005 // is the entry's whole instructions list and the only valid
4006 // Restart-bearing shape.
4007 let e = entry("0.1.0", vec![UpgradeInstruction::Restart]);
4008 e.validate().unwrap();
4009 }
4010
4011 #[test]
4012 fn validate_accepts_typed_sequence_without_restart() {
4013 // Positive control: the canonical typed hot-upgrade authoring
4014 // shape from ABSORPTION-ROADMAP §M2.3 — `:load-module` →
4015 // `:state-change` → `:soft-purge`. Absent `:restart` is the
4016 // only shape that lets the sequence run to completion under
4017 // the wasm-operator's `:from`-match dispatch. Drift here =
4018 // a future tighten that rejects any canonical typed-only shape
4019 // surfaces as a regression at this gate.
4020 let e = entry(
4021 "0.1.0",
4022 vec![
4023 UpgradeInstruction::LoadModule {
4024 module: "hello-rio".into(),
4025 },
4026 UpgradeInstruction::StateChange {
4027 script: PathBuf::from("lib/m.lisp"),
4028 },
4029 UpgradeInstruction::SoftPurge {
4030 module: "hello-rio-old".into(),
4031 },
4032 ],
4033 );
4034 e.validate().unwrap();
4035 }
4036
4037 // ── within-entry state-change-ordering invariant ───────────────────
4038
4039 #[test]
4040 fn validate_rejects_state_change_without_load() {
4041 // Fail-before-pass-after pin: a `:state-change` migrates state
4042 // into the newly-loaded code (gen_server:code_change/3 analog),
4043 // so an entry that runs it with no preceding `:load-module`
4044 // migrates state into code that was never loaded. The operator
4045 // runs instructions in declared order, so this is a build error,
4046 // not a runtime surprise (CAIXA-SDLC §III).
4047 let e = entry(
4048 "0.1.0",
4049 vec![UpgradeInstruction::StateChange {
4050 script: PathBuf::from("lib/m.lisp"),
4051 }],
4052 );
4053 let err = e.validate().unwrap_err();
4054 assert_eq!(
4055 err,
4056 UpgradeError::StateChangeWithoutPriorLoad {
4057 from: "0.1.0".into(),
4058 script: PathBuf::from("lib/m.lisp"),
4059 },
4060 "a `:state-change` with no preceding `:load-module` must surface as \
4061 StateChangeWithoutPriorLoad naming the offending entry + script verbatim"
4062 );
4063 }
4064
4065 #[test]
4066 fn validate_rejects_state_change_before_load() {
4067 // Right-instructions-wrong-order: the load is present but runs
4068 // *after* the migration. Because the operator executes in
4069 // declared order, the migration runs before the new code is
4070 // resident — the same incoherence as the missing-load case.
4071 let e = entry(
4072 "0.1.0",
4073 vec![
4074 UpgradeInstruction::StateChange {
4075 script: PathBuf::from("lib/m.lisp"),
4076 },
4077 UpgradeInstruction::LoadModule {
4078 module: "hello-rio".into(),
4079 },
4080 ],
4081 );
4082 let err = e.validate().unwrap_err();
4083 assert!(
4084 matches!(err, UpgradeError::StateChangeWithoutPriorLoad { .. }),
4085 "a `:state-change` ahead of its `:load-module` must surface as \
4086 StateChangeWithoutPriorLoad, got {err:?}"
4087 );
4088 }
4089
4090 #[test]
4091 fn validate_accepts_state_change_after_load() {
4092 // Positive control: the canonical `(:load-module …)
4093 // (:state-change …)` order validates. The load need not name
4094 // the same module the migration targets (StateChange carries a
4095 // script, not a module ref), so any preceding `:load-module`
4096 // satisfies "new code is resident before its migration runs".
4097 let e = entry(
4098 "0.1.0",
4099 vec![
4100 UpgradeInstruction::LoadModule {
4101 module: "hello-rio".into(),
4102 },
4103 UpgradeInstruction::StateChange {
4104 script: PathBuf::from("lib/m.lisp"),
4105 },
4106 ],
4107 );
4108 e.validate().unwrap();
4109 }
4110
4111 #[test]
4112 fn validate_accepts_multiple_state_changes_after_one_load() {
4113 // A single leading `:load-module` covers every subsequent
4114 // `:state-change` — the `loaded` latch stays set once the new
4115 // code is resident.
4116 let e = entry(
4117 "0.1.0",
4118 vec![
4119 UpgradeInstruction::LoadModule {
4120 module: "hello-rio".into(),
4121 },
4122 UpgradeInstruction::StateChange {
4123 script: PathBuf::from("lib/m1.lisp"),
4124 },
4125 UpgradeInstruction::StateChange {
4126 script: PathBuf::from("lib/m2.lisp"),
4127 },
4128 ],
4129 );
4130 e.validate().unwrap();
4131 }
4132
4133 #[test]
4134 fn validate_state_change_ordering_projects_scripts_through_is_load_module_and_declared_path_accessors()
4135 {
4136 // Byte-identity pin on the
4137 // [`UpgradeFromEntry::validate_state_change_ordering`] load →
4138 // migrate ordering dispatch against the pre-lift
4139 // `match instr { UpgradeInstruction::LoadModule { .. } =>
4140 // loaded = true, UpgradeInstruction::StateChange { script } if
4141 // !loaded => …, _ => {} }` open-coded pattern-match the site
4142 // previously carried. Asserts the two projections agree
4143 // byte-for-byte on every arm of the enum — the load-family
4144 // arm-discriminator via `is_load_module()` and the migration-
4145 // family `:script` scalar via `declared_path()` — so a future
4146 // derive regression that flipped the predicate's arm-set (a
4147 // hole returning `false` for [`UpgradeInstruction::LoadModule`],
4148 // a byte-collision flipping a second variant to `true`) or an
4149 // accessor extension that promoted an additional variant onto
4150 // the `PathBuf`-carrying axis would trip here at caixa-core
4151 // test time rather than laundering the arm at the gate's
4152 // per-entry ordering scan far from the derive site.
4153 //
4154 // Peer of the sibling
4155 // [`validate_load_singularity_projects_modules_through_is_load_module_and_declared_module_accessors`]
4156 // (c9ce91d) pin on the peer within-entry per-instruction-class
4157 // singularity gate's load-family + `String`-carrying dispatch,
4158 // the [`validate_purge_ordering_routes_through_is_load_module_predicate`]
4159 // (580d0f1) pin on the paired load → cleanup ordering gate's
4160 // load-family sticky-latch dispatch, and the
4161 // [`validate_state_change_singularity_projects_scripts_through_declared_path_accessor`]
4162 // pin on the peer within-entry per-instruction-class singularity
4163 // gate's migration-family script-projection dispatch — closes
4164 // the last unlifted `match`-shaped per-arm-hand-rolled load-
4165 // family arm-discriminator + migration-family script-projection
4166 // pair inside `impl UpgradeFromEntry`. The four within-entry
4167 // ordering / singularity gates now share one byte-identity pin
4168 // apiece against their respective substrate-primitive typed
4169 // dispatches on the OTP-appup closed-set enum.
4170 //
4171 // Three-arm projective coverage:
4172 // (a) `LoadModule` satisfies `is_load_module()`, so the
4173 // sticky-latch advances byte-equal to the pre-lift
4174 // `UpgradeInstruction::LoadModule { .. }` arm; every
4175 // other variant leaves the latch untouched;
4176 // (b) a `((:state-change …))`-only entry (no preceding load)
4177 // trips the gate on the first `StateChange` with
4178 // `StateChangeWithoutPriorLoad` carrying the offending
4179 // script verbatim — the migration-family script surfaces
4180 // through `declared_path()` byte-equal to the raw
4181 // `StateChange { script }` pattern-bound field;
4182 // (c) a `((:load-module …) (:state-change …))` entry leaves
4183 // the gate vacuous with `Ok(())` — the `loaded = true`
4184 // latch on the first arm satisfies the `!loaded` guard
4185 // negation on the second, so the `declared_path()`
4186 // `Some(script)` fall-through does not fire — and a
4187 // non-`StateChange`-non-`LoadModule` sequence
4188 // (`SoftPurge` / `Purge` / `Restart` alone) also leaves
4189 // the gate vacuous because `declared_path()` is `None`
4190 // on all three of those arms.
4191 //
4192 // Fail-before-pass-after verified locally: swapping the
4193 // production `if instr.is_load_module() { loaded = true; }
4194 // else if !loaded && let Some(script) = instr.declared_path()
4195 // { … }` back to `match instr { UpgradeInstruction::LoadModule
4196 // { .. } => loaded = true, UpgradeInstruction::StateChange
4197 // { script } if !loaded => …, _ => {} }` keeps arms (a)-(c)
4198 // passing but silently detaches the gate from the accessor's
4199 // typed dispatch — any future `is_load_module` / `declared_path`
4200 // extension (a hole in either predicate, a promotion of an
4201 // additional variant onto either axis, an operator-side
4202 // pre-resolved-path cache the accessor materializes) would
4203 // then silently disagree between this gate's raw pattern-match
4204 // and the peer per-`UpgradeInstruction` consumers that route
4205 // through the accessor pair.
4206
4207 // (a) is_load_module() partitions the arm-set byte-equal to
4208 // the pre-lift `matches!(_, UpgradeInstruction::LoadModule
4209 // { .. })` and declared_path() surfaces the StateChange
4210 // `:script` byte-equal to the raw field access.
4211 let lm = UpgradeInstruction::LoadModule {
4212 module: "hello-rio".into(),
4213 };
4214 assert!(
4215 lm.is_load_module(),
4216 "LoadModule must satisfy is_load_module() — the gate's \
4217 load-family sticky-latch relies on this partition"
4218 );
4219 assert!(
4220 lm.declared_path().is_none(),
4221 "LoadModule must not carry a declared_path — the gate's \
4222 else-if migration-family arm must not fire on load arms"
4223 );
4224 let sc = UpgradeInstruction::StateChange {
4225 script: PathBuf::from("lib/m.lisp"),
4226 };
4227 assert!(
4228 !sc.is_load_module(),
4229 "StateChange must not satisfy is_load_module() — the gate's \
4230 sticky-latch must not advance on migration arms"
4231 );
4232 assert_eq!(
4233 sc.declared_path().map(std::path::PathBuf::as_path),
4234 Some(PathBuf::from("lib/m.lisp").as_path()),
4235 "declared_path() must project the StateChange :script \
4236 byte-equal to the raw field access — accessor divergence \
4237 would silently detach the gate from the projection every \
4238 peer per-`UpgradeInstruction` consumer routes through"
4239 );
4240
4241 // (b) A `((:state-change …))`-only entry trips
4242 // StateChangeWithoutPriorLoad byte-identical to the
4243 // pre-lift match-pattern shape.
4244 let no_prior_load = entry(
4245 "0.1.0",
4246 vec![UpgradeInstruction::StateChange {
4247 script: PathBuf::from("lib/m.lisp"),
4248 }],
4249 );
4250 assert_eq!(
4251 no_prior_load.validate_state_change_ordering(),
4252 Err(UpgradeError::StateChangeWithoutPriorLoad {
4253 from: "0.1.0".into(),
4254 script: PathBuf::from("lib/m.lisp"),
4255 }),
4256 "a `:state-change` with no preceding `:load-module` must fire \
4257 StateChangeWithoutPriorLoad carrying the offending script \
4258 verbatim through the declared_path() accessor"
4259 );
4260
4261 // (c) `((:load-module …) (:state-change …))` leaves the gate
4262 // vacuous; so does a non-StateChange-non-LoadModule
4263 // sequence (SoftPurge / Purge / Restart alone).
4264 let load_before_migrate = entry(
4265 "0.1.0",
4266 vec![
4267 UpgradeInstruction::LoadModule {
4268 module: "hello-rio".into(),
4269 },
4270 UpgradeInstruction::StateChange {
4271 script: PathBuf::from("lib/m.lisp"),
4272 },
4273 ],
4274 );
4275 assert_eq!(
4276 load_before_migrate.validate_state_change_ordering(),
4277 Ok(()),
4278 "load-before-migrate entries must leave the ordering gate \
4279 vacuous — the `loaded = true` sticky-latch on the first arm \
4280 satisfies the `!loaded` guard negation on the else-if arm"
4281 );
4282 for instr in [
4283 UpgradeInstruction::SoftPurge {
4284 module: "x-old".into(),
4285 },
4286 UpgradeInstruction::Purge {
4287 module: "x-old".into(),
4288 },
4289 UpgradeInstruction::Restart,
4290 ] {
4291 let e = entry("0.1.0", vec![instr.clone()]);
4292 assert_eq!(
4293 e.validate_state_change_ordering(),
4294 Ok(()),
4295 "non-StateChange-non-LoadModule sequence ({instr:?}) must \
4296 leave the ordering gate vacuous — declared_path() is None \
4297 on every non-StateChange arm, so the else-if migration-\
4298 family arm never fires"
4299 );
4300 }
4301 }
4302
4303 #[test]
4304 fn validate_state_change_ordering_fires_after_restart_exclusive() {
4305 // Diagnostic-precedence pin: a `((:state-change …) (:restart))`
4306 // shape is *both* state-change-without-load and restart-mixed.
4307 // The more-fundamental `RestartNotExclusive` must win (a valid
4308 // `(:restart)` entry is `(:restart)` alone, so no Restart-bearing
4309 // entry should reach the ordering gate). Guards the call order
4310 // in `validate` against silent reordering.
4311 let e = entry(
4312 "0.1.0",
4313 vec![
4314 UpgradeInstruction::StateChange {
4315 script: PathBuf::from("lib/m.lisp"),
4316 },
4317 UpgradeInstruction::Restart,
4318 ],
4319 );
4320 let err = e.validate().unwrap_err();
4321 assert!(
4322 matches!(err, UpgradeError::RestartNotExclusive { .. }),
4323 "restart-mixed must surface before the ordering gate, got {err:?}"
4324 );
4325 }
4326
4327 // ── within-entry purge-ordering invariant ──────────────────────────
4328
4329 #[test]
4330 fn validate_rejects_soft_purge_without_load() {
4331 // Fail-before-pass-after pin: `:soft-purge` drains the *old*
4332 // module after the new one is resident (OTP's two-phase code
4333 // load — code:load_module/1 then code:soft_purge/1), so an
4334 // entry that runs it with no preceding `:load-module` drains
4335 // the live module with no replacement. The operator runs
4336 // instructions in declared order, so this is a build error,
4337 // not a runtime surprise (CAIXA-SDLC §III).
4338 let e = entry(
4339 "0.1.0",
4340 vec![UpgradeInstruction::SoftPurge {
4341 module: "x-old".into(),
4342 }],
4343 );
4344 let err = e.validate().unwrap_err();
4345 assert_eq!(
4346 err,
4347 UpgradeError::PurgeWithoutPriorLoad {
4348 from: "0.1.0".into(),
4349 kind: crate::render::M2_UPGRADE_INSTRUCTION_KIND_SOFT_PURGE,
4350 module: "x-old".into(),
4351 },
4352 "a `:soft-purge` with no preceding `:load-module` must surface as \
4353 PurgeWithoutPriorLoad naming the offending entry + kind + module verbatim"
4354 );
4355 }
4356
4357 #[test]
4358 fn validate_rejects_purge_without_load() {
4359 // Per-arm coverage: `:purge` (immediate discard, no drain) is
4360 // the more catastrophic peer of `:soft-purge`; same gate, same
4361 // shape, kind-tag differs so the author can grep their
4362 // caixa.lisp for the offending `(:purge …)` form.
4363 let e = entry(
4364 "0.1.0",
4365 vec![UpgradeInstruction::Purge {
4366 module: "x-old".into(),
4367 }],
4368 );
4369 let err = e.validate().unwrap_err();
4370 assert_eq!(
4371 err,
4372 UpgradeError::PurgeWithoutPriorLoad {
4373 from: "0.1.0".into(),
4374 kind: crate::render::M2_UPGRADE_INSTRUCTION_KIND_PURGE,
4375 module: "x-old".into(),
4376 },
4377 );
4378 }
4379
4380 #[test]
4381 fn validate_rejects_soft_purge_before_load() {
4382 // Right-instructions-wrong-order: the load is present but runs
4383 // *after* the purge. Because the operator executes in declared
4384 // order, the cleanup drains the old code before the new code
4385 // is resident — same incoherence as the missing-load case,
4386 // leaving a window during which neither version is available.
4387 let e = entry(
4388 "0.1.0",
4389 vec![
4390 UpgradeInstruction::SoftPurge {
4391 module: "x-old".into(),
4392 },
4393 UpgradeInstruction::LoadModule { module: "x".into() },
4394 ],
4395 );
4396 let err = e.validate().unwrap_err();
4397 assert!(
4398 matches!(
4399 err,
4400 UpgradeError::PurgeWithoutPriorLoad {
4401 kind: crate::render::M2_UPGRADE_INSTRUCTION_KIND_SOFT_PURGE,
4402 ..
4403 }
4404 ),
4405 "a `:soft-purge` ahead of its `:load-module` must surface as \
4406 PurgeWithoutPriorLoad, got {err:?}"
4407 );
4408 }
4409
4410 #[test]
4411 fn validate_rejects_purge_before_load() {
4412 // Symmetric arm on the `:purge` variant — the kind tag
4413 // distinguishes the diagnostic so the author lands on the
4414 // offending form directly.
4415 let e = entry(
4416 "0.1.0",
4417 vec![
4418 UpgradeInstruction::Purge {
4419 module: "x-old".into(),
4420 },
4421 UpgradeInstruction::LoadModule { module: "x".into() },
4422 ],
4423 );
4424 let err = e.validate().unwrap_err();
4425 assert!(
4426 matches!(
4427 err,
4428 UpgradeError::PurgeWithoutPriorLoad {
4429 kind: crate::render::M2_UPGRADE_INSTRUCTION_KIND_PURGE,
4430 ..
4431 }
4432 ),
4433 "a `:purge` ahead of its `:load-module` must surface as \
4434 PurgeWithoutPriorLoad, got {err:?}"
4435 );
4436 }
4437
4438 #[test]
4439 fn validate_accepts_soft_purge_after_load() {
4440 // Positive control: the canonical `(:load-module …)
4441 // (:soft-purge …)` order validates. The load need not name the
4442 // same module the purge targets — the cleanup typically targets
4443 // the *old* module name (e.g. `"x-old"`) and the load brings up
4444 // the *new* one (`"x"`); the gate only requires that *some*
4445 // `:load-module` precedes the purge, so the new code is resident
4446 // before the old one is drained.
4447 let e = entry(
4448 "0.1.0",
4449 vec![
4450 UpgradeInstruction::LoadModule { module: "x".into() },
4451 UpgradeInstruction::SoftPurge {
4452 module: "x-old".into(),
4453 },
4454 ],
4455 );
4456 e.validate().unwrap();
4457 }
4458
4459 #[test]
4460 fn validate_accepts_multiple_purges_after_one_load() {
4461 // A single leading `:load-module` covers every subsequent
4462 // `:soft-purge` / `:purge` — the `loaded` latch stays set once
4463 // the new code is resident. Same shape as
4464 // `validate_accepts_multiple_state_changes_after_one_load` on
4465 // the peer ordering gate.
4466 let e = entry(
4467 "0.1.0",
4468 vec![
4469 UpgradeInstruction::LoadModule { module: "x".into() },
4470 UpgradeInstruction::SoftPurge {
4471 module: "x-old".into(),
4472 },
4473 UpgradeInstruction::Purge {
4474 module: "x-oldest".into(),
4475 },
4476 ],
4477 );
4478 e.validate().unwrap();
4479 }
4480
4481 #[test]
4482 fn validate_purge_ordering_fires_after_state_change_ordering() {
4483 // Diagnostic-precedence pin: an entry like `((:state-change …)
4484 // (:soft-purge …))` is *both* state-change-without-load and
4485 // purge-without-load. The state-change gate must win — it's
4486 // the load-bearing semantic on this ordering contract, and
4487 // surfacing the purge diagnostic first would mask the more-
4488 // fundamental migration-against-stale-code defect. Guards the
4489 // call order in `validate` against silent reordering.
4490 let e = entry(
4491 "0.1.0",
4492 vec![
4493 UpgradeInstruction::StateChange {
4494 script: PathBuf::from("lib/m.lisp"),
4495 },
4496 UpgradeInstruction::SoftPurge {
4497 module: "x-old".into(),
4498 },
4499 ],
4500 );
4501 let err = e.validate().unwrap_err();
4502 assert!(
4503 matches!(err, UpgradeError::StateChangeWithoutPriorLoad { .. }),
4504 "state-change-without-load must surface before purge-without-load, got {err:?}"
4505 );
4506 }
4507
4508 #[test]
4509 fn validate_purge_ordering_fires_after_per_instr_shape() {
4510 // Order pin: a malformed `:module` value on a `:soft-purge` (an
4511 // empty string) surfaces its narrower kind-tagged `ModuleEmpty`
4512 // diagnostic *before* the within-entry purge-ordering gate fires.
4513 // The per-instruction shape pass walks the list inline before
4514 // the ordering checks, so the narrower self-locating diagnostic
4515 // surfaces first — mirrors the empty-first cascade on every peer
4516 // DNS-1123 gate and the `validate_restart_exclusive_fires_after_
4517 // per_instr_shape` pin on the sibling ordering gate.
4518 let e = entry(
4519 "0.1.0",
4520 vec![UpgradeInstruction::SoftPurge {
4521 module: String::new(),
4522 }],
4523 );
4524 let err = e.validate().unwrap_err();
4525 assert_eq!(
4526 err,
4527 UpgradeError::ModuleEmpty {
4528 kind: crate::render::M2_UPGRADE_INSTRUCTION_KIND_SOFT_PURGE
4529 },
4530 "malformed instruction must surface its kind-tagged diagnostic before the \
4531 purge-ordering gate fires, got {err:?}"
4532 );
4533 }
4534
4535 #[test]
4536 fn validate_purge_ordering_threads_through_validate_upgrade_from() {
4537 // The whole-list entry-point surfaces the per-entry ordering
4538 // error (mirrors
4539 // `validate_state_change_ordering_threads_through_validate_upgrade_from`):
4540 // the gate is reachable from the LayoutInvariants call site, not
4541 // only from a direct `entry.validate()`.
4542 let entries = vec![entry(
4543 "0.1.0",
4544 vec![UpgradeInstruction::Purge {
4545 module: "x-old".into(),
4546 }],
4547 )];
4548 let err = validate_upgrade_from(&entries).unwrap_err();
4549 assert!(
4550 matches!(
4551 err,
4552 UpgradeError::PurgeWithoutPriorLoad {
4553 kind: crate::render::M2_UPGRADE_INSTRUCTION_KIND_PURGE,
4554 ..
4555 }
4556 ),
4557 "validate_upgrade_from must thread the purge-ordering error, got {err:?}"
4558 );
4559 }
4560
4561 #[test]
4562 fn validate_state_change_ordering_threads_through_validate_upgrade_from() {
4563 // The whole-list entry-point surfaces the per-entry ordering
4564 // error (mirrors `validate_restart_exclusive_threads_through_…`):
4565 // the gate is reachable from the LayoutInvariants call site, not
4566 // only from a direct `entry.validate()`.
4567 let entries = vec![entry(
4568 "0.1.0",
4569 vec![UpgradeInstruction::StateChange {
4570 script: PathBuf::from("lib/m.lisp"),
4571 }],
4572 )];
4573 let err = validate_upgrade_from(&entries).unwrap_err();
4574 assert!(
4575 matches!(err, UpgradeError::StateChangeWithoutPriorLoad { .. }),
4576 "validate_upgrade_from must thread the ordering error, got {err:?}"
4577 );
4578 }
4579
4580 // ── within-entry cleanup-singularity invariant ─────────────────────
4581
4582 #[test]
4583 fn validate_rejects_duplicate_soft_purge_for_same_module() {
4584 // Fail-before-pass-after pin: `:soft-purge` drains-then-GCs
4585 // its target module (code:soft_purge/1 analog); after the
4586 // first the module is gone, so a second `:soft-purge` of the
4587 // same module is at best a no-op and at worst undefined
4588 // (depending on the operator's handling of a non-resident-
4589 // module purge). Author one cleanup per module.
4590 let e = entry(
4591 "0.1.0",
4592 vec![
4593 UpgradeInstruction::LoadModule { module: "x".into() },
4594 UpgradeInstruction::SoftPurge {
4595 module: "x-old".into(),
4596 },
4597 UpgradeInstruction::SoftPurge {
4598 module: "x-old".into(),
4599 },
4600 ],
4601 );
4602 let err = e.validate().unwrap_err();
4603 assert_eq!(
4604 err,
4605 UpgradeError::DuplicateCleanup {
4606 from: "0.1.0".into(),
4607 module: "x-old".into(),
4608 kinds: vec![
4609 crate::render::M2_UPGRADE_INSTRUCTION_KIND_SOFT_PURGE,
4610 crate::render::M2_UPGRADE_INSTRUCTION_KIND_SOFT_PURGE,
4611 ],
4612 },
4613 "two `:soft-purge` of the same module must surface as DuplicateCleanup naming the \
4614 module + both kinds in declaration order, got {err:?}"
4615 );
4616 }
4617
4618 #[test]
4619 fn validate_rejects_duplicate_purge_for_same_module() {
4620 // Per-arm coverage: `:purge` (immediate discard, no drain) is
4621 // the more catastrophic peer of `:soft-purge`; same gate, same
4622 // shape, kind-tag distinguishes so the author can grep their
4623 // caixa.lisp for the offending `(:purge …)` form.
4624 let e = entry(
4625 "0.1.0",
4626 vec![
4627 UpgradeInstruction::LoadModule { module: "x".into() },
4628 UpgradeInstruction::Purge {
4629 module: "x-old".into(),
4630 },
4631 UpgradeInstruction::Purge {
4632 module: "x-old".into(),
4633 },
4634 ],
4635 );
4636 let err = e.validate().unwrap_err();
4637 assert_eq!(
4638 err,
4639 UpgradeError::DuplicateCleanup {
4640 from: "0.1.0".into(),
4641 module: "x-old".into(),
4642 kinds: vec![
4643 crate::render::M2_UPGRADE_INSTRUCTION_KIND_PURGE,
4644 crate::render::M2_UPGRADE_INSTRUCTION_KIND_PURGE,
4645 ],
4646 },
4647 );
4648 }
4649
4650 #[test]
4651 fn validate_rejects_soft_purge_then_purge_for_same_module() {
4652 // Soft-then-hard footgun: the author wrote "drain, and if
4653 // drain doesn't clean up, force-discard", but the operator
4654 // runs declared instructions unconditionally — the `:purge`
4655 // fires whether the `:soft-purge` already discarded the
4656 // module or not, so the imagined fallback semantic is
4657 // missing. Fallback on cleanup failure is the operator's
4658 // job, not authored into the entry. Both kinds carry in
4659 // declaration order so the author can grep for either side
4660 // and pick one.
4661 let e = entry(
4662 "0.1.0",
4663 vec![
4664 UpgradeInstruction::LoadModule { module: "x".into() },
4665 UpgradeInstruction::SoftPurge {
4666 module: "x-old".into(),
4667 },
4668 UpgradeInstruction::Purge {
4669 module: "x-old".into(),
4670 },
4671 ],
4672 );
4673 let err = e.validate().unwrap_err();
4674 assert_eq!(
4675 err,
4676 UpgradeError::DuplicateCleanup {
4677 from: "0.1.0".into(),
4678 module: "x-old".into(),
4679 kinds: vec![
4680 crate::render::M2_UPGRADE_INSTRUCTION_KIND_SOFT_PURGE,
4681 crate::render::M2_UPGRADE_INSTRUCTION_KIND_PURGE,
4682 ],
4683 },
4684 );
4685 }
4686
4687 #[test]
4688 fn validate_rejects_purge_then_soft_purge_for_same_module() {
4689 // Reversed-ordering arm: `:purge` discards immediately; the
4690 // trailing `:soft-purge` has no module to drain. The kinds
4691 // list reflects declaration order so the diagnostic locates
4692 // both forms in the source.
4693 let e = entry(
4694 "0.1.0",
4695 vec![
4696 UpgradeInstruction::LoadModule { module: "x".into() },
4697 UpgradeInstruction::Purge {
4698 module: "x-old".into(),
4699 },
4700 UpgradeInstruction::SoftPurge {
4701 module: "x-old".into(),
4702 },
4703 ],
4704 );
4705 let err = e.validate().unwrap_err();
4706 assert_eq!(
4707 err,
4708 UpgradeError::DuplicateCleanup {
4709 from: "0.1.0".into(),
4710 module: "x-old".into(),
4711 kinds: vec![
4712 crate::render::M2_UPGRADE_INSTRUCTION_KIND_PURGE,
4713 crate::render::M2_UPGRADE_INSTRUCTION_KIND_SOFT_PURGE,
4714 ],
4715 },
4716 );
4717 }
4718
4719 #[test]
4720 fn validate_accepts_distinct_cleanup_modules() {
4721 // Positive control: `:soft-purge` and `:purge` on *different*
4722 // modules pass the gate. Mirrors
4723 // `validate_accepts_multiple_purges_after_one_load` — the
4724 // cleanup-singularity gate is keyed on (module), not on
4725 // (kind, module) pair, so distinct old-version names render
4726 // distinct cleanup targets and don't collide. Sweep both
4727 // same-class (two `:soft-purge` distinct modules) and cross-
4728 // class (`:soft-purge` then `:purge` distinct modules) so a
4729 // future tighten to a kind-only key (which would over-fire on
4730 // distinct modules) surfaces here.
4731 let two_soft = entry(
4732 "0.1.0",
4733 vec![
4734 UpgradeInstruction::LoadModule { module: "x".into() },
4735 UpgradeInstruction::SoftPurge {
4736 module: "x-old".into(),
4737 },
4738 UpgradeInstruction::SoftPurge {
4739 module: "x-older".into(),
4740 },
4741 ],
4742 );
4743 two_soft.validate().unwrap();
4744 let mixed = entry(
4745 "0.1.0",
4746 vec![
4747 UpgradeInstruction::LoadModule { module: "x".into() },
4748 UpgradeInstruction::SoftPurge {
4749 module: "x-old".into(),
4750 },
4751 UpgradeInstruction::Purge {
4752 module: "x-oldest".into(),
4753 },
4754 ],
4755 );
4756 mixed.validate().unwrap();
4757 }
4758
4759 #[test]
4760 fn validate_accepts_single_cleanup_per_module() {
4761 // Boundary control: a list with exactly one `:soft-purge` and
4762 // one `:purge` (distinct modules, the canonical "drain one,
4763 // hard-discard the other" shape) is the gate's identity
4764 // element. Pin so a future off-by-one in the duplicate-detection
4765 // scan doesn't accidentally flag a single occurrence as
4766 // duplicating itself — mirrors
4767 // `validate_upgrade_from_single_entry_never_duplicates` on
4768 // the peer cross-entry duplicate axis.
4769 let e = entry(
4770 "0.1.0",
4771 vec![
4772 UpgradeInstruction::LoadModule { module: "x".into() },
4773 UpgradeInstruction::SoftPurge {
4774 module: "x-old".into(),
4775 },
4776 UpgradeInstruction::Purge {
4777 module: "y-old".into(),
4778 },
4779 ],
4780 );
4781 e.validate().unwrap();
4782 }
4783
4784 #[test]
4785 fn validate_cleanup_singularity_fires_after_purge_ordering() {
4786 // Diagnostic-precedence pin: an entry like `((:soft-purge "x")
4787 // (:soft-purge "x"))` is *both* purge-without-load and
4788 // duplicate-cleanup. The more-fundamental ordering gate must
4789 // win — the missing-load defect is load-bearing (the canonical
4790 // OTP shape requires the new code be resident before any
4791 // cleanup runs), and surfacing the duplicate diagnostic first
4792 // would mask the no-replacement-window defect the ordering
4793 // gate exists to close. Guards the call order in `validate`
4794 // against silent reordering. Same posture as
4795 // `validate_purge_ordering_fires_after_state_change_ordering`
4796 // on the sibling ordering gate.
4797 let e = entry(
4798 "0.1.0",
4799 vec![
4800 UpgradeInstruction::SoftPurge {
4801 module: "x-old".into(),
4802 },
4803 UpgradeInstruction::SoftPurge {
4804 module: "x-old".into(),
4805 },
4806 ],
4807 );
4808 let err = e.validate().unwrap_err();
4809 assert!(
4810 matches!(
4811 err,
4812 UpgradeError::PurgeWithoutPriorLoad {
4813 kind: crate::render::M2_UPGRADE_INSTRUCTION_KIND_SOFT_PURGE,
4814 ..
4815 }
4816 ),
4817 "purge-without-load must surface before duplicate-cleanup, got {err:?}"
4818 );
4819 }
4820
4821 #[test]
4822 fn validate_cleanup_singularity_fires_after_per_instr_shape() {
4823 // Order pin: a malformed `:module` value on a `:soft-purge`
4824 // (an empty string) surfaces its narrower kind-tagged
4825 // `ModuleEmpty` diagnostic *before* the within-entry cleanup-
4826 // singularity gate fires. The per-instruction shape pass walks
4827 // the list inline before the singularity check, so the
4828 // narrower self-locating diagnostic surfaces first — mirrors
4829 // the empty-first cascade on every peer DNS-1123 gate and the
4830 // `validate_purge_ordering_fires_after_per_instr_shape` pin on
4831 // the sibling ordering gate.
4832 //
4833 // Two empty-string `:soft-purge` would *otherwise* duplicate
4834 // (both modules are the same empty string), so this pin
4835 // double-locks the precedence: the per-instr shape gate must
4836 // win on the first malformed instruction before the duplicate
4837 // scan even reaches the second.
4838 let e = entry(
4839 "0.1.0",
4840 vec![
4841 UpgradeInstruction::LoadModule { module: "x".into() },
4842 UpgradeInstruction::SoftPurge {
4843 module: String::new(),
4844 },
4845 UpgradeInstruction::SoftPurge {
4846 module: String::new(),
4847 },
4848 ],
4849 );
4850 let err = e.validate().unwrap_err();
4851 assert_eq!(
4852 err,
4853 UpgradeError::ModuleEmpty {
4854 kind: crate::render::M2_UPGRADE_INSTRUCTION_KIND_SOFT_PURGE
4855 },
4856 "malformed instruction must surface its kind-tagged diagnostic before the \
4857 cleanup-singularity gate fires, got {err:?}"
4858 );
4859 }
4860
4861 #[test]
4862 fn validate_cleanup_singularity_reports_first_collision() {
4863 // Determinism pin: with three cleanups of the same module the
4864 // gate reports the *first* collision (the second occurrence)
4865 // and stops — the third's duplicate is masked by the first
4866 // surfaced one. Mirrors
4867 // `validate_upgrade_from_duplicate_diagnostic_names_second_collision`
4868 // on the peer cross-entry duplicate axis.
4869 let e = entry(
4870 "0.1.0",
4871 vec![
4872 UpgradeInstruction::LoadModule { module: "x".into() },
4873 UpgradeInstruction::SoftPurge {
4874 module: "x-old".into(),
4875 },
4876 UpgradeInstruction::SoftPurge {
4877 module: "x-old".into(),
4878 },
4879 UpgradeInstruction::Purge {
4880 module: "x-old".into(),
4881 },
4882 ],
4883 );
4884 let err = e.validate().unwrap_err();
4885 assert_eq!(
4886 err,
4887 UpgradeError::DuplicateCleanup {
4888 from: "0.1.0".into(),
4889 module: "x-old".into(),
4890 kinds: vec![
4891 crate::render::M2_UPGRADE_INSTRUCTION_KIND_SOFT_PURGE,
4892 crate::render::M2_UPGRADE_INSTRUCTION_KIND_SOFT_PURGE,
4893 ],
4894 },
4895 "the first colliding pair must surface, not the later `:purge` collision"
4896 );
4897 }
4898
4899 #[test]
4900 fn validate_cleanup_singularity_threads_through_validate_upgrade_from() {
4901 // The whole-list entry-point surfaces the per-entry singularity
4902 // error (mirrors
4903 // `validate_purge_ordering_threads_through_validate_upgrade_from`):
4904 // the gate is reachable from the LayoutInvariants call site,
4905 // not only from a direct `entry.validate()`.
4906 let entries = vec![entry(
4907 "0.1.0",
4908 vec![
4909 UpgradeInstruction::LoadModule { module: "x".into() },
4910 UpgradeInstruction::SoftPurge {
4911 module: "x-old".into(),
4912 },
4913 UpgradeInstruction::Purge {
4914 module: "x-old".into(),
4915 },
4916 ],
4917 )];
4918 let err = validate_upgrade_from(&entries).unwrap_err();
4919 assert!(
4920 matches!(err, UpgradeError::DuplicateCleanup { .. }),
4921 "validate_upgrade_from must thread the cleanup-singularity error, got {err:?}"
4922 );
4923 }
4924
4925 #[test]
4926 fn validate_rejects_duplicate_load_module_for_same_module() {
4927 // `LoadModule` is the `code:load_module/1` analog (INSPIRATIONS
4928 // §II.4): each module is loaded exactly once per upgrade entry,
4929 // the operator's dispatch table reads the module name to bind
4930 // the wasm component, and a second `(:load-module "x")` re-reads
4931 // the same module name and re-binds the same component — a
4932 // no-op the second time. systools-generated `.relup` files emit
4933 // at most one `load_module` per module per upgrade step for
4934 // this reason. Author one `(:load-module "x")` per old module.
4935 let e = entry(
4936 "0.1.0",
4937 vec![
4938 UpgradeInstruction::LoadModule { module: "x".into() },
4939 UpgradeInstruction::LoadModule { module: "x".into() },
4940 ],
4941 );
4942 let err = e.validate().unwrap_err();
4943 assert_eq!(
4944 err,
4945 UpgradeError::DuplicateLoadModule {
4946 from: "0.1.0".into(),
4947 module: "x".into(),
4948 },
4949 "two `:load-module` of the same module must surface as DuplicateLoadModule naming \
4950 the module, got {err:?}"
4951 );
4952 }
4953
4954 #[test]
4955 fn validate_accepts_distinct_load_modules() {
4956 // Positive control: `:load-module` instructions on *different*
4957 // modules pass the gate. Mirrors
4958 // `validate_accepts_distinct_cleanup_modules` on the sibling
4959 // singularity axis — the load-singularity gate is keyed on
4960 // (module), so distinct module names render distinct load
4961 // targets and don't collide. Sweep both the bare two-load shape
4962 // and the canonical load-pair-with-cleanup shape so a future
4963 // tighten that over-fires on distinct loads surfaces here.
4964 let two_loads = entry(
4965 "0.1.0",
4966 vec![
4967 UpgradeInstruction::LoadModule { module: "x".into() },
4968 UpgradeInstruction::LoadModule { module: "y".into() },
4969 ],
4970 );
4971 two_loads.validate().unwrap();
4972 let with_cleanup = entry(
4973 "0.1.0",
4974 vec![
4975 UpgradeInstruction::LoadModule { module: "x".into() },
4976 UpgradeInstruction::LoadModule { module: "y".into() },
4977 UpgradeInstruction::SoftPurge {
4978 module: "x-old".into(),
4979 },
4980 UpgradeInstruction::SoftPurge {
4981 module: "y-old".into(),
4982 },
4983 ],
4984 );
4985 with_cleanup.validate().unwrap();
4986 }
4987
4988 #[test]
4989 fn validate_accepts_single_load_per_module() {
4990 // Boundary control: a list with exactly one `:load-module`
4991 // followed by the canonical `:state-change` + `:soft-purge`
4992 // sequence (the module-doc OTP shape) is the gate's identity
4993 // element. Pin so a future off-by-one in the duplicate-
4994 // detection scan doesn't accidentally flag a single occurrence
4995 // as duplicating itself — mirrors
4996 // `validate_accepts_single_cleanup_per_module` on the sibling
4997 // singularity axis.
4998 let e = entry(
4999 "0.1.0",
5000 vec![
5001 UpgradeInstruction::LoadModule { module: "x".into() },
5002 UpgradeInstruction::StateChange {
5003 script: PathBuf::from("lib/migrations/v01-to-v02.lisp"),
5004 },
5005 UpgradeInstruction::SoftPurge {
5006 module: "x-old".into(),
5007 },
5008 ],
5009 );
5010 e.validate().unwrap();
5011 }
5012
5013 #[test]
5014 fn validate_load_singularity_fires_after_state_change_ordering() {
5015 // Diagnostic-precedence pin: an entry like `((:state-change
5016 // "m.lisp") (:load-module "x") (:load-module "x"))` is *both*
5017 // state-change-without-load and duplicate-load. The more-
5018 // fundamental ordering gate must win — the missing-load defect
5019 // is load-bearing (the migration runs against unloaded code),
5020 // and surfacing the duplicate diagnostic first would mask the
5021 // migrate-into-unloaded-code defect the ordering gate exists
5022 // to close. Guards the call order in `validate` against silent
5023 // reordering. Same posture as
5024 // `validate_cleanup_singularity_fires_after_purge_ordering`
5025 // on the sibling singularity gate.
5026 let e = entry(
5027 "0.1.0",
5028 vec![
5029 UpgradeInstruction::StateChange {
5030 script: PathBuf::from("lib/m.lisp"),
5031 },
5032 UpgradeInstruction::LoadModule { module: "x".into() },
5033 UpgradeInstruction::LoadModule { module: "x".into() },
5034 ],
5035 );
5036 let err = e.validate().unwrap_err();
5037 assert!(
5038 matches!(err, UpgradeError::StateChangeWithoutPriorLoad { .. }),
5039 "state-change-without-load must surface before duplicate-load, got {err:?}"
5040 );
5041 }
5042
5043 #[test]
5044 fn validate_load_singularity_fires_after_purge_ordering() {
5045 // Diagnostic-precedence pin: an entry like `((:soft-purge
5046 // "x-old") (:load-module "x") (:load-module "x"))` is *both*
5047 // purge-without-load and duplicate-load. The more-fundamental
5048 // ordering gate must win — the missing-load defect is load-
5049 // bearing (the cleanup runs against no-replacement-window),
5050 // and surfacing the duplicate diagnostic first would mask the
5051 // drain-to-nothing defect the ordering gate exists to close.
5052 // Sibling of
5053 // `validate_cleanup_singularity_fires_after_purge_ordering` on
5054 // the load-singularity axis.
5055 let e = entry(
5056 "0.1.0",
5057 vec![
5058 UpgradeInstruction::SoftPurge {
5059 module: "x-old".into(),
5060 },
5061 UpgradeInstruction::LoadModule { module: "x".into() },
5062 UpgradeInstruction::LoadModule { module: "x".into() },
5063 ],
5064 );
5065 let err = e.validate().unwrap_err();
5066 assert!(
5067 matches!(
5068 err,
5069 UpgradeError::PurgeWithoutPriorLoad {
5070 kind: crate::render::M2_UPGRADE_INSTRUCTION_KIND_SOFT_PURGE,
5071 ..
5072 }
5073 ),
5074 "purge-without-load must surface before duplicate-load, got {err:?}"
5075 );
5076 }
5077
5078 #[test]
5079 fn validate_load_singularity_fires_after_per_instr_shape() {
5080 // Order pin: a malformed `:module` value on a `:load-module`
5081 // (an empty string) surfaces its narrower kind-tagged
5082 // `ModuleEmpty` diagnostic *before* the within-entry load-
5083 // singularity gate fires. The per-instruction shape pass walks
5084 // the list inline before the singularity check, so the
5085 // narrower self-locating diagnostic surfaces first — mirrors
5086 // the empty-first cascade on every peer DNS-1123 gate and the
5087 // `validate_cleanup_singularity_fires_after_per_instr_shape`
5088 // pin on the sibling singularity gate.
5089 //
5090 // Two empty-string `:load-module` would *otherwise* duplicate
5091 // (both modules are the same empty string), so this pin
5092 // double-locks the precedence: the per-instr shape gate must
5093 // win on the first malformed instruction before the duplicate
5094 // scan even reaches the second.
5095 let e = entry(
5096 "0.1.0",
5097 vec![
5098 UpgradeInstruction::LoadModule {
5099 module: String::new(),
5100 },
5101 UpgradeInstruction::LoadModule {
5102 module: String::new(),
5103 },
5104 ],
5105 );
5106 let err = e.validate().unwrap_err();
5107 assert_eq!(
5108 err,
5109 UpgradeError::ModuleEmpty {
5110 kind: crate::render::M2_UPGRADE_INSTRUCTION_KIND_LOAD_MODULE,
5111 },
5112 "malformed instruction must surface its kind-tagged diagnostic before the \
5113 load-singularity gate fires, got {err:?}"
5114 );
5115 }
5116
5117 #[test]
5118 fn validate_load_singularity_fires_before_cleanup_singularity() {
5119 // Diagnostic-precedence pin: an entry that violates *both*
5120 // singularities — duplicate load on "x" *and* duplicate cleanup
5121 // on "y-old" — must surface the load-side diagnostic first.
5122 // The load axis precedes the cleanup axis in the canonical OTP
5123 // sequence (`code:load_module/1` then `code:soft_purge/1`) and
5124 // in [`UpgradeInstruction`] declaration order (LoadModule
5125 // before SoftPurge/Purge), so the load-side singularity is the
5126 // load-bearing diagnostic when both fire — the cleanup-side
5127 // duplicate is meaningless either way without a coherent load.
5128 // Guards the call order in `validate`: `validate_load_singularity`
5129 // runs before `validate_cleanup_singularity`.
5130 let e = entry(
5131 "0.1.0",
5132 vec![
5133 UpgradeInstruction::LoadModule { module: "x".into() },
5134 UpgradeInstruction::LoadModule { module: "x".into() },
5135 UpgradeInstruction::SoftPurge {
5136 module: "y-old".into(),
5137 },
5138 UpgradeInstruction::SoftPurge {
5139 module: "y-old".into(),
5140 },
5141 ],
5142 );
5143 let err = e.validate().unwrap_err();
5144 assert_eq!(
5145 err,
5146 UpgradeError::DuplicateLoadModule {
5147 from: "0.1.0".into(),
5148 module: "x".into(),
5149 },
5150 "duplicate-load must surface before duplicate-cleanup, got {err:?}"
5151 );
5152 }
5153
5154 #[test]
5155 fn validate_load_singularity_reports_first_collision() {
5156 // Determinism pin: with three loads of the same module the gate
5157 // reports the *first* collision (the second occurrence) and
5158 // stops — the third's duplicate is masked by the first surfaced
5159 // one. Mirrors
5160 // `validate_cleanup_singularity_reports_first_collision` on the
5161 // sibling singularity axis and every peer duplicate gate's
5162 // first-collision discipline.
5163 let e = entry(
5164 "0.1.0",
5165 vec![
5166 UpgradeInstruction::LoadModule { module: "x".into() },
5167 UpgradeInstruction::LoadModule { module: "x".into() },
5168 UpgradeInstruction::LoadModule { module: "x".into() },
5169 ],
5170 );
5171 let err = e.validate().unwrap_err();
5172 assert_eq!(
5173 err,
5174 UpgradeError::DuplicateLoadModule {
5175 from: "0.1.0".into(),
5176 module: "x".into(),
5177 },
5178 "the first colliding occurrence must surface, not the later third-load collision"
5179 );
5180 }
5181
5182 #[test]
5183 fn validate_load_singularity_threads_through_validate_upgrade_from() {
5184 // The whole-list entry-point surfaces the per-entry singularity
5185 // error (mirrors
5186 // `validate_cleanup_singularity_threads_through_validate_upgrade_from`):
5187 // the gate is reachable from the LayoutInvariants call site,
5188 // not only from a direct `entry.validate()`.
5189 let entries = vec![entry(
5190 "0.1.0",
5191 vec![
5192 UpgradeInstruction::LoadModule { module: "x".into() },
5193 UpgradeInstruction::LoadModule { module: "x".into() },
5194 ],
5195 )];
5196 let err = validate_upgrade_from(&entries).unwrap_err();
5197 assert!(
5198 matches!(err, UpgradeError::DuplicateLoadModule { .. }),
5199 "validate_upgrade_from must thread the load-singularity error, got {err:?}"
5200 );
5201 }
5202
5203 // ── within-entry state-change-singularity invariant ────────────────
5204
5205 #[test]
5206 fn validate_rejects_duplicate_state_change_for_same_script() {
5207 // `StateChange` is the `gen_server:code_change/3` analog
5208 // (INSPIRATIONS §II.4): the script folds the prior-version
5209 // state shape into the current-version shape — a one-shot
5210 // transition, not a step that composes with itself. OTP's
5211 // release_handler invokes `code_change/3` exactly once per
5212 // upgrade per gen_server; systools-generated `.relup` files
5213 // emit at most one `code_change` per gen_server per upgrade
5214 // step for this reason. A second `(:state-change "m.lisp")`
5215 // re-runs the same fold on the already-migrated state — at
5216 // best a no-op and at worst silent state corruption from
5217 // double-applied non-idempotent transforms (`add column`,
5218 // `increment counter`, `rename field`). Author one
5219 // `(:state-change "m.lisp")` per migration script per entry.
5220 let e = entry(
5221 "0.1.0",
5222 vec![
5223 UpgradeInstruction::LoadModule { module: "x".into() },
5224 UpgradeInstruction::StateChange {
5225 script: PathBuf::from("lib/migrations/v01-to-v02.lisp"),
5226 },
5227 UpgradeInstruction::StateChange {
5228 script: PathBuf::from("lib/migrations/v01-to-v02.lisp"),
5229 },
5230 ],
5231 );
5232 let err = e.validate().unwrap_err();
5233 assert_eq!(
5234 err,
5235 UpgradeError::DuplicateStateChange {
5236 from: "0.1.0".into(),
5237 script: PathBuf::from("lib/migrations/v01-to-v02.lisp"),
5238 },
5239 "two `:state-change` of the same script must surface as DuplicateStateChange naming \
5240 the script, got {err:?}"
5241 );
5242 }
5243
5244 #[test]
5245 fn validate_accepts_distinct_state_change_scripts() {
5246 // Positive control: `:state-change` instructions on *different*
5247 // scripts pass the gate. Mirrors
5248 // `validate_accepts_distinct_cleanup_modules` /
5249 // `validate_accepts_distinct_load_modules` on the sibling
5250 // singularity axes — the state-change-singularity gate is keyed
5251 // on the script PathBuf, so distinct scripts render distinct
5252 // migration targets and don't collide. Sweep both the bare two-
5253 // migration shape and the canonical load-pair-with-cleanup shape
5254 // so a future tighten that over-fires on distinct scripts
5255 // surfaces here. This positive control is the gate-level peer of
5256 // `validate_accepts_multiple_state_changes_after_one_load` (the
5257 // ordering-gate positive control on distinct scripts), pinned
5258 // here independently so a future refactor that decouples the
5259 // gates can't accidentally drop coverage on either.
5260 let two_migrations = entry(
5261 "0.1.0",
5262 vec![
5263 UpgradeInstruction::LoadModule { module: "x".into() },
5264 UpgradeInstruction::StateChange {
5265 script: PathBuf::from("lib/m1.lisp"),
5266 },
5267 UpgradeInstruction::StateChange {
5268 script: PathBuf::from("lib/m2.lisp"),
5269 },
5270 ],
5271 );
5272 two_migrations.validate().unwrap();
5273 let with_cleanup = entry(
5274 "0.1.0",
5275 vec![
5276 UpgradeInstruction::LoadModule { module: "x".into() },
5277 UpgradeInstruction::StateChange {
5278 script: PathBuf::from("lib/m1.lisp"),
5279 },
5280 UpgradeInstruction::StateChange {
5281 script: PathBuf::from("lib/m2.lisp"),
5282 },
5283 UpgradeInstruction::SoftPurge {
5284 module: "x-old".into(),
5285 },
5286 ],
5287 );
5288 with_cleanup.validate().unwrap();
5289 }
5290
5291 #[test]
5292 fn validate_accepts_single_state_change_per_script() {
5293 // Boundary control: a list with exactly one `:state-change`
5294 // wrapped by the canonical `:load-module` + `:soft-purge`
5295 // sequence (the module-doc OTP shape) is the gate's identity
5296 // element. Pin so a future off-by-one in the duplicate-
5297 // detection scan doesn't accidentally flag a single occurrence
5298 // as duplicating itself — mirrors
5299 // `validate_accepts_single_load_per_module` /
5300 // `validate_accepts_single_cleanup_per_module` on the sibling
5301 // singularity axes.
5302 let e = entry(
5303 "0.1.0",
5304 vec![
5305 UpgradeInstruction::LoadModule { module: "x".into() },
5306 UpgradeInstruction::StateChange {
5307 script: PathBuf::from("lib/migrations/v01-to-v02.lisp"),
5308 },
5309 UpgradeInstruction::SoftPurge {
5310 module: "x-old".into(),
5311 },
5312 ],
5313 );
5314 e.validate().unwrap();
5315 }
5316
5317 #[test]
5318 fn validate_state_change_singularity_fires_after_state_change_ordering() {
5319 // Diagnostic-precedence pin: an entry like `((:state-change
5320 // "m.lisp") (:state-change "m.lisp"))` is *both* state-change-
5321 // without-load and duplicate-state-change. The more-fundamental
5322 // ordering gate must win — the missing-load defect is load-
5323 // bearing (the migration runs against unloaded code), and
5324 // surfacing the duplicate diagnostic first would mask the
5325 // migrate-into-unloaded-code defect the ordering gate exists to
5326 // close. Guards the call order in `validate` against silent
5327 // reordering. Same posture as
5328 // `validate_load_singularity_fires_after_state_change_ordering`
5329 // on the sibling singularity gate.
5330 //
5331 // Two same-script `:state-change` would *otherwise* duplicate
5332 // (both scripts collide on the very first `:state-change`-
5333 // without-load encountered), so this pin double-locks the
5334 // precedence: the ordering gate must win on the first un-loaded
5335 // `:state-change` before the singularity scan even reaches the
5336 // second.
5337 let e = entry(
5338 "0.1.0",
5339 vec![
5340 UpgradeInstruction::StateChange {
5341 script: PathBuf::from("lib/m.lisp"),
5342 },
5343 UpgradeInstruction::StateChange {
5344 script: PathBuf::from("lib/m.lisp"),
5345 },
5346 ],
5347 );
5348 let err = e.validate().unwrap_err();
5349 assert!(
5350 matches!(err, UpgradeError::StateChangeWithoutPriorLoad { .. }),
5351 "state-change-without-load must surface before duplicate-state-change, got {err:?}"
5352 );
5353 }
5354
5355 #[test]
5356 fn validate_state_change_singularity_fires_after_purge_ordering() {
5357 // Diagnostic-precedence pin: an entry like `((:soft-purge
5358 // "x-old") (:load-module "x") (:state-change "m.lisp")
5359 // (:state-change "m.lisp"))` is *both* purge-without-load and
5360 // duplicate-state-change. The more-fundamental ordering gate
5361 // must win — the missing-load defect (a cleanup that drains the
5362 // only resident version to nothing) is load-bearing, and
5363 // surfacing the duplicate diagnostic first would mask the
5364 // drain-to-nothing defect the ordering gate exists to close.
5365 // Sibling of `validate_load_singularity_fires_after_purge_ordering`
5366 // on the state-change-singularity axis.
5367 let e = entry(
5368 "0.1.0",
5369 vec![
5370 UpgradeInstruction::SoftPurge {
5371 module: "x-old".into(),
5372 },
5373 UpgradeInstruction::LoadModule { module: "x".into() },
5374 UpgradeInstruction::StateChange {
5375 script: PathBuf::from("lib/m.lisp"),
5376 },
5377 UpgradeInstruction::StateChange {
5378 script: PathBuf::from("lib/m.lisp"),
5379 },
5380 ],
5381 );
5382 let err = e.validate().unwrap_err();
5383 assert!(
5384 matches!(
5385 err,
5386 UpgradeError::PurgeWithoutPriorLoad {
5387 kind: crate::render::M2_UPGRADE_INSTRUCTION_KIND_SOFT_PURGE,
5388 ..
5389 }
5390 ),
5391 "purge-without-load must surface before duplicate-state-change, got {err:?}"
5392 );
5393 }
5394
5395 #[test]
5396 fn validate_state_change_singularity_fires_after_per_instr_shape() {
5397 // Order pin: a malformed `:script` value on a `:state-change`
5398 // (an empty path) surfaces its narrower `EmptyScript` diagnostic
5399 // *before* the within-entry state-change-singularity gate fires.
5400 // The per-instruction shape pass walks the list inline before
5401 // the singularity check, so the narrower self-locating
5402 // diagnostic surfaces first — mirrors the empty-first cascade on
5403 // every peer path-shape gate and the
5404 // `validate_load_singularity_fires_after_per_instr_shape` /
5405 // `validate_cleanup_singularity_fires_after_per_instr_shape`
5406 // pins on the sibling singularity gates.
5407 //
5408 // Two empty-path `:state-change` would *otherwise* duplicate
5409 // (both scripts are the same empty PathBuf), so this pin double-
5410 // locks the precedence: the per-instr shape gate must win on the
5411 // first malformed instruction before the duplicate scan even
5412 // reaches the second.
5413 let e = entry(
5414 "0.1.0",
5415 vec![
5416 UpgradeInstruction::LoadModule { module: "x".into() },
5417 UpgradeInstruction::StateChange {
5418 script: PathBuf::new(),
5419 },
5420 UpgradeInstruction::StateChange {
5421 script: PathBuf::new(),
5422 },
5423 ],
5424 );
5425 let err = e.validate().unwrap_err();
5426 assert_eq!(
5427 err,
5428 UpgradeError::EmptyScript,
5429 "malformed instruction must surface its narrower diagnostic before the \
5430 state-change-singularity gate fires, got {err:?}"
5431 );
5432 }
5433
5434 #[test]
5435 fn validate_state_change_singularity_fires_after_load_singularity() {
5436 // Diagnostic-precedence pin: an entry that violates *both*
5437 // singularities — duplicate load on "x" *and* duplicate
5438 // state-change on "m.lisp" — must surface the load-side
5439 // diagnostic first. The load axis precedes the migration axis
5440 // in the canonical OTP sequence (`code:load_module/1` then
5441 // `gen_server:code_change/3`) and in [`UpgradeInstruction`]
5442 // declaration order (LoadModule before StateChange), so the
5443 // load-side singularity is the load-bearing diagnostic when
5444 // both fire — the migration-side duplicate is meaningless
5445 // either way without a coherent load. Guards the call order in
5446 // `validate`: `validate_load_singularity` runs before
5447 // `validate_state_change_singularity`.
5448 let e = entry(
5449 "0.1.0",
5450 vec![
5451 UpgradeInstruction::LoadModule { module: "x".into() },
5452 UpgradeInstruction::LoadModule { module: "x".into() },
5453 UpgradeInstruction::StateChange {
5454 script: PathBuf::from("lib/m.lisp"),
5455 },
5456 UpgradeInstruction::StateChange {
5457 script: PathBuf::from("lib/m.lisp"),
5458 },
5459 ],
5460 );
5461 let err = e.validate().unwrap_err();
5462 assert_eq!(
5463 err,
5464 UpgradeError::DuplicateLoadModule {
5465 from: "0.1.0".into(),
5466 module: "x".into(),
5467 },
5468 "duplicate-load must surface before duplicate-state-change, got {err:?}"
5469 );
5470 }
5471
5472 #[test]
5473 fn validate_state_change_singularity_fires_before_cleanup_singularity() {
5474 // Diagnostic-precedence pin: an entry that violates *both*
5475 // singularities — duplicate state-change on "m.lisp" *and*
5476 // duplicate cleanup on "y-old" — must surface the migration-
5477 // side diagnostic first. The migration axis precedes the
5478 // cleanup axis in the canonical OTP sequence
5479 // (`gen_server:code_change/3` then `code:soft_purge/1`) and in
5480 // [`UpgradeInstruction`] declaration order (StateChange before
5481 // SoftPurge/Purge), so the migration-side singularity is the
5482 // load-bearing diagnostic when both fire — the cleanup-side
5483 // duplicate is irrelevant once the migration has corrupted
5484 // state by double-applying. Guards the call order in
5485 // `validate`: `validate_state_change_singularity` runs before
5486 // `validate_cleanup_singularity`.
5487 let e = entry(
5488 "0.1.0",
5489 vec![
5490 UpgradeInstruction::LoadModule { module: "x".into() },
5491 UpgradeInstruction::StateChange {
5492 script: PathBuf::from("lib/m.lisp"),
5493 },
5494 UpgradeInstruction::StateChange {
5495 script: PathBuf::from("lib/m.lisp"),
5496 },
5497 UpgradeInstruction::SoftPurge {
5498 module: "y-old".into(),
5499 },
5500 UpgradeInstruction::SoftPurge {
5501 module: "y-old".into(),
5502 },
5503 ],
5504 );
5505 let err = e.validate().unwrap_err();
5506 assert_eq!(
5507 err,
5508 UpgradeError::DuplicateStateChange {
5509 from: "0.1.0".into(),
5510 script: PathBuf::from("lib/m.lisp"),
5511 },
5512 "duplicate-state-change must surface before duplicate-cleanup, got {err:?}"
5513 );
5514 }
5515
5516 #[test]
5517 fn validate_state_change_singularity_reports_first_collision() {
5518 // Determinism pin: with three state-changes on the same script
5519 // the gate reports the *first* collision (the second
5520 // occurrence) and stops — the third's duplicate is masked by
5521 // the first surfaced one. Mirrors
5522 // `validate_load_singularity_reports_first_collision` /
5523 // `validate_cleanup_singularity_reports_first_collision` on the
5524 // sibling singularity axes and every peer duplicate gate's
5525 // first-collision discipline.
5526 let e = entry(
5527 "0.1.0",
5528 vec![
5529 UpgradeInstruction::LoadModule { module: "x".into() },
5530 UpgradeInstruction::StateChange {
5531 script: PathBuf::from("lib/m.lisp"),
5532 },
5533 UpgradeInstruction::StateChange {
5534 script: PathBuf::from("lib/m.lisp"),
5535 },
5536 UpgradeInstruction::StateChange {
5537 script: PathBuf::from("lib/m.lisp"),
5538 },
5539 ],
5540 );
5541 let err = e.validate().unwrap_err();
5542 assert_eq!(
5543 err,
5544 UpgradeError::DuplicateStateChange {
5545 from: "0.1.0".into(),
5546 script: PathBuf::from("lib/m.lisp"),
5547 },
5548 "the first colliding occurrence must surface, not the later third-migration collision"
5549 );
5550 }
5551
5552 #[test]
5553 fn validate_state_change_singularity_threads_through_validate_upgrade_from() {
5554 // The whole-list entry-point surfaces the per-entry singularity
5555 // error (mirrors
5556 // `validate_load_singularity_threads_through_validate_upgrade_from`
5557 // / `validate_cleanup_singularity_threads_through_validate_upgrade_from`):
5558 // the gate is reachable from the LayoutInvariants call site,
5559 // not only from a direct `entry.validate()`.
5560 let entries = vec![entry(
5561 "0.1.0",
5562 vec![
5563 UpgradeInstruction::LoadModule { module: "x".into() },
5564 UpgradeInstruction::StateChange {
5565 script: PathBuf::from("lib/m.lisp"),
5566 },
5567 UpgradeInstruction::StateChange {
5568 script: PathBuf::from("lib/m.lisp"),
5569 },
5570 ],
5571 )];
5572 let err = validate_upgrade_from(&entries).unwrap_err();
5573 assert!(
5574 matches!(err, UpgradeError::DuplicateStateChange { .. }),
5575 "validate_upgrade_from must thread the state-change-singularity error, got {err:?}"
5576 );
5577 }
5578
5579 #[test]
5580 fn validate_state_change_singularity_projects_scripts_through_declared_path_accessor() {
5581 // Composition pin: [`UpgradeFromEntry::validate_state_change_singularity`]'s
5582 // per-instruction `StateChange`-arm script-path projection must
5583 // route through the sibling lifted
5584 // [`UpgradeInstruction::declared_path`] `Option<&PathBuf>`
5585 // accessor, not the raw
5586 // `match instr { UpgradeInstruction::StateChange { script } =>
5587 // script.as_path(), _ => continue }` open-coded pattern-match
5588 // the gate previously carried.
5589 //
5590 // Structurally: the gate's projection accept-set is the union
5591 // of every [`UpgradeInstruction`] variant for which
5592 // `declared_path().is_some()` — today exactly
5593 // [`UpgradeInstruction::StateChange`] per the sibling
5594 // `declared_path_only_for_state_change` pin, so a
5595 // duplicate-scripts input trips `DuplicateStateChange` and a
5596 // non-`StateChange` input (module-bearing / terminal) leaves
5597 // `seen` empty and the gate returns `Ok(())` byte-identical to
5598 // the pattern-match shape.
5599 //
5600 // Byte-equal today (`declared_path` returns `Some(script)` iff
5601 // `StateChange`, byte-for-byte from the variant's own storage);
5602 // the pin catches any future accessor extension that promotes
5603 // an additional variant onto the `PathBuf`-carrying axis — the
5604 // gate then fires on duplicate scripts from that variant too,
5605 // and the singularity discipline the sibling
5606 // `validate_load_singularity` / `validate_cleanup_singularity`
5607 // gates share on the `String`-carrying axis's per-variant
5608 // consumers extends to the promoted variant by construction.
5609 //
5610 // Peer of the sibling four per-`UpgradeInstruction` consumers
5611 // ([`UpgradeInstruction::validate`]'s per-`StateChange`
5612 // sandbox-path fan-out, the layout-side per-`StateChange`
5613 // script-existence fan-out at
5614 // `caixa-core/src/layout.rs:1017`, the cross-slot
5615 // [`validate_upgrade_from_against_behavior`] gate's per-
5616 // `StateChange` detection loop, the peer
5617 // [`UpgradeInstruction::declared_module`] `String`-axis
5618 // per-variant unifier) — this gate now shares one typed
5619 // dispatch on the substrate primitive's `PathBuf`-carrying
5620 // axis with those consumers, so a future rebrand on the axis
5621 // migrates as a single caixa-core edit rather than a
5622 // coordinated rewrite of five call sites.
5623 //
5624 // Three-arm projective coverage:
5625 // (a) `StateChange` scripts project through `declared_path()`
5626 // byte-equal to the raw `script.as_path()` field access;
5627 // (b) a duplicate-`StateChange` input trips the gate on the
5628 // second occurrence with `DuplicateStateChange` carrying
5629 // the offending script verbatim;
5630 // (c) a non-`StateChange`-only input (`LoadModule` /
5631 // `SoftPurge` / `Purge` / `Restart`) leaves the gate
5632 // vacuous with `Ok(())` — the `declared_path().is_none()`
5633 // arm's `continue` fall-through pins.
5634 //
5635 // Fail-before-pass-after verified locally: swapping the
5636 // production `let Some(script) = instr.declared_path() else {
5637 // continue };` back to `let script = match instr {
5638 // UpgradeInstruction::StateChange { script } =>
5639 // script.as_path(), _ => continue, };` keeps arms (a)-(c)
5640 // passing but silently detaches the gate from the accessor's
5641 // typed dispatch — any future `declared_path` extension
5642 // (promotion of an additional variant onto the axis, an
5643 // operator-side pre-resolved-path cache the accessor
5644 // materializes) would then silently disagree between this
5645 // gate's raw pattern-match and the peer four sibling consumers
5646 // that route through the accessor.
5647 use std::path::PathBuf;
5648
5649 // (a) StateChange projection byte-equal via declared_path.
5650 let sc = UpgradeInstruction::StateChange {
5651 script: PathBuf::from("lib/m.lisp"),
5652 };
5653 assert_eq!(
5654 sc.declared_path().map(std::path::PathBuf::as_path),
5655 Some(PathBuf::from("lib/m.lisp").as_path()),
5656 "declared_path() must project the StateChange :script byte-equal to the raw \
5657 field access — accessor divergence would silently detach the gate from the \
5658 projection every peer per-`UpgradeInstruction` consumer routes through"
5659 );
5660
5661 // (b) Duplicate-StateChange input trips the gate.
5662 let dup = entry(
5663 "0.1.0",
5664 vec![
5665 UpgradeInstruction::LoadModule { module: "x".into() },
5666 UpgradeInstruction::StateChange {
5667 script: PathBuf::from("lib/m.lisp"),
5668 },
5669 UpgradeInstruction::StateChange {
5670 script: PathBuf::from("lib/m.lisp"),
5671 },
5672 ],
5673 );
5674 assert_eq!(
5675 dup.validate_state_change_singularity(),
5676 Err(UpgradeError::DuplicateStateChange {
5677 from: "0.1.0".into(),
5678 script: PathBuf::from("lib/m.lisp"),
5679 }),
5680 "duplicate StateChange scripts must trip the gate on the second occurrence \
5681 through the declared_path accessor's Some(script) arm"
5682 );
5683
5684 // (c) Non-StateChange-only inputs leave the gate vacuous.
5685 for instrs in [
5686 vec![UpgradeInstruction::LoadModule { module: "x".into() }],
5687 vec![
5688 UpgradeInstruction::LoadModule { module: "x".into() },
5689 UpgradeInstruction::SoftPurge {
5690 module: "x-old".into(),
5691 },
5692 ],
5693 vec![
5694 UpgradeInstruction::LoadModule { module: "x".into() },
5695 UpgradeInstruction::Purge {
5696 module: "x-old".into(),
5697 },
5698 ],
5699 vec![UpgradeInstruction::Restart],
5700 ] {
5701 for instr in &instrs {
5702 assert!(
5703 instr.declared_path().is_none(),
5704 "non-StateChange variants must project None through declared_path — \
5705 accessor divergence would let this gate silently fire on a duplicate \
5706 module reference far from any :state-change site"
5707 );
5708 }
5709 let e = entry("0.1.0", instrs);
5710 assert_eq!(
5711 e.validate_state_change_singularity(),
5712 Ok(()),
5713 "the state-change-singularity gate must return Ok(()) on an entry whose \
5714 instructions all project None through declared_path — the accessor's \
5715 continue arm the pattern-match's `_ => continue` previously carried"
5716 );
5717 }
5718 }
5719
5720 // ── within-entry state-change-before-cleanup ordering invariant ──
5721
5722 #[test]
5723 fn validate_rejects_state_change_after_soft_purge() {
5724 // Fail-before-pass-after pin: `:state-change` is the
5725 // gen_server:code_change/3 analog and folds the prior-version
5726 // state shape into the current shape; `:soft-purge` drains the
5727 // prior code. The operator runs instructions in declared order,
5728 // so a `:soft-purge` ahead of a `:state-change` drains the
5729 // prior module before the migration callback runs against the
5730 // state it held — the canonical OTP error mode
5731 // "`code_change/3` invoked on a purged module" the
5732 // release_handler closes by always ordering the migration
5733 // before the cleanup.
5734 let e = entry(
5735 "0.1.0",
5736 vec![
5737 UpgradeInstruction::LoadModule { module: "x".into() },
5738 UpgradeInstruction::SoftPurge {
5739 module: "x-old".into(),
5740 },
5741 UpgradeInstruction::StateChange {
5742 script: PathBuf::from("lib/m.lisp"),
5743 },
5744 ],
5745 );
5746 let err = e.validate().unwrap_err();
5747 assert_eq!(
5748 err,
5749 UpgradeError::StateChangeAfterCleanup {
5750 from: "0.1.0".into(),
5751 script: PathBuf::from("lib/m.lisp"),
5752 prior_cleanup_kind: crate::render::M2_UPGRADE_INSTRUCTION_KIND_SOFT_PURGE,
5753 prior_cleanup_module: "x-old".into(),
5754 },
5755 "a `:state-change` after a `:soft-purge` must surface as StateChangeAfterCleanup \
5756 naming the offending entry + script + the prior cleanup's kind/module, got {err:?}"
5757 );
5758 }
5759
5760 #[test]
5761 fn validate_rejects_state_change_after_purge() {
5762 // Per-arm coverage: `:purge` (immediate discard, no drain) is
5763 // the more catastrophic peer of `:soft-purge` on the cleanup
5764 // axis; same gate, same shape, the `prior_cleanup_kind` field
5765 // distinguishes the diagnostic so the author can grep their
5766 // caixa.lisp for the offending `(:purge …)` form.
5767 let e = entry(
5768 "0.1.0",
5769 vec![
5770 UpgradeInstruction::LoadModule { module: "x".into() },
5771 UpgradeInstruction::Purge {
5772 module: "x-old".into(),
5773 },
5774 UpgradeInstruction::StateChange {
5775 script: PathBuf::from("lib/m.lisp"),
5776 },
5777 ],
5778 );
5779 let err = e.validate().unwrap_err();
5780 assert_eq!(
5781 err,
5782 UpgradeError::StateChangeAfterCleanup {
5783 from: "0.1.0".into(),
5784 script: PathBuf::from("lib/m.lisp"),
5785 prior_cleanup_kind: crate::render::M2_UPGRADE_INSTRUCTION_KIND_PURGE,
5786 prior_cleanup_module: "x-old".into(),
5787 },
5788 "a `:state-change` after a `:purge` must surface as StateChangeAfterCleanup with \
5789 `prior_cleanup_kind: \":purge\"`, got {err:?}"
5790 );
5791 }
5792
5793 #[test]
5794 fn validate_accepts_state_change_before_cleanup() {
5795 // Positive control: the canonical `(:load-module …)
5796 // (:state-change …) (:soft-purge …)` order validates — the
5797 // exact shape the module doc example and `validate_accepts_
5798 // well_formed` already pin, restated here on the new gate's
5799 // identity element so a future shortcut that runs the
5800 // singularity gates first doesn't silently mask a regression
5801 // here.
5802 let e = entry(
5803 "0.1.0",
5804 vec![
5805 UpgradeInstruction::LoadModule { module: "x".into() },
5806 UpgradeInstruction::StateChange {
5807 script: PathBuf::from("lib/m.lisp"),
5808 },
5809 UpgradeInstruction::SoftPurge {
5810 module: "x-old".into(),
5811 },
5812 ],
5813 );
5814 e.validate().unwrap();
5815 }
5816
5817 #[test]
5818 fn validate_accepts_cleanup_without_state_change() {
5819 // Empty-set identity: an entry that carries no `:state-change`
5820 // at all has nothing to order against the cleanup, so the gate
5821 // passes regardless of how the cleanups are placed (after the
5822 // single required `:load-module`). Mirrors the
5823 // `validate_accepts_multiple_purges_after_one_load` positive
5824 // control on the peer purge-ordering gate; metadata-only
5825 // upgrades with cleanup-but-no-migration land here.
5826 let e = entry(
5827 "0.1.0",
5828 vec![
5829 UpgradeInstruction::LoadModule { module: "x".into() },
5830 UpgradeInstruction::SoftPurge {
5831 module: "x-old".into(),
5832 },
5833 UpgradeInstruction::Purge {
5834 module: "x-oldest".into(),
5835 },
5836 ],
5837 );
5838 e.validate().unwrap();
5839 }
5840
5841 #[test]
5842 fn validate_accepts_state_change_without_cleanup() {
5843 // Empty-set identity on the dual axis: an entry that carries no
5844 // cleanup at all has nothing to order against the state-change,
5845 // so the gate passes — additive-upgrade shapes (load new code,
5846 // migrate state, leave old code resident for in-flight callers
5847 // to drain naturally) land here.
5848 let e = entry(
5849 "0.1.0",
5850 vec![
5851 UpgradeInstruction::LoadModule { module: "x".into() },
5852 UpgradeInstruction::StateChange {
5853 script: PathBuf::from("lib/m.lisp"),
5854 },
5855 ],
5856 );
5857 e.validate().unwrap();
5858 }
5859
5860 #[test]
5861 fn validate_accepts_multiple_state_changes_before_cleanup() {
5862 // Coverage: every state-change must precede every cleanup, not
5863 // just the first. A chain `(load) (sc) (sc) (sp)` is the
5864 // canonical "two distinct migration scripts on a chained
5865 // upgrade" shape (one module's schema *and* another's
5866 // projection per the DuplicateStateChange diagnostic), and
5867 // it must pass when each state-change has distinct script
5868 // paths. Pinned here so a future shortcut that only checks
5869 // the first state-change doesn't silently accept a
5870 // `(load) (sc-1) (sp) (sc-2)` regression.
5871 let e = entry(
5872 "0.1.0",
5873 vec![
5874 UpgradeInstruction::LoadModule { module: "x".into() },
5875 UpgradeInstruction::StateChange {
5876 script: PathBuf::from("lib/m1.lisp"),
5877 },
5878 UpgradeInstruction::StateChange {
5879 script: PathBuf::from("lib/m2.lisp"),
5880 },
5881 UpgradeInstruction::SoftPurge {
5882 module: "x-old".into(),
5883 },
5884 ],
5885 );
5886 e.validate().unwrap();
5887 }
5888
5889 #[test]
5890 fn validate_rejects_state_change_sandwiched_between_cleanups() {
5891 // First-cleanup-wins pin: an entry like `(load) (sp-1) (sc)
5892 // (sp-2)` violates the gate because the state-change runs
5893 // after the first cleanup. The reported `prior_cleanup_*`
5894 // names the *first* cleanup (the load-bearing one), not the
5895 // last — mirrors every peer first-collision diagnostic
5896 // posture on this module (`validate_state_change_ordering`,
5897 // `validate_purge_ordering`, `validate_load_singularity`,
5898 // `validate_state_change_singularity`,
5899 // `validate_cleanup_singularity` all report the first
5900 // colliding instruction, not the last).
5901 let e = entry(
5902 "0.1.0",
5903 vec![
5904 UpgradeInstruction::LoadModule { module: "x".into() },
5905 UpgradeInstruction::SoftPurge {
5906 module: "x-old".into(),
5907 },
5908 UpgradeInstruction::StateChange {
5909 script: PathBuf::from("lib/m.lisp"),
5910 },
5911 UpgradeInstruction::Purge {
5912 module: "y-old".into(),
5913 },
5914 ],
5915 );
5916 let err = e.validate().unwrap_err();
5917 assert_eq!(
5918 err,
5919 UpgradeError::StateChangeAfterCleanup {
5920 from: "0.1.0".into(),
5921 script: PathBuf::from("lib/m.lisp"),
5922 prior_cleanup_kind: crate::render::M2_UPGRADE_INSTRUCTION_KIND_SOFT_PURGE,
5923 prior_cleanup_module: "x-old".into(),
5924 },
5925 "the first cleanup the state-change follows must surface (not the trailing one), \
5926 got {err:?}"
5927 );
5928 }
5929
5930 #[test]
5931 fn validate_state_change_before_cleanup_fires_after_purge_ordering() {
5932 // Diagnostic-precedence pin: an entry like `((:soft-purge
5933 // "x-old") (:load-module "x") (:state-change "m.lisp"))` is
5934 // *both* purge-without-load (the cleanup runs before the
5935 // load) and state-change-after-cleanup (the state-change
5936 // runs after the cleanup). The more-fundamental ordering
5937 // gate must win — the missing-load defect (a cleanup that
5938 // drains the only resident version to nothing) is load-
5939 // bearing, and surfacing the state-change-after-cleanup
5940 // diagnostic first would mask the drain-to-nothing defect
5941 // the peer purge-ordering gate exists to close. Guards the
5942 // call order in `validate` against silent reordering. Same
5943 // posture as `validate_purge_ordering_fires_after_state_
5944 // change_ordering` on the sibling ordering gate.
5945 //
5946 // Pin specifically uses the load-after-cleanup shape (rather
5947 // than load-less) so the state-change-ordering gate (which
5948 // would otherwise fire first on a `((:soft-purge …)
5949 // (:state-change …))` shape with no leading load) is
5950 // sidestepped: with the load present after the cleanup,
5951 // state-change-ordering passes (its `loaded` latch is set
5952 // before the state-change is encountered) but purge-ordering
5953 // still fails (the cleanup precedes the load). That isolates
5954 // the precedence between purge-ordering and this gate
5955 // cleanly.
5956 let e = entry(
5957 "0.1.0",
5958 vec![
5959 UpgradeInstruction::SoftPurge {
5960 module: "x-old".into(),
5961 },
5962 UpgradeInstruction::LoadModule { module: "x".into() },
5963 UpgradeInstruction::StateChange {
5964 script: PathBuf::from("lib/m.lisp"),
5965 },
5966 ],
5967 );
5968 let err = e.validate().unwrap_err();
5969 assert!(
5970 matches!(
5971 err,
5972 UpgradeError::PurgeWithoutPriorLoad {
5973 kind: crate::render::M2_UPGRADE_INSTRUCTION_KIND_SOFT_PURGE,
5974 ..
5975 }
5976 ),
5977 "purge-without-load must surface before state-change-after-cleanup, got {err:?}"
5978 );
5979 }
5980
5981 #[test]
5982 fn validate_state_change_before_cleanup_fires_after_state_change_ordering() {
5983 // Diagnostic-precedence pin: an entry like `((:state-change
5984 // "m.lisp") (:soft-purge "x-old"))` is state-change-without-
5985 // load (because no `:load-module` precedes the state-change)
5986 // but *not* state-change-after-cleanup (the state-change
5987 // precedes the cleanup textually). The state-change-ordering
5988 // gate must surface first regardless — the missing-load
5989 // defect on the migration axis is the load-bearing semantic
5990 // and surfacing a different ordering diagnostic would mask
5991 // the migration-against-stale-code defect. Guards the call
5992 // order in `validate` against silent reordering on a shape
5993 // that fires only the state-change-ordering gate (not this
5994 // one), pinning that the state-change-ordering gate wins
5995 // ahead of this gate's chance to look at the list.
5996 let e = entry(
5997 "0.1.0",
5998 vec![
5999 UpgradeInstruction::StateChange {
6000 script: PathBuf::from("lib/m.lisp"),
6001 },
6002 UpgradeInstruction::SoftPurge {
6003 module: "x-old".into(),
6004 },
6005 ],
6006 );
6007 let err = e.validate().unwrap_err();
6008 assert!(
6009 matches!(err, UpgradeError::StateChangeWithoutPriorLoad { .. }),
6010 "state-change-without-load must surface before purge-without-load (the canonical \
6011 validate_purge_ordering_fires_after_state_change_ordering pin), got {err:?}"
6012 );
6013 }
6014
6015 #[test]
6016 fn validate_state_change_before_cleanup_fires_after_per_instr_shape() {
6017 // Order pin: a malformed `:script` value on a `:state-change`
6018 // (an empty path) surfaces its narrower `EmptyScript`
6019 // diagnostic *before* the within-entry state-change-before-
6020 // cleanup gate fires. The per-instruction shape pass walks
6021 // the list inline before the ordering check, so the narrower
6022 // self-locating diagnostic surfaces first — mirrors the
6023 // empty-first cascade on every peer path-shape gate and the
6024 // `validate_purge_ordering_fires_after_per_instr_shape` pin
6025 // on the sibling ordering gate.
6026 let e = entry(
6027 "0.1.0",
6028 vec![
6029 UpgradeInstruction::LoadModule { module: "x".into() },
6030 UpgradeInstruction::SoftPurge {
6031 module: "x-old".into(),
6032 },
6033 UpgradeInstruction::StateChange {
6034 script: PathBuf::new(),
6035 },
6036 ],
6037 );
6038 let err = e.validate().unwrap_err();
6039 assert_eq!(
6040 err,
6041 UpgradeError::EmptyScript,
6042 "malformed instruction must surface its narrower diagnostic before the \
6043 state-change-before-cleanup gate fires, got {err:?}"
6044 );
6045 }
6046
6047 #[test]
6048 fn validate_state_change_before_cleanup_fires_before_state_change_singularity() {
6049 // Diagnostic-precedence pin: an entry like `((:load-module
6050 // "x") (:soft-purge "x-old") (:state-change "m.lisp")
6051 // (:state-change "m.lisp"))` violates *both* this ordering
6052 // gate (the first state-change follows the cleanup) and the
6053 // state-change-singularity gate (the same script appears
6054 // twice). The ordering gate must win — the canonical
6055 // "ordering before singularity" precedence the peer
6056 // `validate_state_change_ordering` / `validate_purge_
6057 // ordering` gates already establish over their own singularity
6058 // gates, applied uniformly across the OTP canonical-sequence
6059 // ordering axis here. Guards the call order in `validate`:
6060 // `validate_state_change_before_cleanup` runs before the
6061 // per-instruction-class singularity gates.
6062 let e = entry(
6063 "0.1.0",
6064 vec![
6065 UpgradeInstruction::LoadModule { module: "x".into() },
6066 UpgradeInstruction::SoftPurge {
6067 module: "x-old".into(),
6068 },
6069 UpgradeInstruction::StateChange {
6070 script: PathBuf::from("lib/m.lisp"),
6071 },
6072 UpgradeInstruction::StateChange {
6073 script: PathBuf::from("lib/m.lisp"),
6074 },
6075 ],
6076 );
6077 let err = e.validate().unwrap_err();
6078 assert!(
6079 matches!(err, UpgradeError::StateChangeAfterCleanup { .. }),
6080 "state-change-after-cleanup must surface before duplicate-state-change, got {err:?}"
6081 );
6082 }
6083
6084 #[test]
6085 fn validate_state_change_before_cleanup_threads_through_validate_upgrade_from() {
6086 // The whole-list entry-point surfaces the per-entry ordering
6087 // error (mirrors `validate_purge_ordering_threads_through_
6088 // validate_upgrade_from` and every peer wiring pin): the gate
6089 // is reachable from the LayoutInvariants call site, not only
6090 // from a direct `entry.validate()`.
6091 let entries = vec![entry(
6092 "0.1.0",
6093 vec![
6094 UpgradeInstruction::LoadModule { module: "x".into() },
6095 UpgradeInstruction::SoftPurge {
6096 module: "x-old".into(),
6097 },
6098 UpgradeInstruction::StateChange {
6099 script: PathBuf::from("lib/m.lisp"),
6100 },
6101 ],
6102 )];
6103 let err = validate_upgrade_from(&entries).unwrap_err();
6104 assert!(
6105 matches!(err, UpgradeError::StateChangeAfterCleanup { .. }),
6106 "validate_upgrade_from must thread the state-change-before-cleanup error, \
6107 got {err:?}"
6108 );
6109 }
6110
6111 #[test]
6112 fn validate_state_change_before_cleanup_projects_scripts_through_declared_path_accessor() {
6113 // Composition pin: [`UpgradeFromEntry::validate_state_change_before_cleanup`]'s
6114 // per-instruction `StateChange`-arm script-path projection must
6115 // route through the sibling lifted
6116 // [`UpgradeInstruction::declared_path`] `Option<&PathBuf>`
6117 // accessor, not the raw
6118 // `if let UpgradeInstruction::StateChange { script } = instr`
6119 // open-coded pattern-match the gate previously carried inside
6120 // `impl UpgradeFromEntry` at caixa-core/src/upgrade.rs:806.
6121 //
6122 // Structurally: the gate's projection accept-set is the union
6123 // of every [`UpgradeInstruction`] variant for which
6124 // `declared_path().is_some()` — today exactly
6125 // [`UpgradeInstruction::StateChange`] per the sibling
6126 // `declared_path_only_for_state_change` pin, so a
6127 // state-change-after-cleanup input trips
6128 // `StateChangeAfterCleanup` and a non-`StateChange` input
6129 // (module-bearing / terminal) leaves the sticky-once latch
6130 // sweep quiet byte-identical to the pattern-match shape.
6131 //
6132 // Byte-equal today (`declared_path` returns `Some(script)` iff
6133 // `StateChange`, byte-for-byte from the variant's own storage);
6134 // the pin catches any future accessor extension that promotes
6135 // an additional variant onto the `PathBuf`-carrying axis — the
6136 // gate then fires on migrate-after-cleanup for that variant too,
6137 // and the migrate→cleanup ordering discipline the peer
6138 // [`validate_state_change_singularity`] /
6139 // [`validate_upgrade_from_against_behavior`] gates share on the
6140 // same axis extends to the promoted variant by construction.
6141 //
6142 // Peer of the sibling four per-`UpgradeInstruction` consumers
6143 // ([`UpgradeInstruction::validate`]'s per-`StateChange`
6144 // sandbox-path fan-out, the layout-side per-`StateChange`
6145 // script-existence fan-out at
6146 // `caixa-core/src/layout.rs:1058`, the within-entry
6147 // [`UpgradeFromEntry::validate_state_change_singularity`]
6148 // per-`StateChange` script-projection fan-out, the cross-slot
6149 // [`validate_upgrade_from_against_behavior`] per-`StateChange`
6150 // detection loop) — the fifth (and last unlifted inside
6151 // `impl UpgradeFromEntry`) per-`UpgradeInstruction`-consumer of
6152 // the `PathBuf`-carrying axis to now route through the accessor.
6153 // Same shape as the sibling
6154 // `validate_state_change_singularity_projects_scripts_through_declared_path_accessor`
6155 // and `validate_upgrade_from_against_behavior_projects_scripts_through_declared_path_accessor`
6156 // pins extended onto the within-entry migrate→cleanup ordering
6157 // gate.
6158 //
6159 // Three-arm projective coverage:
6160 // (a) `StateChange` scripts project through `declared_path()`
6161 // byte-equal to the raw `script.clone()` field access
6162 // the diagnostic previously carried;
6163 // (b) a `:state-change`-after-cleanup input trips the gate
6164 // with `StateChangeAfterCleanup` carrying the offending
6165 // script + the prior cleanup's kind/module verbatim;
6166 // (c) a non-`StateChange`-only input (`LoadModule` /
6167 // `SoftPurge` / `Purge` / `Restart`) leaves the gate
6168 // vacuous with `Ok(())` — the `declared_path().is_none()`
6169 // arm's fall-through pins.
6170 //
6171 // Fail-before-pass-after verified structurally: swapping the
6172 // production
6173 // `else if let Some(script) = instr.declared_path() && … { … }`
6174 // back to
6175 // `else if let UpgradeInstruction::StateChange { script } = instr && … { … }`
6176 // keeps arms (a)-(c) passing but silently detaches this within-
6177 // entry ordering gate from the accessor's typed dispatch — any
6178 // future `declared_path` extension (promotion of an additional
6179 // variant onto the axis, an operator-side pre-resolved-path
6180 // cache the accessor materializes) would then silently disagree
6181 // between this gate's raw pattern-match and the peer four
6182 // sibling consumers that route through the accessor.
6183
6184 // (a) StateChange projection byte-equal via declared_path.
6185 let sc = UpgradeInstruction::StateChange {
6186 script: PathBuf::from("lib/m.lisp"),
6187 };
6188 assert_eq!(
6189 sc.declared_path().cloned(),
6190 Some(PathBuf::from("lib/m.lisp")),
6191 "declared_path() must project the StateChange :script byte-equal to the raw \
6192 field access — accessor divergence would silently detach this within-entry \
6193 migrate→cleanup ordering gate from the projection every peer per-`UpgradeInstruction` \
6194 consumer routes through"
6195 );
6196
6197 // (b) StateChange-after-cleanup trips the gate through the accessor.
6198 let after = entry(
6199 "0.1.0",
6200 vec![
6201 UpgradeInstruction::LoadModule { module: "x".into() },
6202 UpgradeInstruction::SoftPurge {
6203 module: "x-old".into(),
6204 },
6205 UpgradeInstruction::StateChange {
6206 script: PathBuf::from("lib/m.lisp"),
6207 },
6208 ],
6209 );
6210 assert_eq!(
6211 after.validate(),
6212 Err(UpgradeError::StateChangeAfterCleanup {
6213 from: "0.1.0".into(),
6214 script: PathBuf::from("lib/m.lisp"),
6215 prior_cleanup_kind: crate::render::M2_UPGRADE_INSTRUCTION_KIND_SOFT_PURGE,
6216 prior_cleanup_module: "x-old".into(),
6217 }),
6218 "a :state-change following a cleanup must trip the gate through the declared_path \
6219 accessor's Some(script) arm — carrying the offending script + the prior cleanup's \
6220 kind/module verbatim byte-identical to the pattern-match shape"
6221 );
6222
6223 // (c) Non-StateChange-only inputs leave the gate vacuous.
6224 for instrs in [
6225 vec![UpgradeInstruction::LoadModule { module: "x".into() }],
6226 vec![
6227 UpgradeInstruction::LoadModule { module: "x".into() },
6228 UpgradeInstruction::SoftPurge {
6229 module: "x-old".into(),
6230 },
6231 ],
6232 vec![
6233 UpgradeInstruction::LoadModule { module: "x".into() },
6234 UpgradeInstruction::Purge {
6235 module: "x-old".into(),
6236 },
6237 ],
6238 vec![UpgradeInstruction::Restart],
6239 ] {
6240 for instr in &instrs {
6241 assert!(
6242 instr.declared_path().is_none(),
6243 "non-StateChange variants must project None through declared_path — \
6244 accessor divergence would let this within-entry ordering gate silently \
6245 fire on a cleanup-only sequence far from any :state-change site"
6246 );
6247 }
6248 let e = entry("0.1.0", instrs);
6249 assert_eq!(
6250 e.validate(),
6251 Ok(()),
6252 "the state-change-before-cleanup gate must return Ok(()) on an entry whose \
6253 instructions all project None through declared_path — the accessor's \
6254 None arm the pattern-match's implicit fall-through previously carried"
6255 );
6256 }
6257 }
6258
6259 #[test]
6260 fn validate_restart_order_independent() {
6261 // Position-agnostic: `(:restart)` leading or trailing the
6262 // mixed sequence surfaces the same RestartNotExclusive shape.
6263 // Mirrors OTP appup's order-insensitive
6264 // `restart_emulator | restart_new_emulator` terminal rule —
6265 // the position of the restart instruction in the script is
6266 // irrelevant; what matters is the script *contains* it
6267 // alongside other instructions at all. The gate must not
6268 // gain a false positive by depending on instruction ordering.
6269 let leading = entry(
6270 "0.1.0",
6271 vec![
6272 UpgradeInstruction::Restart,
6273 UpgradeInstruction::LoadModule { module: "x".into() },
6274 ],
6275 );
6276 let trailing = entry(
6277 "0.1.0",
6278 vec![
6279 UpgradeInstruction::LoadModule { module: "x".into() },
6280 UpgradeInstruction::Restart,
6281 ],
6282 );
6283 let middle = entry(
6284 "0.1.0",
6285 vec![
6286 UpgradeInstruction::LoadModule { module: "a".into() },
6287 UpgradeInstruction::Restart,
6288 UpgradeInstruction::SoftPurge {
6289 module: "a-old".into(),
6290 },
6291 ],
6292 );
6293 for e in [&leading, &trailing, &middle] {
6294 assert!(
6295 matches!(
6296 e.validate().unwrap_err(),
6297 UpgradeError::RestartNotExclusive {
6298 restart_count: 1,
6299 ..
6300 }
6301 ),
6302 "mixed-with-:restart entry must surface RestartNotExclusive regardless of \
6303 instruction order, got {:?}",
6304 e.validate()
6305 );
6306 }
6307 }
6308
6309 #[test]
6310 fn validate_restart_exclusive_fires_after_per_instr_shape() {
6311 // Order pin: a malformed `:module` value on a Module-bearing
6312 // instruction (an empty string) surfaces its narrower
6313 // kind-tagged `ModuleEmpty` diagnostic *before* the within-
6314 // entry restart-exclusivity gate fires. The per-instruction
6315 // shape pass walks the list inline before the restart-
6316 // exclusive check, so the narrower self-locating diagnostic
6317 // surfaces first — mirrors the empty-first cascade on every
6318 // peer DNS-1123 gate (`validate_module`,
6319 // `validate_membro_caixa`, `validate_placement_cluster`) and
6320 // the `*_invalid_fires_before_duplicate_check` arm-ordering
6321 // pins on every typed-graph axis. Without this pin a future
6322 // shortcut that runs the restart-exclusive check ahead of
6323 // per-instruction shape would surface a less-actionable
6324 // RestartNotExclusive over an instruction list that's also
6325 // malformed at the per-instruction layer.
6326 let e = entry(
6327 "0.1.0",
6328 vec![
6329 UpgradeInstruction::LoadModule {
6330 module: String::new(),
6331 },
6332 UpgradeInstruction::Restart,
6333 ],
6334 );
6335 let err = e.validate().unwrap_err();
6336 assert_eq!(
6337 err,
6338 UpgradeError::ModuleEmpty {
6339 kind: crate::render::M2_UPGRADE_INSTRUCTION_KIND_LOAD_MODULE
6340 },
6341 "malformed instruction must surface its kind-tagged diagnostic before the \
6342 restart-exclusivity gate fires, got {err:?}"
6343 );
6344 }
6345
6346 fn behavior_with_state_change_callback() -> crate::BehaviorSpec {
6347 // Helper for the cross-slot composition gate's pass arm: a
6348 // BehaviorSpec carrying just the `:on-state-change` callback,
6349 // the runtime hook the per-version `(:state-change "…")`
6350 // instruction is delivered through during hot upgrade. Mirrors
6351 // the canonical authoring shape pinned in the module doc.
6352 crate::BehaviorSpec {
6353 on_state_change: Some(PathBuf::from("lib/migrations.lisp")),
6354 ..Default::default()
6355 }
6356 }
6357
6358 #[test]
6359 fn behavior_gate_rejects_state_change_without_any_behavior() {
6360 // `:upgrade-from` with a `(:state-change "lib/m.lisp")` and the
6361 // caixa carries no `:behavior` at all surfaces the missing-
6362 // callback diagnostic naming the offending entry's `:from` +
6363 // script. The "I added the upgrade path but never declared
6364 // `:behavior`" footgun: `:behavior` is optional at the typed
6365 // root, the typed `:upgrade-from` slot validates on its own
6366 // merits, and the operator's hot-upgrade dispatch reaches for
6367 // a callback that doesn't exist.
6368 let entries = vec![entry(
6369 "0.1.0",
6370 vec![
6371 UpgradeInstruction::LoadModule { module: "x".into() },
6372 UpgradeInstruction::StateChange {
6373 script: PathBuf::from("lib/m.lisp"),
6374 },
6375 ],
6376 )];
6377 let err = validate_upgrade_from_against_behavior(&entries, None).unwrap_err();
6378 assert_eq!(
6379 err,
6380 UpgradeError::StateChangeWithoutOnStateChangeCallback {
6381 from: "0.1.0".into(),
6382 script: PathBuf::from("lib/m.lisp"),
6383 },
6384 );
6385 }
6386
6387 #[test]
6388 fn behavior_gate_rejects_state_change_when_on_state_change_is_none() {
6389 // `:behavior` declared with *other* callbacks set
6390 // (`:on-init`, `:on-terminate`, etc.) but `:on-state-change`
6391 // None still surfaces the missing-callback diagnostic — only
6392 // the `:on-state-change` axis matters for this gate. The
6393 // "I declared `:behavior` but missed the migration callback"
6394 // footgun: a caixa that registers its lifecycle hooks but
6395 // forgets the migration delivery path leaves the
6396 // `:state-change` instruction with no runtime hook to
6397 // dispatch through.
6398 let entries = vec![entry(
6399 "0.1.0",
6400 vec![
6401 UpgradeInstruction::LoadModule { module: "x".into() },
6402 UpgradeInstruction::StateChange {
6403 script: PathBuf::from("lib/m.lisp"),
6404 },
6405 ],
6406 )];
6407 let b = crate::BehaviorSpec {
6408 on_init: Some(PathBuf::from("lib/init.lisp")),
6409 on_terminate: Some(PathBuf::from("lib/cleanup.lisp")),
6410 ..Default::default()
6411 };
6412 let err = validate_upgrade_from_against_behavior(&entries, Some(&b)).unwrap_err();
6413 assert_eq!(
6414 err,
6415 UpgradeError::StateChangeWithoutOnStateChangeCallback {
6416 from: "0.1.0".into(),
6417 script: PathBuf::from("lib/m.lisp"),
6418 },
6419 "only `:on-state-change` satisfies the composition; other callbacks must not mask \
6420 the missing migration hook"
6421 );
6422 }
6423
6424 #[test]
6425 fn behavior_gate_accepts_state_change_with_on_state_change_callback() {
6426 // The canonical composition shape: a per-version
6427 // `(:state-change "lib/m.lisp")` instruction paired with the
6428 // `:behavior :on-state-change "lib/migrations.lisp"` callback
6429 // it is delivered through at hot-upgrade time. Pins the gate's
6430 // pass arm — drift here = a future tighten that rejects the
6431 // canonical OTP-shape composition surfaces as a regression at
6432 // this positive-control pin.
6433 let entries = vec![entry(
6434 "0.1.0",
6435 vec![
6436 UpgradeInstruction::LoadModule { module: "x".into() },
6437 UpgradeInstruction::StateChange {
6438 script: PathBuf::from("lib/m.lisp"),
6439 },
6440 ],
6441 )];
6442 let b = behavior_with_state_change_callback();
6443 validate_upgrade_from_against_behavior(&entries, Some(&b)).unwrap();
6444 }
6445
6446 #[test]
6447 fn behavior_gate_accepts_entries_without_any_state_change() {
6448 // Empty-set identity: entries carrying no `:state-change`
6449 // instruction at all (load + cleanup only — the metadata-only
6450 // upgrade shape the module doc names, "On any failure, the
6451 // current version stays load-bearing — a typed atomic
6452 // upgrade") leave the gate vacuous. The composition only
6453 // requires a callback when the per-version script exists; a
6454 // load + cleanup pair has no migration to deliver, so the
6455 // absence of `:on-state-change` is coherent.
6456 let entries = vec![entry(
6457 "0.1.0",
6458 vec![
6459 UpgradeInstruction::LoadModule { module: "x".into() },
6460 UpgradeInstruction::SoftPurge {
6461 module: "x-old".into(),
6462 },
6463 ],
6464 )];
6465 validate_upgrade_from_against_behavior(&entries, None).unwrap();
6466 }
6467
6468 #[test]
6469 fn behavior_gate_accepts_restart_only_entry() {
6470 // The terminal-fallback `((:restart))` shape carries no
6471 // `:state-change` — the operator restarts the pod and the
6472 // new version comes up fresh against its initial state, no
6473 // migration. Pinned alongside the metadata-only positive
6474 // control above as the second empty-state-change shape.
6475 let entries = vec![entry("0.1.0", vec![UpgradeInstruction::Restart])];
6476 validate_upgrade_from_against_behavior(&entries, None).unwrap();
6477 }
6478
6479 #[test]
6480 fn behavior_gate_accepts_empty_entries_list() {
6481 // Empty `:upgrade-from` (a caixa with no declared upgrade
6482 // paths — the v0.1.0 caixa before any upgrade entries are
6483 // added) trivially passes the gate. Pinned so the gate
6484 // doesn't accidentally fire on a caixa that hasn't yet
6485 // declared any upgrades.
6486 let entries: Vec<UpgradeFromEntry> = vec![];
6487 validate_upgrade_from_against_behavior(&entries, None).unwrap();
6488 }
6489
6490 #[test]
6491 fn behavior_gate_reports_first_state_change_in_first_entry() {
6492 // First-collision determinism: with multiple `:state-change`
6493 // instructions across multiple entries, the gate reports the
6494 // *first* one encountered in declaration order — the entry's
6495 // declaration order first, then the within-entry instruction
6496 // order. Mirrors every peer first-collision diagnostic posture
6497 // on this module (`validate_state_change_ordering`,
6498 // `validate_purge_ordering`, the singularity gates), so a
6499 // future shortcut that walks the list in reverse or returns
6500 // the last collision surfaces as a regression here.
6501 let entries = vec![
6502 entry(
6503 "0.1.0",
6504 vec![
6505 UpgradeInstruction::LoadModule { module: "x".into() },
6506 UpgradeInstruction::StateChange {
6507 script: PathBuf::from("lib/m1.lisp"),
6508 },
6509 UpgradeInstruction::StateChange {
6510 script: PathBuf::from("lib/m2.lisp"),
6511 },
6512 ],
6513 ),
6514 entry(
6515 "0.1.5",
6516 vec![
6517 UpgradeInstruction::LoadModule { module: "x".into() },
6518 UpgradeInstruction::StateChange {
6519 script: PathBuf::from("lib/m3.lisp"),
6520 },
6521 ],
6522 ),
6523 ];
6524 let err = validate_upgrade_from_against_behavior(&entries, None).unwrap_err();
6525 assert_eq!(
6526 err,
6527 UpgradeError::StateChangeWithoutOnStateChangeCallback {
6528 from: "0.1.0".into(),
6529 script: PathBuf::from("lib/m1.lisp"),
6530 },
6531 "the first :state-change in the first entry must surface, not later collisions"
6532 );
6533 }
6534
6535 #[test]
6536 fn behavior_gate_reports_second_entry_when_first_has_no_state_change() {
6537 // Cross-entry pin: a first entry with no `:state-change` (just
6538 // a load + cleanup) leaves the gate's per-entry walk continuing
6539 // to the second entry, where the offending instruction lives.
6540 // The diagnostic names the *second* entry's `:from` because
6541 // that's where the missing-callback shape is exposed — pinned
6542 // so a shortcut that bails on the first entry without a
6543 // `:state-change` (rather than continuing) doesn't mask the
6544 // defect in a later entry.
6545 let entries = vec![
6546 entry(
6547 "0.1.0",
6548 vec![
6549 UpgradeInstruction::LoadModule { module: "x".into() },
6550 UpgradeInstruction::SoftPurge {
6551 module: "x-old".into(),
6552 },
6553 ],
6554 ),
6555 entry(
6556 "0.1.5",
6557 vec![
6558 UpgradeInstruction::LoadModule { module: "x".into() },
6559 UpgradeInstruction::StateChange {
6560 script: PathBuf::from("lib/m.lisp"),
6561 },
6562 ],
6563 ),
6564 ];
6565 let err = validate_upgrade_from_against_behavior(&entries, None).unwrap_err();
6566 assert_eq!(
6567 err,
6568 UpgradeError::StateChangeWithoutOnStateChangeCallback {
6569 from: "0.1.5".into(),
6570 script: PathBuf::from("lib/m.lisp"),
6571 },
6572 "the offending entry's `:from` must surface even when an earlier entry carries no \
6573 :state-change"
6574 );
6575 }
6576
6577 #[test]
6578 fn behavior_gate_does_not_fire_when_callback_is_declared_across_many_entries() {
6579 // Positive control: a multi-entry `:upgrade-from` (chained
6580 // upgrades from v0.1.0 *and* v0.1.5) where every entry carries
6581 // a `:state-change` passes when the callback is declared once
6582 // at the caixa root. The callback is a single per-caixa
6583 // runtime hook; one declaration covers every entry's
6584 // `:state-change`, mirroring OTP's
6585 // `release_handler:install_release/1` which dispatches every
6586 // appup's `code_change` instruction through the single
6587 // `gen_server:code_change/3` callback registered on the
6588 // module.
6589 let entries = vec![
6590 entry(
6591 "0.1.0",
6592 vec![
6593 UpgradeInstruction::LoadModule { module: "x".into() },
6594 UpgradeInstruction::StateChange {
6595 script: PathBuf::from("lib/m1.lisp"),
6596 },
6597 ],
6598 ),
6599 entry(
6600 "0.1.5",
6601 vec![
6602 UpgradeInstruction::LoadModule { module: "x".into() },
6603 UpgradeInstruction::StateChange {
6604 script: PathBuf::from("lib/m2.lisp"),
6605 },
6606 ],
6607 ),
6608 ];
6609 let b = behavior_with_state_change_callback();
6610 validate_upgrade_from_against_behavior(&entries, Some(&b)).unwrap();
6611 }
6612
6613 #[test]
6614 fn behavior_gate_accepts_load_and_cleanup_only_when_behavior_carries_on_state_change() {
6615 // Symmetry pin: the gate's pass arm doesn't depend on the
6616 // entry actually carrying a `:state-change` — if no
6617 // `:state-change` is declared, the gate is vacuous regardless
6618 // of the callback (an `:on-state-change` declared without a
6619 // matching per-version script is fine, the callback is the
6620 // runtime default for any *future* migration the author hasn't
6621 // yet added). Pins that a caixa author can declare the
6622 // callback ahead of any migration without the gate
6623 // complaining.
6624 let entries = vec![entry(
6625 "0.1.0",
6626 vec![
6627 UpgradeInstruction::LoadModule { module: "x".into() },
6628 UpgradeInstruction::SoftPurge {
6629 module: "x-old".into(),
6630 },
6631 ],
6632 )];
6633 let b = behavior_with_state_change_callback();
6634 validate_upgrade_from_against_behavior(&entries, Some(&b)).unwrap();
6635 }
6636
6637 #[test]
6638 fn validate_upgrade_from_against_behavior_projects_scripts_through_declared_path_accessor() {
6639 // Composition pin: [`validate_upgrade_from_against_behavior`]'s
6640 // per-instruction `StateChange`-arm script-path projection must
6641 // route through the sibling lifted
6642 // [`UpgradeInstruction::declared_path`] `Option<&PathBuf>`
6643 // accessor, not the raw
6644 // `if let UpgradeInstruction::StateChange { script } = instr`
6645 // open-coded pattern-match the cross-slot gate previously
6646 // carried at caixa-core/src/upgrade.rs:1365.
6647 //
6648 // Structurally: the gate's projection accept-set is the union
6649 // of every [`UpgradeInstruction`] variant for which
6650 // `declared_path().is_some()` — today exactly
6651 // [`UpgradeInstruction::StateChange`] per the sibling
6652 // `declared_path_only_for_state_change` pin, so a
6653 // `:state-change`-carrying entry without an `:on-state-change`
6654 // callback trips `StateChangeWithoutOnStateChangeCallback` and
6655 // a non-`StateChange` entry (load-only / cleanup-only /
6656 // restart-only / empty-`:instructions`) leaves the per-entry
6657 // walk continuing past every non-projecting instruction
6658 // byte-identical to the pattern-match shape.
6659 //
6660 // Byte-equal today (`declared_path` returns `Some(script)` iff
6661 // `StateChange`, byte-for-byte from the variant's own storage);
6662 // the pin catches any future accessor extension that promotes
6663 // an additional variant onto the `PathBuf`-carrying axis — the
6664 // gate then fires on scripts from that variant too, and the
6665 // cross-slot composition discipline the sibling per-
6666 // `UpgradeInstruction` consumers share on the `PathBuf`-
6667 // carrying axis extends to the promoted variant by
6668 // construction.
6669 //
6670 // Peer of the sibling four per-`UpgradeInstruction` consumers
6671 // ([`UpgradeInstruction::validate`]'s per-`StateChange`
6672 // sandbox-path fan-out, the layout-side per-`StateChange`
6673 // script-existence fan-out at
6674 // `caixa-core/src/layout.rs:1058`, the within-entry
6675 // [`UpgradeFromEntry::validate_state_change_singularity`]
6676 // (2bf3ce5) per-`StateChange` script-projection fan-out, the
6677 // peer [`UpgradeInstruction::declared_module`] `String`-axis
6678 // per-variant unifier) — the fourth (and last) per-
6679 // `UpgradeInstruction`-consumer of the `PathBuf`-carrying axis
6680 // to now route through the accessor. Same shape as the
6681 // sibling
6682 // `validate_state_change_singularity_projects_scripts_through_declared_path_accessor`
6683 // pin extended onto the cross-slot composition gate.
6684 //
6685 // Three-arm projective coverage:
6686 // (a) `StateChange` scripts project through `declared_path()`
6687 // byte-equal to the raw `script.clone()` field access
6688 // the diagnostic previously carried;
6689 // (b) a `:state-change`-carrying entry with `behavior: None`
6690 // trips the gate with `StateChangeWithoutOnStateChangeCallback`
6691 // carrying the offending script verbatim;
6692 // (c) a non-`StateChange`-only entry (`LoadModule` /
6693 // `SoftPurge` / `Purge` / `Restart`) leaves the gate
6694 // vacuous with `Ok(())` — the `declared_path().is_none()`
6695 // arm's fall-through pins.
6696 //
6697 // Fail-before-pass-after verified structurally: swapping the
6698 // production
6699 // `if let Some(script) = instr.declared_path() { … }`
6700 // back to
6701 // `if let UpgradeInstruction::StateChange { script } = instr { … }`
6702 // keeps arms (a)-(c) passing but silently detaches the gate
6703 // from the accessor's typed dispatch — any future
6704 // `declared_path` extension (promotion of an additional
6705 // variant onto the axis, an operator-side pre-resolved-path
6706 // cache the accessor materializes) would then silently
6707 // disagree between this cross-slot gate's raw pattern-match
6708 // and the peer four sibling consumers that route through the
6709 // accessor.
6710
6711 // (a) StateChange projection byte-equal via declared_path.
6712 let sc = UpgradeInstruction::StateChange {
6713 script: PathBuf::from("lib/m.lisp"),
6714 };
6715 assert_eq!(
6716 sc.declared_path().cloned(),
6717 Some(PathBuf::from("lib/m.lisp")),
6718 "declared_path() must project the StateChange :script byte-equal to the raw \
6719 field access — accessor divergence would silently detach this cross-slot \
6720 composition gate from the projection every peer per-`UpgradeInstruction` \
6721 consumer routes through"
6722 );
6723
6724 // (b) StateChange-carrying entry with behavior: None trips gate.
6725 let entries = vec![entry(
6726 "0.1.0",
6727 vec![
6728 UpgradeInstruction::LoadModule { module: "x".into() },
6729 UpgradeInstruction::StateChange {
6730 script: PathBuf::from("lib/m.lisp"),
6731 },
6732 ],
6733 )];
6734 assert_eq!(
6735 validate_upgrade_from_against_behavior(&entries, None),
6736 Err(UpgradeError::StateChangeWithoutOnStateChangeCallback {
6737 from: "0.1.0".into(),
6738 script: PathBuf::from("lib/m.lisp"),
6739 }),
6740 "a :state-change-carrying entry with behavior: None must trip the gate through \
6741 the declared_path accessor's Some(script) arm — carrying the offending script \
6742 verbatim byte-identical to the pattern-match shape"
6743 );
6744
6745 // (c) Non-StateChange-only inputs leave the gate vacuous.
6746 for instrs in [
6747 vec![UpgradeInstruction::LoadModule { module: "x".into() }],
6748 vec![
6749 UpgradeInstruction::LoadModule { module: "x".into() },
6750 UpgradeInstruction::SoftPurge {
6751 module: "x-old".into(),
6752 },
6753 ],
6754 vec![
6755 UpgradeInstruction::LoadModule { module: "x".into() },
6756 UpgradeInstruction::Purge {
6757 module: "x-old".into(),
6758 },
6759 ],
6760 vec![UpgradeInstruction::Restart],
6761 ] {
6762 for instr in &instrs {
6763 assert!(
6764 instr.declared_path().is_none(),
6765 "non-StateChange variants must project None through declared_path — \
6766 accessor divergence would let this cross-slot composition gate silently \
6767 fire on a module reference far from any :state-change site"
6768 );
6769 }
6770 let entries = vec![entry("0.1.0", instrs)];
6771 assert_eq!(
6772 validate_upgrade_from_against_behavior(&entries, None),
6773 Ok(()),
6774 "the cross-slot composition gate must return Ok(()) on an entry whose \
6775 instructions all project None through declared_path — the accessor's \
6776 None arm the pattern-match's implicit fall-through previously carried"
6777 );
6778 }
6779 }
6780
6781 #[test]
6782 fn validate_restart_exclusive_threads_through_validate_upgrade_from() {
6783 // Wiring pin: the within-entry restart-exclusivity gate fires
6784 // through [`validate_upgrade_from`] (which delegates to
6785 // [`UpgradeFromEntry::validate`] per entry) before the cross-
6786 // entry duplicate-`:from` gate would have a chance to run on
6787 // the malformed entry. Pinned here so a future refactor that
6788 // walks the cross-entry gate first doesn't accidentally
6789 // surface a DuplicateFrom over an entry that's also malformed
6790 // at the within-entry restart-exclusivity layer.
6791 let entries = vec![
6792 entry(
6793 "0.1.0",
6794 vec![
6795 UpgradeInstruction::LoadModule { module: "x".into() },
6796 UpgradeInstruction::Restart,
6797 ],
6798 ),
6799 entry("0.1.0", vec![UpgradeInstruction::Restart]),
6800 ];
6801 let err = validate_upgrade_from(&entries).unwrap_err();
6802 assert!(
6803 matches!(
6804 err,
6805 UpgradeError::RestartNotExclusive {
6806 restart_count: 1,
6807 ..
6808 }
6809 ),
6810 "within-entry restart-exclusivity diagnostic must surface before the cross-entry \
6811 duplicate-`:from` gate fires, got {err:?}"
6812 );
6813 }
6814
6815 // ── drift-detection: serde-derive-to-M2_UPGRADE_FROM_KEY_* identity ──
6816
6817 #[test]
6818 fn upgrade_from_entry_serde_keys_match_lifted_m2_upgrade_from_key_consts() {
6819 // Load-bearing invariant: the two `M2_UPGRADE_FROM_KEY_*` consts
6820 // (`M2_UPGRADE_FROM_KEY_FROM` / `M2_UPGRADE_FROM_KEY_INSTRUCTIONS`)
6821 // name the exact camelCase JSON keys the `#[serde(rename_all =
6822 // "camelCase")]` attribute on `UpgradeFromEntry` emits, and every
6823 // test-side probe across the caixa-core / caixa-flux renderer
6824 // test fixtures navigates into each element of the rendered
6825 // `:upgrade-from` overlay sequence by consulting one of these two
6826 // `&'static str`s. Serialize a fully-populated UpgradeFromEntry
6827 // and pin that each canonical byte-sequence appears verbatim in
6828 // the JSON — a future accidental `rename_all = "snake_case"` /
6829 // `"kebab-case"` / verbatim-field-name flip at the derive
6830 // attribute (any of which would silently break every test-side
6831 // probe that reaches for one of the two consts) surfaces here as
6832 // a build-time test failure at `upgrade.rs`, not as an apply-time
6833 // `.get(<stale-canonical-const>)` returning `None` far from the
6834 // derive-attr drift's commit. Same discipline the sibling
6835 // `limits_spec_serde_keys_match_lifted_m2_limits_key_consts`
6836 // (d8b8b4f) and
6837 // `behavior_spec_serde_keys_match_lifted_m2_behavior_key_consts`
6838 // (21fe462) pins established on the peer `:limits` / `:behavior`
6839 // sub-slot axes: one canonical byte-string per typed sub-key
6840 // axis, pinned to the load-bearing serde derivation at the type
6841 // itself.
6842 let e = UpgradeFromEntry {
6843 from: "0.1.0".into(),
6844 instructions: vec![UpgradeInstruction::LoadModule {
6845 module: "hello-rio".into(),
6846 }],
6847 };
6848 let json = serde_json::to_string(&e).unwrap();
6849 for key in [
6850 crate::render::M2_UPGRADE_FROM_KEY_FROM,
6851 crate::render::M2_UPGRADE_FROM_KEY_INSTRUCTIONS,
6852 ] {
6853 let quoted = format!("\"{key}\"");
6854 assert!(
6855 json.contains("ed),
6856 "serialized UpgradeFromEntry must carry the lifted \
6857 M2_UPGRADE_FROM_KEY_* byte-sequence {quoted} verbatim in \
6858 the JSON emission (got: {json})",
6859 );
6860 }
6861 }
6862
6863 #[test]
6864 fn m2_upgrade_from_key_consts_are_pairwise_distinct() {
6865 // Cross-axis drift-detection pin: a future collapse of the two
6866 // canonical sub-key byte-strings onto the same value (e.g. an
6867 // accidental copy-paste flip of `M2_UPGRADE_FROM_KEY_INSTRUCTIONS`
6868 // to also read `"from"`) would silently reroute every test-side
6869 // probe on one axis onto the sibling axis's per-entry field and
6870 // pass every propagation-probe test that expected only the stale
6871 // axis's value. Peer of `m2_limits_key_consts_are_pairwise_distinct`
6872 // (d8b8b4f) and `m2_behavior_key_consts_are_pairwise_distinct`
6873 // (21fe462) on the sibling `:limits` / `:behavior` sub-slot axes.
6874 let all = [
6875 crate::render::M2_UPGRADE_FROM_KEY_FROM,
6876 crate::render::M2_UPGRADE_FROM_KEY_INSTRUCTIONS,
6877 ];
6878 for (i, a) in all.iter().enumerate() {
6879 for b in all.iter().skip(i + 1) {
6880 assert_ne!(
6881 a, b,
6882 "M2_UPGRADE_FROM_KEY_* consts must be pairwise-distinct \
6883 canonical byte-sequences — got `{a}` == `{b}`",
6884 );
6885 }
6886 }
6887 }
6888
6889 #[test]
6890 fn upgrade_instruction_serde_tag_key_matches_lifted_m2_upgrade_instruction_key_kind_const() {
6891 // Load-bearing invariant on the M2 `:upgrade-from :instructions`
6892 // per-entry OTP-appup [`UpgradeInstruction`] enum's internally-
6893 // tagged variant-discriminator key axis: the
6894 // `M2_UPGRADE_INSTRUCTION_KEY_KIND` const names the exact tag-slot
6895 // JSON key the `#[serde(tag = "kind", rename_all = "kebab-case")]`
6896 // attribute on [`UpgradeInstruction`] emits, and every downstream
6897 // consumer that navigates the serialized instruction blob to
6898 // route by variant (the caixa-core reflection-vs-serde round-trip
6899 // check in `dispatcher_registration.rs` that probes
6900 // `v.get("kind")` against every variant's expected kebab-case
6901 // tag, the future M4 admission-webhook path, any wasm-operator
6902 // dispatch step consuming the serialized instruction blob) reads
6903 // through the same `&'static str`. Serialize every variant and
6904 // pin that the const's byte-sequence appears verbatim as the
6905 // tag-slot JSON key with the expected kebab-case value — a
6906 // future accidental `tag = "type"` / `tag = "op"` /
6907 // `tag = "instruction"` rebrand at the derive attribute (any of
6908 // which would silently break every consumer probe reaching for
6909 // the stale-tag-key const) surfaces here as a build-time test
6910 // failure at `upgrade.rs`, not as an apply-time
6911 // `.get(<stale-tag-key>)` returning `None` far from the derive-
6912 // attr drift's commit.
6913 //
6914 // Same "one canonical byte-string per typed axis" discipline the
6915 // sibling `upgrade_from_entry_serde_keys_match_lifted_m2_upgrade_from_key_consts`
6916 // pin (36ffe65) established on the peer `:upgrade-from` per-entry
6917 // outer-container axis — this pin extends the discipline one
6918 // altitude deeper onto the per-instruction *tag* axis inside
6919 // each element of the `:instructions` list, completing the
6920 // typed coverage of the `:upgrade-from :instructions` dual
6921 // (key = "kind" + five variant-value tags): the five
6922 // `M2_UPGRADE_INSTRUCTION_KIND_*` consts (56120ef) pin the
6923 // per-variant kebab-case *values*; this pin pins the tag *key*
6924 // above them.
6925 let samples: [(UpgradeInstruction, &'static str); 5] = [
6926 (
6927 UpgradeInstruction::LoadModule {
6928 module: "hello-rio".into(),
6929 },
6930 crate::render::M2_UPGRADE_INSTRUCTION_KIND_LOAD_MODULE.trim_start_matches(':'),
6931 ),
6932 (
6933 UpgradeInstruction::StateChange {
6934 script: PathBuf::from("lib/migrations/v01-to-v02.lisp"),
6935 },
6936 crate::render::M2_UPGRADE_INSTRUCTION_KIND_STATE_CHANGE.trim_start_matches(':'),
6937 ),
6938 (
6939 UpgradeInstruction::SoftPurge {
6940 module: "hello-rio-old".into(),
6941 },
6942 crate::render::M2_UPGRADE_INSTRUCTION_KIND_SOFT_PURGE.trim_start_matches(':'),
6943 ),
6944 (
6945 UpgradeInstruction::Purge {
6946 module: "hello-rio-old".into(),
6947 },
6948 crate::render::M2_UPGRADE_INSTRUCTION_KIND_PURGE.trim_start_matches(':'),
6949 ),
6950 (
6951 UpgradeInstruction::Restart,
6952 crate::render::M2_UPGRADE_INSTRUCTION_KIND_RESTART.trim_start_matches(':'),
6953 ),
6954 ];
6955 for (sample, expected_value) in &samples {
6956 let v: serde_json::Value = serde_json::to_value(sample).unwrap();
6957 let got = v
6958 .get(crate::render::M2_UPGRADE_INSTRUCTION_KEY_KIND)
6959 .and_then(|k| k.as_str());
6960 assert_eq!(
6961 got,
6962 Some(*expected_value),
6963 "serialized {sample:?} must carry the lifted \
6964 M2_UPGRADE_INSTRUCTION_KEY_KIND byte-sequence \
6965 ({:?}) verbatim as the tag-slot JSON key, holding the \
6966 expected kebab-case value {expected_value:?} (got: {v})",
6967 crate::render::M2_UPGRADE_INSTRUCTION_KEY_KIND,
6968 );
6969 }
6970 }
6971
6972 #[test]
6973 fn m2_upgrade_instruction_key_kind_const_is_lower_camel_case_shape() {
6974 // Shape-pin: the `M2_UPGRADE_INSTRUCTION_KEY_KIND` const must be
6975 // a lowerCamelCase byte-sequence (non-empty, ASCII-lowercase
6976 // leader, ASCII-alphanumeric only — no `snake_case` underscores,
6977 // no `kebab-case` hyphens, no `PascalCase` leading capital, no
6978 // whitespace / colons / dots) — the canonical shape a serde
6979 // internally-tagged discriminator key takes across every peer
6980 // enum in this crate. A future flip to a non-camelCase byte at
6981 // the const surfaces here at build time. Peer of
6982 // `m2_upgrade_from_key_consts_are_lower_camel_case_shape` on the
6983 // sibling per-entry outer-container axis.
6984 let key = crate::render::M2_UPGRADE_INSTRUCTION_KEY_KIND;
6985 assert!(
6986 !key.is_empty(),
6987 "M2_UPGRADE_INSTRUCTION_KEY_KIND must be non-empty (got {key:?})"
6988 );
6989 let first = key.chars().next().unwrap();
6990 assert!(
6991 first.is_ascii_lowercase(),
6992 "M2_UPGRADE_INSTRUCTION_KEY_KIND must lead with an ASCII-lowercase \
6993 byte (got {key:?}, leads with {first:?})",
6994 );
6995 assert!(
6996 key.chars().all(|c| c.is_ascii_alphanumeric()),
6997 "M2_UPGRADE_INSTRUCTION_KEY_KIND must be ASCII-alphanumeric only \
6998 — no `_` / `-` / `:` / `.` / whitespace (got {key:?})",
6999 );
7000 }
7001
7002 #[test]
7003 fn m2_upgrade_instruction_key_kind_const_disjoint_from_variant_data_keys() {
7004 // Cross-axis drift-detection pin: the tag-slot key
7005 // `M2_UPGRADE_INSTRUCTION_KEY_KIND` (`"kind"`) must be
7006 // disjoint from every per-variant data-field key the
7007 // internally-tagged serialization also emits (`"module"` for
7008 // LoadModule/SoftPurge/Purge, `"script"` for StateChange). A
7009 // future accidental rebrand that collapses `tag = "kind"` onto
7010 // one of the data-field names (e.g. `tag = "module"`) would
7011 // silently corrupt every serialized LoadModule blob (the
7012 // module string and the variant tag would collide on the same
7013 // JSON key) and every consumer probe would either misread the
7014 // tag or fail to distinguish variants. Pin the disjointness at
7015 // build time. Same cross-axis discipline the sibling
7016 // `m2_upgrade_from_key_consts_are_pairwise_distinct` pin
7017 // (36ffe65) established on the outer container's own
7018 // `from`/`instructions` pair.
7019 let key = crate::render::M2_UPGRADE_INSTRUCTION_KEY_KIND;
7020 // Enumerate every per-variant data-field key across all five
7021 // variants of [`UpgradeInstruction`], routing through the two
7022 // lifted `M2_UPGRADE_INSTRUCTION_FIELD_KEY_*` byte-string consts
7023 // that name the same per-variant data-field JSON keys the
7024 // `variant_fields` reflection in
7025 // `caixa-core/tests/dispatcher_registration.rs` surfaces. A future
7026 // per-variant struct-field rebrand (`module` → `component`,
7027 // `script` → `path`) lands as an edit to exactly one const and
7028 // reaches this disjointness pin by construction — the two axes
7029 // (tag-slot key on one side, per-variant data-field keys on the
7030 // other) share one source of truth per axis.
7031 for data_field in [
7032 crate::render::M2_UPGRADE_INSTRUCTION_FIELD_KEY_MODULE,
7033 crate::render::M2_UPGRADE_INSTRUCTION_FIELD_KEY_SCRIPT,
7034 ] {
7035 assert_ne!(
7036 key, data_field,
7037 "M2_UPGRADE_INSTRUCTION_KEY_KIND (the serde `tag` slot) \
7038 must be disjoint from every UpgradeInstruction per-variant \
7039 data-field key — got tag-key {key:?} colliding with \
7040 data-field {data_field:?}, which would silently corrupt \
7041 the internally-tagged serialization",
7042 );
7043 }
7044 }
7045
7046 #[test]
7047 fn upgrade_instruction_variant_data_field_keys_match_lifted_field_key_consts() {
7048 // Load-bearing invariant on the M2 `:upgrade-from :instructions`
7049 // per-entry OTP-appup [`UpgradeInstruction`] enum's per-variant
7050 // data-field JSON key axis: the two
7051 // `M2_UPGRADE_INSTRUCTION_FIELD_KEY_*` consts (`_MODULE`,
7052 // `_SCRIPT`) name the exact per-variant field JSON keys the
7053 // `#[serde(tag = "kind", rename_all = "kebab-case")]` attribute on
7054 // [`UpgradeInstruction`] emits alongside the tag-slot key from the
7055 // sibling [`crate::render::M2_UPGRADE_INSTRUCTION_KEY_KIND`]
7056 // const — the `module: String` struct-field on
7057 // `LoadModule`/`SoftPurge`/`Purge` and the `script: PathBuf`
7058 // struct-field on `StateChange` are promoted to sibling JSON keys
7059 // at the same nesting level as the tag by the internally-tagged
7060 // serialization, and every downstream consumer that navigates the
7061 // serialized instruction blob to reach the payload (the caixa-core
7062 // reflection round-trip in `dispatcher_registration.rs` that
7063 // consults `variant_fields`, the sibling disjointness pin below,
7064 // any future wasm-operator upgrade-dispatch step consuming the
7065 // serialized instruction blob to route the per-module load /
7066 // soft-purge / purge action or the per-script state-change action)
7067 // reads through the same `&'static str`. Serialize one Module-
7068 // bearing variant and one Script-bearing variant, then pin that
7069 // each const's byte-sequence appears verbatim in the JSON emission
7070 // — a future accidental struct-field rebrand (`module: String` →
7071 // `component: String`, `script: PathBuf` → `path: PathBuf`) at
7072 // either variant surfaces here as a build-time test failure at
7073 // `upgrade.rs`, not as an apply-time `.get(<stale-field-key>)`
7074 // returning `None` far from the field-name drift's commit.
7075 //
7076 // Same "one canonical byte-string per typed axis" discipline the
7077 // sibling `upgrade_instruction_serde_tag_key_matches_lifted_m2_upgrade_instruction_key_kind_const`
7078 // pin established on the peer tag-slot key axis on the same
7079 // enum — this pin extends the discipline onto the per-variant
7080 // data-field key axis, completing the `:upgrade-from :instructions`
7081 // variant-JSON dual (tag key + tag values + per-variant field keys)
7082 // fully into caixa-core.
7083 let module_sample = UpgradeInstruction::LoadModule {
7084 module: "hello-rio".into(),
7085 };
7086 let v: serde_json::Value = serde_json::to_value(&module_sample).unwrap();
7087 assert_eq!(
7088 v.get(crate::render::M2_UPGRADE_INSTRUCTION_FIELD_KEY_MODULE)
7089 .and_then(|k| k.as_str()),
7090 Some("hello-rio"),
7091 "serialized {module_sample:?} must carry the lifted \
7092 M2_UPGRADE_INSTRUCTION_FIELD_KEY_MODULE byte-sequence \
7093 ({:?}) verbatim as the data-field JSON key holding the \
7094 module string (got: {v})",
7095 crate::render::M2_UPGRADE_INSTRUCTION_FIELD_KEY_MODULE,
7096 );
7097
7098 let script_sample = UpgradeInstruction::StateChange {
7099 script: PathBuf::from("lib/migrations/v01-to-v02.lisp"),
7100 };
7101 let v: serde_json::Value = serde_json::to_value(&script_sample).unwrap();
7102 assert_eq!(
7103 v.get(crate::render::M2_UPGRADE_INSTRUCTION_FIELD_KEY_SCRIPT)
7104 .and_then(|k| k.as_str()),
7105 Some("lib/migrations/v01-to-v02.lisp"),
7106 "serialized {script_sample:?} must carry the lifted \
7107 M2_UPGRADE_INSTRUCTION_FIELD_KEY_SCRIPT byte-sequence \
7108 ({:?}) verbatim as the data-field JSON key holding the \
7109 script path (got: {v})",
7110 crate::render::M2_UPGRADE_INSTRUCTION_FIELD_KEY_SCRIPT,
7111 );
7112 }
7113
7114 #[test]
7115 fn m2_upgrade_instruction_field_key_consts_are_lower_camel_case_shape() {
7116 // Shape-pin: every `M2_UPGRADE_INSTRUCTION_FIELD_KEY_*` const must
7117 // be a lowerCamelCase byte-sequence (non-empty, ASCII-lowercase
7118 // leader, ASCII-alphanumeric only — no `snake_case` underscores,
7119 // no `kebab-case` hyphens, no `PascalCase` leading capital, no
7120 // whitespace / colons / dots) — the canonical shape a Rust
7121 // struct-field name promoted to a JSON key by serde takes on this
7122 // internally-tagged variant surface, matching the sibling
7123 // [`crate::render::M2_UPGRADE_INSTRUCTION_KEY_KIND`] tag-slot key
7124 // shape. A future flip to a non-camelCase byte at either const
7125 // (an accidental `rename_all` regime interleave, or a struct-
7126 // field flip like `module` → `module_name`) surfaces here at
7127 // build time. Peer of
7128 // `m2_upgrade_instruction_key_kind_const_is_lower_camel_case_shape`
7129 // and `m2_upgrade_from_key_consts_are_lower_camel_case_shape` on
7130 // the sibling wire-key axes.
7131 for key in [
7132 crate::render::M2_UPGRADE_INSTRUCTION_FIELD_KEY_MODULE,
7133 crate::render::M2_UPGRADE_INSTRUCTION_FIELD_KEY_SCRIPT,
7134 ] {
7135 assert!(
7136 !key.is_empty(),
7137 "M2_UPGRADE_INSTRUCTION_FIELD_KEY_* must be non-empty (got {key:?})"
7138 );
7139 let first = key.chars().next().unwrap();
7140 assert!(
7141 first.is_ascii_lowercase(),
7142 "M2_UPGRADE_INSTRUCTION_FIELD_KEY_* must lead with an ASCII-lowercase \
7143 byte (got {key:?}, leads with {first:?})",
7144 );
7145 assert!(
7146 key.chars().all(|c| c.is_ascii_alphanumeric()),
7147 "M2_UPGRADE_INSTRUCTION_FIELD_KEY_* must be ASCII-alphanumeric only \
7148 — no `_` / `-` / `:` / `.` / whitespace (got {key:?})",
7149 );
7150 }
7151 }
7152
7153 #[test]
7154 fn m2_upgrade_instruction_field_key_consts_are_pairwise_distinct() {
7155 // Cross-axis drift-detection pin: a future collapse of the two
7156 // canonical per-variant data-field byte-strings onto the same
7157 // value (e.g. an accidental copy-paste flip of
7158 // `M2_UPGRADE_INSTRUCTION_FIELD_KEY_SCRIPT` to also read
7159 // `"module"`) would silently reroute every test-side probe on one
7160 // variant's payload onto the sibling variant's payload and pass
7161 // every propagation-probe test that expected only the stale
7162 // axis's value. Peer of `m2_upgrade_from_key_consts_are_pairwise_distinct`
7163 // on the sibling per-entry outer-container axis, and of
7164 // `m2_upgrade_instruction_key_kind_const_disjoint_from_variant_data_keys`
7165 // on the sibling tag-slot key ↔ per-variant data-field key axis.
7166 let all = [
7167 crate::render::M2_UPGRADE_INSTRUCTION_FIELD_KEY_MODULE,
7168 crate::render::M2_UPGRADE_INSTRUCTION_FIELD_KEY_SCRIPT,
7169 ];
7170 for (i, a) in all.iter().enumerate() {
7171 for b in all.iter().skip(i + 1) {
7172 assert_ne!(
7173 a, b,
7174 "M2_UPGRADE_INSTRUCTION_FIELD_KEY_* consts must be pairwise-distinct \
7175 canonical byte-sequences — got `{a}` == `{b}`",
7176 );
7177 }
7178 }
7179 }
7180
7181 #[test]
7182 fn m2_upgrade_from_key_consts_are_lower_camel_case_shape() {
7183 // Shape-pin: every `M2_UPGRADE_FROM_KEY_*` const must be a
7184 // lowerCamelCase byte-sequence (no `snake_case` underscores, no
7185 // `kebab-case` hyphens, no `PascalCase` leading capital, no
7186 // whitespace / colons / dots) — the canonical shape the
7187 // `#[serde(rename_all = "camelCase")]` derive produces on
7188 // `UpgradeFromEntry`. A future flip to a non-camelCase attribute
7189 // at the derive surfaces both here (this test fails on the
7190 // stale-constant shape) and at
7191 // `upgrade_from_entry_serde_keys_match_lifted_m2_upgrade_from_key_consts`
7192 // (that test fails on the mismatch between const and derive).
7193 // Peer of `m2_limits_key_consts_are_lower_camel_case_shape`
7194 // (d8b8b4f) and `m2_behavior_key_consts_are_lower_camel_case_shape`
7195 // (21fe462) on the sibling `:limits` / `:behavior` sub-slot axes.
7196 for key in [
7197 crate::render::M2_UPGRADE_FROM_KEY_FROM,
7198 crate::render::M2_UPGRADE_FROM_KEY_INSTRUCTIONS,
7199 ] {
7200 assert!(
7201 !key.is_empty(),
7202 "M2_UPGRADE_FROM_KEY_* must be non-empty (got {key:?})"
7203 );
7204 let first = key.chars().next().unwrap();
7205 assert!(
7206 first.is_ascii_lowercase(),
7207 "M2_UPGRADE_FROM_KEY_* must lead with an ASCII-lowercase \
7208 byte (got {key:?}, leads with {first:?})",
7209 );
7210 assert!(
7211 key.chars().all(|c| c.is_ascii_alphanumeric()),
7212 "M2_UPGRADE_FROM_KEY_* must be ASCII-alphanumeric only \
7213 — no `_` / `-` / `:` / `.` / whitespace (got {key:?})",
7214 );
7215 }
7216 }
7217
7218 #[test]
7219 fn m2_upgrade_instruction_kind_consts_pin_canonical_kebab_case_labels() {
7220 // Scalar-value pin on the M2 `:upgrade-from :instructions` per-entry
7221 // OTP-appup variant-tag axis: the five canonical author-facing
7222 // kebab-case labels (`:load-module` / `:state-change` /
7223 // `:soft-purge` / `:purge` / `:restart`) the substrate's
7224 // per-variant [`UpgradeInstruction::lisp_form`] dispatch reads
7225 // from and every downstream consumer probes for verbatim. Same
7226 // scalar-value discipline the peer
7227 // `contrato_author_key_consts_pin_canonical_kebab_case_labels`
7228 // (f50c875), `m3_top_level_author_key_consts_pin_canonical_kebab_case_labels`
7229 // (882f498), `m2_top_level_author_key_consts_pin_canonical_kebab_case_labels`
7230 // (f49c8b0), and `supervisor_top_level_author_key_consts_pin_canonical_kebab_case_labels`
7231 // (be40492) established for the sibling M2 / M3 / Supervisor
7232 // top-level and sub-slot author-facing-label axes. Fail-before-
7233 // pass-after locally verified by mutating
7234 // `M2_UPGRADE_INSTRUCTION_KIND_LOAD_MODULE` to `":load"` — this
7235 // pin fires as expected; restoring passes.
7236 //
7237 // A future OTP-lineage per-variant rebrand (e.g.
7238 // `:load-module` → `:load` matching Erlang's abbreviated
7239 // `code:load_module` name, `:state-change` → `:code-change`
7240 // matching Erlang's verbatim `code_change/3` callback,
7241 // `:soft-purge` → `:drain` matching a hypothetical operator-side
7242 // vocabulary flip, `:purge` → `:discard` matching a hypothetical
7243 // Elixir/Phoenix hot-reload rebrand, `:restart` → `:reboot`
7244 // matching a supervisor-tree vocabulary alignment) lands as an
7245 // edit to exactly one const, and every consumer that reaches for
7246 // the label (the [`UpgradeInstruction::lisp_form`] dispatch, the
7247 // [`validate_cleanup_singularity`] per-variant `kind:` tagger,
7248 // every [`UpgradeError`] `kind:` / `kinds:` / `other_kinds:` /
7249 // `prior_cleanup_kind:` diagnostic field, the
7250 // [`LayoutError::UpgradeViolation`] `issue:` probe in
7251 // `layout.rs`) picks it up at build time rather than at runtime
7252 // as a downstream `kind: <stale-kebab-case>` diagnostic mismatch
7253 // far from the rename's commit.
7254 assert_eq!(
7255 crate::render::M2_UPGRADE_INSTRUCTION_KIND_LOAD_MODULE,
7256 ":load-module"
7257 );
7258 assert_eq!(
7259 crate::render::M2_UPGRADE_INSTRUCTION_KIND_STATE_CHANGE,
7260 ":state-change"
7261 );
7262 assert_eq!(
7263 crate::render::M2_UPGRADE_INSTRUCTION_KIND_SOFT_PURGE,
7264 ":soft-purge"
7265 );
7266 assert_eq!(crate::render::M2_UPGRADE_INSTRUCTION_KIND_PURGE, ":purge");
7267 assert_eq!(
7268 crate::render::M2_UPGRADE_INSTRUCTION_KIND_RESTART,
7269 ":restart"
7270 );
7271 }
7272
7273 #[test]
7274 fn m2_upgrade_instruction_kind_consts_are_pairwise_distinct() {
7275 // Cross-arm drift-detection pin on the M2
7276 // [`crate::render::M2_UPGRADE_INSTRUCTION_KIND_LOAD_MODULE`] /
7277 // [`crate::render::M2_UPGRADE_INSTRUCTION_KIND_STATE_CHANGE`] /
7278 // [`crate::render::M2_UPGRADE_INSTRUCTION_KIND_SOFT_PURGE`] /
7279 // [`crate::render::M2_UPGRADE_INSTRUCTION_KIND_PURGE`] /
7280 // [`crate::render::M2_UPGRADE_INSTRUCTION_KIND_RESTART`]
7281 // closed-set OTP-appup variant-tag pentad: a future collapse
7282 // of two canonical variant byte-strings onto the same value
7283 // (an accidental copy-paste flip of
7284 // [`crate::render::M2_UPGRADE_INSTRUCTION_KIND_SOFT_PURGE`]
7285 // to also read `":purge"`, a per-arm rebrand that lands one
7286 // const without touching its paired peer) would silently
7287 // reroute every downstream OTP-appup dispatcher's per-
7288 // instruction branch onto the sibling arm's runtime
7289 // behavior and pass every propagation-probe test that
7290 // expected only the stale arm's tag — a `:soft-purge`
7291 // instruction (drain-then-swap: existing callers finish
7292 // under the old module, new callers land on the new one)
7293 // would come up under the `:purge` reconcile branch
7294 // (drop-existing: every in-flight caller terminates
7295 // immediately) on every hot-upgrade cycle, so a rolling
7296 // module swap would silently downgrade to a hard cutover
7297 // against its declared appup discipline, with no field
7298 // naming the instruction-tag drift root cause. Every
7299 // [`crate::UpgradeError`] diagnostic that surfaces the tag
7300 // ([`crate::UpgradeError::ModuleEmpty`] with `kind:` field,
7301 // [`crate::UpgradeError::CleanupCollision`] with `kinds:`
7302 // slice, [`crate::UpgradeError::CleanupPrecedes`] with
7303 // `prior_cleanup_kind:` field, the
7304 // [`crate::LayoutError::UpgradeViolation`] `issue:` probe in
7305 // `layout.rs`) would emit the sibling arm's stale bytes at
7306 // the operator's console, far from the source rebrand
7307 // commit. Peer of the sibling
7308 // [`crate::supervisor::tests::supervisor_estrategia_consts_are_pairwise_distinct`]
7309 // (09ffb2d) /
7310 // [`crate::supervisor::tests::supervisor_child_restart_consts_are_pairwise_distinct`]
7311 // (ccdf955) /
7312 // [`crate::kind::tests::caixa_kind_label_consts_are_pairwise_distinct`]
7313 // (d739850) distinctness pins on the sibling OTP-shape /
7314 // caixa-kind closed-set typed-enum discriminator axes —
7315 // the fifth closed-set OTP-appup / typed-enum axis to
7316 // converge on the same
7317 // "pairwise-distinct-by-construction" discipline, and the
7318 // canonical companion to the peer
7319 // [`m2_upgrade_instruction_field_key_consts_are_pairwise_distinct`]
7320 // (ff980bb) distinctness pin on the sibling internally-
7321 // tagged-JSON per-variant data-field-key axis (the tag axis
7322 // this pin covers vs. the data-field-key axis its peer
7323 // covers — two paired axes on the same
7324 // [`crate::UpgradeInstruction`] typed enum surface).
7325 //
7326 // Fail-before-pass-after locally verified by mutating
7327 // [`crate::render::M2_UPGRADE_INSTRUCTION_KIND_SOFT_PURGE`]
7328 // to also read `":purge"` — this pin fires as expected;
7329 // restoring passes.
7330 let all = [
7331 crate::render::M2_UPGRADE_INSTRUCTION_KIND_LOAD_MODULE,
7332 crate::render::M2_UPGRADE_INSTRUCTION_KIND_STATE_CHANGE,
7333 crate::render::M2_UPGRADE_INSTRUCTION_KIND_SOFT_PURGE,
7334 crate::render::M2_UPGRADE_INSTRUCTION_KIND_PURGE,
7335 crate::render::M2_UPGRADE_INSTRUCTION_KIND_RESTART,
7336 ];
7337 for (i, a) in all.iter().enumerate() {
7338 for (j, b) in all.iter().enumerate() {
7339 if i != j {
7340 assert_ne!(
7341 a, b,
7342 "M2_UPGRADE_INSTRUCTION_KIND_* consts must be pairwise \
7343 distinct — got duplicate {a:?} at indices {i} and {j}",
7344 );
7345 }
7346 }
7347 }
7348 }
7349
7350 #[test]
7351 fn upgrade_instruction_lisp_form_routes_through_lifted_kind_consts() {
7352 // Production-through-const pin: the five per-variant labels
7353 // [`UpgradeInstruction::lisp_form`] returns route through the
7354 // lifted [`crate::render::M2_UPGRADE_INSTRUCTION_KIND_*`] consts,
7355 // so a future rebrand that reaches the const but not the
7356 // dispatch (or vice versa) surfaces here at build time rather
7357 // than at runtime as a downstream
7358 // [`UpgradeError::ModuleEmpty`] `kind: <stale-kebab-case>`
7359 // diagnostic drift far from the rename's commit. Mirror of the
7360 // peer `contrato_shape_gate_routes_through_lifted_contrato_author_key_consts`
7361 // (f50c875), `declared_mesh_slots_route_through_lifted_m3_author_key_consts`
7362 // (882f498), and `declared_servico_slots_route_through_lifted_m2_author_key_consts`
7363 // (f49c8b0) production-through-const pins on the sibling M3 /
7364 // M2 top-level slot axes.
7365 //
7366 // Fail-before-pass-after locally verified by mutating
7367 // `UpgradeInstruction::lisp_form`'s `Self::Purge` arm to return
7368 // `":purge-drift"` — this pin fires as expected; restoring
7369 // passes.
7370 let cases: &[(UpgradeInstruction, &'static str)] = &[
7371 (
7372 UpgradeInstruction::LoadModule { module: "x".into() },
7373 crate::render::M2_UPGRADE_INSTRUCTION_KIND_LOAD_MODULE,
7374 ),
7375 (
7376 UpgradeInstruction::StateChange {
7377 script: PathBuf::from("lib/m.lisp"),
7378 },
7379 crate::render::M2_UPGRADE_INSTRUCTION_KIND_STATE_CHANGE,
7380 ),
7381 (
7382 UpgradeInstruction::SoftPurge {
7383 module: "x-old".into(),
7384 },
7385 crate::render::M2_UPGRADE_INSTRUCTION_KIND_SOFT_PURGE,
7386 ),
7387 (
7388 UpgradeInstruction::Purge {
7389 module: "x-old".into(),
7390 },
7391 crate::render::M2_UPGRADE_INSTRUCTION_KIND_PURGE,
7392 ),
7393 (
7394 UpgradeInstruction::Restart,
7395 crate::render::M2_UPGRADE_INSTRUCTION_KIND_RESTART,
7396 ),
7397 ];
7398 for (instr, expected) in cases {
7399 assert_eq!(
7400 instr.lisp_form(),
7401 *expected,
7402 "UpgradeInstruction::lisp_form on {instr:?} must route through the lifted \
7403 const (expected {expected:?})",
7404 );
7405 }
7406 }
7407
7408 #[test]
7409 fn upgrade_from_entry_instructions_returns_instructions_slice_byte_equal_across_permutations() {
7410 // The canonical per-`:upgrade-from :instructions` OTP-appup
7411 // migration-instruction-list slice-shape pin:
7412 // [`UpgradeFromEntry::instructions`] must return the
7413 // `:instructions` typed `Vec<UpgradeInstruction>` verbatim as
7414 // a `&[UpgradeInstruction]` slice-view over the same backing
7415 // buffer the raw `self.instructions.as_slice()` field access
7416 // borrows from, byte-equal across every representative fixture
7417 // in the accept-set — the empty slice (the "no-op upgrade" /
7418 // metadata-only sentinel the [`UpgradeFromEntry::instructions`]
7419 // field's own docstring names), the singleton slice on every
7420 // variant of the [`UpgradeInstruction`] arm-space
7421 // (`LoadModule` / `StateChange` / `SoftPurge` / `Purge` /
7422 // `Restart` — the five OTP-appup runtime-primitive variants),
7423 // and multi-instruction cohorts (the canonical
7424 // `LoadModule → StateChange → SoftPurge` OTP two-phase code-
7425 // load + state-migration triad the module doc names as the
7426 // "runs the instructions in order" example).
7427 //
7428 // Pins against a future silent detour that returned
7429 // `&Vec<UpgradeInstruction>` (which would type-check but leak
7430 // the storage-side `Vec`'s grow/push/reserve surface no
7431 // consumer of the typed view reaches for), a fresh-allocated
7432 // `Vec<UpgradeInstruction>` copy (which would type-check via
7433 // a coercion but silently break every downstream caller that
7434 // relied on the slice sharing the backing buffer's identity),
7435 // or an out-of-order or length-drifted projection (which
7436 // would silently split the paired within-entry cross-
7437 // instruction ordering gates' inputs from the peer per-
7438 // instruction shape-check loop's input, one seven-gate cohort
7439 // silently drifting from the peer gate's actual traversal
7440 // input).
7441 //
7442 // Peer of the sibling
7443 // `aplicacao_spec_contratos_returns_contratos_slice_byte_equal_across_permutations`
7444 // (0dcc926) `&[WitContract]` byte-equal pin on the M3 per-
7445 // `:contratos` edge-list axis, extended onto the M2 per-
7446 // `:upgrade-from :instructions` migration-instruction-list
7447 // axis — the fifth `&[T]`-return byte-equal pin, closing the
7448 // last unlifted `Vec`-carry axis on any M2 or M3 typed slot.
7449 let fixtures: Vec<Vec<UpgradeInstruction>> = vec![
7450 Vec::new(),
7451 vec![UpgradeInstruction::LoadModule { module: "x".into() }],
7452 vec![UpgradeInstruction::StateChange {
7453 script: PathBuf::from("lib/m.lisp"),
7454 }],
7455 vec![UpgradeInstruction::SoftPurge {
7456 module: "x-old".into(),
7457 }],
7458 vec![UpgradeInstruction::Purge {
7459 module: "x-old".into(),
7460 }],
7461 vec![UpgradeInstruction::Restart],
7462 vec![
7463 UpgradeInstruction::LoadModule { module: "x".into() },
7464 UpgradeInstruction::StateChange {
7465 script: PathBuf::from("lib/migrations/v01-to-v02.lisp"),
7466 },
7467 UpgradeInstruction::SoftPurge {
7468 module: "x-old".into(),
7469 },
7470 ],
7471 ];
7472 for instructions in fixtures {
7473 let e = UpgradeFromEntry {
7474 from: "0.1.0".into(),
7475 instructions: instructions.clone(),
7476 };
7477 assert_eq!(
7478 e.instructions(),
7479 e.instructions.as_slice(),
7480 "UpgradeFromEntry::instructions must project the raw \
7481 `:instructions` `Vec<UpgradeInstruction>` verbatim as a \
7482 `&[UpgradeInstruction]` slice-view over the same backing buffer \
7483 (fixture: {instructions:?})",
7484 );
7485 assert_eq!(
7486 e.instructions().len(),
7487 instructions.len(),
7488 "UpgradeFromEntry::instructions length must match the raw \
7489 `:instructions` `Vec<UpgradeInstruction>` length (fixture: {instructions:?})",
7490 );
7491 }
7492 }
7493
7494 #[test]
7495 fn validate_reads_through_lifted_instructions_accessor() {
7496 // Three-consumer coherence pin on the lifted
7497 // [`UpgradeFromEntry::instructions`] slice-return accessor:
7498 // exercises three of the nine paired production consumers of
7499 // the per-`:upgrade-from :instructions` OTP-appup migration-
7500 // instruction-list surface through end-to-end validate() paths
7501 // that require the accessor to reach each of the fixture's
7502 // instructions.
7503 //
7504 // (1) The per-instruction shape-check fan-out
7505 // ([`UpgradeFromEntry::validate`]'s `for instr in
7506 // self.instructions()` loop): pass the well-formed load →
7507 // state-change → soft-purge triad — `validate()` must accept
7508 // it, which requires the accessor to project every entry so
7509 // each `instr.validate()` fires.
7510 //
7511 // (2) The within-entry state-change-ordering gate
7512 // ([`Self::validate_state_change_ordering`]): pass a
7513 // `((:state-change …))` singleton — `validate()` must return
7514 // [`UpgradeError::StateChangeWithoutPriorLoad`], which
7515 // requires the accessor to reach the state-change so the
7516 // no-prior-load probe fires.
7517 //
7518 // (3) The within-entry per-module cleanup-singularity gate
7519 // ([`Self::validate_cleanup_singularity`]): pass a
7520 // `((:load-module "x") (:soft-purge "x-old") (:soft-purge
7521 // "x-old"))` cohort — `validate()` must return
7522 // [`UpgradeError::DuplicateCleanup`], which requires the
7523 // accessor to iterate the whole list so the second `SoftPurge`
7524 // matches the first via the `seen` set.
7525 //
7526 // Peer of the sibling
7527 // `validate_reads_through_lifted_contratos_accessor` (0dcc926)
7528 // three-consumer coherence pin on the M3 per-`:contratos`
7529 // edge-list axis, extended onto the M2 per-`:upgrade-from
7530 // :instructions` migration-instruction-list axis.
7531
7532 // (1) accept the well-formed OTP two-phase code-load triad
7533 let well_formed = entry(
7534 "0.1.0",
7535 vec![
7536 UpgradeInstruction::LoadModule { module: "x".into() },
7537 UpgradeInstruction::StateChange {
7538 script: PathBuf::from("lib/migrations/v01-to-v02.lisp"),
7539 },
7540 UpgradeInstruction::SoftPurge {
7541 module: "x-old".into(),
7542 },
7543 ],
7544 );
7545 assert!(
7546 well_formed.validate().is_ok(),
7547 "well-formed `LoadModule → StateChange → SoftPurge` triad must accept — \
7548 the per-instruction shape-check fan-out requires the accessor to reach every entry"
7549 );
7550
7551 // (2) refuse a `((:state-change …))` singleton — the
7552 // state-change-without-prior-load gate must fire, which
7553 // requires the accessor to reach the single instruction.
7554 let no_prior_load = entry(
7555 "0.1.0",
7556 vec![UpgradeInstruction::StateChange {
7557 script: PathBuf::from("lib/m.lisp"),
7558 }],
7559 );
7560 match no_prior_load.validate() {
7561 Err(UpgradeError::StateChangeWithoutPriorLoad { .. }) => {}
7562 other => panic!(
7563 "expected StateChangeWithoutPriorLoad on a `((:state-change …))` singleton \
7564 — the within-entry state-change-ordering gate must reach the single \
7565 instruction through the lifted accessor; got: {other:?}"
7566 ),
7567 }
7568
7569 // (3) refuse a `((:load-module "x") (:soft-purge "x-old")
7570 // (:soft-purge "x-old"))` cohort — the per-module cleanup-
7571 // singularity gate must fire on the second `SoftPurge`, which
7572 // requires the accessor to iterate the whole list.
7573 let duplicate_cleanup = entry(
7574 "0.1.0",
7575 vec![
7576 UpgradeInstruction::LoadModule { module: "x".into() },
7577 UpgradeInstruction::SoftPurge {
7578 module: "x-old".into(),
7579 },
7580 UpgradeInstruction::SoftPurge {
7581 module: "x-old".into(),
7582 },
7583 ],
7584 );
7585 match duplicate_cleanup.validate() {
7586 Err(UpgradeError::DuplicateCleanup { module, .. }) => {
7587 assert_eq!(
7588 module, "x-old",
7589 "DuplicateCleanup must name the colliding module `x-old` — the per-module \
7590 cleanup-singularity gate must iterate through the lifted accessor to \
7591 match the second SoftPurge against the first via the `seen` set"
7592 );
7593 }
7594 other => panic!(
7595 "expected DuplicateCleanup on `((:load-module x) (:soft-purge x-old) \
7596 (:soft-purge x-old))` — the within-entry cleanup-singularity gate must \
7597 iterate the whole list through the lifted accessor; got: {other:?}"
7598 ),
7599 }
7600
7601 // Path::new suppresses the unused-import warning if the
7602 // outer module trims `use std::path::Path;` in a future edit.
7603 let _ = Path::new("lib/m.lisp");
7604 }
7605}