footprintjs 8.0.0 → 8.2.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.
@@ -0,0 +1,138 @@
1
+ "use strict";
2
+ /**
3
+ * checkpointSanitize — clone-resilience helpers for `buildPauseCheckpoint`.
4
+ *
5
+ * The pause checkpoint is detached via one `structuredClone` of the assembled
6
+ * checkpoint. The JSON-safe contract governs what CONSUMERS put into a
7
+ * checkpoint (pauseData, shared state) — but the execution tree's diagnostic
8
+ * bags (`logs`/`errors`/`metrics`/`evals`) accept ANY value at write time
9
+ * without cloning (`$debug`/`$error`/`$metric`/`$eval` route through
10
+ * `DiagnosticCollector`, which stores raw references). A `$debug`'d function
11
+ * in any stage of a pausing run would make the whole-checkpoint clone throw
12
+ * `DataCloneError` — swallowing the pause.
13
+ *
14
+ * That violates the library's error-isolation grain: observability side-bags
15
+ * never abort traversal anywhere else. These helpers restore the grain:
16
+ *
17
+ * - `sanitizeDiagnosticBags` — replace non-cloneable diagnostic values with
18
+ * marker strings (`'[non-serializable: function]'`) so the pause survives.
19
+ * - `describeCheckpointCloneFailure` — when the clone STILL fails after
20
+ * sanitization (the non-cloneable lives in consumer-owned data, e.g.
21
+ * `pauseData`), name the offending checkpoint field(s) and point at the
22
+ * JSON-safe contract instead of letting a naked `DataCloneError` escape.
23
+ *
24
+ * Both run ONLY on the clone-failure path of a pause — never on the hot path.
25
+ */
26
+ Object.defineProperty(exports, "__esModule", { value: true });
27
+ exports.describeCheckpointCloneFailure = exports.sanitizeDiagnosticBags = void 0;
28
+ /** The StageSnapshot fields written by `$debug`/`$error`/`$metric`/`$eval`. */
29
+ const DIAGNOSTIC_BAGS = ['logs', 'errors', 'metrics', 'evals'];
30
+ /** `true` when `structuredClone` accepts the value as-is. */
31
+ function isCloneable(value) {
32
+ try {
33
+ structuredClone(value);
34
+ return true;
35
+ }
36
+ catch {
37
+ return false;
38
+ }
39
+ }
40
+ /** Human-readable kind for the `[non-serializable: …]` marker. */
41
+ function describeKind(value) {
42
+ if (value === null)
43
+ return 'null';
44
+ if (typeof value !== 'object')
45
+ return typeof value;
46
+ return value.constructor?.name ?? 'object';
47
+ }
48
+ /** Plain data container we can rebuild entry-by-entry without lying about the type. */
49
+ function isPlainObject(value) {
50
+ const proto = Object.getPrototypeOf(value);
51
+ return proto === Object.prototype || proto === null;
52
+ }
53
+ /**
54
+ * Deep-replace non-cloneable values with `'[non-serializable: <kind>]'`
55
+ * marker strings, preserving everything `structuredClone` accepts.
56
+ *
57
+ * Fast path: a cloneable value is returned AS-IS (no copy — the caller
58
+ * clones the whole checkpoint right after). Only containers that actually
59
+ * hold a non-cloneable leaf are rebuilt, and only KNOWN container shapes
60
+ * (array / Map / Set / plain object) are rebuilt entry-by-entry — exotic
61
+ * non-cloneables (Promise, WeakMap, class instances holding a function, …)
62
+ * become a typed marker rather than a misleading empty shell. Pure cycles
63
+ * pass the fast path untouched (`structuredClone` supports them); a cycle
64
+ * is only broken — with a marker — when it shares a container with a
65
+ * non-cloneable value.
66
+ */
67
+ function sanitizeValue(value, seen) {
68
+ if (isCloneable(value))
69
+ return value;
70
+ if (value !== null && typeof value === 'object') {
71
+ if (seen.has(value))
72
+ return '[non-serializable: circular]';
73
+ seen.add(value);
74
+ if (Array.isArray(value)) {
75
+ return value.map((v) => sanitizeValue(v, seen));
76
+ }
77
+ if (value instanceof Map) {
78
+ return new Map([...value].map(([k, v]) => [sanitizeValue(k, seen), sanitizeValue(v, seen)]));
79
+ }
80
+ if (value instanceof Set) {
81
+ return new Set([...value].map((v) => sanitizeValue(v, seen)));
82
+ }
83
+ if (isPlainObject(value)) {
84
+ return Object.fromEntries(Object.entries(value).map(([k, v]) => [k, sanitizeValue(v, seen)]));
85
+ }
86
+ }
87
+ return `[non-serializable: ${describeKind(value)}]`;
88
+ }
89
+ /**
90
+ * Walk a `StageSnapshot` tree (via `next` + `children`) and sanitize the four
91
+ * diagnostic bags on every node IN PLACE.
92
+ *
93
+ * In-place is safe and intentional: `StageContext.getSnapshot()` builds fresh
94
+ * node objects on every call, but the bag fields on those fresh nodes ALIAS
95
+ * the live `DiagnosticCollector` bags. We replace the node's bag REFERENCE
96
+ * with a sanitized copy — the live engine bags are never mutated, so a
97
+ * same-executor resume keeps the original diagnostic values.
98
+ */
99
+ function sanitizeDiagnosticBags(tree) {
100
+ const seen = new WeakSet();
101
+ const visit = (node) => {
102
+ for (const bag of DIAGNOSTIC_BAGS) {
103
+ const bagValue = node[bag];
104
+ if (bagValue !== undefined && !isCloneable(bagValue)) {
105
+ node[bag] = sanitizeValue(bagValue, seen);
106
+ }
107
+ }
108
+ if (node.next)
109
+ visit(node.next);
110
+ if (node.children)
111
+ for (const child of node.children)
112
+ visit(child);
113
+ };
114
+ visit(tree);
115
+ return tree;
116
+ }
117
+ exports.sanitizeDiagnosticBags = sanitizeDiagnosticBags;
118
+ /**
119
+ * Build the DESCRIPTIVE error for a checkpoint that still cannot be cloned
120
+ * after diagnostic-bag sanitization — i.e. the non-cloneable value lives in
121
+ * consumer-owned data (a genuine JSON-safe contract violation). Probes each
122
+ * top-level checkpoint field individually so the message names the offending
123
+ * field family. Never lets a naked `DataCloneError` escape.
124
+ */
125
+ function describeCheckpointCloneFailure(checkpoint, cause) {
126
+ const failing = Object.entries(checkpoint)
127
+ .filter(([, value]) => !isCloneable(value))
128
+ .map(([field]) => field);
129
+ const fields = failing.length > 0 ? failing.join(', ') : 'unknown';
130
+ return new Error('FlowChartExecutor: cannot build the pause checkpoint — non-serializable value(s) in ' +
131
+ `checkpoint field(s): ${fields}. The checkpoint contract is JSON-safe (no functions, no ` +
132
+ "class instances). Check the pauseData returned by the pausable stage's execute(), and any " +
133
+ 'subflow state captured at the pause. Diagnostic values from $debug/$metric/$error/$eval ' +
134
+ 'are sanitized automatically and never cause this error. ' +
135
+ 'See docs/guides/execution-model.md ("Pause / resume — what a checkpoint captures").', { cause });
136
+ }
137
+ exports.describeCheckpointCloneFailure = describeCheckpointCloneFailure;
138
+ //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"checkpointSanitize.js","sourceRoot":"","sources":["../../../src/lib/runner/checkpointSanitize.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;;;AAIH,+EAA+E;AAC/E,MAAM,eAAe,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,CAAU,CAAC;AAExE,6DAA6D;AAC7D,SAAS,WAAW,CAAC,KAAc;IACjC,IAAI,CAAC;QACH,eAAe,CAAC,KAAK,CAAC,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,kEAAkE;AAClE,SAAS,YAAY,CAAC,KAAc;IAClC,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,MAAM,CAAC;IAClC,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,OAAO,KAAK,CAAC;IACnD,OAAO,KAAK,CAAC,WAAW,EAAE,IAAI,IAAI,QAAQ,CAAC;AAC7C,CAAC;AAED,uFAAuF;AACvF,SAAS,aAAa,CAAC,KAAa;IAClC,MAAM,KAAK,GAAG,MAAM,CAAC,cAAc,CAAC,KAAK,CAAkB,CAAC;IAC5D,OAAO,KAAK,KAAK,MAAM,CAAC,SAAS,IAAI,KAAK,KAAK,IAAI,CAAC;AACtD,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,SAAS,aAAa,CAAC,KAAc,EAAE,IAAqB;IAC1D,IAAI,WAAW,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACrC,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAChD,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC;YAAE,OAAO,8BAA8B,CAAC;QAC3D,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAChB,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;QAClD,CAAC;QACD,IAAI,KAAK,YAAY,GAAG,EAAE,CAAC;YACzB,OAAO,IAAI,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,aAAa,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/F,CAAC;QACD,IAAI,KAAK,YAAY,GAAG,EAAE,CAAC;YACzB,OAAO,IAAI,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;QAChE,CAAC;QACD,IAAI,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QAChG,CAAC;IACH,CAAC;IACD,OAAO,sBAAsB,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC;AACtD,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,sBAAsB,CAAC,IAAmB;IACxD,MAAM,IAAI,GAAG,IAAI,OAAO,EAAU,CAAC;IACnC,MAAM,KAAK,GAAG,CAAC,IAAmB,EAAQ,EAAE;QAC1C,KAAK,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;YAClC,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;YAC3B,IAAI,QAAQ,KAAK,SAAS,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACrD,IAAI,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC,QAAQ,EAAE,IAAI,CAA4B,CAAC;YACvE,CAAC;QACH,CAAC;QACD,IAAI,IAAI,CAAC,IAAI;YAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChC,IAAI,IAAI,CAAC,QAAQ;YAAE,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ;gBAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IACrE,CAAC,CAAC;IACF,KAAK,CAAC,IAAI,CAAC,CAAC;IACZ,OAAO,IAAI,CAAC;AACd,CAAC;AAdD,wDAcC;AAED;;;;;;GAMG;AACH,SAAgB,8BAA8B,CAAC,UAAmC,EAAE,KAAc;IAChG,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC;SACvC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;SAC1C,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;IAC3B,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACnE,OAAO,IAAI,KAAK,CACd,sFAAsF;QACpF,wBAAwB,MAAM,2DAA2D;QACzF,4FAA4F;QAC5F,0FAA0F;QAC1F,0DAA0D;QAC1D,qFAAqF,EACvF,EAAE,KAAK,EAAE,CACV,CAAC;AACJ,CAAC;AAdD,wEAcC","sourcesContent":["/**\n * checkpointSanitize — clone-resilience helpers for `buildPauseCheckpoint`.\n *\n * The pause checkpoint is detached via one `structuredClone` of the assembled\n * checkpoint. The JSON-safe contract governs what CONSUMERS put into a\n * checkpoint (pauseData, shared state) — but the execution tree's diagnostic\n * bags (`logs`/`errors`/`metrics`/`evals`) accept ANY value at write time\n * without cloning (`$debug`/`$error`/`$metric`/`$eval` route through\n * `DiagnosticCollector`, which stores raw references). A `$debug`'d function\n * in any stage of a pausing run would make the whole-checkpoint clone throw\n * `DataCloneError` — swallowing the pause.\n *\n * That violates the library's error-isolation grain: observability side-bags\n * never abort traversal anywhere else. These helpers restore the grain:\n *\n *   - `sanitizeDiagnosticBags` — replace non-cloneable diagnostic values with\n *     marker strings (`'[non-serializable: function]'`) so the pause survives.\n *   - `describeCheckpointCloneFailure` — when the clone STILL fails after\n *     sanitization (the non-cloneable lives in consumer-owned data, e.g.\n *     `pauseData`), name the offending checkpoint field(s) and point at the\n *     JSON-safe contract instead of letting a naked `DataCloneError` escape.\n *\n * Both run ONLY on the clone-failure path of a pause — never on the hot path.\n */\n\nimport type { StageSnapshot } from '../memory/types.js';\n\n/** The StageSnapshot fields written by `$debug`/`$error`/`$metric`/`$eval`. */\nconst DIAGNOSTIC_BAGS = ['logs', 'errors', 'metrics', 'evals'] as const;\n\n/** `true` when `structuredClone` accepts the value as-is. */\nfunction isCloneable(value: unknown): boolean {\n  try {\n    structuredClone(value);\n    return true;\n  } catch {\n    return false;\n  }\n}\n\n/** Human-readable kind for the `[non-serializable: …]` marker. */\nfunction describeKind(value: unknown): string {\n  if (value === null) return 'null';\n  if (typeof value !== 'object') return typeof value;\n  return value.constructor?.name ?? 'object';\n}\n\n/** Plain data container we can rebuild entry-by-entry without lying about the type. */\nfunction isPlainObject(value: object): boolean {\n  const proto = Object.getPrototypeOf(value) as object | null;\n  return proto === Object.prototype || proto === null;\n}\n\n/**\n * Deep-replace non-cloneable values with `'[non-serializable: <kind>]'`\n * marker strings, preserving everything `structuredClone` accepts.\n *\n * Fast path: a cloneable value is returned AS-IS (no copy — the caller\n * clones the whole checkpoint right after). Only containers that actually\n * hold a non-cloneable leaf are rebuilt, and only KNOWN container shapes\n * (array / Map / Set / plain object) are rebuilt entry-by-entry — exotic\n * non-cloneables (Promise, WeakMap, class instances holding a function, …)\n * become a typed marker rather than a misleading empty shell. Pure cycles\n * pass the fast path untouched (`structuredClone` supports them); a cycle\n * is only broken — with a marker — when it shares a container with a\n * non-cloneable value.\n */\nfunction sanitizeValue(value: unknown, seen: WeakSet<object>): unknown {\n  if (isCloneable(value)) return value;\n  if (value !== null && typeof value === 'object') {\n    if (seen.has(value)) return '[non-serializable: circular]';\n    seen.add(value);\n    if (Array.isArray(value)) {\n      return value.map((v) => sanitizeValue(v, seen));\n    }\n    if (value instanceof Map) {\n      return new Map([...value].map(([k, v]) => [sanitizeValue(k, seen), sanitizeValue(v, seen)]));\n    }\n    if (value instanceof Set) {\n      return new Set([...value].map((v) => sanitizeValue(v, seen)));\n    }\n    if (isPlainObject(value)) {\n      return Object.fromEntries(Object.entries(value).map(([k, v]) => [k, sanitizeValue(v, seen)]));\n    }\n  }\n  return `[non-serializable: ${describeKind(value)}]`;\n}\n\n/**\n * Walk a `StageSnapshot` tree (via `next` + `children`) and sanitize the four\n * diagnostic bags on every node IN PLACE.\n *\n * In-place is safe and intentional: `StageContext.getSnapshot()` builds fresh\n * node objects on every call, but the bag fields on those fresh nodes ALIAS\n * the live `DiagnosticCollector` bags. We replace the node's bag REFERENCE\n * with a sanitized copy — the live engine bags are never mutated, so a\n * same-executor resume keeps the original diagnostic values.\n */\nexport function sanitizeDiagnosticBags(tree: StageSnapshot): StageSnapshot {\n  const seen = new WeakSet<object>();\n  const visit = (node: StageSnapshot): void => {\n    for (const bag of DIAGNOSTIC_BAGS) {\n      const bagValue = node[bag];\n      if (bagValue !== undefined && !isCloneable(bagValue)) {\n        node[bag] = sanitizeValue(bagValue, seen) as Record<string, unknown>;\n      }\n    }\n    if (node.next) visit(node.next);\n    if (node.children) for (const child of node.children) visit(child);\n  };\n  visit(tree);\n  return tree;\n}\n\n/**\n * Build the DESCRIPTIVE error for a checkpoint that still cannot be cloned\n * after diagnostic-bag sanitization — i.e. the non-cloneable value lives in\n * consumer-owned data (a genuine JSON-safe contract violation). Probes each\n * top-level checkpoint field individually so the message names the offending\n * field family. Never lets a naked `DataCloneError` escape.\n */\nexport function describeCheckpointCloneFailure(checkpoint: Record<string, unknown>, cause: unknown): Error {\n  const failing = Object.entries(checkpoint)\n    .filter(([, value]) => !isCloneable(value))\n    .map(([field]) => field);\n  const fields = failing.length > 0 ? failing.join(', ') : 'unknown';\n  return new Error(\n    'FlowChartExecutor: cannot build the pause checkpoint — non-serializable value(s) in ' +\n      `checkpoint field(s): ${fields}. The checkpoint contract is JSON-safe (no functions, no ` +\n      \"class instances). Check the pauseData returned by the pausable stage's execute(), and any \" +\n      'subflow state captured at the pause. Diagnostic values from $debug/$metric/$error/$eval ' +\n      'are sanitized automatically and never cause this error. ' +\n      'See docs/guides/execution-model.md (\"Pause / resume — what a checkpoint captures\").',\n    { cause },\n  );\n}\n"]}
@@ -66,7 +66,9 @@ export declare class StageContext {
66
66
  useRedactedMirror(mirror: SharedMemory): void;
67
67
  /** Returns the redacted mirror if installed, else undefined. */
68
68
  getRedactedSharedMemory(): SharedMemory | undefined;
69
- /** Lazily creates the transaction buffer (pay clone cost only if stage writes). */
69
+ /** Lazily creates the transaction buffer on the stage's FIRST state access
70
+ * reads included, so read-only stages currently pay the clone cost too.
71
+ * (Truly lazy-on-write is backlog Phase-3 #13.) */
70
72
  getTransactionBuffer(): TransactionBuffer;
71
73
  /** Builds an absolute path inside the shared memory (run namespace). */
72
74
  private withNamespace;
@@ -107,6 +107,16 @@ export declare class FlowChartExecutor<TOut = any, TScope = any> {
107
107
  * scope. See `test/lib/pause/cross-executor-resume.test.ts`.
108
108
  */
109
109
  private _hasRunBefore;
110
+ /**
111
+ * Re-entrancy guard. `run()` and `resume()` mutate per-run instance state
112
+ * (traverser, runId, execution counter, checkpoint) and clear attached
113
+ * recorders — a second concurrent entry on the SAME executor would
114
+ * interleave runIds and cross-contaminate recorder/narrative state, and
115
+ * `getCheckpoint()` would return whichever run paused last. One executor =
116
+ * one in-flight execution; create an executor per concurrent run.
117
+ * See docs/guides/execution-model.md.
118
+ */
119
+ private _isExecuting;
110
120
  private readonly flowChartArgs;
111
121
  /**
112
122
  * Create a FlowChartExecutor.
@@ -143,6 +153,11 @@ export declare class FlowChartExecutor<TOut = any, TScope = any> {
143
153
  *
144
154
  * The checkpoint is JSON-serializable — store it in Redis, Postgres, localStorage, etc.
145
155
  *
156
+ * It is fully DETACHED from engine state: every field was deep-copied at
157
+ * pause time (see `buildPauseCheckpoint`). Holding, mutating, or persisting
158
+ * it cannot affect the executor, and a later same-executor resume cannot
159
+ * mutate a checkpoint you already stored.
160
+ *
146
161
  * @example
147
162
  * ```typescript
148
163
  * const result = await executor.run({ input });
@@ -198,6 +213,47 @@ export declare class FlowChartExecutor<TOut = any, TScope = any> {
198
213
  * ```
199
214
  */
200
215
  resume(checkpoint: FlowchartCheckpoint, resumeInput?: unknown, options?: Pick<RunOptions, 'signal' | 'env' | 'maxDepth'>): Promise<ExecutorResult>;
216
+ /**
217
+ * Build a fully DETACHED checkpoint from a caught PauseSignal.
218
+ *
219
+ * Every field is deep-copied via one `structuredClone` of the assembled
220
+ * checkpoint, because the raw pieces alias live engine state:
221
+ *
222
+ * - `sharedState` IS `SharedMemory`'s internal context object — the alias
223
+ * only detaches at the next commit (`applySmartMerge` rebuilds it), and
224
+ * after a pause there is no next commit until resume.
225
+ * - `executionTree` nodes are fresh, but their `logs`/`errors`/`metrics`/
226
+ * `evals`/`stageReads`/`flowMessages` fields reference live
227
+ * `DiagnosticCollector` bags that keep accumulating on same-executor
228
+ * resume.
229
+ * - `subflowStates` values are shallow copies whose NESTED objects alias
230
+ * subflow memory, and they get seeded back into live runtimes on resume.
231
+ * - `subflowResults` values stay referenced by the traverser's results map.
232
+ *
233
+ * The checkpoint is persisted by contract ("store in Redis/Postgres") — it
234
+ * must never share structure with the engine. Pause is not a hot path; the
235
+ * clone cost is irrelevant.
236
+ *
237
+ * The JSON-safe checkpoint contract (no functions, no class instances)
238
+ * governs CONSUMER-owned data — but the executionTree's diagnostic bags
239
+ * accept ANY value at write time without cloning ($debug/$error/$metric/
240
+ * $eval store raw references), so a contract-compliant run can still carry
241
+ * a non-cloneable diagnostic. Observability side-bags never abort traversal
242
+ * anywhere else in the library, so they must not abort the pause either:
243
+ * on clone failure we sanitize the diagnostic bags (non-cloneable values
244
+ * become '[non-serializable: …]' markers — the live engine bags are never
245
+ * touched) and retry. If the retry STILL fails, the violation is in
246
+ * consumer-owned data (realistically `pauseData` — a function in shared
247
+ * state already rejects at stage entry when TransactionBuffer clones the
248
+ * context) and we throw a DESCRIPTIVE contract error naming the offending
249
+ * checkpoint field(s). A naked DataCloneError never escapes.
250
+ *
251
+ * Subflow scope capture (`subflowStates`) survives ONLY on the signal — the
252
+ * nested runtimes are GC'd as the stack unwinds. Promoting it onto the
253
+ * checkpoint here lets cross-executor resume restore pre-pause subflow
254
+ * scope (e.g. an Agent's `scope.history`). Empty `{}` for root-level pauses.
255
+ */
256
+ private buildPauseCheckpoint;
201
257
  /**
202
258
  * Find a StageNode in the compiled graph by ID.
203
259
  * Handles subflow paths by drilling into registered subflows.
@@ -395,6 +451,11 @@ export declare class FlowChartExecutor<TOut = any, TScope = any> {
395
451
  *
396
452
  * The commit log is already redacted at write-time regardless of this
397
453
  * flag, and the execution tree carries only structural metadata.
454
+ *
455
+ * **Treat `sharedState` as READ-ONLY.** In production it is a live view of
456
+ * the engine's working memory (zero copy cost) — mutating it corrupts
457
+ * engine state. In dev mode (`enableDevMode()`) it is a deep-frozen CLONE,
458
+ * so any consumer mutation throws loudly instead of corrupting silently.
398
459
  */
399
460
  getSnapshot(options?: {
400
461
  redact?: boolean;
@@ -0,0 +1,44 @@
1
+ /**
2
+ * checkpointSanitize — clone-resilience helpers for `buildPauseCheckpoint`.
3
+ *
4
+ * The pause checkpoint is detached via one `structuredClone` of the assembled
5
+ * checkpoint. The JSON-safe contract governs what CONSUMERS put into a
6
+ * checkpoint (pauseData, shared state) — but the execution tree's diagnostic
7
+ * bags (`logs`/`errors`/`metrics`/`evals`) accept ANY value at write time
8
+ * without cloning (`$debug`/`$error`/`$metric`/`$eval` route through
9
+ * `DiagnosticCollector`, which stores raw references). A `$debug`'d function
10
+ * in any stage of a pausing run would make the whole-checkpoint clone throw
11
+ * `DataCloneError` — swallowing the pause.
12
+ *
13
+ * That violates the library's error-isolation grain: observability side-bags
14
+ * never abort traversal anywhere else. These helpers restore the grain:
15
+ *
16
+ * - `sanitizeDiagnosticBags` — replace non-cloneable diagnostic values with
17
+ * marker strings (`'[non-serializable: function]'`) so the pause survives.
18
+ * - `describeCheckpointCloneFailure` — when the clone STILL fails after
19
+ * sanitization (the non-cloneable lives in consumer-owned data, e.g.
20
+ * `pauseData`), name the offending checkpoint field(s) and point at the
21
+ * JSON-safe contract instead of letting a naked `DataCloneError` escape.
22
+ *
23
+ * Both run ONLY on the clone-failure path of a pause — never on the hot path.
24
+ */
25
+ import type { StageSnapshot } from '../memory/types.js';
26
+ /**
27
+ * Walk a `StageSnapshot` tree (via `next` + `children`) and sanitize the four
28
+ * diagnostic bags on every node IN PLACE.
29
+ *
30
+ * In-place is safe and intentional: `StageContext.getSnapshot()` builds fresh
31
+ * node objects on every call, but the bag fields on those fresh nodes ALIAS
32
+ * the live `DiagnosticCollector` bags. We replace the node's bag REFERENCE
33
+ * with a sanitized copy — the live engine bags are never mutated, so a
34
+ * same-executor resume keeps the original diagnostic values.
35
+ */
36
+ export declare function sanitizeDiagnosticBags(tree: StageSnapshot): StageSnapshot;
37
+ /**
38
+ * Build the DESCRIPTIVE error for a checkpoint that still cannot be cloned
39
+ * after diagnostic-bag sanitization — i.e. the non-cloneable value lives in
40
+ * consumer-owned data (a genuine JSON-safe contract violation). Probes each
41
+ * top-level checkpoint field individually so the message names the offending
42
+ * field family. Never lets a naked `DataCloneError` escape.
43
+ */
44
+ export declare function describeCheckpointCloneFailure(checkpoint: Record<string, unknown>, cause: unknown): Error;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "footprintjs",
3
- "version": "8.0.0",
3
+ "version": "8.2.0",
4
4
  "description": "Explainable backend flows — automatic causal traces, decision evidence, and MCP tool generation for AI agents",
5
5
  "license": "MIT",
6
6
  "author": "Sanjay Krishna Anbalagan",
@@ -53,7 +53,11 @@
53
53
  "lint:fix": "eslint '{src,test}/**/*.ts' --ext .ts --fix",
54
54
  "format:fix": "prettier --config .prettierrc.js --write '{src,test}/**/*.ts'",
55
55
  "format": "prettier --config .prettierrc.js --list-different '{src,test}/**/*.ts'",
56
- "bench": "npx tsx bench/run.ts",
56
+ "bench": "npm run bench:micro && npm run bench:baseline && npm run bench:depth",
57
+ "bench:micro": "npx tsx bench/run.ts",
58
+ "bench:baseline": "npx tsx bench/baseline.ts",
59
+ "bench:depth": "npx tsx bench/depth-probe.ts",
60
+ "bench:typecheck": "tsc -p bench/tsconfig.json",
57
61
  "docs": "typedoc",
58
62
  "docs:serve": "typedoc && npx serve docs",
59
63
  "test:coverage": "vitest run --coverage --coverage.reporter=json-summary --coverage.reporter=text-summary --coverage.reportsDirectory=coverage",