Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .changeset/automation-result-stranded-status.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
---
"@objectstack/spec": minor
---

feat(spec): name the terminally-failed-but-repairable run on `AutomationResult.status` — `'stranded'` (#14384, contract half of #13937)

`AutomationResult.status` (`contracts/automation-service.ts`) gains a fourth
member beside `'completed' | 'paused' | 'failed'`: **`'stranded'`** — the run
whose resume CONSUMED its suspension and then had a downstream node throw, so
the run is recorded as failed and can be re-armed only by an explicit operator
verb (#13909's condition; the #13937 shape-4 ruling, maintainer 2026-09-01
「命名同批定」). The wire mirror `TriggerFlowResponseSchema.data.status`
(`api/automation-api.zod.ts`) carries the same four, and a pin test binds the
two at the type level and the value level.

Additive: no existing literal changes meaning, `'failed'` still says "the run
ran and was rejected", and no engine, route or client behaviour moves in this
change — the engine begins stamping `'stranded'` when #13937's services half
(the operator re-arm verb) lands. A consumer that switches exhaustively over
`status` needs a `'stranded'` arm; the measured count of such switches in this
repo is zero. plugin-approvals' report-only `StrandedRunState`
(`'missing' | 'failed'`) is deliberately not promoted (same ruling).
2 changes: 1 addition & 1 deletion content/docs/references/api/automation-api.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -607,7 +607,7 @@ const result = AutomationApiErrorCode.parse(data);
| **error** | `string` | optional | Error message if execution failed |
| **durationMs** | `number` | optional | Execution duration in milliseconds |
| **code** | `Enum<'PERMISSION_DENIED' \| 'INVALID_SIGNAL' \| 'RUN_NOT_FOUND' \| 'STORE_UNAVAILABLE' \| …>` | optional | Machine-readable failure classification, set alongside `error` when the caller must distinguish WHY it failed. A closed union - the members and their transport mappings are documented on the contract (`AutomationResult.code`, contracts/automation-service.ts). |
| **status** | `Enum<'completed' \| 'paused' \| 'failed'>` | optional | Lifecycle status. `paused` means the run suspended at a node and can be continued with the resume route. Absent or `completed`/`failed` means the run reached a terminal state. |
| **status** | `Enum<'completed' \| 'paused' \| 'failed' \| 'stranded'>` | optional | Lifecycle status. `paused` means the run suspended at a node and can be continued with the resume route. Absent or `completed`/`failed`/`stranded` means the run reached a terminal state. `stranded` is the terminally-failed-but-repairable run: a resume consumed the suspension and a downstream node threw, so the run is recorded as failed and can be re-armed only by an explicit operator verb - never by the resume route, which answers RUN_NOT_FOUND for it. |
| **runId** | `string` | optional | Run id - set when `status` is `paused`, so callers can resume it |
| **screen** | `{ nodeId: string; title?: string; description?: string; fields: object[]; … }` | optional | The screen to render - set when the run paused at a `screen` node awaiting user input. The client collects values for `screen.fields` and resumes the run with them. |
| **successMessage** | `string` | optional | Friendly terminal message copied from the flow definition on terminal success, so a screen-flow runner can show a meaningful toast |
Expand Down
13 changes: 10 additions & 3 deletions packages/spec/src/api/automation-api.zod.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -337,10 +337,17 @@ export const TriggerFlowResponseSchema = lazySchema(() => BaseResponseSchema.ext
+ 'their transport mappings are documented on the contract '
+ '(`AutomationResult.code`, contracts/automation-service.ts).',
),
status: z.enum(['completed', 'paused', 'failed']).optional().describe(
// `stranded` is the contract half of the #13937 shape-4 ruling (#14384);
// the condition is #13909's. Mirrors `AutomationResult.status` member for
// member — the pin is `contracts/automation-result-status.pin.test.ts`.
status: z.enum(['completed', 'paused', 'failed', 'stranded']).optional().describe(
'Lifecycle status. `paused` means the run suspended at a node and can be '
+ 'continued with the resume route. Absent or `completed`/`failed` means '
+ 'the run reached a terminal state.',
+ 'continued with the resume route. Absent or `completed`/`failed`/`stranded` '
+ 'means the run reached a terminal state. `stranded` is the '
+ 'terminally-failed-but-repairable run: a resume consumed the suspension '
+ 'and a downstream node threw, so the run is recorded as failed and can be '
+ 're-armed only by an explicit operator verb - never by the resume route, '
+ 'which answers RUN_NOT_FOUND for it.',
),
runId: z.string().optional()
.describe('Run id - set when `status` is `paused`, so callers can resume it'),
Expand Down
140 changes: 140 additions & 0 deletions packages/spec/src/contracts/automation-result-status.pin.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
// Copyright (c) 2026 ObjectStack. Licensed under the Apache-2.0 license.

/**
* [#14384] `AutomationResult.status` is exactly
* `'completed' | 'paused' | 'failed' | 'stranded'`, and the wire mirror
* (`TriggerFlowResponseSchema.data.status`, `api/automation-api.zod.ts`) is
* the same four — contract half of the #13937 shape-4 ruling (maintainer
* 2026-09-01), which names the terminally-failed-but-repairable run on this
* union: a resume consumed the suspension, a downstream node threw, the run is
* recorded as failed and can be re-armed only by an explicit operator verb
* (#13909's condition). The literal is `'stranded'`.
*
* Three things are pinned, because each drifts on its own:
*
* 1. **The union's membership, at the type level.** `status` is a TypeScript
* interface member, not a Zod enum, so the only thing that can assert it is
* a compile-time identity (`Eq`, the `automation-api.zod.test.ts` form —
* a widening or a narrowing on either side turns the exported alias red
* under `check:test-typecheck`, which reads this file).
* 2. **Wire ↔ contract parity, at both levels.** The Zod enum's `.options`
* are read at runtime and compared to the same list, and its inferred
* type is bound to the contract's. #13078 bound the whole `data` object;
* this pins the ONE member the ruling added so a future member added to
* one side alone fails here by name.
* 3. **The JSDoc names the condition.** The card's acceptance is a JSDoc line
* naming the condition, and prose is unassertable except by reading it:
* the contract source is read and the doc block above the union is
* required to say what `'stranded'` is.
*
* ⛔ Not pinned, deliberately: any relation to `ExecutionStatus`
* (`automation/execution.zod.ts`, the persisted run-row vocabulary) or to
* plugin-approvals' `StrandedRunState` — the ruling keeps the latter a
* plugin-local report label, and whether the run ROW ever carries this word is
* the services half's to measure (#13937).
*/

import { readFileSync } from 'node:fs';
import { fileURLToPath } from 'node:url';

import { describe, it, expect } from 'vitest';

import { TriggerFlowResponseSchema } from '../api/automation-api.zod';
import type { TriggerFlowResponse } from '../api/automation-api.zod';

import type { AutomationResult } from './automation-service';

/** Type-level identity: true iff A and B are the same type. */
type Eq< A, B > = (< T >() => T extends A ? 1 : 2) extends (< T >() => T extends B ? 1 : 2) ? true : false;
/** Compile error when the argument is not `true`. */
type Assert< T extends true > = T;

type ContractStatus = NonNullable<AutomationResult['status']>;
type WireStatus = NonNullable<TriggerFlowResponse['data']['status']>;

/**
* The closed union, spelled once, in declaration order. `satisfies` proves
* every literal here is a member; the `Eq` below proves there is no member
* that is not here.
*/
export const AUTOMATION_RESULT_STATUSES = [
'completed',
'paused',
'failed',
'stranded',
] as const satisfies readonly ContractStatus[];

/**
* Exported deliberately — an unread alias inside a test body is TS6196, and a
* pin no program compiles is no pin at all (`check:test-typecheck` compiles
* this file under `tsconfig.test.json`).
*/
export type AutomationResultStatusIsExactlyTheFour = Assert< Eq< ContractStatus, (typeof AUTOMATION_RESULT_STATUSES)[number] > >;
/** Wire ↔ contract: the Zod enum's inferred type IS the interface's union. */
export type WireStatusMatchesContract = Assert< Eq< WireStatus, ContractStatus > >;

/** The wire enum, unwrapped from `.optional()` through the `lazySchema` Proxy. */
const wireStatusEnum = TriggerFlowResponseSchema.shape.data.shape.status.unwrap();

describe('[#14384] AutomationResult.status names the stranded run', () => {
it('reads a non-empty membership (anti-vacuity)', () => {
expect(AUTOMATION_RESULT_STATUSES.length).toBe(4);
expect(wireStatusEnum.options.length).toBeGreaterThan(0);
});

it('the wire enum carries exactly the contract union, in the same order', () => {
expect([...wireStatusEnum.options]).toEqual([...AUTOMATION_RESULT_STATUSES]);
});

it("names the terminally-failed-but-repairable run 'stranded' (#13937 shape 4)", () => {
expect(AUTOMATION_RESULT_STATUSES).toContain('stranded');
expect(wireStatusEnum.options).toContain('stranded');
});

it('a stranded terminal envelope parses and is PRESERVED on the wire', () => {
// A strip-mode object drops undeclared keys silently — the #13078 lesson —
// so parse success alone proves nothing; the value must come back out.
const parsed = TriggerFlowResponseSchema.parse({
success: true,
data: {
success: false,
status: 'stranded',
runId: 'run_stranded_001',
error: "node 'notify' threw after the approval was consumed",
},
});
expect(parsed.data.status).toBe('stranded');
expect(parsed.data.success).toBe(false);
expect(parsed.data.runId).toBe('run_stranded_001');
});

it('refuses a status outside the four, at `data.status`, as an enum violation', () => {
const result = TriggerFlowResponseSchema.safeParse({
success: true,
data: { success: false, status: 'strand' },
});
expect(result.success).toBe(false);
if (result.success) return;
const issue = result.error.issues.find((i) => i.path.join('.') === 'data.status');
expect(issue).toBeDefined();
expect(issue?.code).toBe('invalid_value');
});

it('the contract JSDoc names the condition beside the literal', () => {
const source = readFileSync(fileURLToPath(new URL('./automation-service.ts', import.meta.url)), 'utf8');
const declaration = "status?: 'completed' | 'paused' | 'failed' | 'stranded';";
const at = source.indexOf(declaration);
expect(at).toBeGreaterThan(-1);
// The doc block immediately above the declaration — from its last `/**`.
const docStart = source.lastIndexOf('/**', at);
const doc = source.slice(docStart, at);
expect(doc).toContain("`'stranded'`");
// The condition, in the ruling's own terms: a consumed suspension, a
// downstream throw, re-armable only by an explicit operator verb.
expect(doc).toMatch(/consumed the\s+\*?\s*suspension/i);
expect(doc).toMatch(/downstream node threw/i);
expect(doc).toMatch(/explicit operator verb/i);
// And the ruling's boundary: the plugin-local label is not promoted.
expect(doc).toContain('StrandedRunState');
});
});
25 changes: 22 additions & 3 deletions packages/spec/src/contracts/automation-service.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -291,9 +291,28 @@ export interface AutomationResult {
* Lifecycle status. `'paused'` means the run suspended at a node (e.g.
* an Approval node awaiting a human decision, ADR-0019) and can be
* continued later with {@link IAutomationService.resume}. Absent or
* `'completed'`/`'failed'` ⇒ the run reached a terminal state.
*/
status?: 'completed' | 'paused' | 'failed';
* `'completed'`/`'failed'`/`'stranded'` ⇒ the run reached a terminal
* state.
*
* `'stranded'` names the terminally-failed-but-repairable run (#13909;
* the #13937 shape-4 ruling, maintainer 2026-09-01): a resume CONSUMED the
* suspension, a downstream node threw, and the run is recorded as failed —
* terminal exactly like `'failed'`, except that the pause a durable
* decision (an approval, a screen submission) was waiting on is gone with
* it, so the run can be re-armed only by an explicit operator verb — never
* by {@link IAutomationService.resume} (which answers `'RUN_NOT_FOUND'`:
* there is no suspension left) and never automatically. Distinct from
* `'failed'` on purpose: that one says the run ran and was rejected; this
* one says a recorded continuation stopped mid-flight and an operator has
* something to repair. This member is the ruling's contract half; the
* engine begins stamping it when #13937's services half (the re-arm verb
* and the catch-arm stamp in `resumeInternal`) lands. plugin-approvals'
* `StrandedRunState` (`'missing' | 'failed'`) is a report-only label over
* a request's run and is deliberately NOT promoted to this status (same
* ruling): it classifies WHY a request's run is unrecoverable, this names
* the run's own lifecycle verdict.
*/
status?: 'completed' | 'paused' | 'failed' | 'stranded';
/** Run id — set when `status` is `'paused'`, so callers can resume it. */
runId?: string;
/**
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .changeset/automation-result-stranded-status.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
---
"@objectstack/spec": minor
---

feat(spec): name the terminally-failed-but-repairable run on `AutomationResult.status` — `'stranded'` (#14384, contract half of #13937)

`AutomationResult.status` (`contracts/automation-service.ts`) gains a fourth
member beside `'completed' | 'paused' | 'failed'`: **`'stranded'`** — the run
whose resume CONSUMED its suspension and then had a downstream node throw, so
the run is recorded as failed and can be re-armed only by an explicit operator
verb (#13909's condition; the #13937 shape-4 ruling, maintainer 2026-09-01
「命名同批定」). The wire mirror `TriggerFlowResponseSchema.data.status`
(`api/automation-api.zod.ts`) carries the same four, and a pin test binds the
two at the type level and the value level.

Additive: no existing literal changes meaning, `'failed'` still says "the run
ran and was rejected", and no engine, route or client behaviour moves in this
change — the engine begins stamping `'stranded'` when #13937's services half
(the operator re-arm verb) lands. A consumer that switches exhaustively over
`status` needs a `'stranded'` arm; the measured count of such switches in this
repo is zero. plugin-approvals' report-only `StrandedRunState`
(`'missing' | 'failed'`) is deliberately not promoted (same ruling).
2 changes: 1 addition & 1 deletion content/docs/references/api/automation-api.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -607,7 +607,7 @@ const result = AutomationApiErrorCode.parse(data);
| **error** | `string` | optional | Error message if execution failed |
| **durationMs** | `number` | optional | Execution duration in milliseconds |
| **code** | `Enum<'PERMISSION_DENIED' \| 'INVALID_SIGNAL' \| 'RUN_NOT_FOUND' \| 'STORE_UNAVAILABLE' \| …>` | optional | Machine-readable failure classification, set alongside `error` when the caller must distinguish WHY it failed. A closed union - the members and their transport mappings are documented on the contract (`AutomationResult.code`, contracts/automation-service.ts). |
| **status** | `Enum<'completed' \| 'paused' \| 'failed'>` | optional | Lifecycle status. `paused` means the run suspended at a node and can be continued with the resume route. Absent or `completed`/`failed` means the run reached a terminal state. |
| **status** | `Enum<'completed' \| 'paused' \| 'failed' \| 'stranded'>` | optional | Lifecycle status. `paused` means the run suspended at a node and can be continued with the resume route. Absent or `completed`/`failed`/`stranded` means the run reached a terminal state. `stranded` is the terminally-failed-but-repairable run: a resume consumed the suspension and a downstream node threw, so the run is recorded as failed and can be re-armed only by an explicit operator verb - never by the resume route, which answers RUN_NOT_FOUND for it. |
| **runId** | `string` | optional | Run id - set when `status` is `paused`, so callers can resume it |
| **screen** | `{ nodeId: string; title?: string; description?: string; fields: object[]; … }` | optional | The screen to render - set when the run paused at a `screen` node awaiting user input. The client collects values for `screen.fields` and resumes the run with them. |
| **successMessage** | `string` | optional | Friendly terminal message copied from the flow definition on terminal success, so a screen-flow runner can show a meaningful toast |
Expand Down
13 changes: 10 additions & 3 deletions packages/spec/src/api/automation-api.zod.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -337,10 +337,17 @@ export const TriggerFlowResponseSchema = lazySchema(() => BaseResponseSchema.ext
+ 'their transport mappings are documented on the contract '
+ '(`AutomationResult.code`, contracts/automation-service.ts).',
),
status: z.enum(['completed', 'paused', 'failed']).optional().describe(
// `stranded` is the contract half of the #13937 shape-4 ruling (#14384);
// the condition is #13909's. Mirrors `AutomationResult.status` member for
// member — the pin is `contracts/automation-result-status.pin.test.ts`.
status: z.enum(['completed', 'paused', 'failed', 'stranded']).optional().describe(
'Lifecycle status. `paused` means the run suspended at a node and can be '
+ 'continued with the resume route. Absent or `completed`/`failed` means '
+ 'the run reached a terminal state.',
+ 'continued with the resume route. Absent or `completed`/`failed`/`stranded` '
+ 'means the run reached a terminal state. `stranded` is the '
+ 'terminally-failed-but-repairable run: a resume consumed the suspension '
+ 'and a downstream node threw, so the run is recorded as failed and can be '
+ 're-armed only by an explicit operator verb - never by the resume route, '
+ 'which answers RUN_NOT_FOUND for it.',
),
runId: z.string().optional()
.describe('Run id - set when `status` is `paused`, so callers can resume it'),
Expand Down
140 changes: 140 additions & 0 deletions packages/spec/src/contracts/automation-result-status.pin.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
// Copyright (c) 2026 ObjectStack. Licensed under the Apache-2.0 license.

/**
* [#14384] `AutomationResult.status` is exactly
* `'completed' | 'paused' | 'failed' | 'stranded'`, and the wire mirror
* (`TriggerFlowResponseSchema.data.status`, `api/automation-api.zod.ts`) is
* the same four — contract half of the #13937 shape-4 ruling (maintainer
* 2026-09-01), which names the terminally-failed-but-repairable run on this
* union: a resume consumed the suspension, a downstream node threw, the run is
* recorded as failed and can be re-armed only by an explicit operator verb
* (#13909's condition). The literal is `'stranded'`.
*
* Three things are pinned, because each drifts on its own:
*
* 1. **The union's membership, at the type level.** `status` is a TypeScript
* interface member, not a Zod enum, so the only thing that can assert it is
* a compile-time identity (`Eq`, the `automation-api.zod.test.ts` form —
* a widening or a narrowing on either side turns the exported alias red
* under `check:test-typecheck`, which reads this file).
* 2. **Wire ↔ contract parity, at both levels.** The Zod enum's `.options`
* are read at runtime and compared to the same list, and its inferred
* type is bound to the contract's. #13078 bound the whole `data` object;
* this pins the ONE member the ruling added so a future member added to
* one side alone fails here by name.
* 3. **The JSDoc names the condition.** The card's acceptance is a JSDoc line
* naming the condition, and prose is unassertable except by reading it:
* the contract source is read and the doc block above the union is
* required to say what `'stranded'` is.
*
* ⛔ Not pinned, deliberately: any relation to `ExecutionStatus`
* (`automation/execution.zod.ts`, the persisted run-row vocabulary) or to
* plugin-approvals' `StrandedRunState` — the ruling keeps the latter a
* plugin-local report label, and whether the run ROW ever carries this word is
* the services half's to measure (#13937).
*/

import { readFileSync } from 'node:fs';
import { fileURLToPath } from 'node:url';

import { describe, it, expect } from 'vitest';

import { TriggerFlowResponseSchema } from '../api/automation-api.zod';
import type { TriggerFlowResponse } from '../api/automation-api.zod';

import type { AutomationResult } from './automation-service';

/** Type-level identity: true iff A and B are the same type. */
type Eq< A, B > = (< T >() => T extends A ? 1 : 2) extends (< T >() => T extends B ? 1 : 2) ? true : false;
/** Compile error when the argument is not `true`. */
type Assert< T extends true > = T;

type ContractStatus = NonNullable<AutomationResult['status']>;
type WireStatus = NonNullable<TriggerFlowResponse['data']['status']>;

/**
* The closed union, spelled once, in declaration order. `satisfies` proves
* every literal here is a member; the `Eq` below proves there is no member
* that is not here.
*/
export const AUTOMATION_RESULT_STATUSES = [
'completed',
'paused',
'failed',
'stranded',
] as const satisfies readonly ContractStatus[];

/**
* Exported deliberately — an unread alias inside a test body is TS6196, and a
* pin no program compiles is no pin at all (`check:test-typecheck` compiles
* this file under `tsconfig.test.json`).
*/
export type AutomationResultStatusIsExactlyTheFour = Assert< Eq< ContractStatus, (typeof AUTOMATION_RESULT_STATUSES)[number] > >;
/** Wire ↔ contract: the Zod enum's inferred type IS the interface's union. */
export type WireStatusMatchesContract = Assert< Eq< WireStatus, ContractStatus > >;

/** The wire enum, unwrapped from `.optional()` through the `lazySchema` Proxy. */
const wireStatusEnum = TriggerFlowResponseSchema.shape.data.shape.status.unwrap();

describe('[#14384] AutomationResult.status names the stranded run', () => {
it('reads a non-empty membership (anti-vacuity)', () => {
expect(AUTOMATION_RESULT_STATUSES.length).toBe(4);
expect(wireStatusEnum.options.length).toBeGreaterThan(0);
});

it('the wire enum carries exactly the contract union, in the same order', () => {
expect([...wireStatusEnum.options]).toEqual([...AUTOMATION_RESULT_STATUSES]);
});

it("names the terminally-failed-but-repairable run 'stranded' (#13937 shape 4)", () => {
expect(AUTOMATION_RESULT_STATUSES).toContain('stranded');
expect(wireStatusEnum.options).toContain('stranded');
});

it('a stranded terminal envelope parses and is PRESERVED on the wire', () => {
// A strip-mode object drops undeclared keys silently — the #13078 lesson —
// so parse success alone proves nothing; the value must come back out.
const parsed = TriggerFlowResponseSchema.parse({
success: true,
data: {
success: false,
status: 'stranded',
runId: 'run_stranded_001',
error: "node 'notify' threw after the approval was consumed",
},
});
expect(parsed.data.status).toBe('stranded');
expect(parsed.data.success).toBe(false);
expect(parsed.data.runId).toBe('run_stranded_001');
});

it('refuses a status outside the four, at `data.status`, as an enum violation', () => {
const result = TriggerFlowResponseSchema.safeParse({
success: true,
data: { success: false, status: 'strand' },
});
expect(result.success).toBe(false);
if (result.success) return;
const issue = result.error.issues.find((i) => i.path.join('.') === 'data.status');
expect(issue).toBeDefined();
expect(issue?.code).toBe('invalid_value');
});

it('the contract JSDoc names the condition beside the literal', () => {
const source = readFileSync(fileURLToPath(new URL('./automation-service.ts', import.meta.url)), 'utf8');
const declaration = "status?: 'completed' | 'paused' | 'failed' | 'stranded';";
const at = source.indexOf(declaration);
expect(at).toBeGreaterThan(-1);
// The doc block immediately above the declaration — from its last `/**`.
const docStart = source.lastIndexOf('/**', at);
const doc = source.slice(docStart, at);
expect(doc).toContain("`'stranded'`");
// The condition, in the ruling's own terms: a consumed suspension, a
// downstream throw, re-armable only by an explicit operator verb.
expect(doc).toMatch(/consumed the\s+\*?\s*suspension/i);
expect(doc).toMatch(/downstream node threw/i);
expect(doc).toMatch(/explicit operator verb/i);
// And the ruling's boundary: the plugin-local label is not promoted.
expect(doc).toContain('StrandedRunState');
});
});
25 changes: 22 additions & 3 deletions packages/spec/src/contracts/automation-service.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -291,9 +291,28 @@ export interface AutomationResult {
* Lifecycle status. `'paused'` means the run suspended at a node (e.g.
* an Approval node awaiting a human decision, ADR-0019) and can be
* continued later with {@link IAutomationService.resume}. Absent or
* `'completed'`/`'failed'` ⇒ the run reached a terminal state.
*/
status?: 'completed' | 'paused' | 'failed';
* `'completed'`/`'failed'`/`'stranded'` ⇒ the run reached a terminal
* state.
*
* `'stranded'` names the terminally-failed-but-repairable run (#13909;
* the #13937 shape-4 ruling, maintainer 2026-09-01): a resume CONSUMED the
* suspension, a downstream node threw, and the run is recorded as failed —
* terminal exactly like `'failed'`, except that the pause a durable
* decision (an approval, a screen submission) was waiting on is gone with
* it, so the run can be re-armed only by an explicit operator verb — never
* by {@link IAutomationService.resume} (which answers `'RUN_NOT_FOUND'`:
* there is no suspension left) and never automatically. Distinct from
* `'failed'` on purpose: that one says the run ran and was rejected; this
* one says a recorded continuation stopped mid-flight and an operator has
* something to repair. This member is the ruling's contract half; the
* engine begins stamping it when #13937's services half (the re-arm verb
* and the catch-arm stamp in `resumeInternal`) lands. plugin-approvals'
* `StrandedRunState` (`'missing' | 'failed'`) is a report-only label over
* a request's run and is deliberately NOT promoted to this status (same
* ruling): it classifies WHY a request's run is unrecoverable, this names
* the run's own lifecycle verdict.
*/
status?: 'completed' | 'paused' | 'failed' | 'stranded';
/** Run id — set when `status` is `'paused'`, so callers can resume it. */
runId?: string;
/**
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .changeset/automation-result-stranded-status.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
---
"@objectstack/spec": minor
---

feat(spec): name the terminally-failed-but-repairable run on `AutomationResult.status` — `'stranded'` (#14384, contract half of #13937)

`AutomationResult.status` (`contracts/automation-service.ts`) gains a fourth
member beside `'completed' | 'paused' | 'failed'`: **`'stranded'`** — the run
whose resume CONSUMED its suspension and then had a downstream node throw, so
the run is recorded as failed and can be re-armed only by an explicit operator
verb (#13909's condition; the #13937 shape-4 ruling, maintainer 2026-09-01
「命名同批定」). The wire mirror `TriggerFlowResponseSchema.data.status`
(`api/automation-api.zod.ts`) carries the same four, and a pin test binds the
two at the type level and the value level.

Additive: no existing literal changes meaning, `'failed'` still says "the run
ran and was rejected", and no engine, route or client behaviour moves in this
change — the engine begins stamping `'stranded'` when #13937's services half
(the operator re-arm verb) lands. A consumer that switches exhaustively over
`status` needs a `'stranded'` arm; the measured count of such switches in this
repo is zero. plugin-approvals' report-only `StrandedRunState`
(`'missing' | 'failed'`) is deliberately not promoted (same ruling).
2 changes: 1 addition & 1 deletion content/docs/references/api/automation-api.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -607,7 +607,7 @@ const result = AutomationApiErrorCode.parse(data);
| **error** | `string` | optional | Error message if execution failed |
| **durationMs** | `number` | optional | Execution duration in milliseconds |
| **code** | `Enum<'PERMISSION_DENIED' \| 'INVALID_SIGNAL' \| 'RUN_NOT_FOUND' \| 'STORE_UNAVAILABLE' \| …>` | optional | Machine-readable failure classification, set alongside `error` when the caller must distinguish WHY it failed. A closed union - the members and their transport mappings are documented on the contract (`AutomationResult.code`, contracts/automation-service.ts). |
| **status** | `Enum<'completed' \| 'paused' \| 'failed'>` | optional | Lifecycle status. `paused` means the run suspended at a node and can be continued with the resume route. Absent or `completed`/`failed` means the run reached a terminal state. |
| **status** | `Enum<'completed' \| 'paused' \| 'failed' \| 'stranded'>` | optional | Lifecycle status. `paused` means the run suspended at a node and can be continued with the resume route. Absent or `completed`/`failed`/`stranded` means the run reached a terminal state. `stranded` is the terminally-failed-but-repairable run: a resume consumed the suspension and a downstream node threw, so the run is recorded as failed and can be re-armed only by an explicit operator verb - never by the resume route, which answers RUN_NOT_FOUND for it. |
| **runId** | `string` | optional | Run id - set when `status` is `paused`, so callers can resume it |
| **screen** | `{ nodeId: string; title?: string; description?: string; fields: object[]; … }` | optional | The screen to render - set when the run paused at a `screen` node awaiting user input. The client collects values for `screen.fields` and resumes the run with them. |
| **successMessage** | `string` | optional | Friendly terminal message copied from the flow definition on terminal success, so a screen-flow runner can show a meaningful toast |
Expand Down
13 changes: 10 additions & 3 deletions packages/spec/src/api/automation-api.zod.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -337,10 +337,17 @@ export const TriggerFlowResponseSchema = lazySchema(() => BaseResponseSchema.ext
+ 'their transport mappings are documented on the contract '
+ '(`AutomationResult.code`, contracts/automation-service.ts).',
),
status: z.enum(['completed', 'paused', 'failed']).optional().describe(
// `stranded` is the contract half of the #13937 shape-4 ruling (#14384);
// the condition is #13909's. Mirrors `AutomationResult.status` member for
// member — the pin is `contracts/automation-result-status.pin.test.ts`.
status: z.enum(['completed', 'paused', 'failed', 'stranded']).optional().describe(
'Lifecycle status. `paused` means the run suspended at a node and can be '
+ 'continued with the resume route. Absent or `completed`/`failed` means '
+ 'the run reached a terminal state.',
+ 'continued with the resume route. Absent or `completed`/`failed`/`stranded` '
+ 'means the run reached a terminal state. `stranded` is the '
+ 'terminally-failed-but-repairable run: a resume consumed the suspension '
+ 'and a downstream node threw, so the run is recorded as failed and can be '
+ 're-armed only by an explicit operator verb - never by the resume route, '
+ 'which answers RUN_NOT_FOUND for it.',
),
runId: z.string().optional()
.describe('Run id - set when `status` is `paused`, so callers can resume it'),
Expand Down
140 changes: 140 additions & 0 deletions packages/spec/src/contracts/automation-result-status.pin.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
// Copyright (c) 2026 ObjectStack. Licensed under the Apache-2.0 license.

/**
* [#14384] `AutomationResult.status` is exactly
* `'completed' | 'paused' | 'failed' | 'stranded'`, and the wire mirror
* (`TriggerFlowResponseSchema.data.status`, `api/automation-api.zod.ts`) is
* the same four — contract half of the #13937 shape-4 ruling (maintainer
* 2026-09-01), which names the terminally-failed-but-repairable run on this
* union: a resume consumed the suspension, a downstream node threw, the run is
* recorded as failed and can be re-armed only by an explicit operator verb
* (#13909's condition). The literal is `'stranded'`.
*
* Three things are pinned, because each drifts on its own:
*
* 1. **The union's membership, at the type level.** `status` is a TypeScript
* interface member, not a Zod enum, so the only thing that can assert it is
* a compile-time identity (`Eq`, the `automation-api.zod.test.ts` form —
* a widening or a narrowing on either side turns the exported alias red
* under `check:test-typecheck`, which reads this file).
* 2. **Wire ↔ contract parity, at both levels.** The Zod enum's `.options`
* are read at runtime and compared to the same list, and its inferred
* type is bound to the contract's. #13078 bound the whole `data` object;
* this pins the ONE member the ruling added so a future member added to
* one side alone fails here by name.
* 3. **The JSDoc names the condition.** The card's acceptance is a JSDoc line
* naming the condition, and prose is unassertable except by reading it:
* the contract source is read and the doc block above the union is
* required to say what `'stranded'` is.
*
* ⛔ Not pinned, deliberately: any relation to `ExecutionStatus`
* (`automation/execution.zod.ts`, the persisted run-row vocabulary) or to
* plugin-approvals' `StrandedRunState` — the ruling keeps the latter a
* plugin-local report label, and whether the run ROW ever carries this word is
* the services half's to measure (#13937).
*/

import { readFileSync } from 'node:fs';
import { fileURLToPath } from 'node:url';

import { describe, it, expect } from 'vitest';

import { TriggerFlowResponseSchema } from '../api/automation-api.zod';
import type { TriggerFlowResponse } from '../api/automation-api.zod';

import type { AutomationResult } from './automation-service';

/** Type-level identity: true iff A and B are the same type. */
type Eq< A, B > = (< T >() => T extends A ? 1 : 2) extends (< T >() => T extends B ? 1 : 2) ? true : false;
/** Compile error when the argument is not `true`. */
type Assert< T extends true > = T;

type ContractStatus = NonNullable<AutomationResult['status']>;
type WireStatus = NonNullable<TriggerFlowResponse['data']['status']>;

/**
* The closed union, spelled once, in declaration order. `satisfies` proves
* every literal here is a member; the `Eq` below proves there is no member
* that is not here.
*/
export const AUTOMATION_RESULT_STATUSES = [
'completed',
'paused',
'failed',
'stranded',
] as const satisfies readonly ContractStatus[];

/**
* Exported deliberately — an unread alias inside a test body is TS6196, and a
* pin no program compiles is no pin at all (`check:test-typecheck` compiles
* this file under `tsconfig.test.json`).
*/
export type AutomationResultStatusIsExactlyTheFour = Assert< Eq< ContractStatus, (typeof AUTOMATION_RESULT_STATUSES)[number] > >;
/** Wire ↔ contract: the Zod enum's inferred type IS the interface's union. */
export type WireStatusMatchesContract = Assert< Eq< WireStatus, ContractStatus > >;

/** The wire enum, unwrapped from `.optional()` through the `lazySchema` Proxy. */
const wireStatusEnum = TriggerFlowResponseSchema.shape.data.shape.status.unwrap();

describe('[#14384] AutomationResult.status names the stranded run', () => {
it('reads a non-empty membership (anti-vacuity)', () => {
expect(AUTOMATION_RESULT_STATUSES.length).toBe(4);
expect(wireStatusEnum.options.length).toBeGreaterThan(0);
});

it('the wire enum carries exactly the contract union, in the same order', () => {
expect([...wireStatusEnum.options]).toEqual([...AUTOMATION_RESULT_STATUSES]);
});

it("names the terminally-failed-but-repairable run 'stranded' (#13937 shape 4)", () => {
expect(AUTOMATION_RESULT_STATUSES).toContain('stranded');
expect(wireStatusEnum.options).toContain('stranded');
});

it('a stranded terminal envelope parses and is PRESERVED on the wire', () => {
// A strip-mode object drops undeclared keys silently — the #13078 lesson —
// so parse success alone proves nothing; the value must come back out.
const parsed = TriggerFlowResponseSchema.parse({
success: true,
data: {
success: false,
status: 'stranded',
runId: 'run_stranded_001',
error: "node 'notify' threw after the approval was consumed",
},
});
expect(parsed.data.status).toBe('stranded');
expect(parsed.data.success).toBe(false);
expect(parsed.data.runId).toBe('run_stranded_001');
});

it('refuses a status outside the four, at `data.status`, as an enum violation', () => {
const result = TriggerFlowResponseSchema.safeParse({
success: true,
data: { success: false, status: 'strand' },
});
expect(result.success).toBe(false);
if (result.success) return;
const issue = result.error.issues.find((i) => i.path.join('.') === 'data.status');
expect(issue).toBeDefined();
expect(issue?.code).toBe('invalid_value');
});

it('the contract JSDoc names the condition beside the literal', () => {
const source = readFileSync(fileURLToPath(new URL('./automation-service.ts', import.meta.url)), 'utf8');
const declaration = "status?: 'completed' | 'paused' | 'failed' | 'stranded';";
const at = source.indexOf(declaration);
expect(at).toBeGreaterThan(-1);
// The doc block immediately above the declaration — from its last `/**`.
const docStart = source.lastIndexOf('/**', at);
const doc = source.slice(docStart, at);
expect(doc).toContain("`'stranded'`");
// The condition, in the ruling's own terms: a consumed suspension, a
// downstream throw, re-armable only by an explicit operator verb.
expect(doc).toMatch(/consumed the\s+\*?\s*suspension/i);
expect(doc).toMatch(/downstream node threw/i);
expect(doc).toMatch(/explicit operator verb/i);
// And the ruling's boundary: the plugin-local label is not promoted.
expect(doc).toContain('StrandedRunState');
});
});
25 changes: 22 additions & 3 deletions packages/spec/src/contracts/automation-service.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -291,9 +291,28 @@ export interface AutomationResult {
* Lifecycle status. `'paused'` means the run suspended at a node (e.g.
* an Approval node awaiting a human decision, ADR-0019) and can be
* continued later with {@link IAutomationService.resume}. Absent or
* `'completed'`/`'failed'` ⇒ the run reached a terminal state.
*/
status?: 'completed' | 'paused' | 'failed';
* `'completed'`/`'failed'`/`'stranded'` ⇒ the run reached a terminal
* state.
*
* `'stranded'` names the terminally-failed-but-repairable run (#13909;
* the #13937 shape-4 ruling, maintainer 2026-09-01): a resume CONSUMED the
* suspension, a downstream node threw, and the run is recorded as failed —
* terminal exactly like `'failed'`, except that the pause a durable
* decision (an approval, a screen submission) was waiting on is gone with
* it, so the run can be re-armed only by an explicit operator verb — never
* by {@link IAutomationService.resume} (which answers `'RUN_NOT_FOUND'`:
* there is no suspension left) and never automatically. Distinct from
* `'failed'` on purpose: that one says the run ran and was rejected; this
* one says a recorded continuation stopped mid-flight and an operator has
* something to repair. This member is the ruling's contract half; the
* engine begins stamping it when #13937's services half (the re-arm verb
* and the catch-arm stamp in `resumeInternal`) lands. plugin-approvals'
* `StrandedRunState` (`'missing' | 'failed'`) is a report-only label over
* a request's run and is deliberately NOT promoted to this status (same
* ruling): it classifies WHY a request's run is unrecoverable, this names
* the run's own lifecycle verdict.
*/
status?: 'completed' | 'paused' | 'failed' | 'stranded';
/** Run id — set when `status` is `'paused'`, so callers can resume it. */
runId?: string;
/**
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .changeset/automation-result-stranded-status.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
---
"@objectstack/spec": minor
---

feat(spec): name the terminally-failed-but-repairable run on `AutomationResult.status` — `'stranded'` (#14384, contract half of #13937)

`AutomationResult.status` (`contracts/automation-service.ts`) gains a fourth
member beside `'completed' | 'paused' | 'failed'`: **`'stranded'`** — the run
whose resume CONSUMED its suspension and then had a downstream node throw, so
the run is recorded as failed and can be re-armed only by an explicit operator
verb (#13909's condition; the #13937 shape-4 ruling, maintainer 2026-09-01
「命名同批定」). The wire mirror `TriggerFlowResponseSchema.data.status`
(`api/automation-api.zod.ts`) carries the same four, and a pin test binds the
two at the type level and the value level.

Additive: no existing literal changes meaning, `'failed'` still says "the run
ran and was rejected", and no engine, route or client behaviour moves in this
change — the engine begins stamping `'stranded'` when #13937's services half
(the operator re-arm verb) lands. A consumer that switches exhaustively over
`status` needs a `'stranded'` arm; the measured count of such switches in this
repo is zero. plugin-approvals' report-only `StrandedRunState`
(`'missing' | 'failed'`) is deliberately not promoted (same ruling).
2 changes: 1 addition & 1 deletion content/docs/references/api/automation-api.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -607,7 +607,7 @@ const result = AutomationApiErrorCode.parse(data);
| **error** | `string` | optional | Error message if execution failed |
| **durationMs** | `number` | optional | Execution duration in milliseconds |
| **code** | `Enum<'PERMISSION_DENIED' \| 'INVALID_SIGNAL' \| 'RUN_NOT_FOUND' \| 'STORE_UNAVAILABLE' \| …>` | optional | Machine-readable failure classification, set alongside `error` when the caller must distinguish WHY it failed. A closed union - the members and their transport mappings are documented on the contract (`AutomationResult.code`, contracts/automation-service.ts). |
| **status** | `Enum<'completed' \| 'paused' \| 'failed'>` | optional | Lifecycle status. `paused` means the run suspended at a node and can be continued with the resume route. Absent or `completed`/`failed` means the run reached a terminal state. |
| **status** | `Enum<'completed' \| 'paused' \| 'failed' \| 'stranded'>` | optional | Lifecycle status. `paused` means the run suspended at a node and can be continued with the resume route. Absent or `completed`/`failed`/`stranded` means the run reached a terminal state. `stranded` is the terminally-failed-but-repairable run: a resume consumed the suspension and a downstream node threw, so the run is recorded as failed and can be re-armed only by an explicit operator verb - never by the resume route, which answers RUN_NOT_FOUND for it. |
| **runId** | `string` | optional | Run id - set when `status` is `paused`, so callers can resume it |
| **screen** | `{ nodeId: string; title?: string; description?: string; fields: object[]; … }` | optional | The screen to render - set when the run paused at a `screen` node awaiting user input. The client collects values for `screen.fields` and resumes the run with them. |
| **successMessage** | `string` | optional | Friendly terminal message copied from the flow definition on terminal success, so a screen-flow runner can show a meaningful toast |
Expand Down
13 changes: 10 additions & 3 deletions packages/spec/src/api/automation-api.zod.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -337,10 +337,17 @@ export const TriggerFlowResponseSchema = lazySchema(() => BaseResponseSchema.ext
+ 'their transport mappings are documented on the contract '
+ '(`AutomationResult.code`, contracts/automation-service.ts).',
),
status: z.enum(['completed', 'paused', 'failed']).optional().describe(
// `stranded` is the contract half of the #13937 shape-4 ruling (#14384);
// the condition is #13909's. Mirrors `AutomationResult.status` member for
// member — the pin is `contracts/automation-result-status.pin.test.ts`.
status: z.enum(['completed', 'paused', 'failed', 'stranded']).optional().describe(
'Lifecycle status. `paused` means the run suspended at a node and can be '
+ 'continued with the resume route. Absent or `completed`/`failed` means '
+ 'the run reached a terminal state.',
+ 'continued with the resume route. Absent or `completed`/`failed`/`stranded` '
+ 'means the run reached a terminal state. `stranded` is the '
+ 'terminally-failed-but-repairable run: a resume consumed the suspension '
+ 'and a downstream node threw, so the run is recorded as failed and can be '
+ 're-armed only by an explicit operator verb - never by the resume route, '
+ 'which answers RUN_NOT_FOUND for it.',
),
runId: z.string().optional()
.describe('Run id - set when `status` is `paused`, so callers can resume it'),
Expand Down
140 changes: 140 additions & 0 deletions packages/spec/src/contracts/automation-result-status.pin.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
// Copyright (c) 2026 ObjectStack. Licensed under the Apache-2.0 license.

/**
* [#14384] `AutomationResult.status` is exactly
* `'completed' | 'paused' | 'failed' | 'stranded'`, and the wire mirror
* (`TriggerFlowResponseSchema.data.status`, `api/automation-api.zod.ts`) is
* the same four — contract half of the #13937 shape-4 ruling (maintainer
* 2026-09-01), which names the terminally-failed-but-repairable run on this
* union: a resume consumed the suspension, a downstream node threw, the run is
* recorded as failed and can be re-armed only by an explicit operator verb
* (#13909's condition). The literal is `'stranded'`.
*
* Three things are pinned, because each drifts on its own:
*
* 1. **The union's membership, at the type level.** `status` is a TypeScript
* interface member, not a Zod enum, so the only thing that can assert it is
* a compile-time identity (`Eq`, the `automation-api.zod.test.ts` form —
* a widening or a narrowing on either side turns the exported alias red
* under `check:test-typecheck`, which reads this file).
* 2. **Wire ↔ contract parity, at both levels.** The Zod enum's `.options`
* are read at runtime and compared to the same list, and its inferred
* type is bound to the contract's. #13078 bound the whole `data` object;
* this pins the ONE member the ruling added so a future member added to
* one side alone fails here by name.
* 3. **The JSDoc names the condition.** The card's acceptance is a JSDoc line
* naming the condition, and prose is unassertable except by reading it:
* the contract source is read and the doc block above the union is
* required to say what `'stranded'` is.
*
* ⛔ Not pinned, deliberately: any relation to `ExecutionStatus`
* (`automation/execution.zod.ts`, the persisted run-row vocabulary) or to
* plugin-approvals' `StrandedRunState` — the ruling keeps the latter a
* plugin-local report label, and whether the run ROW ever carries this word is
* the services half's to measure (#13937).
*/

import { readFileSync } from 'node:fs';
import { fileURLToPath } from 'node:url';

import { describe, it, expect } from 'vitest';

import { TriggerFlowResponseSchema } from '../api/automation-api.zod';
import type { TriggerFlowResponse } from '../api/automation-api.zod';

import type { AutomationResult } from './automation-service';

/** Type-level identity: true iff A and B are the same type. */
type Eq< A, B > = (< T >() => T extends A ? 1 : 2) extends (< T >() => T extends B ? 1 : 2) ? true : false;
/** Compile error when the argument is not `true`. */
type Assert< T extends true > = T;

type ContractStatus = NonNullable<AutomationResult['status']>;
type WireStatus = NonNullable<TriggerFlowResponse['data']['status']>;

/**
* The closed union, spelled once, in declaration order. `satisfies` proves
* every literal here is a member; the `Eq` below proves there is no member
* that is not here.
*/
export const AUTOMATION_RESULT_STATUSES = [
'completed',
'paused',
'failed',
'stranded',
] as const satisfies readonly ContractStatus[];

/**
* Exported deliberately — an unread alias inside a test body is TS6196, and a
* pin no program compiles is no pin at all (`check:test-typecheck` compiles
* this file under `tsconfig.test.json`).
*/
export type AutomationResultStatusIsExactlyTheFour = Assert< Eq< ContractStatus, (typeof AUTOMATION_RESULT_STATUSES)[number] > >;
/** Wire ↔ contract: the Zod enum's inferred type IS the interface's union. */
export type WireStatusMatchesContract = Assert< Eq< WireStatus, ContractStatus > >;

/** The wire enum, unwrapped from `.optional()` through the `lazySchema` Proxy. */
const wireStatusEnum = TriggerFlowResponseSchema.shape.data.shape.status.unwrap();

describe('[#14384] AutomationResult.status names the stranded run', () => {
it('reads a non-empty membership (anti-vacuity)', () => {
expect(AUTOMATION_RESULT_STATUSES.length).toBe(4);
expect(wireStatusEnum.options.length).toBeGreaterThan(0);
});

it('the wire enum carries exactly the contract union, in the same order', () => {
expect([...wireStatusEnum.options]).toEqual([...AUTOMATION_RESULT_STATUSES]);
});

it("names the terminally-failed-but-repairable run 'stranded' (#13937 shape 4)", () => {
expect(AUTOMATION_RESULT_STATUSES).toContain('stranded');
expect(wireStatusEnum.options).toContain('stranded');
});

it('a stranded terminal envelope parses and is PRESERVED on the wire', () => {
// A strip-mode object drops undeclared keys silently — the #13078 lesson —
// so parse success alone proves nothing; the value must come back out.
const parsed = TriggerFlowResponseSchema.parse({
success: true,
data: {
success: false,
status: 'stranded',
runId: 'run_stranded_001',
error: "node 'notify' threw after the approval was consumed",
},
});
expect(parsed.data.status).toBe('stranded');
expect(parsed.data.success).toBe(false);
expect(parsed.data.runId).toBe('run_stranded_001');
});

it('refuses a status outside the four, at `data.status`, as an enum violation', () => {
const result = TriggerFlowResponseSchema.safeParse({
success: true,
data: { success: false, status: 'strand' },
});
expect(result.success).toBe(false);
if (result.success) return;
const issue = result.error.issues.find((i) => i.path.join('.') === 'data.status');
expect(issue).toBeDefined();
expect(issue?.code).toBe('invalid_value');
});

it('the contract JSDoc names the condition beside the literal', () => {
const source = readFileSync(fileURLToPath(new URL('./automation-service.ts', import.meta.url)), 'utf8');
const declaration = "status?: 'completed' | 'paused' | 'failed' | 'stranded';";
const at = source.indexOf(declaration);
expect(at).toBeGreaterThan(-1);
// The doc block immediately above the declaration — from its last `/**`.
const docStart = source.lastIndexOf('/**', at);
const doc = source.slice(docStart, at);
expect(doc).toContain("`'stranded'`");
// The condition, in the ruling's own terms: a consumed suspension, a
// downstream throw, re-armable only by an explicit operator verb.
expect(doc).toMatch(/consumed the\s+\*?\s*suspension/i);
expect(doc).toMatch(/downstream node threw/i);
expect(doc).toMatch(/explicit operator verb/i);
// And the ruling's boundary: the plugin-local label is not promoted.
expect(doc).toContain('StrandedRunState');
});
});
25 changes: 22 additions & 3 deletions packages/spec/src/contracts/automation-service.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -291,9 +291,28 @@ export interface AutomationResult {
* Lifecycle status. `'paused'` means the run suspended at a node (e.g.
* an Approval node awaiting a human decision, ADR-0019) and can be
* continued later with {@link IAutomationService.resume}. Absent or
* `'completed'`/`'failed'` ⇒ the run reached a terminal state.
*/
status?: 'completed' | 'paused' | 'failed';
* `'completed'`/`'failed'`/`'stranded'` ⇒ the run reached a terminal
* state.
*
* `'stranded'` names the terminally-failed-but-repairable run (#13909;
* the #13937 shape-4 ruling, maintainer 2026-09-01): a resume CONSUMED the
* suspension, a downstream node threw, and the run is recorded as failed —
* terminal exactly like `'failed'`, except that the pause a durable
* decision (an approval, a screen submission) was waiting on is gone with
* it, so the run can be re-armed only by an explicit operator verb — never
* by {@link IAutomationService.resume} (which answers `'RUN_NOT_FOUND'`:
* there is no suspension left) and never automatically. Distinct from
* `'failed'` on purpose: that one says the run ran and was rejected; this
* one says a recorded continuation stopped mid-flight and an operator has
* something to repair. This member is the ruling's contract half; the
* engine begins stamping it when #13937's services half (the re-arm verb
* and the catch-arm stamp in `resumeInternal`) lands. plugin-approvals'
* `StrandedRunState` (`'missing' | 'failed'`) is a report-only label over
* a request's run and is deliberately NOT promoted to this status (same
* ruling): it classifies WHY a request's run is unrecoverable, this names
* the run's own lifecycle verdict.
*/
status?: 'completed' | 'paused' | 'failed' | 'stranded';
/** Run id — set when `status` is `'paused'`, so callers can resume it. */
runId?: string;
/**
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .changeset/automation-result-stranded-status.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
---
"@objectstack/spec": minor
---

feat(spec): name the terminally-failed-but-repairable run on `AutomationResult.status` — `'stranded'` (#14384, contract half of #13937)

`AutomationResult.status` (`contracts/automation-service.ts`) gains a fourth
member beside `'completed' | 'paused' | 'failed'`: **`'stranded'`** — the run
whose resume CONSUMED its suspension and then had a downstream node throw, so
the run is recorded as failed and can be re-armed only by an explicit operator
verb (#13909's condition; the #13937 shape-4 ruling, maintainer 2026-09-01
「命名同批定」). The wire mirror `TriggerFlowResponseSchema.data.status`
(`api/automation-api.zod.ts`) carries the same four, and a pin test binds the
two at the type level and the value level.

Additive: no existing literal changes meaning, `'failed'` still says "the run
ran and was rejected", and no engine, route or client behaviour moves in this
change — the engine begins stamping `'stranded'` when #13937's services half
(the operator re-arm verb) lands. A consumer that switches exhaustively over
`status` needs a `'stranded'` arm; the measured count of such switches in this
repo is zero. plugin-approvals' report-only `StrandedRunState`
(`'missing' | 'failed'`) is deliberately not promoted (same ruling).
2 changes: 1 addition & 1 deletion content/docs/references/api/automation-api.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -607,7 +607,7 @@ const result = AutomationApiErrorCode.parse(data);
| **error** | `string` | optional | Error message if execution failed |
| **durationMs** | `number` | optional | Execution duration in milliseconds |
| **code** | `Enum<'PERMISSION_DENIED' \| 'INVALID_SIGNAL' \| 'RUN_NOT_FOUND' \| 'STORE_UNAVAILABLE' \| …>` | optional | Machine-readable failure classification, set alongside `error` when the caller must distinguish WHY it failed. A closed union - the members and their transport mappings are documented on the contract (`AutomationResult.code`, contracts/automation-service.ts). |
| **status** | `Enum<'completed' \| 'paused' \| 'failed'>` | optional | Lifecycle status. `paused` means the run suspended at a node and can be continued with the resume route. Absent or `completed`/`failed` means the run reached a terminal state. |
| **status** | `Enum<'completed' \| 'paused' \| 'failed' \| 'stranded'>` | optional | Lifecycle status. `paused` means the run suspended at a node and can be continued with the resume route. Absent or `completed`/`failed`/`stranded` means the run reached a terminal state. `stranded` is the terminally-failed-but-repairable run: a resume consumed the suspension and a downstream node threw, so the run is recorded as failed and can be re-armed only by an explicit operator verb - never by the resume route, which answers RUN_NOT_FOUND for it. |
| **runId** | `string` | optional | Run id - set when `status` is `paused`, so callers can resume it |
| **screen** | `{ nodeId: string; title?: string; description?: string; fields: object[]; … }` | optional | The screen to render - set when the run paused at a `screen` node awaiting user input. The client collects values for `screen.fields` and resumes the run with them. |
| **successMessage** | `string` | optional | Friendly terminal message copied from the flow definition on terminal success, so a screen-flow runner can show a meaningful toast |
Expand Down
13 changes: 10 additions & 3 deletions packages/spec/src/api/automation-api.zod.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -337,10 +337,17 @@ export const TriggerFlowResponseSchema = lazySchema(() => BaseResponseSchema.ext
+ 'their transport mappings are documented on the contract '
+ '(`AutomationResult.code`, contracts/automation-service.ts).',
),
status: z.enum(['completed', 'paused', 'failed']).optional().describe(
// `stranded` is the contract half of the #13937 shape-4 ruling (#14384);
// the condition is #13909's. Mirrors `AutomationResult.status` member for
// member — the pin is `contracts/automation-result-status.pin.test.ts`.
status: z.enum(['completed', 'paused', 'failed', 'stranded']).optional().describe(
'Lifecycle status. `paused` means the run suspended at a node and can be '
+ 'continued with the resume route. Absent or `completed`/`failed` means '
+ 'the run reached a terminal state.',
+ 'continued with the resume route. Absent or `completed`/`failed`/`stranded` '
+ 'means the run reached a terminal state. `stranded` is the '
+ 'terminally-failed-but-repairable run: a resume consumed the suspension '
+ 'and a downstream node threw, so the run is recorded as failed and can be '
+ 're-armed only by an explicit operator verb - never by the resume route, '
+ 'which answers RUN_NOT_FOUND for it.',
),
runId: z.string().optional()
.describe('Run id - set when `status` is `paused`, so callers can resume it'),
Expand Down
140 changes: 140 additions & 0 deletions packages/spec/src/contracts/automation-result-status.pin.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
// Copyright (c) 2026 ObjectStack. Licensed under the Apache-2.0 license.

/**
* [#14384] `AutomationResult.status` is exactly
* `'completed' | 'paused' | 'failed' | 'stranded'`, and the wire mirror
* (`TriggerFlowResponseSchema.data.status`, `api/automation-api.zod.ts`) is
* the same four — contract half of the #13937 shape-4 ruling (maintainer
* 2026-09-01), which names the terminally-failed-but-repairable run on this
* union: a resume consumed the suspension, a downstream node threw, the run is
* recorded as failed and can be re-armed only by an explicit operator verb
* (#13909's condition). The literal is `'stranded'`.
*
* Three things are pinned, because each drifts on its own:
*
* 1. **The union's membership, at the type level.** `status` is a TypeScript
* interface member, not a Zod enum, so the only thing that can assert it is
* a compile-time identity (`Eq`, the `automation-api.zod.test.ts` form —
* a widening or a narrowing on either side turns the exported alias red
* under `check:test-typecheck`, which reads this file).
* 2. **Wire ↔ contract parity, at both levels.** The Zod enum's `.options`
* are read at runtime and compared to the same list, and its inferred
* type is bound to the contract's. #13078 bound the whole `data` object;
* this pins the ONE member the ruling added so a future member added to
* one side alone fails here by name.
* 3. **The JSDoc names the condition.** The card's acceptance is a JSDoc line
* naming the condition, and prose is unassertable except by reading it:
* the contract source is read and the doc block above the union is
* required to say what `'stranded'` is.
*
* ⛔ Not pinned, deliberately: any relation to `ExecutionStatus`
* (`automation/execution.zod.ts`, the persisted run-row vocabulary) or to
* plugin-approvals' `StrandedRunState` — the ruling keeps the latter a
* plugin-local report label, and whether the run ROW ever carries this word is
* the services half's to measure (#13937).
*/

import { readFileSync } from 'node:fs';
import { fileURLToPath } from 'node:url';

import { describe, it, expect } from 'vitest';

import { TriggerFlowResponseSchema } from '../api/automation-api.zod';
import type { TriggerFlowResponse } from '../api/automation-api.zod';

import type { AutomationResult } from './automation-service';

/** Type-level identity: true iff A and B are the same type. */
type Eq< A, B > = (< T >() => T extends A ? 1 : 2) extends (< T >() => T extends B ? 1 : 2) ? true : false;
/** Compile error when the argument is not `true`. */
type Assert< T extends true > = T;

type ContractStatus = NonNullable<AutomationResult['status']>;
type WireStatus = NonNullable<TriggerFlowResponse['data']['status']>;

/**
* The closed union, spelled once, in declaration order. `satisfies` proves
* every literal here is a member; the `Eq` below proves there is no member
* that is not here.
*/
export const AUTOMATION_RESULT_STATUSES = [
'completed',
'paused',
'failed',
'stranded',
] as const satisfies readonly ContractStatus[];

/**
* Exported deliberately — an unread alias inside a test body is TS6196, and a
* pin no program compiles is no pin at all (`check:test-typecheck` compiles
* this file under `tsconfig.test.json`).
*/
export type AutomationResultStatusIsExactlyTheFour = Assert< Eq< ContractStatus, (typeof AUTOMATION_RESULT_STATUSES)[number] > >;
/** Wire ↔ contract: the Zod enum's inferred type IS the interface's union. */
export type WireStatusMatchesContract = Assert< Eq< WireStatus, ContractStatus > >;

/** The wire enum, unwrapped from `.optional()` through the `lazySchema` Proxy. */
const wireStatusEnum = TriggerFlowResponseSchema.shape.data.shape.status.unwrap();

describe('[#14384] AutomationResult.status names the stranded run', () => {
it('reads a non-empty membership (anti-vacuity)', () => {
expect(AUTOMATION_RESULT_STATUSES.length).toBe(4);
expect(wireStatusEnum.options.length).toBeGreaterThan(0);
});

it('the wire enum carries exactly the contract union, in the same order', () => {
expect([...wireStatusEnum.options]).toEqual([...AUTOMATION_RESULT_STATUSES]);
});

it("names the terminally-failed-but-repairable run 'stranded' (#13937 shape 4)", () => {
expect(AUTOMATION_RESULT_STATUSES).toContain('stranded');
expect(wireStatusEnum.options).toContain('stranded');
});

it('a stranded terminal envelope parses and is PRESERVED on the wire', () => {
// A strip-mode object drops undeclared keys silently — the #13078 lesson —
// so parse success alone proves nothing; the value must come back out.
const parsed = TriggerFlowResponseSchema.parse({
success: true,
data: {
success: false,
status: 'stranded',
runId: 'run_stranded_001',
error: "node 'notify' threw after the approval was consumed",
},
});
expect(parsed.data.status).toBe('stranded');
expect(parsed.data.success).toBe(false);
expect(parsed.data.runId).toBe('run_stranded_001');
});

it('refuses a status outside the four, at `data.status`, as an enum violation', () => {
const result = TriggerFlowResponseSchema.safeParse({
success: true,
data: { success: false, status: 'strand' },
});
expect(result.success).toBe(false);
if (result.success) return;
const issue = result.error.issues.find((i) => i.path.join('.') === 'data.status');
expect(issue).toBeDefined();
expect(issue?.code).toBe('invalid_value');
});

it('the contract JSDoc names the condition beside the literal', () => {
const source = readFileSync(fileURLToPath(new URL('./automation-service.ts', import.meta.url)), 'utf8');
const declaration = "status?: 'completed' | 'paused' | 'failed' | 'stranded';";
const at = source.indexOf(declaration);
expect(at).toBeGreaterThan(-1);
// The doc block immediately above the declaration — from its last `/**`.
const docStart = source.lastIndexOf('/**', at);
const doc = source.slice(docStart, at);
expect(doc).toContain("`'stranded'`");
// The condition, in the ruling's own terms: a consumed suspension, a
// downstream throw, re-armable only by an explicit operator verb.
expect(doc).toMatch(/consumed the\s+\*?\s*suspension/i);
expect(doc).toMatch(/downstream node threw/i);
expect(doc).toMatch(/explicit operator verb/i);
// And the ruling's boundary: the plugin-local label is not promoted.
expect(doc).toContain('StrandedRunState');
});
});
25 changes: 22 additions & 3 deletions packages/spec/src/contracts/automation-service.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -291,9 +291,28 @@ export interface AutomationResult {
* Lifecycle status. `'paused'` means the run suspended at a node (e.g.
* an Approval node awaiting a human decision, ADR-0019) and can be
* continued later with {@link IAutomationService.resume}. Absent or
* `'completed'`/`'failed'` ⇒ the run reached a terminal state.
*/
status?: 'completed' | 'paused' | 'failed';
* `'completed'`/`'failed'`/`'stranded'` ⇒ the run reached a terminal
* state.
*
* `'stranded'` names the terminally-failed-but-repairable run (#13909;
* the #13937 shape-4 ruling, maintainer 2026-09-01): a resume CONSUMED the
* suspension, a downstream node threw, and the run is recorded as failed —
* terminal exactly like `'failed'`, except that the pause a durable
* decision (an approval, a screen submission) was waiting on is gone with
* it, so the run can be re-armed only by an explicit operator verb — never
* by {@link IAutomationService.resume} (which answers `'RUN_NOT_FOUND'`:
* there is no suspension left) and never automatically. Distinct from
* `'failed'` on purpose: that one says the run ran and was rejected; this
* one says a recorded continuation stopped mid-flight and an operator has
* something to repair. This member is the ruling's contract half; the
* engine begins stamping it when #13937's services half (the re-arm verb
* and the catch-arm stamp in `resumeInternal`) lands. plugin-approvals'
* `StrandedRunState` (`'missing' | 'failed'`) is a report-only label over
* a request's run and is deliberately NOT promoted to this status (same
* ruling): it classifies WHY a request's run is unrecoverable, this names
* the run's own lifecycle verdict.
*/
status?: 'completed' | 'paused' | 'failed' | 'stranded';
/** Run id — set when `status` is `'paused'`, so callers can resume it. */
runId?: string;
/**
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .changeset/automation-result-stranded-status.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
---
"@objectstack/spec": minor
---

feat(spec): name the terminally-failed-but-repairable run on `AutomationResult.status` — `'stranded'` (#14384, contract half of #13937)

`AutomationResult.status` (`contracts/automation-service.ts`) gains a fourth
member beside `'completed' | 'paused' | 'failed'`: **`'stranded'`** — the run
whose resume CONSUMED its suspension and then had a downstream node throw, so
the run is recorded as failed and can be re-armed only by an explicit operator
verb (#13909's condition; the #13937 shape-4 ruling, maintainer 2026-09-01
「命名同批定」). The wire mirror `TriggerFlowResponseSchema.data.status`
(`api/automation-api.zod.ts`) carries the same four, and a pin test binds the
two at the type level and the value level.

Additive: no existing literal changes meaning, `'failed'` still says "the run
ran and was rejected", and no engine, route or client behaviour moves in this
change — the engine begins stamping `'stranded'` when #13937's services half
(the operator re-arm verb) lands. A consumer that switches exhaustively over
`status` needs a `'stranded'` arm; the measured count of such switches in this
repo is zero. plugin-approvals' report-only `StrandedRunState`
(`'missing' | 'failed'`) is deliberately not promoted (same ruling).
2 changes: 1 addition & 1 deletion content/docs/references/api/automation-api.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -607,7 +607,7 @@ const result = AutomationApiErrorCode.parse(data);
| **error** | `string` | optional | Error message if execution failed |
| **durationMs** | `number` | optional | Execution duration in milliseconds |
| **code** | `Enum<'PERMISSION_DENIED' \| 'INVALID_SIGNAL' \| 'RUN_NOT_FOUND' \| 'STORE_UNAVAILABLE' \| …>` | optional | Machine-readable failure classification, set alongside `error` when the caller must distinguish WHY it failed. A closed union - the members and their transport mappings are documented on the contract (`AutomationResult.code`, contracts/automation-service.ts). |
| **status** | `Enum<'completed' \| 'paused' \| 'failed'>` | optional | Lifecycle status. `paused` means the run suspended at a node and can be continued with the resume route. Absent or `completed`/`failed` means the run reached a terminal state. |
| **status** | `Enum<'completed' \| 'paused' \| 'failed' \| 'stranded'>` | optional | Lifecycle status. `paused` means the run suspended at a node and can be continued with the resume route. Absent or `completed`/`failed`/`stranded` means the run reached a terminal state. `stranded` is the terminally-failed-but-repairable run: a resume consumed the suspension and a downstream node threw, so the run is recorded as failed and can be re-armed only by an explicit operator verb - never by the resume route, which answers RUN_NOT_FOUND for it. |
| **runId** | `string` | optional | Run id - set when `status` is `paused`, so callers can resume it |
| **screen** | `{ nodeId: string; title?: string; description?: string; fields: object[]; … }` | optional | The screen to render - set when the run paused at a `screen` node awaiting user input. The client collects values for `screen.fields` and resumes the run with them. |
| **successMessage** | `string` | optional | Friendly terminal message copied from the flow definition on terminal success, so a screen-flow runner can show a meaningful toast |
Expand Down
13 changes: 10 additions & 3 deletions packages/spec/src/api/automation-api.zod.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -337,10 +337,17 @@ export const TriggerFlowResponseSchema = lazySchema(() => BaseResponseSchema.ext
+ 'their transport mappings are documented on the contract '
+ '(`AutomationResult.code`, contracts/automation-service.ts).',
),
status: z.enum(['completed', 'paused', 'failed']).optional().describe(
// `stranded` is the contract half of the #13937 shape-4 ruling (#14384);
// the condition is #13909's. Mirrors `AutomationResult.status` member for
// member — the pin is `contracts/automation-result-status.pin.test.ts`.
status: z.enum(['completed', 'paused', 'failed', 'stranded']).optional().describe(
'Lifecycle status. `paused` means the run suspended at a node and can be '
+ 'continued with the resume route. Absent or `completed`/`failed` means '
+ 'the run reached a terminal state.',
+ 'continued with the resume route. Absent or `completed`/`failed`/`stranded` '
+ 'means the run reached a terminal state. `stranded` is the '
+ 'terminally-failed-but-repairable run: a resume consumed the suspension '
+ 'and a downstream node threw, so the run is recorded as failed and can be '
+ 're-armed only by an explicit operator verb - never by the resume route, '
+ 'which answers RUN_NOT_FOUND for it.',
),
runId: z.string().optional()
.describe('Run id - set when `status` is `paused`, so callers can resume it'),
Expand Down
140 changes: 140 additions & 0 deletions packages/spec/src/contracts/automation-result-status.pin.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
// Copyright (c) 2026 ObjectStack. Licensed under the Apache-2.0 license.

/**
* [#14384] `AutomationResult.status` is exactly
* `'completed' | 'paused' | 'failed' | 'stranded'`, and the wire mirror
* (`TriggerFlowResponseSchema.data.status`, `api/automation-api.zod.ts`) is
* the same four — contract half of the #13937 shape-4 ruling (maintainer
* 2026-09-01), which names the terminally-failed-but-repairable run on this
* union: a resume consumed the suspension, a downstream node threw, the run is
* recorded as failed and can be re-armed only by an explicit operator verb
* (#13909's condition). The literal is `'stranded'`.
*
* Three things are pinned, because each drifts on its own:
*
* 1. **The union's membership, at the type level.** `status` is a TypeScript
* interface member, not a Zod enum, so the only thing that can assert it is
* a compile-time identity (`Eq`, the `automation-api.zod.test.ts` form —
* a widening or a narrowing on either side turns the exported alias red
* under `check:test-typecheck`, which reads this file).
* 2. **Wire ↔ contract parity, at both levels.** The Zod enum's `.options`
* are read at runtime and compared to the same list, and its inferred
* type is bound to the contract's. #13078 bound the whole `data` object;
* this pins the ONE member the ruling added so a future member added to
* one side alone fails here by name.
* 3. **The JSDoc names the condition.** The card's acceptance is a JSDoc line
* naming the condition, and prose is unassertable except by reading it:
* the contract source is read and the doc block above the union is
* required to say what `'stranded'` is.
*
* ⛔ Not pinned, deliberately: any relation to `ExecutionStatus`
* (`automation/execution.zod.ts`, the persisted run-row vocabulary) or to
* plugin-approvals' `StrandedRunState` — the ruling keeps the latter a
* plugin-local report label, and whether the run ROW ever carries this word is
* the services half's to measure (#13937).
*/

import { readFileSync } from 'node:fs';
import { fileURLToPath } from 'node:url';

import { describe, it, expect } from 'vitest';

import { TriggerFlowResponseSchema } from '../api/automation-api.zod';
import type { TriggerFlowResponse } from '../api/automation-api.zod';

import type { AutomationResult } from './automation-service';

/** Type-level identity: true iff A and B are the same type. */
type Eq< A, B > = (< T >() => T extends A ? 1 : 2) extends (< T >() => T extends B ? 1 : 2) ? true : false;
/** Compile error when the argument is not `true`. */
type Assert< T extends true > = T;

type ContractStatus = NonNullable<AutomationResult['status']>;
type WireStatus = NonNullable<TriggerFlowResponse['data']['status']>;

/**
* The closed union, spelled once, in declaration order. `satisfies` proves
* every literal here is a member; the `Eq` below proves there is no member
* that is not here.
*/
export const AUTOMATION_RESULT_STATUSES = [
'completed',
'paused',
'failed',
'stranded',
] as const satisfies readonly ContractStatus[];

/**
* Exported deliberately — an unread alias inside a test body is TS6196, and a
* pin no program compiles is no pin at all (`check:test-typecheck` compiles
* this file under `tsconfig.test.json`).
*/
export type AutomationResultStatusIsExactlyTheFour = Assert< Eq< ContractStatus, (typeof AUTOMATION_RESULT_STATUSES)[number] > >;
/** Wire ↔ contract: the Zod enum's inferred type IS the interface's union. */
export type WireStatusMatchesContract = Assert< Eq< WireStatus, ContractStatus > >;

/** The wire enum, unwrapped from `.optional()` through the `lazySchema` Proxy. */
const wireStatusEnum = TriggerFlowResponseSchema.shape.data.shape.status.unwrap();

describe('[#14384] AutomationResult.status names the stranded run', () => {
it('reads a non-empty membership (anti-vacuity)', () => {
expect(AUTOMATION_RESULT_STATUSES.length).toBe(4);
expect(wireStatusEnum.options.length).toBeGreaterThan(0);
});

it('the wire enum carries exactly the contract union, in the same order', () => {
expect([...wireStatusEnum.options]).toEqual([...AUTOMATION_RESULT_STATUSES]);
});

it("names the terminally-failed-but-repairable run 'stranded' (#13937 shape 4)", () => {
expect(AUTOMATION_RESULT_STATUSES).toContain('stranded');
expect(wireStatusEnum.options).toContain('stranded');
});

it('a stranded terminal envelope parses and is PRESERVED on the wire', () => {
// A strip-mode object drops undeclared keys silently — the #13078 lesson —
// so parse success alone proves nothing; the value must come back out.
const parsed = TriggerFlowResponseSchema.parse({
success: true,
data: {
success: false,
status: 'stranded',
runId: 'run_stranded_001',
error: "node 'notify' threw after the approval was consumed",
},
});
expect(parsed.data.status).toBe('stranded');
expect(parsed.data.success).toBe(false);
expect(parsed.data.runId).toBe('run_stranded_001');
});

it('refuses a status outside the four, at `data.status`, as an enum violation', () => {
const result = TriggerFlowResponseSchema.safeParse({
success: true,
data: { success: false, status: 'strand' },
});
expect(result.success).toBe(false);
if (result.success) return;
const issue = result.error.issues.find((i) => i.path.join('.') === 'data.status');
expect(issue).toBeDefined();
expect(issue?.code).toBe('invalid_value');
});

it('the contract JSDoc names the condition beside the literal', () => {
const source = readFileSync(fileURLToPath(new URL('./automation-service.ts', import.meta.url)), 'utf8');
const declaration = "status?: 'completed' | 'paused' | 'failed' | 'stranded';";
const at = source.indexOf(declaration);
expect(at).toBeGreaterThan(-1);
// The doc block immediately above the declaration — from its last `/**`.
const docStart = source.lastIndexOf('/**', at);
const doc = source.slice(docStart, at);
expect(doc).toContain("`'stranded'`");
// The condition, in the ruling's own terms: a consumed suspension, a
// downstream throw, re-armable only by an explicit operator verb.
expect(doc).toMatch(/consumed the\s+\*?\s*suspension/i);
expect(doc).toMatch(/downstream node threw/i);
expect(doc).toMatch(/explicit operator verb/i);
// And the ruling's boundary: the plugin-local label is not promoted.
expect(doc).toContain('StrandedRunState');
});
});
25 changes: 22 additions & 3 deletions packages/spec/src/contracts/automation-service.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -291,9 +291,28 @@ export interface AutomationResult {
* Lifecycle status. `'paused'` means the run suspended at a node (e.g.
* an Approval node awaiting a human decision, ADR-0019) and can be
* continued later with {@link IAutomationService.resume}. Absent or
* `'completed'`/`'failed'` ⇒ the run reached a terminal state.
*/
status?: 'completed' | 'paused' | 'failed';
* `'completed'`/`'failed'`/`'stranded'` ⇒ the run reached a terminal
* state.
*
* `'stranded'` names the terminally-failed-but-repairable run (#13909;
* the #13937 shape-4 ruling, maintainer 2026-09-01): a resume CONSUMED the
* suspension, a downstream node threw, and the run is recorded as failed —
* terminal exactly like `'failed'`, except that the pause a durable
* decision (an approval, a screen submission) was waiting on is gone with
* it, so the run can be re-armed only by an explicit operator verb — never
* by {@link IAutomationService.resume} (which answers `'RUN_NOT_FOUND'`:
* there is no suspension left) and never automatically. Distinct from
* `'failed'` on purpose: that one says the run ran and was rejected; this
* one says a recorded continuation stopped mid-flight and an operator has
* something to repair. This member is the ruling's contract half; the
* engine begins stamping it when #13937's services half (the re-arm verb
* and the catch-arm stamp in `resumeInternal`) lands. plugin-approvals'
* `StrandedRunState` (`'missing' | 'failed'`) is a report-only label over
* a request's run and is deliberately NOT promoted to this status (same
* ruling): it classifies WHY a request's run is unrecoverable, this names
* the run's own lifecycle verdict.
*/
status?: 'completed' | 'paused' | 'failed' | 'stranded';
/** Run id — set when `status` is `'paused'`, so callers can resume it. */
runId?: string;
/**
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .changeset/automation-result-stranded-status.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
---
"@objectstack/spec": minor
---

feat(spec): name the terminally-failed-but-repairable run on `AutomationResult.status` — `'stranded'` (#14384, contract half of #13937)

`AutomationResult.status` (`contracts/automation-service.ts`) gains a fourth
member beside `'completed' | 'paused' | 'failed'`: **`'stranded'`** — the run
whose resume CONSUMED its suspension and then had a downstream node throw, so
the run is recorded as failed and can be re-armed only by an explicit operator
verb (#13909's condition; the #13937 shape-4 ruling, maintainer 2026-09-01
「命名同批定」). The wire mirror `TriggerFlowResponseSchema.data.status`
(`api/automation-api.zod.ts`) carries the same four, and a pin test binds the
two at the type level and the value level.

Additive: no existing literal changes meaning, `'failed'` still says "the run
ran and was rejected", and no engine, route or client behaviour moves in this
change — the engine begins stamping `'stranded'` when #13937's services half
(the operator re-arm verb) lands. A consumer that switches exhaustively over
`status` needs a `'stranded'` arm; the measured count of such switches in this
repo is zero. plugin-approvals' report-only `StrandedRunState`
(`'missing' | 'failed'`) is deliberately not promoted (same ruling).
2 changes: 1 addition & 1 deletion content/docs/references/api/automation-api.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -607,7 +607,7 @@ const result = AutomationApiErrorCode.parse(data);
| **error** | `string` | optional | Error message if execution failed |
| **durationMs** | `number` | optional | Execution duration in milliseconds |
| **code** | `Enum<'PERMISSION_DENIED' \| 'INVALID_SIGNAL' \| 'RUN_NOT_FOUND' \| 'STORE_UNAVAILABLE' \| …>` | optional | Machine-readable failure classification, set alongside `error` when the caller must distinguish WHY it failed. A closed union - the members and their transport mappings are documented on the contract (`AutomationResult.code`, contracts/automation-service.ts). |
| **status** | `Enum<'completed' \| 'paused' \| 'failed'>` | optional | Lifecycle status. `paused` means the run suspended at a node and can be continued with the resume route. Absent or `completed`/`failed` means the run reached a terminal state. |
| **status** | `Enum<'completed' \| 'paused' \| 'failed' \| 'stranded'>` | optional | Lifecycle status. `paused` means the run suspended at a node and can be continued with the resume route. Absent or `completed`/`failed`/`stranded` means the run reached a terminal state. `stranded` is the terminally-failed-but-repairable run: a resume consumed the suspension and a downstream node threw, so the run is recorded as failed and can be re-armed only by an explicit operator verb - never by the resume route, which answers RUN_NOT_FOUND for it. |
| **runId** | `string` | optional | Run id - set when `status` is `paused`, so callers can resume it |
| **screen** | `{ nodeId: string; title?: string; description?: string; fields: object[]; … }` | optional | The screen to render - set when the run paused at a `screen` node awaiting user input. The client collects values for `screen.fields` and resumes the run with them. |
| **successMessage** | `string` | optional | Friendly terminal message copied from the flow definition on terminal success, so a screen-flow runner can show a meaningful toast |
Expand Down
13 changes: 10 additions & 3 deletions packages/spec/src/api/automation-api.zod.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -337,10 +337,17 @@ export const TriggerFlowResponseSchema = lazySchema(() => BaseResponseSchema.ext
+ 'their transport mappings are documented on the contract '
+ '(`AutomationResult.code`, contracts/automation-service.ts).',
),
status: z.enum(['completed', 'paused', 'failed']).optional().describe(
// `stranded` is the contract half of the #13937 shape-4 ruling (#14384);
// the condition is #13909's. Mirrors `AutomationResult.status` member for
// member — the pin is `contracts/automation-result-status.pin.test.ts`.
status: z.enum(['completed', 'paused', 'failed', 'stranded']).optional().describe(
'Lifecycle status. `paused` means the run suspended at a node and can be '
+ 'continued with the resume route. Absent or `completed`/`failed` means '
+ 'the run reached a terminal state.',
+ 'continued with the resume route. Absent or `completed`/`failed`/`stranded` '
+ 'means the run reached a terminal state. `stranded` is the '
+ 'terminally-failed-but-repairable run: a resume consumed the suspension '
+ 'and a downstream node threw, so the run is recorded as failed and can be '
+ 're-armed only by an explicit operator verb - never by the resume route, '
+ 'which answers RUN_NOT_FOUND for it.',
),
runId: z.string().optional()
.describe('Run id - set when `status` is `paused`, so callers can resume it'),
Expand Down
140 changes: 140 additions & 0 deletions packages/spec/src/contracts/automation-result-status.pin.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
// Copyright (c) 2026 ObjectStack. Licensed under the Apache-2.0 license.

/**
* [#14384] `AutomationResult.status` is exactly
* `'completed' | 'paused' | 'failed' | 'stranded'`, and the wire mirror
* (`TriggerFlowResponseSchema.data.status`, `api/automation-api.zod.ts`) is
* the same four — contract half of the #13937 shape-4 ruling (maintainer
* 2026-09-01), which names the terminally-failed-but-repairable run on this
* union: a resume consumed the suspension, a downstream node threw, the run is
* recorded as failed and can be re-armed only by an explicit operator verb
* (#13909's condition). The literal is `'stranded'`.
*
* Three things are pinned, because each drifts on its own:
*
* 1. **The union's membership, at the type level.** `status` is a TypeScript
* interface member, not a Zod enum, so the only thing that can assert it is
* a compile-time identity (`Eq`, the `automation-api.zod.test.ts` form —
* a widening or a narrowing on either side turns the exported alias red
* under `check:test-typecheck`, which reads this file).
* 2. **Wire ↔ contract parity, at both levels.** The Zod enum's `.options`
* are read at runtime and compared to the same list, and its inferred
* type is bound to the contract's. #13078 bound the whole `data` object;
* this pins the ONE member the ruling added so a future member added to
* one side alone fails here by name.
* 3. **The JSDoc names the condition.** The card's acceptance is a JSDoc line
* naming the condition, and prose is unassertable except by reading it:
* the contract source is read and the doc block above the union is
* required to say what `'stranded'` is.
*
* ⛔ Not pinned, deliberately: any relation to `ExecutionStatus`
* (`automation/execution.zod.ts`, the persisted run-row vocabulary) or to
* plugin-approvals' `StrandedRunState` — the ruling keeps the latter a
* plugin-local report label, and whether the run ROW ever carries this word is
* the services half's to measure (#13937).
*/

import { readFileSync } from 'node:fs';
import { fileURLToPath } from 'node:url';

import { describe, it, expect } from 'vitest';

import { TriggerFlowResponseSchema } from '../api/automation-api.zod';
import type { TriggerFlowResponse } from '../api/automation-api.zod';

import type { AutomationResult } from './automation-service';

/** Type-level identity: true iff A and B are the same type. */
type Eq< A, B > = (< T >() => T extends A ? 1 : 2) extends (< T >() => T extends B ? 1 : 2) ? true : false;
/** Compile error when the argument is not `true`. */
type Assert< T extends true > = T;

type ContractStatus = NonNullable<AutomationResult['status']>;
type WireStatus = NonNullable<TriggerFlowResponse['data']['status']>;

/**
* The closed union, spelled once, in declaration order. `satisfies` proves
* every literal here is a member; the `Eq` below proves there is no member
* that is not here.
*/
export const AUTOMATION_RESULT_STATUSES = [
'completed',
'paused',
'failed',
'stranded',
] as const satisfies readonly ContractStatus[];

/**
* Exported deliberately — an unread alias inside a test body is TS6196, and a
* pin no program compiles is no pin at all (`check:test-typecheck` compiles
* this file under `tsconfig.test.json`).
*/
export type AutomationResultStatusIsExactlyTheFour = Assert< Eq< ContractStatus, (typeof AUTOMATION_RESULT_STATUSES)[number] > >;
/** Wire ↔ contract: the Zod enum's inferred type IS the interface's union. */
export type WireStatusMatchesContract = Assert< Eq< WireStatus, ContractStatus > >;

/** The wire enum, unwrapped from `.optional()` through the `lazySchema` Proxy. */
const wireStatusEnum = TriggerFlowResponseSchema.shape.data.shape.status.unwrap();

describe('[#14384] AutomationResult.status names the stranded run', () => {
it('reads a non-empty membership (anti-vacuity)', () => {
expect(AUTOMATION_RESULT_STATUSES.length).toBe(4);
expect(wireStatusEnum.options.length).toBeGreaterThan(0);
});

it('the wire enum carries exactly the contract union, in the same order', () => {
expect([...wireStatusEnum.options]).toEqual([...AUTOMATION_RESULT_STATUSES]);
});

it("names the terminally-failed-but-repairable run 'stranded' (#13937 shape 4)", () => {
expect(AUTOMATION_RESULT_STATUSES).toContain('stranded');
expect(wireStatusEnum.options).toContain('stranded');
});

it('a stranded terminal envelope parses and is PRESERVED on the wire', () => {
// A strip-mode object drops undeclared keys silently — the #13078 lesson —
// so parse success alone proves nothing; the value must come back out.
const parsed = TriggerFlowResponseSchema.parse({
success: true,
data: {
success: false,
status: 'stranded',
runId: 'run_stranded_001',
error: "node 'notify' threw after the approval was consumed",
},
});
expect(parsed.data.status).toBe('stranded');
expect(parsed.data.success).toBe(false);
expect(parsed.data.runId).toBe('run_stranded_001');
});

it('refuses a status outside the four, at `data.status`, as an enum violation', () => {
const result = TriggerFlowResponseSchema.safeParse({
success: true,
data: { success: false, status: 'strand' },
});
expect(result.success).toBe(false);
if (result.success) return;
const issue = result.error.issues.find((i) => i.path.join('.') === 'data.status');
expect(issue).toBeDefined();
expect(issue?.code).toBe('invalid_value');
});

it('the contract JSDoc names the condition beside the literal', () => {
const source = readFileSync(fileURLToPath(new URL('./automation-service.ts', import.meta.url)), 'utf8');
const declaration = "status?: 'completed' | 'paused' | 'failed' | 'stranded';";
const at = source.indexOf(declaration);
expect(at).toBeGreaterThan(-1);
// The doc block immediately above the declaration — from its last `/**`.
const docStart = source.lastIndexOf('/**', at);
const doc = source.slice(docStart, at);
expect(doc).toContain("`'stranded'`");
// The condition, in the ruling's own terms: a consumed suspension, a
// downstream throw, re-armable only by an explicit operator verb.
expect(doc).toMatch(/consumed the\s+\*?\s*suspension/i);
expect(doc).toMatch(/downstream node threw/i);
expect(doc).toMatch(/explicit operator verb/i);
// And the ruling's boundary: the plugin-local label is not promoted.
expect(doc).toContain('StrandedRunState');
});
});
25 changes: 22 additions & 3 deletions packages/spec/src/contracts/automation-service.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -291,9 +291,28 @@ export interface AutomationResult {
* Lifecycle status. `'paused'` means the run suspended at a node (e.g.
* an Approval node awaiting a human decision, ADR-0019) and can be
* continued later with {@link IAutomationService.resume}. Absent or
* `'completed'`/`'failed'` ⇒ the run reached a terminal state.
*/
status?: 'completed' | 'paused' | 'failed';
* `'completed'`/`'failed'`/`'stranded'` ⇒ the run reached a terminal
* state.
*
* `'stranded'` names the terminally-failed-but-repairable run (#13909;
* the #13937 shape-4 ruling, maintainer 2026-09-01): a resume CONSUMED the
* suspension, a downstream node threw, and the run is recorded as failed —
* terminal exactly like `'failed'`, except that the pause a durable
* decision (an approval, a screen submission) was waiting on is gone with
* it, so the run can be re-armed only by an explicit operator verb — never
* by {@link IAutomationService.resume} (which answers `'RUN_NOT_FOUND'`:
* there is no suspension left) and never automatically. Distinct from
* `'failed'` on purpose: that one says the run ran and was rejected; this
* one says a recorded continuation stopped mid-flight and an operator has
* something to repair. This member is the ruling's contract half; the
* engine begins stamping it when #13937's services half (the re-arm verb
* and the catch-arm stamp in `resumeInternal`) lands. plugin-approvals'
* `StrandedRunState` (`'missing' | 'failed'`) is a report-only label over
* a request's run and is deliberately NOT promoted to this status (same
* ruling): it classifies WHY a request's run is unrecoverable, this names
* the run's own lifecycle verdict.
*/
status?: 'completed' | 'paused' | 'failed' | 'stranded';
/** Run id — set when `status` is `'paused'`, so callers can resume it. */
runId?: string;
/**
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .changeset/automation-result-stranded-status.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
---
"@objectstack/spec": minor
---

feat(spec): name the terminally-failed-but-repairable run on `AutomationResult.status` — `'stranded'` (#14384, contract half of #13937)

`AutomationResult.status` (`contracts/automation-service.ts`) gains a fourth
member beside `'completed' | 'paused' | 'failed'`: **`'stranded'`** — the run
whose resume CONSUMED its suspension and then had a downstream node throw, so
the run is recorded as failed and can be re-armed only by an explicit operator
verb (#13909's condition; the #13937 shape-4 ruling, maintainer 2026-09-01
「命名同批定」). The wire mirror `TriggerFlowResponseSchema.data.status`
(`api/automation-api.zod.ts`) carries the same four, and a pin test binds the
two at the type level and the value level.

Additive: no existing literal changes meaning, `'failed'` still says "the run
ran and was rejected", and no engine, route or client behaviour moves in this
change — the engine begins stamping `'stranded'` when #13937's services half
(the operator re-arm verb) lands. A consumer that switches exhaustively over
`status` needs a `'stranded'` arm; the measured count of such switches in this
repo is zero. plugin-approvals' report-only `StrandedRunState`
(`'missing' | 'failed'`) is deliberately not promoted (same ruling).
2 changes: 1 addition & 1 deletion content/docs/references/api/automation-api.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -607,7 +607,7 @@ const result = AutomationApiErrorCode.parse(data);
| **error** | `string` | optional | Error message if execution failed |
| **durationMs** | `number` | optional | Execution duration in milliseconds |
| **code** | `Enum<'PERMISSION_DENIED' \| 'INVALID_SIGNAL' \| 'RUN_NOT_FOUND' \| 'STORE_UNAVAILABLE' \| …>` | optional | Machine-readable failure classification, set alongside `error` when the caller must distinguish WHY it failed. A closed union - the members and their transport mappings are documented on the contract (`AutomationResult.code`, contracts/automation-service.ts). |
| **status** | `Enum<'completed' \| 'paused' \| 'failed'>` | optional | Lifecycle status. `paused` means the run suspended at a node and can be continued with the resume route. Absent or `completed`/`failed` means the run reached a terminal state. |
| **status** | `Enum<'completed' \| 'paused' \| 'failed' \| 'stranded'>` | optional | Lifecycle status. `paused` means the run suspended at a node and can be continued with the resume route. Absent or `completed`/`failed`/`stranded` means the run reached a terminal state. `stranded` is the terminally-failed-but-repairable run: a resume consumed the suspension and a downstream node threw, so the run is recorded as failed and can be re-armed only by an explicit operator verb - never by the resume route, which answers RUN_NOT_FOUND for it. |
| **runId** | `string` | optional | Run id - set when `status` is `paused`, so callers can resume it |
| **screen** | `{ nodeId: string; title?: string; description?: string; fields: object[]; … }` | optional | The screen to render - set when the run paused at a `screen` node awaiting user input. The client collects values for `screen.fields` and resumes the run with them. |
| **successMessage** | `string` | optional | Friendly terminal message copied from the flow definition on terminal success, so a screen-flow runner can show a meaningful toast |
Expand Down
13 changes: 10 additions & 3 deletions packages/spec/src/api/automation-api.zod.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -337,10 +337,17 @@ export const TriggerFlowResponseSchema = lazySchema(() => BaseResponseSchema.ext
+ 'their transport mappings are documented on the contract '
+ '(`AutomationResult.code`, contracts/automation-service.ts).',
),
status: z.enum(['completed', 'paused', 'failed']).optional().describe(
// `stranded` is the contract half of the #13937 shape-4 ruling (#14384);
// the condition is #13909's. Mirrors `AutomationResult.status` member for
// member — the pin is `contracts/automation-result-status.pin.test.ts`.
status: z.enum(['completed', 'paused', 'failed', 'stranded']).optional().describe(
'Lifecycle status. `paused` means the run suspended at a node and can be '
+ 'continued with the resume route. Absent or `completed`/`failed` means '
+ 'the run reached a terminal state.',
+ 'continued with the resume route. Absent or `completed`/`failed`/`stranded` '
+ 'means the run reached a terminal state. `stranded` is the '
+ 'terminally-failed-but-repairable run: a resume consumed the suspension '
+ 'and a downstream node threw, so the run is recorded as failed and can be '
+ 're-armed only by an explicit operator verb - never by the resume route, '
+ 'which answers RUN_NOT_FOUND for it.',
),
runId: z.string().optional()
.describe('Run id - set when `status` is `paused`, so callers can resume it'),
Expand Down
140 changes: 140 additions & 0 deletions packages/spec/src/contracts/automation-result-status.pin.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
// Copyright (c) 2026 ObjectStack. Licensed under the Apache-2.0 license.

/**
* [#14384] `AutomationResult.status` is exactly
* `'completed' | 'paused' | 'failed' | 'stranded'`, and the wire mirror
* (`TriggerFlowResponseSchema.data.status`, `api/automation-api.zod.ts`) is
* the same four — contract half of the #13937 shape-4 ruling (maintainer
* 2026-09-01), which names the terminally-failed-but-repairable run on this
* union: a resume consumed the suspension, a downstream node threw, the run is
* recorded as failed and can be re-armed only by an explicit operator verb
* (#13909's condition). The literal is `'stranded'`.
*
* Three things are pinned, because each drifts on its own:
*
* 1. **The union's membership, at the type level.** `status` is a TypeScript
* interface member, not a Zod enum, so the only thing that can assert it is
* a compile-time identity (`Eq`, the `automation-api.zod.test.ts` form —
* a widening or a narrowing on either side turns the exported alias red
* under `check:test-typecheck`, which reads this file).
* 2. **Wire ↔ contract parity, at both levels.** The Zod enum's `.options`
* are read at runtime and compared to the same list, and its inferred
* type is bound to the contract's. #13078 bound the whole `data` object;
* this pins the ONE member the ruling added so a future member added to
* one side alone fails here by name.
* 3. **The JSDoc names the condition.** The card's acceptance is a JSDoc line
* naming the condition, and prose is unassertable except by reading it:
* the contract source is read and the doc block above the union is
* required to say what `'stranded'` is.
*
* ⛔ Not pinned, deliberately: any relation to `ExecutionStatus`
* (`automation/execution.zod.ts`, the persisted run-row vocabulary) or to
* plugin-approvals' `StrandedRunState` — the ruling keeps the latter a
* plugin-local report label, and whether the run ROW ever carries this word is
* the services half's to measure (#13937).
*/

import { readFileSync } from 'node:fs';
import { fileURLToPath } from 'node:url';

import { describe, it, expect } from 'vitest';

import { TriggerFlowResponseSchema } from '../api/automation-api.zod';
import type { TriggerFlowResponse } from '../api/automation-api.zod';

import type { AutomationResult } from './automation-service';

/** Type-level identity: true iff A and B are the same type. */
type Eq< A, B > = (< T >() => T extends A ? 1 : 2) extends (< T >() => T extends B ? 1 : 2) ? true : false;
/** Compile error when the argument is not `true`. */
type Assert< T extends true > = T;

type ContractStatus = NonNullable<AutomationResult['status']>;
type WireStatus = NonNullable<TriggerFlowResponse['data']['status']>;

/**
* The closed union, spelled once, in declaration order. `satisfies` proves
* every literal here is a member; the `Eq` below proves there is no member
* that is not here.
*/
export const AUTOMATION_RESULT_STATUSES = [
'completed',
'paused',
'failed',
'stranded',
] as const satisfies readonly ContractStatus[];

/**
* Exported deliberately — an unread alias inside a test body is TS6196, and a
* pin no program compiles is no pin at all (`check:test-typecheck` compiles
* this file under `tsconfig.test.json`).
*/
export type AutomationResultStatusIsExactlyTheFour = Assert< Eq< ContractStatus, (typeof AUTOMATION_RESULT_STATUSES)[number] > >;
/** Wire ↔ contract: the Zod enum's inferred type IS the interface's union. */
export type WireStatusMatchesContract = Assert< Eq< WireStatus, ContractStatus > >;

/** The wire enum, unwrapped from `.optional()` through the `lazySchema` Proxy. */
const wireStatusEnum = TriggerFlowResponseSchema.shape.data.shape.status.unwrap();

describe('[#14384] AutomationResult.status names the stranded run', () => {
it('reads a non-empty membership (anti-vacuity)', () => {
expect(AUTOMATION_RESULT_STATUSES.length).toBe(4);
expect(wireStatusEnum.options.length).toBeGreaterThan(0);
});

it('the wire enum carries exactly the contract union, in the same order', () => {
expect([...wireStatusEnum.options]).toEqual([...AUTOMATION_RESULT_STATUSES]);
});

it("names the terminally-failed-but-repairable run 'stranded' (#13937 shape 4)", () => {
expect(AUTOMATION_RESULT_STATUSES).toContain('stranded');
expect(wireStatusEnum.options).toContain('stranded');
});

it('a stranded terminal envelope parses and is PRESERVED on the wire', () => {
// A strip-mode object drops undeclared keys silently — the #13078 lesson —
// so parse success alone proves nothing; the value must come back out.
const parsed = TriggerFlowResponseSchema.parse({
success: true,
data: {
success: false,
status: 'stranded',
runId: 'run_stranded_001',
error: "node 'notify' threw after the approval was consumed",
},
});
expect(parsed.data.status).toBe('stranded');
expect(parsed.data.success).toBe(false);
expect(parsed.data.runId).toBe('run_stranded_001');
});

it('refuses a status outside the four, at `data.status`, as an enum violation', () => {
const result = TriggerFlowResponseSchema.safeParse({
success: true,
data: { success: false, status: 'strand' },
});
expect(result.success).toBe(false);
if (result.success) return;
const issue = result.error.issues.find((i) => i.path.join('.') === 'data.status');
expect(issue).toBeDefined();
expect(issue?.code).toBe('invalid_value');
});

it('the contract JSDoc names the condition beside the literal', () => {
const source = readFileSync(fileURLToPath(new URL('./automation-service.ts', import.meta.url)), 'utf8');
const declaration = "status?: 'completed' | 'paused' | 'failed' | 'stranded';";
const at = source.indexOf(declaration);
expect(at).toBeGreaterThan(-1);
// The doc block immediately above the declaration — from its last `/**`.
const docStart = source.lastIndexOf('/**', at);
const doc = source.slice(docStart, at);
expect(doc).toContain("`'stranded'`");
// The condition, in the ruling's own terms: a consumed suspension, a
// downstream throw, re-armable only by an explicit operator verb.
expect(doc).toMatch(/consumed the\s+\*?\s*suspension/i);
expect(doc).toMatch(/downstream node threw/i);
expect(doc).toMatch(/explicit operator verb/i);
// And the ruling's boundary: the plugin-local label is not promoted.
expect(doc).toContain('StrandedRunState');
});
});
25 changes: 22 additions & 3 deletions packages/spec/src/contracts/automation-service.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -291,9 +291,28 @@ export interface AutomationResult {
* Lifecycle status. `'paused'` means the run suspended at a node (e.g.
* an Approval node awaiting a human decision, ADR-0019) and can be
* continued later with {@link IAutomationService.resume}. Absent or
* `'completed'`/`'failed'` ⇒ the run reached a terminal state.
*/
status?: 'completed' | 'paused' | 'failed';
* `'completed'`/`'failed'`/`'stranded'` ⇒ the run reached a terminal
* state.
*
* `'stranded'` names the terminally-failed-but-repairable run (#13909;
* the #13937 shape-4 ruling, maintainer 2026-09-01): a resume CONSUMED the
* suspension, a downstream node threw, and the run is recorded as failed —
* terminal exactly like `'failed'`, except that the pause a durable
* decision (an approval, a screen submission) was waiting on is gone with
* it, so the run can be re-armed only by an explicit operator verb — never
* by {@link IAutomationService.resume} (which answers `'RUN_NOT_FOUND'`:
* there is no suspension left) and never automatically. Distinct from
* `'failed'` on purpose: that one says the run ran and was rejected; this
* one says a recorded continuation stopped mid-flight and an operator has
* something to repair. This member is the ruling's contract half; the
* engine begins stamping it when #13937's services half (the re-arm verb
* and the catch-arm stamp in `resumeInternal`) lands. plugin-approvals'
* `StrandedRunState` (`'missing' | 'failed'`) is a report-only label over
* a request's run and is deliberately NOT promoted to this status (same
* ruling): it classifies WHY a request's run is unrecoverable, this names
* the run's own lifecycle verdict.
*/
status?: 'completed' | 'paused' | 'failed' | 'stranded';
/** Run id — set when `status` is `'paused'`, so callers can resume it. */
runId?: string;
/**
Expand Down
Loading