footprintjs 9.44.3 → 9.46.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CLAUDE.md +9 -8
- package/dist/esm/lib/memory/DiagnosticCollector.js +2 -2
- package/dist/esm/lib/memory/RecordFrame.d.ts +197 -0
- package/dist/esm/lib/memory/RecordFrame.js +265 -0
- package/dist/esm/lib/memory/SharedMemory.d.ts +11 -10
- package/dist/esm/lib/memory/SharedMemory.js +19 -20
- package/dist/esm/lib/memory/StageContext.d.ts +52 -137
- package/dist/esm/lib/memory/StageContext.js +111 -215
- package/dist/esm/lib/memory/TransactionBuffer.d.ts +6 -5
- package/dist/esm/lib/memory/TransactionBuffer.js +7 -6
- package/dist/esm/lib/memory/utils.d.ts +11 -7
- package/dist/esm/lib/memory/utils.js +46 -28
- package/dist/esm/lib/reactive/structuralWrite.d.ts +1 -1
- package/dist/esm/lib/reactive/structuralWrite.js +2 -2
- package/dist/lib/memory/DiagnosticCollector.js +2 -2
- package/dist/lib/memory/RecordFrame.js +269 -0
- package/dist/lib/memory/SharedMemory.js +19 -20
- package/dist/lib/memory/StageContext.js +111 -215
- package/dist/lib/memory/TransactionBuffer.js +7 -6
- package/dist/lib/memory/utils.js +46 -28
- package/dist/lib/reactive/structuralWrite.js +2 -2
- package/dist/types/lib/memory/RecordFrame.d.ts +197 -0
- package/dist/types/lib/memory/SharedMemory.d.ts +11 -10
- package/dist/types/lib/memory/StageContext.d.ts +52 -137
- package/dist/types/lib/memory/TransactionBuffer.d.ts +6 -5
- package/dist/types/lib/memory/utils.d.ts +11 -7
- package/dist/types/lib/reactive/structuralWrite.d.ts +1 -1
- package/package.json +1 -1
package/CLAUDE.md
CHANGED
|
@@ -9,7 +9,7 @@ Entry points: `footprintjs` (public API) · `/recorders` (factories) · `/trace`
|
|
|
9
9
|
| src/lib/ | one job |
|
|
10
10
|
|---|---|
|
|
11
11
|
| capture/ | retention policies + bounded payload summarization (leaf; shared by tracking dials AND deferred-observer capture) + `valueKinds` (the ONE classifier of value kinds: `deepEqual`'s arms and what freezing seals, 9.44.2) + the shared leaves `invokeHook` (the one recorder-hook invoker both delivery tiers use), `circular` (dev-mode cycle probe), `summarizeValue` (the narrative one-liner); `lib/devMode.ts` — the dev-mode flag — is its sibling leaf (all four moved out of scope/ and recorder/ in F0: they closed the one memory ⇄ scope ⇄ recorder module cycle) |
|
|
12
|
-
| memory/ | transactional state: SharedMemory heap, StageContext frames, TransactionBuffer staging (+ admission.ts, the admitted record's check; deltaEncoding.ts, the delta encoder's helpers), EventLog commit log — PLUS the ONE verb law (`verbs.ts`, L1: `applyVerb`, `foldRows`, `foldKey`; leaves `paths.ts` / `equality.ts` / `merge.ts`; `utils.ts` re-exports them) and trace analysis (backtrack.ts causalChain, commitLogUtils.ts) |
|
|
12
|
+
| memory/ | transactional state: SharedMemory heap, StageContext frames, `RecordFrame` (the record half of a frame, L3, C3: the address, the first-touch base, the two-tier read, the lazy buffer, the readKeys list, and the commit through `recordCommit`; StageContext composes it), TransactionBuffer staging (+ admission.ts, the admitted record's check; deltaEncoding.ts, the delta encoder's helpers), EventLog commit log — PLUS the ONE verb law (`verbs.ts`, L1: `applyVerb`, `foldRows`, `foldKey`; leaves `paths.ts` / `equality.ts` / `merge.ts`; `utils.ts` re-exports them) and trace analysis (backtrack.ts causalChain, commitLogUtils.ts) |
|
|
13
13
|
| schema/ | duck-typed validation (`.safeParse/.parse` ⇒ 'parseable') |
|
|
14
14
|
| builder/ | fluent DSL → FlowChartSpec → StageNode graph; build-time StructureRecorder channel. NOT standalone: imports runner's makeRunnable (FlowChartBuilder.ts:18) |
|
|
15
15
|
| scope/ | ScopeFacade per stage (tracked get/set, $emit, frozen args/env); built-in ScopeRecorders in scope/recorders/ |
|
|
@@ -24,21 +24,21 @@ Entry points: `footprintjs` (public API) · `/recorders` (factories) · `/trace`
|
|
|
24
24
|
| observer-queue/ | pure deferred-delivery pipeline (engine imports IT, never reverse) |
|
|
25
25
|
| contract/, detach/ | I/O schema normalization (OpenAPI generation belongs to runner/RunnableChart); fire-and-forget child charts (drivers passed explicitly) |
|
|
26
26
|
|
|
27
|
-
**The fence (F0):** a file imports only its own layer or BELOW — L0 values/leaves · L1 verbs · L2 staging+commit · L3 the log as a read model · L4 frame+run policy · L5 scope/recorders/hooks · L6 engine · L7 builder+executor · L8 the `src/*.ts` entry barrels. The table is DATA in `scripts/layering.config.cjs` (most specific pattern wins; an unplaced file is an error, and `memory/` has no directory default because it spans L0–L4) and has three readers, none with a copy: `.eslintrc.js` (generated `import/no-restricted-paths` zones + `import/no-cycle`, src only), `npm run check:layering` (value-level cycles at module AND file level + upward RUNTIME edges; type-only imports excluded — the set equals the compiled CJS `require` graph), `test/architecture/layering.test.ts`. Three edges are named on purpose — builder → `runner/RunnableChart.ts` (`makeRunnable`), engine → `reactive/handles.ts`, scope → `detach/spawn.ts` — plus a short `TYPE_ONLY_ALLOWANCES` list (upward imports tsc erases, which the lint rule cannot tell apart); both lists are live-checked and only shrink. A new src file under an unsplit directory inherits its layer; one under `memory/` (or an exact-path entry) must be added to LAYERS — an unplaced file fails lint and the script. Public symbols have ONE canonical door each — `test/architecture/exports.test.ts` fails on any symbol two of the six `package.json` doors both hand out unless it is in `SECOND_DOORS` (28 today, in four reasoned groups; an alias counts as a door).
|
|
27
|
+
**The fence (F0):** a file imports only its own layer or BELOW — L0 values/leaves · L1 verbs · L2 staging+commit · L3 the log as a read model + the record half of a frame (`RecordFrame`) · L4 frame+run policy · L5 scope/recorders/hooks · L6 engine · L7 builder+executor · L8 the `src/*.ts` entry barrels. The table is DATA in `scripts/layering.config.cjs` (most specific pattern wins; an unplaced file is an error, and `memory/` has no directory default because it spans L0–L4) and has three readers, none with a copy: `.eslintrc.js` (generated `import/no-restricted-paths` zones + `import/no-cycle`, src only), `npm run check:layering` (value-level cycles at module AND file level + upward RUNTIME edges; type-only imports excluded — the set equals the compiled CJS `require` graph), `test/architecture/layering.test.ts`. Three edges are named on purpose — builder → `runner/RunnableChart.ts` (`makeRunnable`), engine → `reactive/handles.ts`, scope → `detach/spawn.ts` — plus a short `TYPE_ONLY_ALLOWANCES` list (upward imports tsc erases, which the lint rule cannot tell apart); both lists are live-checked and only shrink. A new src file under an unsplit directory inherits its layer; one under `memory/` (or an exact-path entry) must be added to LAYERS — an unplaced file fails lint and the script. Public symbols have ONE canonical door each — `test/architecture/exports.test.ts` fails on any symbol two of the six `package.json` doors both hand out unless it is in `SECOND_DOORS` (28 today, in four reasoned groups; an alias counts as a door).
|
|
28
28
|
|
|
29
29
|
## Core state & flow
|
|
30
|
-
- `SharedMemory` (memory/SharedMemory.ts) —
|
|
31
|
-
- `StageContext` (memory/StageContext.ts:29) — per-stage frame: lazy TransactionBuffer
|
|
30
|
+
- `SharedMemory` (memory/SharedMemory.ts) — address-scoped heap: the frame's record frame hands it the address (`RecordFrame · address`; the engine decides it in `StageContext.ts · runAddress` / `useAddressOf` from the ONE L4 constant `RUN_NAMESPACE`, C2/C3); committed state is **immutable-after-swap**, COPY-ON-WRITE since 9.29.0: every write (`applyPatch` → `verbs · nextGeneration`, `setValue`/`updateValue`) copies the root + the containers on each written path and SHARES every other subtree with the previous generation, then swaps. A generation is never edited; the seed is detached once at construction. Design: docs/design/2026-10-copy-on-write-commit.md.
|
|
31
|
+
- `StageContext` (memory/StageContext.ts:29) — per-stage frame inside a run; composes `RecordFrame` (memory/RecordFrame.ts, L3, C3: the lazy TransactionBuffer, the first-touch base, the two-tier read, readKeys, the address); `commit()` → `RecordFrame · commit` (payload, then the names) → `memory/recordCommit.ts · recordCommit` (live apply → scrub → mirror → `EventLog.record`) → onCommit → `RecordFrame · release`. `runId` is readonly (the address is decided once, 9.46.0).
|
|
32
32
|
- `CommitBundle`/`EventLog` — one bundle per executed stage, `bundle.idx` == array position; encoding governed by `commitValues: 'full'|'delta'`.
|
|
33
33
|
- `TraversalContext` (engine/narrative/types.ts:172) — THE per-event context (runId, runtimeStageId, parentRuntimeStageId, subflowPath, loopIteration); stamped on every FlowRecorder event.
|
|
34
34
|
- `runtimeStageId` = `[subflowPath/]stageId#executionIndex`; counter shared by reference into subflow traversers → globally unique; NOT reset on resume.
|
|
35
35
|
- Subflows get a fresh isolated ExecutionRuntime (SubflowExecutor.ts:119); inputMapper seeds, outputMapper merges back (arrays CONCAT unless `arrayMerge: Replace`).
|
|
36
36
|
|
|
37
|
-
**Retry (9.15.0):** `StageNode.retry` is a POLICY on a stage, not a kind — no new node type, no `computeNodeType` edit. The loop lives in `FlowchartTraverser.executeStage` (:720), so linear/streaming/pausable/decider/selector/fork-child/subflow-inner all get it from one implementation. A failed non-final attempt calls `StageContext.discardStaged()` (buffer
|
|
37
|
+
**Retry (9.15.0):** `StageNode.retry` is a POLICY on a stage, not a kind — no new node type, no `computeNodeType` edit. The loop lives in `FlowchartTraverser.executeStage` (:720), so linear/streaming/pausable/decider/selector/fork-child/subflow-inner all get it from one implementation. A failed non-final attempt calls `StageContext.discardStaged()` (`RecordFrame · discard`, which drops the buffer, the first-touch base and readKeys, plus _stageWrites/_stageReads + _untrackedSources); the final attempt is today's law untouched. PauseSignal and abort are NEVER retried. One runtimeStageId + one CommitBundle per stage regardless of attempts; retries do not consume `maxIterations`.
|
|
38
38
|
|
|
39
39
|
**Declared tags (9.21.0):** `StageNode.tags?: readonly string[]` is a NAME on a stage, declared at build time — POLICY-like (the retry precedent): no node type, no `computeNodeType` edit, no type-union site, and the one prefixer (`engine/graph/prefixNodeTree.ts`, 9.37.0) spreads `{ ...node }` so it rides subflow prefixing untouched. ONE landing site `FlowChartBuilder.ts · applyTags` (twin of `applyRetryPolicy`) serves the `.tag(...names)` cursor modifier and every `options.tags` site; refuses empty/non-string/`~`/duplicate/double-declare at build. Stamp: `FlowchartTraverser.executeNodeStep` sets `context.tags = node.tags` beside `runtimeStageId` (unconditionally — a re-used context must not keep a prior node's names); `memory/recordCommit.ts · recordCommit` (C1, 9.44.3; was `StageContext · bundleFor`) stamps `tags` beside `untrackedSources` on BOTH commit paths and `StageContext · commit` RELEASES them, so a double-commit path (fork child fan-out repeat, mount exit) records it once — absent when empty (`CommitBundle.tags?`; pinned byte-identical to 9.20.0 by test/lib/engine/scenario/declared-tags-byte-identity.test.ts). NOT inherited by createNext/createChild; the one synthetic node that could lose it is `FlowChartExecutor.resume`'s stand-in for the paused stage — built by `runner/resume.ts · standInFor` from the paused node ITSELF (fn swapped), so it keeps the tags on both re-entries; it runs ONCE — a later visit of the paused id runs the chart's real node, which carries its own tags. The spec carries `tags` as-is (Map advertises the vocabulary; `RuntimeStructureManager.stageNodeToStructure` copies it for run-time-resolved nodes). Reader: `time-travel/tagStops.ts` = `filterStops(commitStops(...), any-of over log[stop.commitIdx].tags, meta = the array)`, exported from `/trace`. Never a runtime `$tag()` — a value would ride past every redaction point. Design: docs/design/2026-09-declared-tags.md.
|
|
40
40
|
|
|
41
|
-
**Event order (code-verified; older docs had 3/4 swapped):** onStageStart → onRead/onWrite (live, PRE-commit) → **onStageEnd (StageRunner.ts:81) → onCommit (StageContext
|
|
41
|
+
**Event order (code-verified; older docs had 3/4 swapped):** onStageStart → onRead/onWrite (live, PRE-commit) → **onStageEnd (StageRunner.ts:81) → onCommit (`StageContext · commit`, after `RecordFrame · commit`)** → FlowRecorder onDecision/onFork/onSelected/onSubflowEntry → onStageExecuted (uniform, with stageType). Error path: commit STILL happens (FlowchartTraverser.ts:1088) before onError+rethrow — a failing stage's writes land. For ANY thrown value (null, null-prototype, hostile Proxy) catch blocks describe it with `errors/errorInfo · thrownText` (never throws), onError fires, and run() rejects with the ORIGINAL value; a failed commit (e.g. an uncloneable write) also fires onError (`handlers/commitStage.ts`, 9.40.0). `interrupt()` rides the ERROR path's shape, not the pausable one: the stage function threw, so onStageEnd does NOT fire (the `addPausableFunction` pause DOES fire it — there the function returned normally).
|
|
42
42
|
|
|
43
43
|
## Extension points
|
|
44
44
|
- **New stage kind**: boolean flag on `StageNode` (engine/graph/StageNode.ts:39 — kinds are flags, not an enum) + builder method on FlowChartBuilder (pattern: addPausableFunction :1264; fire structure events endpoint-before-edge) + phase in the hard-coded chain `executeNodeStep` (FlowchartTraverser.ts:801 — no handler registry; new handler class takes HandlerDeps, engine/types.ts:344, instantiated in traverser ctor :402-413). Must also edit 5 type-union sites: engine/types.ts:477, builder/types.ts:50, builder/types.ts:104, engine/types.ts:427, and computeNodeType's flag→type mapping (RuntimeStructureManager.ts:19-21 — the only one the compiler won't flag; miss it and the new kind silently serializes as 'stage'). Zero-engine alternative: pure sugar over addFunction (pattern: addDetachAndForget :1343). WORKED EXAMPLE (9.14.0 addParallelForEach): flag `isDynamicParallel` + ParallelForEachHandler + Phase 0b (BEFORE Phase 1 VALIDATE — the node has no fn/children/decider by design); it added NO new node type — the spec carries a BOOLEAN and computeNodeType returns 'fork' (precedent: isPausable/isLazy/isStreaming are flags on a 'stage'), which is the cheaper choice whenever the new kind is a variant of an existing shape.
|
|
@@ -54,11 +54,12 @@ Entry points: `footprintjs` (public API) · `/recorders` (factories) · `/trace`
|
|
|
54
54
|
|
|
55
55
|
## Change-impact map
|
|
56
56
|
- **Trace verbs** (`set|merge|append|delete`, memory/types.ts:42) → ONE law, `memory/verbs.ts` (L1) — F2 deleted the three replicas. `applyVerb` is the ONLY function with an arm per verb (a fifth verb in the union stops compiling there; `TRAITS` — `isTotal` / `recordsTail` — says what a verb IS, pinned against the step), `placeVerb` puts its value or removes the key (`ABSENT`), and two loops fold it: `foldRows` folds ONE bundle's rows into a state with the clone DISCIPLINE as a parameter (`'private'` = the PUBLIC `applySmartMerge`, which keeps its 9.28.0 contract: base deep-cloned, fully detached result — 9.29.0; `'pathCopy'` = the engine's `nextGeneration` — live commit + redacted mirror — and the folds' `applySmartMergeInto` — `stateAt`, `EventLog.materialise`; `'byReference'` = `dryFold`, the admitted record's comparison fold — 9.30.0), and `foldKey` folds ONE path's rows across a log — `commitLogUtils · commitValueAt` (anchored at the last total row) and `slice/elementProvenance · arrayProvenance` (an OBSERVER of that fold: it keeps the births and has no verb switch); causalChain/findLastWriter only match paths. A bundle's merge delta is detached ONCE per bundle (`RecordedPayload`): `deepSmartMerge` dedups an array union BY REFERENCE, so the merge rows of one bundle must see the same objects (a per-row clone made `commitValueAt` double the elements — the 9.29.0 reader bug, fixed here); `foldKey` narrows that copy to its one path. **An unknown verb is REFUSED** (`UnknownVerbError`, public on `/trace`; R2) by `foldRows` (so `applySmartMerge`), `commitValueAt`, `arrayProvenance` — they used to fold it as a `merge`; `time-travel/bundles · bundleRefusal` asks the same `isVerb` and makes it a GAP instead. Pinned: the three old replicas live on as the CONTROL in test/lib/memory/property/verb-law-differential.property.test.ts (kept for the packet's lifetime). The delta encoder keeps VOCABULARY only since 9.30.0 (it picks a verb; its values come from `dryFold` of the stage's 'full' rows — `TransactionBuffer · fullRowsValue`; `replayPathVerbs`/`replayFamilyVerbs` deleted). NOT a second loop (9.22.1): `verbs.ts · supersededByNextSet` — the ONE repeated-path skip (CONSECUTIVE same-path `set` rows: only the last is applied), asked by `foldRows` before its step; its commit-side twin is the last-materialised-path memo in `toChangeOnlyPayload`. Rows are never dropped from the log; a non-consecutive skip is WRONG (a descendant op in between coerces/shells the container) — pinned by test/lib/memory/scenario/repeated-path-byte-identity.test.ts. Since 9.23.0 the clone in that memo loop (and every `structuredClone` in `toDeltaPayload`) is THE clone — the patch trees hold references until commit; no verb switch was touched.
|
|
57
|
-
- **
|
|
57
|
+
- **Write address** → ONE constant, `StageContext.ts · RUN_NAMESPACE` (L4), read by `runAddress` and `useAddressOf`; the frame's `RecordFrame` holds the address (C3). `SharedMemory` and the nested writers take the address as data and refuse a non-array; `TransactionBuffer` takes it too (C2, 9.45.0). `test/architecture/write-address.test.ts` refuses the namespace below L4, as a literal or a property (exceptions `RedactionRule · verdictOfRead` / `retainState` until C4).
|
|
58
|
+
- **StageContext.commit / dials** → ONE owner since 9.35.0 (F5): `memory/runPolicy.ts` — a frozen `RunPolicy` (the four dials + the `RedactionRule` + the mirror flag) built ONCE by `FlowChartExecutor · createTraverser` (run AND resume), handed to `ExecutionRuntime`, held BY REFERENCE by every `StageContext` (`inheritRun` in createNext/createChild) and by its `RecordFrame` as its encoding (`useEncoding`, through `StageContext · adoptPolicy`, the one place a frame's policy changes) and passed by `SubflowExecutor · executeSubflow` to the nested runtime BEFORE the seed. A fifth dial = the policy type + its consumer. The old per-dial `use*`/`get*` and `enableRedactedMirror` were removed in 9.36.0 (no compat shims — owner ruling). `commit()`'s FIRST act (9.23.0) is `materialiseWrites` — the `writeTracking` retained form is taken there, once per key, from `_pendingWrites` (bare references + the write-time verdict); anything that reads `_stageWrites` goes through `retainedWrites()` (a non-consuming fold, so a mid-run snapshot is honest), and `discardStaged` drops the pending map with the rest.
|
|
58
59
|
- **runtimeStageId format** (`#`/`/` delimiters) → ONE grammar owner since 9.37.0 (F7): `src/lib/ids/` (L0 leaf: `runtimeStageId.ts` — `parseRuntimeStageId`, `isExecutionKey`, `stageIdOf`, `subflowPathOf`, `refuseReservedId`; `branchSegment.ts` — the `~` grammar). Every parser (ScopeFacade subflow path, subflowResults dual-keying, narrative buffering, store keys) calls it; none re-derives the grammar. R5: every id door (22 at build, plus the run-time dynamic-StageNode door) refuses `#` and `/`; stage ids may contain `~`. `TraversalContext` has ONE constructor (`engine/traversalContext.ts`); `depth` = subflow nesting read off the runtimeStageId on every stamp. Brands `RuntimeStageId`/`ExecutionIndex`/`CommitIdx` on `/trace` (types only).
|
|
59
60
|
- **Subflow id prefixing** → ONE prefixer since 9.37.0: `engine/graph/prefixNodeTree.ts`, used by the builder AND the traverser (eager, lazy and `parallelForEach` mounts — lazy/branch roots were unprefixed before 9.37.0, so branch ids collided); change it + stageMap key composition + resume drilling; the builder's eager mounts all go through `FlowChartBuilder · _mountSubflow` (F10). test/lib/engine/branch-segment-prefixer-equivalence.test.ts stays as a guard.
|
|
60
61
|
- **Checkpoint shape** (format 2 since 9.44.0, LEAN: only what resume reads + the pause's record — no `executionTree`/`subflowResults`; size independent of run length, pinned by test/lib/pause/checkpoint-size.test.ts; 9.39–9.43 refuse format 2, so upgrade readers before writers) → `runner/checkpoint.ts · buildPauseCheckpoint` ↔ `pause/record.ts · decodeCheckpoint` (one upcaster drops v0/v1 fields) ↔ `runner/resume.ts · planResume` (validation via `pause/record.ts · decodeCheckpoint`) ↔ `ResumeEntry.plan` (the path's mounts + captures + dispatcher continuations, the `pendingPauses` queue; refused up front when unwalkable, ambiguous, or a pending record is not a sibling) ↔ `SubflowExecutor · executeSubflow` resume hop (seed from the capture in place of the mapper's values — the mapper still runs, for the args — FIRST entry only) ↔ `ChildrenExecutor · raisePauses` (fills `pendingPauses`). 9.28.0 adds ONE optional field, `pendingPauses` (present only when parallel siblings wait); the redaction law adds `redactionMarks` (names only, present only when the run marked something); every stored checkpoint enters through `pause/record.ts · decodeCheckpoint` (`checkpointVersion: 1`, one upcaster from unversioned v0 which drops the legacy `continuationStageId`, one validator, one message set; 9.39.0). Pinned: a 9.27.0 checkpoint resumes, test/lib/pause/resume-real-chart-9.27.0-checkpoints.test.ts.
|
|
61
|
-
- **Committed-state writers** (copy-on-write, 9.29.0) → anything that writes into `SharedMemory`'s state, a fold's working copy or the buffer's working copy must copy before it writes: `pathOps · ownSpine` for the containers on the path, `ownedRootOf` for the root, `own`/`adopt` for what it created. An in-place edit of a container it did not create edits every generation sharing it — the counted guard stays green while the generations property fails. A new READ path through `TransactionBuffer` goes through `get` (private after the first write) unless it only compares (`peek`); a read the working copy cannot answer is served from LIVE state (`
|
|
62
|
+
- **Committed-state writers** (copy-on-write, 9.29.0) → anything that writes into `SharedMemory`'s state, a fold's working copy or the buffer's working copy must copy before it writes: `pathOps · ownSpine` for the containers on the path, `ownedRootOf` for the root, `own`/`adopt` for what it created. An in-place edit of a container it did not create edits every generation sharing it — the counted guard stays green while the generations property fails. A new READ path through `TransactionBuffer` goes through `get` (private after the first write) unless it only compares (`peek`); a read the working copy cannot answer is served from LIVE state (`RecordFrame · read`, as on 9.28.0) after `TransactionBuffer · detachBase` gives the diff base a private copy at that path — a private copy of the value handed out instead would change live state wherever 9.28.0 let an in-place edit in (a fork child's read of a parent key). `TransactionBuffer · merge` privatises its base first: `deepSmartMerge` dedups arrays BY REFERENCE, so the identity of the base is part of the bytes.
|
|
62
63
|
- **Redaction** (9.19.0; the law restored to owner ruling (a)) has ONE owner: `memory/redaction.ts` `RedactionRule` (verdict per user-level path: `clear | whole | fields`), carried on the run's `RunPolicy` with the four dials (F5). THE LAW: a policy covers EVERYTHING the library retains or serves — log (both encodings), mirror, stageReads/stageWrites, every recorder event inline and deferred (and the rows built from them), narrative, snapshots, diagnostics, pause payloads, boundary records, logger lines — and NEVER the live heap or the resume checkpoint. The two true exceptions are the caller's own values: the `run()` rejection and the live fork result. It selects by NAME, never by content: state by path (`verdict`); a record handed out whole (root input/output — `FlowchartTraverser.execute`; subflow seed/exit — `SubflowExecutor`; pause payload — `engine/handlers/servedPause.ts`; thrown value — `retainStageError`) by its keys at every depth plus declared `fields` under a key of that name (`retainBoundary` — one decision per PATH via `servedByPath`: copy-on-write per path, the visited set only the current path's ancestor stack, a cycle edge landing on the served copy; a path rule is exact under shared references, a key-NAME rule masks a shared node everywhere); a diagnostic entry as the record `{ [name]: value }` (`retainDiagnostic`; `policy.diagnostics` ADDS diagnostic-only selectors, the only ones that reach flow-message text); a subflow mapper's copy by TAINT (`MapperTaint`, asked by `SubflowInputMapper` for both mappers; the `parallelForEach` items selector counts selected reads via `StageContext · selectedReads` and marks `item`/`into`): a value passed under its own name keeps that name's verdict, an object by reference (or the whole handed record, as fields) keeps its source's, anything computed after a selected read is marked whole (conservative); never value equality across names. A mark is a NAME, run-wide, until the key is deleted — and a pause carries the marks (names only) to the resumed run (`FlowchartCheckpoint.redactionMarks`, checked by `pause/record.ts`). A thrown value is walked with its `cause`/`errors`; an object a mapper passes on by reference is scanned for the selected values it read (planted → fields). Name-only patterns (`needsPath` false — no `.`, lookaround, or escape/class that can match `.`) are decided per object, so the walk shares decisions per (object, targets) — linear on a DAG or a linked history; only a path-dependent pattern walks paths, and past 1,000,000 visits it serves the unvisited remainder as the placeholder (one dev-mode warning), never fails the run. Inside a stage, an OBJECT read under a selected name and written under another keeps its rule (`StageContext · stageWrite`, by identity); a primitive or a new object copied across names is selected by its own name only. `StageContext.stageWrite` is the ONE write funnel (facade writes, subflow seed, outputMapper merge-back, resume re-seed) and `getValue` retention asks the same rule; the facade asks it for read/write recorder payloads. An inert rule never enumerates a payload. `emitPatterns` is the one separate scrub (`$emit` payloads, by event name). Two placeholders, historical: log/mirror `'REDACTED'`, scope-tier `'[REDACTED]'`. See `docs/guides/scope.md` → "The one law". Capture the retained form at runtime; no second tree walk or recorder-local policy.
|
|
63
64
|
- **Diagnostic retention** → `DiagnosticCollector` asks the current run rule before merging/storing: a named entry maps to the state key of its name (the run's keys/patterns/marks/fields, at every depth of the value), then the opt-in `RedactionPolicy.diagnostics` selectors (same path algorithm, rooted at the channel). Its internal retained-write bridge supplies legacy facade emits. Existing writers stay void. Only flow-message description/rationale are payloads (no name — diagnostic selectors only); keys/topology/timing stay present. Dynamic capture uses a per-visit engine flag, not a diagnostic bag. A redacted `logs.deciderRationale` also reaches decision explanations. Checkpoints keep retained diagnostic bags but preserve operational state; no retroactive scrub. See the scope guide's diagnostic contract.
|
|
64
65
|
- **Traverser phases** → node-shape reads must use eff* overlay accessors (:646-703) or dynamic StageNode returns break; tail continuations must return ContinuationHops or stacks regrow; decider flat-dispatch must keep InvokerStamp or pause loses its invoker.
|
|
@@ -33,7 +33,7 @@ export class DiagnosticCollector {
|
|
|
33
33
|
write(channel, key, value, path, replace) {
|
|
34
34
|
const kept = this.retain(channel, path, key, value);
|
|
35
35
|
const write = replace ? setNestedValue : updateNestedValue;
|
|
36
|
-
write(this[BAG_FIELDS[channel]],
|
|
36
|
+
write(this[BAG_FIELDS[channel]], [], path, key, kept);
|
|
37
37
|
return kept;
|
|
38
38
|
}
|
|
39
39
|
/** @internal Add once, returning the retained incoming value for emit.
|
|
@@ -83,4 +83,4 @@ export class DiagnosticCollector {
|
|
|
83
83
|
}
|
|
84
84
|
}
|
|
85
85
|
}
|
|
86
|
-
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRGlhZ25vc3RpY0NvbGxlY3Rvci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9saWIvbWVtb3J5L0RpYWdub3N0aWNDb2xsZWN0b3IudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUE7Ozs7Ozs7O0dBUUc7QUFJSCxPQUFPLEVBQUUsY0FBYyxFQUFFLGlCQUFpQixFQUFFLE1BQU0sWUFBWSxDQUFDO0FBSy9ELE1BQU0sVUFBVSxHQUFHO0lBQ2pCLElBQUksRUFBRSxZQUFZO0lBQ2xCLE1BQU0sRUFBRSxjQUFjO0lBQ3RCLE9BQU8sRUFBRSxlQUFlO0lBQ3hCLEtBQUssRUFBRSxhQUFhO0NBQ1osQ0FBQztBQUVYLE1BQU0sT0FBTyxtQkFBbUI7SUFRRDtJQVB0QixVQUFVLEdBQTJCLEVBQUUsQ0FBQztJQUN4QyxZQUFZLEdBQTJCLEVBQUUsQ0FBQztJQUMxQyxhQUFhLEdBQTJCLEVBQUUsQ0FBQztJQUMzQyxXQUFXLEdBQTJCLEVBQUUsQ0FBQztJQUN6QyxZQUFZLEdBQWtCLEVBQUUsQ0FBQztJQUV4QyxzRUFBc0U7SUFDdEUsWUFBNkIsUUFBMEM7UUFBMUMsYUFBUSxHQUFSLFFBQVEsQ0FBa0M7SUFBRyxDQUFDO0lBRTNFLHNHQUFzRztJQUM5RixNQUFNLENBQUMsT0FBMEIsRUFBRSxJQUFjLEVBQUUsR0FBVyxFQUFFLEtBQWM7UUFDcEYsTUFBTSxJQUFJLEdBQUcsSUFBSSxDQUFDLFFBQVEsRUFBRSxFQUFFLENBQUM7UUFDL0IsT0FBTyxJQUFJLElBQUksQ0FBQyxJQUFJLENBQUMsaUJBQWlCLEVBQUUsQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLGdCQUFnQixDQUFDLENBQUMsT0FBTyxFQUFFLEdBQUcsSUFBSSxFQUFFLEdBQUcsQ0FBQyxFQUFFLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUM7SUFDM0csQ0FBQztJQUVPLEtBQUssQ0FBQyxPQUEwQixFQUFFLEdBQVcsRUFBRSxLQUFjLEVBQUUsSUFBYyxFQUFFLE9BQWdCO1FBQ3JHLE1BQU0sSUFBSSxHQUFHLElBQUksQ0FBQyxNQUFNLENBQUMsT0FBTyxFQUFFLElBQUksRUFBRSxHQUFHLEVBQUUsS0FBSyxDQUFDLENBQUM7UUFDcEQsTUFBTSxLQUFLLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxjQUFjLENBQUMsQ0FBQyxDQUFDLGlCQUFpQixDQUFDO1FBQzNELEtBQUssQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLE9BQU8sQ0FBQyxDQUFDLEVBQUUsRUFBRSxFQUFFLElBQUksRUFBRSxHQUFHLEVBQUUsSUFBSSxDQUFDLENBQUM7UUFDdEQsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0lBRUQ7NEVBQ3dFO0lBQ3hFLEdBQUcsQ0FBQyxPQUEwQixFQUFFLEdBQVcsRUFBRSxLQUFjLEVBQUUsT0FBaUIsRUFBRTtRQUM5RSxPQUFPLElBQUksQ0FBQyxLQUFLLENBQUMsT0FBTyxFQUFFLEdBQUcsRUFBRSxLQUFLLEVBQUUsSUFBSSxFQUFFLEtBQUssQ0FBQyxDQUFDO0lBQ3RELENBQUM7SUFFRCxNQUFNLENBQUMsR0FBVyxFQUFFLEtBQVUsRUFBRSxPQUFpQixFQUFFO1FBQ2pELElBQUksQ0FBQyxHQUFHLENBQUMsTUFBTSxFQUFFLEdBQUcsRUFBRSxLQUFLLEVBQUUsSUFBSSxDQUFDLENBQUM7SUFDckMsQ0FBQztJQUVELE1BQU0sQ0FBQyxHQUFXLEVBQUUsS0FBVSxFQUFFLE9BQWlCLEVBQUU7UUFDakQsSUFBSSxDQUFDLEtBQUssQ0FBQyxNQUFNLEVBQUUsR0FBRyxFQUFFLEtBQUssRUFBRSxJQUFJLEVBQUUsSUFBSSxDQUFDLENBQUM7SUFDN0MsQ0FBQztJQUVELFFBQVEsQ0FBQyxHQUFXLEVBQUUsS0FBVSxFQUFFLE9BQWlCLEVBQUU7UUFDbkQsSUFBSSxDQUFDLEdBQUcsQ0FBQyxRQUFRLEVBQUUsR0FBRyxFQUFFLEtBQUssRUFBRSxJQUFJLENBQUMsQ0FBQztJQUN2QyxDQUFDO0lBRUQsU0FBUyxDQUFDLEdBQVcsRUFBRSxLQUFVLEVBQUUsT0FBaUIsRUFBRTtRQUNwRCxJQUFJLENBQUMsR0FBRyxDQUFDLFNBQVMsRUFBRSxHQUFHLEVBQUUsS0FBSyxFQUFFLElBQUksQ0FBQyxDQUFDO0lBQ3hDLENBQUM7SUFFRCxTQUFTLENBQUMsR0FBVyxFQUFFLEtBQVUsRUFBRSxPQUFpQixFQUFFO1FBQ3BELElBQUksQ0FBQyxLQUFLLENBQUMsU0FBUyxFQUFFLEdBQUcsRUFBRSxLQUFLLEVBQUUsSUFBSSxFQUFFLElBQUksQ0FBQyxDQUFDO0lBQ2hELENBQUM7SUFFRCxPQUFPLENBQUMsR0FBVyxFQUFFLEtBQVUsRUFBRSxPQUFpQixFQUFFO1FBQ2xELElBQUksQ0FBQyxHQUFHLENBQUMsT0FBTyxFQUFFLEdBQUcsRUFBRSxLQUFLLEVBQUUsSUFBSSxDQUFDLENBQUM7SUFDdEMsQ0FBQztJQUVELE9BQU8sQ0FBQyxHQUFXLEVBQUUsS0FBVSxFQUFFLE9BQWlCLEVBQUU7UUFDbEQsSUFBSSxDQUFDLEtBQUssQ0FBQyxPQUFPLEVBQUUsR0FBRyxFQUFFLEtBQUssRUFBRSxJQUFJLEVBQUUsSUFBSSxDQUFDLENBQUM7SUFDOUMsQ0FBQztJQUVELGNBQWMsQ0FBQyxXQUF3QjtRQUNyQyxNQUFNLElBQUksR0FBRyxJQUFJLENBQUMsUUFBUSxFQUFFLEVBQUUsQ0FBQztRQUMvQixJQUFJLENBQUMsSUFBSSxJQUFJLElBQUksQ0FBQyxlQUFlLEVBQUUsRUFBRSxDQUFDO1lBQ3BDLElBQUksQ0FBQyxZQUFZLENBQUMsSUFBSSxDQUFDLFdBQVcsQ0FBQyxDQUFDO1lBQ3BDLE9BQU87UUFDVCxDQUFDO1FBQ0QsMkVBQTJFO1FBQzNFLHdFQUF3RTtRQUN4RSx1RUFBdUU7UUFDdkUsTUFBTSxXQUFXLEdBQUcsSUFBSSxDQUFDLGNBQWMsQ0FBQyxDQUFDLGNBQWMsRUFBRSxhQUFhLENBQUMsRUFBRSxXQUFXLENBQUMsV0FBVyxDQUFDLENBQUM7UUFDbEcsTUFBTSxTQUFTLEdBQ2IsV0FBVyxDQUFDLFNBQVMsS0FBSyxTQUFTO1lBQ2pDLENBQUMsQ0FBQyxTQUFTO1lBQ1gsQ0FBQyxDQUFDLElBQUksQ0FBQyxjQUFjLENBQUMsQ0FBQyxjQUFjLEVBQUUsV0FBVyxDQUFDLEVBQUUsV0FBVyxDQUFDLFNBQVMsQ0FBQyxDQUFDO1FBQ2hGLElBQUksV0FBVyxLQUFLLFdBQVcsQ0FBQyxXQUFXLElBQUksU0FBUyxLQUFLLFdBQVcsQ0FBQyxTQUFTLEVBQUUsQ0FBQztZQUNuRixJQUFJLENBQUMsWUFBWSxDQUFDLElBQUksQ0FBQyxXQUFXLENBQUMsQ0FBQztRQUN0QyxDQUFDO2FBQU0sQ0FBQztZQUNOLElBQUksQ0FBQyxZQUFZLENBQUMsSUFBSSxDQUFDLEVBQUUsR0FBRyxXQUFXLEVBQUUsV0FBVyxFQUFFLEdBQUcsQ0FBQyxTQUFTLEtBQUssU0FBUyxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUMsQ0FBQyxDQUFDLEVBQUUsU0FBUyxFQUFFLENBQUMsRUFBRSxDQUFDLENBQUM7UUFDN0csQ0FBQztJQUNILENBQUM7Q0FDRiIsInNvdXJjZXNDb250ZW50IjpbIi8qKlxuICogRGlhZ25vc3RpY0NvbGxlY3RvciDigJQgUGVyLXN0YWdlIG1ldGFkYXRhIGNvbGxlY3RvclxuICpcbiAqIENvbGxlY3RzIG5vbi1leGVjdXRpb24gbWV0YWRhdGEgZHVyaW5nIGEgc3RhZ2UncyBydW46XG4gKiAtIGxvZ3MsIGVycm9ycywgbWV0cmljcywgZXZhbHMsIGZsb3dNZXNzYWdlc1xuICpcbiAqIExpa2UgYSBjb21waWxlcidzIGRpYWdub3N0aWMgY29sbGVjdG9yIOKAlCBnYXRoZXJzIHdhcm5pbmdzLCBlcnJvcnMsXG4gKiBhbmQgdGltaW5nIGluZm8gd2l0aG91dCBhZmZlY3RpbmcgdGhlIGNvbXBpbGF0aW9uIG91dHB1dC5cbiAqL1xuXG5pbXBvcnQgdHlwZSB7IFJlZGFjdGlvblJ1bGUgfSBmcm9tICcuL3JlZGFjdGlvbi5qcyc7XG5pbXBvcnQgdHlwZSB7IEZsb3dNZXNzYWdlIH0gZnJvbSAnLi90eXBlcy5qcyc7XG5pbXBvcnQgeyBzZXROZXN0ZWRWYWx1ZSwgdXBkYXRlTmVzdGVkVmFsdWUgfSBmcm9tICcuL3V0aWxzLmpzJztcblxuLyoqIEBpbnRlcm5hbCBEaWFnbm9zdGljIG5hbWVzcGFjZXMsIHNlcGFyYXRlIGZyb20gc3RhdGUgcGF0aHMuICovXG5leHBvcnQgdHlwZSBEaWFnbm9zdGljQ2hhbm5lbCA9ICdsb2dzJyB8ICdlcnJvcnMnIHwgJ21ldHJpY3MnIHwgJ2V2YWxzJztcblxuY29uc3QgQkFHX0ZJRUxEUyA9IHtcbiAgbG9nczogJ2xvZ0NvbnRleHQnLFxuICBlcnJvcnM6ICdlcnJvckNvbnRleHQnLFxuICBtZXRyaWNzOiAnbWV0cmljQ29udGV4dCcsXG4gIGV2YWxzOiAnZXZhbENvbnRleHQnLFxufSBhcyBjb25zdDtcblxuZXhwb3J0IGNsYXNzIERpYWdub3N0aWNDb2xsZWN0b3Ige1xuICBwdWJsaWMgbG9nQ29udGV4dDogeyBba2V5OiBzdHJpbmddOiBhbnkgfSA9IHt9O1xuICBwdWJsaWMgZXJyb3JDb250ZXh0OiB7IFtrZXk6IHN0cmluZ106IGFueSB9ID0ge307XG4gIHB1YmxpYyBtZXRyaWNDb250ZXh0OiB7IFtrZXk6IHN0cmluZ106IGFueSB9ID0ge307XG4gIHB1YmxpYyBldmFsQ29udGV4dDogeyBba2V5OiBzdHJpbmddOiBhbnkgfSA9IHt9O1xuICBwdWJsaWMgZmxvd01lc3NhZ2VzOiBGbG93TWVzc2FnZVtdID0gW107XG5cbiAgLyoqIFJlYWQgdGhlIGN1cnJlbnQgcnVuIHBvbGljeSwgaW5jbHVkaW5nIHBvbGljeSBzd2FwcyBhbmQgcmVzdW1lLiAqL1xuICBjb25zdHJ1Y3Rvcihwcml2YXRlIHJlYWRvbmx5IHJlYWRSdWxlPzogKCkgPT4gUmVkYWN0aW9uUnVsZSB8IHVuZGVmaW5lZCkge31cblxuICAvKiogQSBuYW1lZCBlbnRyeTogdGhlIHJ1bidzIHJ1bGUgbWFwcyBpdHMgbmFtZSB0byBhIHN0YXRlIGtleSwgdGhlbiBhZGRzIHRoZSBkaWFnbm9zdGljIHNlbGVjdG9ycy4gKi9cbiAgcHJpdmF0ZSByZXRhaW4oY2hhbm5lbDogRGlhZ25vc3RpY0NoYW5uZWwsIHBhdGg6IHN0cmluZ1tdLCBrZXk6IHN0cmluZywgdmFsdWU6IHVua25vd24pOiB1bmtub3duIHtcbiAgICBjb25zdCBydWxlID0gdGhpcy5yZWFkUnVsZT8uKCk7XG4gICAgcmV0dXJuIHJ1bGUgJiYgIXJ1bGUuaXNEaWFnbm9zdGljSW5lcnQoKSA/IHJ1bGUucmV0YWluRGlhZ25vc3RpYyhbY2hhbm5lbCwgLi4ucGF0aCwga2V5XSwgdmFsdWUpIDogdmFsdWU7XG4gIH1cblxuICBwcml2YXRlIHdyaXRlKGNoYW5uZWw6IERpYWdub3N0aWNDaGFubmVsLCBrZXk6IHN0cmluZywgdmFsdWU6IHVua25vd24sIHBhdGg6IHN0cmluZ1tdLCByZXBsYWNlOiBib29sZWFuKTogdW5rbm93biB7XG4gICAgY29uc3Qga2VwdCA9IHRoaXMucmV0YWluKGNoYW5uZWwsIHBhdGgsIGtleSwgdmFsdWUpO1xuICAgIGNvbnN0IHdyaXRlID0gcmVwbGFjZSA/
|
|
86
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"DiagnosticCollector.js","sourceRoot":"","sources":["../../../../src/lib/memory/DiagnosticCollector.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAIH,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAK/D,MAAM,UAAU,GAAG;IACjB,IAAI,EAAE,YAAY;IAClB,MAAM,EAAE,cAAc;IACtB,OAAO,EAAE,eAAe;IACxB,KAAK,EAAE,aAAa;CACZ,CAAC;AAEX,MAAM,OAAO,mBAAmB;IAQD;IAPtB,UAAU,GAA2B,EAAE,CAAC;IACxC,YAAY,GAA2B,EAAE,CAAC;IAC1C,aAAa,GAA2B,EAAE,CAAC;IAC3C,WAAW,GAA2B,EAAE,CAAC;IACzC,YAAY,GAAkB,EAAE,CAAC;IAExC,sEAAsE;IACtE,YAA6B,QAA0C;QAA1C,aAAQ,GAAR,QAAQ,CAAkC;IAAG,CAAC;IAE3E,sGAAsG;IAC9F,MAAM,CAAC,OAA0B,EAAE,IAAc,EAAE,GAAW,EAAE,KAAc;QACpF,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC;QAC/B,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAC3G,CAAC;IAEO,KAAK,CAAC,OAA0B,EAAE,GAAW,EAAE,KAAc,EAAE,IAAc,EAAE,OAAgB;QACrG,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;QACpD,MAAM,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,iBAAiB,CAAC;QAC3D,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;QACtD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;4EACwE;IACxE,GAAG,CAAC,OAA0B,EAAE,GAAW,EAAE,KAAc,EAAE,OAAiB,EAAE;QAC9E,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IACtD,CAAC;IAED,MAAM,CAAC,GAAW,EAAE,KAAU,EAAE,OAAiB,EAAE;QACjD,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IACrC,CAAC;IAED,MAAM,CAAC,GAAW,EAAE,KAAU,EAAE,OAAiB,EAAE;QACjD,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED,QAAQ,CAAC,GAAW,EAAE,KAAU,EAAE,OAAiB,EAAE;QACnD,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IACvC,CAAC;IAED,SAAS,CAAC,GAAW,EAAE,KAAU,EAAE,OAAiB,EAAE;QACpD,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IACxC,CAAC;IAED,SAAS,CAAC,GAAW,EAAE,KAAU,EAAE,OAAiB,EAAE;QACpD,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAChD,CAAC;IAED,OAAO,CAAC,GAAW,EAAE,KAAU,EAAE,OAAiB,EAAE;QAClD,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IACtC,CAAC;IAED,OAAO,CAAC,GAAW,EAAE,KAAU,EAAE,OAAiB,EAAE;QAClD,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC9C,CAAC;IAED,cAAc,CAAC,WAAwB;QACrC,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC;QAC/B,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,eAAe,EAAE,EAAE,CAAC;YACpC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACpC,OAAO;QACT,CAAC;QACD,2EAA2E;QAC3E,wEAAwE;QACxE,uEAAuE;QACvE,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC,cAAc,EAAE,aAAa,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC,CAAC;QAClG,MAAM,SAAS,GACb,WAAW,CAAC,SAAS,KAAK,SAAS;YACjC,CAAC,CAAC,SAAS;YACX,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,cAAc,EAAE,WAAW,CAAC,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;QAChF,IAAI,WAAW,KAAK,WAAW,CAAC,WAAW,IAAI,SAAS,KAAK,WAAW,CAAC,SAAS,EAAE,CAAC;YACnF,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACtC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,GAAG,WAAW,EAAE,WAAW,EAAE,GAAG,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC,CAAC;QAC7G,CAAC;IACH,CAAC;CACF","sourcesContent":["/**\n * DiagnosticCollector — Per-stage metadata collector\n *\n * Collects non-execution metadata during a stage's run:\n * - logs, errors, metrics, evals, flowMessages\n *\n * Like a compiler's diagnostic collector — gathers warnings, errors,\n * and timing info without affecting the compilation output.\n */\n\nimport type { RedactionRule } from './redaction.js';\nimport type { FlowMessage } from './types.js';\nimport { setNestedValue, updateNestedValue } from './utils.js';\n\n/** @internal Diagnostic namespaces, separate from state paths. */\nexport type DiagnosticChannel = 'logs' | 'errors' | 'metrics' | 'evals';\n\nconst BAG_FIELDS = {\n  logs: 'logContext',\n  errors: 'errorContext',\n  metrics: 'metricContext',\n  evals: 'evalContext',\n} as const;\n\nexport class DiagnosticCollector {\n  public logContext: { [key: string]: any } = {};\n  public errorContext: { [key: string]: any } = {};\n  public metricContext: { [key: string]: any } = {};\n  public evalContext: { [key: string]: any } = {};\n  public flowMessages: FlowMessage[] = [];\n\n  /** Read the current run policy, including policy swaps and resume. */\n  constructor(private readonly readRule?: () => RedactionRule | undefined) {}\n\n  /** A named entry: the run's rule maps its name to a state key, then adds the diagnostic selectors. */\n  private retain(channel: DiagnosticChannel, path: string[], key: string, value: unknown): unknown {\n    const rule = this.readRule?.();\n    return rule && !rule.isDiagnosticInert() ? rule.retainDiagnostic([channel, ...path, key], value) : value;\n  }\n\n  private write(channel: DiagnosticChannel, key: string, value: unknown, path: string[], replace: boolean): unknown {\n    const kept = this.retain(channel, path, key, value);\n    const write = replace ? setNestedValue : updateNestedValue;\n    write(this[BAG_FIELDS[channel]], [], path, key, kept);\n    return kept;\n  }\n\n  /** @internal Add once, returning the retained incoming value for emit.\n   * Legacy writers stay void: their result may be returned by a stage. */\n  add(channel: DiagnosticChannel, key: string, value: unknown, path: string[] = []): unknown {\n    return this.write(channel, key, value, path, false);\n  }\n\n  addLog(key: string, value: any, path: string[] = []) {\n    this.add('logs', key, value, path);\n  }\n\n  setLog(key: string, value: any, path: string[] = []) {\n    this.write('logs', key, value, path, true);\n  }\n\n  addError(key: string, value: any, path: string[] = []) {\n    this.add('errors', key, value, path);\n  }\n\n  addMetric(key: string, value: any, path: string[] = []) {\n    this.add('metrics', key, value, path);\n  }\n\n  setMetric(key: string, value: any, path: string[] = []) {\n    this.write('metrics', key, value, path, true);\n  }\n\n  addEval(key: string, value: any, path: string[] = []) {\n    this.add('evals', key, value, path);\n  }\n\n  setEval(key: string, value: any, path: string[] = []) {\n    this.write('evals', key, value, path, true);\n  }\n\n  addFlowMessage(flowMessage: FlowMessage) {\n    const rule = this.readRule?.();\n    if (!rule || rule.isFlowTextInert()) {\n      this.flowMessages.push(flowMessage);\n      return;\n    }\n    // Only payload text is selectable — and it has no name of its own, so only\n    // the diagnostic selectors reach it. Keep the evidence of what happened\n    // (type, targets, timing, counts) even when its explanation is masked.\n    const description = rule.retainFlowText(['flowMessages', 'description'], flowMessage.description);\n    const rationale =\n      flowMessage.rationale === undefined\n        ? undefined\n        : rule.retainFlowText(['flowMessages', 'rationale'], flowMessage.rationale);\n    if (description === flowMessage.description && rationale === flowMessage.rationale) {\n      this.flowMessages.push(flowMessage);\n    } else {\n      this.flowMessages.push({ ...flowMessage, description, ...(rationale === undefined ? {} : { rationale }) });\n    }\n  }\n}\n"]}
|
|
@@ -0,0 +1,197 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* RecordFrame — the record half of one stage's frame (C3, L3).
|
|
3
|
+
*
|
|
4
|
+
* What a stage's frame needs to READ and WRITE the record, and nothing about the stage inside a run:
|
|
5
|
+
* where it writes (its address), what it read first (the first-touch base), what it staged (the lazy
|
|
6
|
+
* transaction buffer), which keys it read (the readKeys list), and where a commit lands (live state,
|
|
7
|
+
* the redacted mirror, the log — through `recordCommit`). The engine's frame (`StageContext`, L4)
|
|
8
|
+
* composes one and keeps the rest: retention, diagnostics, the dev-mode warnings, the commit observer
|
|
9
|
+
* and the redaction verdict.
|
|
10
|
+
*
|
|
11
|
+
* THE LAW:
|
|
12
|
+
* 1. ADDRESS. The frame reads and writes at its address, a path prefix the engine computed and hands
|
|
13
|
+
* over as data (C2: `['runs', <id>]` or `[]`, the root). It moves only before the first write:
|
|
14
|
+
* the buffer keeps the address it was built at (the engine refuses a later move).
|
|
15
|
+
* 2. FIRST TOUCH. The committed generation the frame first touched — its first read OR first write —
|
|
16
|
+
* is held by reference, never cloned: the read view before the first write and the buffer's
|
|
17
|
+
* net-change diff base after it.
|
|
18
|
+
* 3. TWO TIERS. A read is served from the stage's own view (the buffer's working copy once the stage
|
|
19
|
+
* wrote, else the first-touch base); a key absent there is served from LIVE state (at the
|
|
20
|
+
* address, then the root). After the first write the buffer's diff base is first given a private
|
|
21
|
+
* copy at that path (`TransactionBuffer · detachBase`).
|
|
22
|
+
* 4. LAZY BUFFER. The buffer is built at the first write — on the first-touch base, at the address,
|
|
23
|
+
* under the encoding. A frame that never writes builds none, and its commit is the empty bundle.
|
|
24
|
+
* 5. READ KEYS. Under `writeProvenance: 'reads-prefix'` every noted read puts its user-level key
|
|
25
|
+
* (dotted for a nested path) on the frame's list, once, in order; each staged row carries a copy
|
|
26
|
+
* of the list as it stands when the row is staged.
|
|
27
|
+
* 6. COMMIT, RELEASE, DISCARD. `commit` takes the buffer's payload (none = the empty commit), then
|
|
28
|
+
* the names, and hands both to `recordCommit`. `release` drops the buffer and the base; a frame
|
|
29
|
+
* touched again re-anchors on the state as it stands then. The readKeys list survives a release,
|
|
30
|
+
* and goes with `discard` (a failed attempt never happened).
|
|
31
|
+
*/
|
|
32
|
+
import type { EventLog } from './EventLog.js';
|
|
33
|
+
import { type CommitStamp } from './recordCommit.js';
|
|
34
|
+
import type { SharedMemory } from './SharedMemory.js';
|
|
35
|
+
import { TransactionBuffer } from './TransactionBuffer.js';
|
|
36
|
+
import type { CommitValuesMode, WriteProvenanceMode } from './types.js';
|
|
37
|
+
/**
|
|
38
|
+
* The two dials that shape a frame's bytes: the log's value encoding and the per-row read prefix.
|
|
39
|
+
* Held by reference and swapped whole (`useEncoding`), never edited — the engine hands the run's
|
|
40
|
+
* frozen policy itself. Absent: `'full'` values and no read prefix.
|
|
41
|
+
*/
|
|
42
|
+
export interface RecordEncoding {
|
|
43
|
+
readonly commitValues: CommitValuesMode;
|
|
44
|
+
readonly writeProvenance: WriteProvenanceMode;
|
|
45
|
+
}
|
|
46
|
+
export declare class RecordFrame {
|
|
47
|
+
/** Live committed state — the heap every frame of the run shares. */
|
|
48
|
+
readonly state: SharedMemory;
|
|
49
|
+
/** The log the frame's commits land on, when the run keeps one. */
|
|
50
|
+
readonly log?: EventLog;
|
|
51
|
+
/** The redacted mirror the frame's commits land on, when the run keeps one ({@link useMirror}). */
|
|
52
|
+
private _mirror?;
|
|
53
|
+
/** Where the frame reads and writes (law 1). */
|
|
54
|
+
private _address;
|
|
55
|
+
/** The two dials (law 4, 5); absent → the record's defaults. */
|
|
56
|
+
private encoding?;
|
|
57
|
+
/**
|
|
58
|
+
* The committed generation at the frame's FIRST touch (law 2) — held by REFERENCE, never cloned.
|
|
59
|
+
* See {@link firstTouch} for the algorithm and the immutability invariant that makes a bare
|
|
60
|
+
* reference safe.
|
|
61
|
+
*/
|
|
62
|
+
private base?;
|
|
63
|
+
/** The stage's staged writes — built at its first write (law 4), released at commit. */
|
|
64
|
+
private buffer?;
|
|
65
|
+
/**
|
|
66
|
+
* Keys tracked-read so far, in order (law 5) — the source of each staged row's `readKeys`. Only
|
|
67
|
+
* allocated under `'reads-prefix'`; insertion-ordered (a Set) and monotonic, which is what makes
|
|
68
|
+
* "last write's prefix == union" hold in delta mode.
|
|
69
|
+
*/
|
|
70
|
+
private readKeys?;
|
|
71
|
+
constructor(state: SharedMemory, log?: EventLog, address?: readonly string[]);
|
|
72
|
+
/** Where the frame reads and writes (law 1). */
|
|
73
|
+
get address(): readonly string[];
|
|
74
|
+
/**
|
|
75
|
+
* Read and write at `address` from now on — before the frame's first write (law 1): the buffer keeps
|
|
76
|
+
* the address it was built at. The engine's one caller, `StageContext · useAddressOf`, refuses a move
|
|
77
|
+
* once the frame has staged.
|
|
78
|
+
*/
|
|
79
|
+
useAddress(address: readonly string[]): void;
|
|
80
|
+
/** The two dials the frame encodes under from its next buffer and its next read on (law 4, 5). */
|
|
81
|
+
useEncoding(encoding: RecordEncoding): void;
|
|
82
|
+
/** The redacted mirror, if the run keeps one. */
|
|
83
|
+
get mirror(): SharedMemory | undefined;
|
|
84
|
+
/** Land every commit from now on on `mirror` too, with the scrubbed rows the log takes (`recordCommit`). */
|
|
85
|
+
useMirror(mirror: SharedMemory | undefined): void;
|
|
86
|
+
/** The absolute path of `key` under `path`: the frame's address, then the path, then the key. */
|
|
87
|
+
at(path: readonly string[], key: string): string[];
|
|
88
|
+
/**
|
|
89
|
+
* ── The first-touch base (#13) ───────────────────────────────────────────
|
|
90
|
+
*
|
|
91
|
+
* WHAT: returns the committed shared state as it was at this frame's FIRST touch (first read or
|
|
92
|
+
* first write), capturing the reference on first call. Serves two consumers: reads before the first
|
|
93
|
+
* write ({@link read}) and the transaction buffer's diff base ({@link getTransactionBuffer}).
|
|
94
|
+
*
|
|
95
|
+
* WHY A BARE REFERENCE IS SAFE — the invariant this rests on: committed state is
|
|
96
|
+
* immutable-after-swap. Every write to `SharedMemory` builds the NEXT generation and swaps it in
|
|
97
|
+
* (copy-on-write, 9.29.0: `applyPatch` via `nextGeneration`, and `setValue`/`updateValue` too) — it
|
|
98
|
+
* copies the root and the containers on each written path, shares the rest, and never edits a
|
|
99
|
+
* container of the generation a stage captured here. Holding the reference therefore gives this
|
|
100
|
+
* stage a stable snapshot at zero cost — no clone, which is the entire point of #13. The transaction
|
|
101
|
+
* buffer's net-change diff base rests on the same guarantee: it IS this view.
|
|
102
|
+
*
|
|
103
|
+
* WHY FIRST TOUCH, not first write: the pre-#13 eager engine cloned the state into the buffer at
|
|
104
|
+
* the stage's first ACCESS, anchoring both its snapshot reads and its commit baseline (the
|
|
105
|
+
* net-change diff base) there. #13's first cut anchored the lazy buffer at first WRITE — observably
|
|
106
|
+
* different when something else commits in the gap between this stage's first read and its first
|
|
107
|
+
* write. That gap is REACHABLE: fork siblings are namespace-isolated for run-scoped keys (each child
|
|
108
|
+
* writes under `runs/<childId>/`), but ROOT-level keys are shared — written via `setGlobal` from
|
|
109
|
+
* consumer scope code and, critically, by `SubflowInputMapper`'s output mapping
|
|
110
|
+
* (`parentContext.setGlobal`), which is exactly what runs when a subflow is a fork branch. A
|
|
111
|
+
* sibling's root-key commit landing in the gap would shift this stage's diff base, making its
|
|
112
|
+
* CommitBundle record a phantom change (or swallow a real one) relative to the eager engine.
|
|
113
|
+
* Anchoring the view at first touch restores the EXACT eager semantics — sequential AND parallel —
|
|
114
|
+
* at zero clone cost.
|
|
115
|
+
*
|
|
116
|
+
* Read visibility is two-tier, matching eager byte-for-byte: keys present in the view at first
|
|
117
|
+
* touch read repeatably from it; keys ABSENT from it fall back to LIVE state (the eager engine's
|
|
118
|
+
* exact fallback — a mid-flight sibling root-key write was always visible to reads, and stays
|
|
119
|
+
* visible; only the DIFF BASE is pinned).
|
|
120
|
+
*/
|
|
121
|
+
private firstTouch;
|
|
122
|
+
/**
|
|
123
|
+
* The transaction buffer, created lazily on the frame's FIRST WRITE (#13).
|
|
124
|
+
*
|
|
125
|
+
* Reads NEVER construct it: read-your-writes only matters once a staged write exists, so before that
|
|
126
|
+
* {@link read} serves from the first-touch base and {@link commit} records an empty bundle — all with
|
|
127
|
+
* ZERO `structuredClone`s of the shared state.
|
|
128
|
+
*
|
|
129
|
+
* The buffer's base is the FIRST-TOUCH view, NOT the live state at write time: under parallel forks
|
|
130
|
+
* a sibling may have committed between this frame's first read and this write, and the net-change
|
|
131
|
+
* diff base must stay anchored at first touch to match the eager engine — see {@link firstTouch}.
|
|
132
|
+
*/
|
|
133
|
+
getTransactionBuffer(): TransactionBuffer;
|
|
134
|
+
/** Has the frame staged a write since its last release — does its buffer exist? */
|
|
135
|
+
get hasStaged(): boolean;
|
|
136
|
+
/**
|
|
137
|
+
* The frame's read, mirroring the eager engine's read order byte-for-byte (law 3):
|
|
138
|
+
*
|
|
139
|
+
* 1. staged writes + first-touch snapshot — `buffer.get` over its workingCopy when the buffer
|
|
140
|
+
* exists, else `nativeGet` over the zero-clone first-touch base (the buffer's base IS that
|
|
141
|
+
* view, so the two tiers agree on content);
|
|
142
|
+
* 2. LIVE state via `SharedMemory · getValue` for keys absent from the snapshot — including its
|
|
143
|
+
* address→root fallback. The eager engine had this exact live fallback for snapshot-missing
|
|
144
|
+
* keys; byte-identity over purity. After the frame's first write such a value can be the very
|
|
145
|
+
* container the buffer's diff base holds at the path (the stage deleted or unset it, or
|
|
146
|
+
* replaced a container above it), so the base is detached there first
|
|
147
|
+
* (`TransactionBuffer · detachBase`): an in-place edit of the value (out of contract) written
|
|
148
|
+
* back is recorded, as on 9.28.0, whose base was a clone taken at the first write.
|
|
149
|
+
*
|
|
150
|
+
* Reads never construct the buffer (#13): a frame that never writes performs zero clones of the
|
|
151
|
+
* shared state.
|
|
152
|
+
*/
|
|
153
|
+
read(path: string[], key?: string): unknown;
|
|
154
|
+
/** Put a tracked read's user-level key on the readKeys list (law 5) — a no-op unless the frame keeps one. */
|
|
155
|
+
noteRead(path: readonly string[], key: string): void;
|
|
156
|
+
/**
|
|
157
|
+
* Live committed state at `key`: at the frame's address, else at the root — never the stage's own
|
|
158
|
+
* view. Typed as `SharedMemory · getValue` types it, which `StageContext · getRoot` hands on.
|
|
159
|
+
*/
|
|
160
|
+
readLive(key: string): any;
|
|
161
|
+
/** Live committed state at `key` at the root — typed as `SharedMemory · getValue` (`StageContext · getGlobal`). */
|
|
162
|
+
readGlobal(key: string): any;
|
|
163
|
+
/** Did a staged op touch `path` — on it, above it or below it? (A report's question; never the hot path.) */
|
|
164
|
+
wasStaged(path: (string | number)[]): boolean;
|
|
165
|
+
/**
|
|
166
|
+
* The value at `path` in what the stage has seen — its working copy once it wrote, else its
|
|
167
|
+
* first-touch base — WITHOUT taking a private copy: for a report that only compares.
|
|
168
|
+
*/
|
|
169
|
+
peek(path: (string | number)[]): unknown;
|
|
170
|
+
/** The value at `path` in the first-touch base — committed state as the frame first touched it. */
|
|
171
|
+
baseAt(path: (string | number)[]): unknown;
|
|
172
|
+
/**
|
|
173
|
+
* Record what the frame staged (law 6): the buffer's payload first — none, the empty commit, when
|
|
174
|
+
* it staged nothing (#13: zero clones) — then the names (`stampOf()`), read once the payload is
|
|
175
|
+
* built, and both to `recordCommit`. User code can run while the payload is built (a getter on a
|
|
176
|
+
* staged value, which the net-change compare and the clone invoke); what it adds to the names —
|
|
177
|
+
* an untracked read, say — is on the bundle.
|
|
178
|
+
*/
|
|
179
|
+
commit(stampOf: () => CommitStamp): void;
|
|
180
|
+
/**
|
|
181
|
+
* End the frame's hold on state (#13b, law 6): drop the buffer (its working copy and whatever private
|
|
182
|
+
* copies its reads took) and the first-touch base (a reference that pins one committed-state
|
|
183
|
+
* GENERATION). Both re-create lazily: a later read re-anchors on the CURRENT committed state, and a
|
|
184
|
+
* later write builds a fresh buffer on it — so a second commit diffs against the state after the
|
|
185
|
+
* first. Without the release, the execution tree — which retains every frame for the lifetime of
|
|
186
|
+
* the run — retains one state generation per executed stage (measured O(N²) before copy-on-write;
|
|
187
|
+
* a 500-iteration agent OOMed a default Node heap, backlog #18).
|
|
188
|
+
*/
|
|
189
|
+
release(): void;
|
|
190
|
+
/**
|
|
191
|
+
* Throw away everything the frame staged and read (law 6): the buffer, the first-touch base (the next
|
|
192
|
+
* attempt re-anchors on committed state as it stands NOW) and the readKeys list — a discarded
|
|
193
|
+
* attempt's reads must never reach the next attempt's `TraceEntry.readKeys`, or a backward slice
|
|
194
|
+
* would follow an edge that no committed write ever had. Nothing is recorded.
|
|
195
|
+
*/
|
|
196
|
+
discard(): void;
|
|
197
|
+
}
|