Files
fusion/packages/core/src/workflow-compiler.ts
gsxdsm bd87ce7d7e FN-6304: add optional workflow steps
Allow workflows to define default-on optional steps and expose browser verification as a togglable workflow option.

- Add core optional-step helpers, IR metadata, compiler support, exports, and regression coverage.
- Mark browser verification optional in the built-in coding workflow and document optional workflow-step behavior.
- Add dashboard/API support for optional step defaults and enabled-state presentation with localized label cleanup.
- Add a patch changeset for the published Fusion package.

Files changed:
 .changeset/fn-6304-optional-workflow-steps.md      |  5 ++
 docs/task-management.md                            |  2 +-
 docs/workflow-steps.md                             |  8 ++
 packages/core/src/__tests__/workflow-ir.test.ts    | 45 +++++++++++
 .../src/__tests__/workflow-optional-steps.test.ts  | 88 ++++++++++++++++++++++
 packages/core/src/builtin-coding-workflow-ir.ts    |  1 +
 packages/core/src/index.ts                         |  3 +
 packages/core/src/store.ts                         |  3 +
 packages/core/src/workflow-compiler.ts             | 30 +++++++-
 packages/core/src/workflow-ir-types.ts             | 11 +++
 packages/core/src/workflow-ir.ts                   | 32 +++++++-
 packages/core/src/workflow-optional-steps.ts       | 46 +++++++++++
 packages/dashboard/app/api/legacy.ts               | 10 +++
 .../dashboard/app/components/InlineCreateCard.css  | 20 +++++
 .../dashboard/app/components/InlineCreateCard.tsx  | 87 ++++++++++++++++-----
 .../app/components/WorkflowResultsTab.tsx          | 44 +++++++++--
 .../components/__tests__/InlineCreateCard.test.tsx | 41 +++++++++-
 .../__tests__/WorkflowResultsTab.test.tsx          | 58 +++++++++++++-
 .../src/__tests__/workflow-routes.test.ts          | 22 ++++++
 .../src/routes/register-workflow-routes.ts         | 16 +++-
 packages/i18n/locales/en/app.json                  |  6 +-
 packages/i18n/locales/es/app.json                  |  3 -
 packages/i18n/locales/fr/app.json                  |  3 -
 packages/i18n/locales/ko/app.json                  |  3 -
 packages/i18n/locales/zh-CN/app.json               |  3 -
 packages/i18n/locales/zh-TW/app.json               |  3 -
 packages/i18n/src/resources.d.ts                   |  6 +-
 27 files changed, 543 insertions(+), 56 deletions(-)

Fusion-Task-Id: FN-6304

Fusion-Task-Lineage: 385f8ae1-494f-4e2b-a6e9-3a2d2bbe7f71
2026-06-12 17:57:19 -07:00

320 lines
12 KiB
TypeScript

import type { WorkflowIr, WorkflowIrNode, WorkflowIrEdge } from "./workflow-ir-types.js";
import { parseWorkflowIr } from "./workflow-ir.js";
import type { WorkflowStepInput, WorkflowStepGateMode } from "./types.js";
/**
* Raised when a WorkflowIr graph cannot be compiled onto the executable
* WorkflowStep engine — typically because it branches beyond the canonical
* seam success/failure chain and therefore requires the (deferred) graph
* interpreter rather than the linear pre/post-merge step runner.
*/
export class WorkflowCompileError extends Error {
constructor(message: string) {
super(message);
this.name = "WorkflowCompileError";
}
}
export const WORKFLOW_INTERPRETER_DEFERRED_SUFFIX = "require the workflow interpreter (deferred)";
export function isInterpreterDeferredWorkflowCompileError(error: unknown): boolean {
return error instanceof WorkflowCompileError && error.message.includes(WORKFLOW_INTERPRETER_DEFERRED_SUFFIX);
}
/** Workflow-owned merge/retry/recovery policy primitives. The WorkflowStep
* compiler treats this region as a terminal engine-owned boundary: these nodes
* may branch internally, are not emitted as steps, and are not walked by the
* linear step compiler. */
export const MERGE_REGION_NODE_KINDS: ReadonlySet<WorkflowIrNode["kind"]> = new Set([
"merge-gate",
"merge-attempt",
"manual-merge-hold",
"retry-backoff",
"recovery-router",
"branch-group-member-integration",
"branch-group-promotion",
]);
function isMergeRegionKind(node: WorkflowIrNode): boolean {
return MERGE_REGION_NODE_KINDS.has(node.kind);
}
/** Seam anchor kinds, encoded on IR nodes as `config.seam`. These map to the
* fixed planning → execute → workflow-step → review → merge pipeline and are
* not emitted as steps. */
const SEAM_NAMES = new Set(["planning", "execute", "workflow-step", "review", "merge"]);
const ENGINE_PRIMITIVE_NODE_KINDS = new Set<WorkflowIrNode["kind"]>([
"merge-gate",
"merge-attempt",
"manual-merge-hold",
"retry-backoff",
"recovery-router",
"branch-group-member-integration",
"branch-group-promotion",
"pr-create",
"pr-respond",
"pr-merge",
]);
function isEnginePrimitive(node: WorkflowIrNode): boolean {
return ENGINE_PRIMITIVE_NODE_KINDS.has(node.kind);
}
function seamOf(node: WorkflowIrNode): string | undefined {
const seam = node.config?.seam;
return typeof seam === "string" && SEAM_NAMES.has(seam) ? seam : undefined;
}
function configString(node: WorkflowIrNode, key: string): string | undefined {
const value = node.config?.[key];
return typeof value === "string" && value.trim() ? value : undefined;
}
function buildOutgoing(ir: WorkflowIr): Map<string, WorkflowIrEdge[]> {
const outgoing = new Map<string, WorkflowIrEdge[]>();
for (const edge of ir.edges) {
const list = outgoing.get(edge.from);
if (list) list.push(edge);
else outgoing.set(edge.from, [edge]);
}
return outgoing;
}
function mainEdge(edges: WorkflowIrEdge[]): WorkflowIrEdge | undefined {
return edges.find((edge) => edge.condition !== "failure");
}
/**
* Validate that a workflow graph reduces to a linear pre-merge → seams →
* post-merge chain the WorkflowStep engine can run. Returns a
* WorkflowCompileError describing the first problem, or null when compilable.
*
* Allowed shape: a single path from start to end or to the engine-owned merge
* policy region. Seam nodes may carry an extra `failure` edge to the end node;
* merge-policy primitives are terminal and may fan out internally; every other
* non-terminal node has exactly one outgoing edge. Anything else (true
* branching) requires the deferred interpreter.
*/
export function validateLinearity(ir: WorkflowIr): WorkflowCompileError | null {
const nodesById = new Map(ir.nodes.map((node) => [node.id, node]));
for (const edge of ir.edges) {
if (!nodesById.has(edge.from)) return new WorkflowCompileError(`edge references unknown node '${edge.from}'`);
if (!nodesById.has(edge.to)) return new WorkflowCompileError(`edge references unknown node '${edge.to}'`);
}
const endNode = ir.nodes.find((node) => node.kind === "end");
const startNode = ir.nodes.find((node) => node.kind === "start");
if (!startNode || !endNode) {
return new WorkflowCompileError("workflow must contain exactly one start and one end node");
}
const outgoing = buildOutgoing(ir);
for (const node of ir.nodes) {
const outs = outgoing.get(node.id) ?? [];
if (node.kind === "end") {
if (outs.length > 0) return new WorkflowCompileError("end node must have no outgoing edges");
continue;
}
if (isEnginePrimitive(node)) {
continue;
}
if (isMergeRegionKind(node)) {
continue;
}
const seam = seamOf(node);
if (seam) {
const failureEdges = outs.filter((edge) => edge.condition === "failure");
const mainEdges = outs.filter((edge) => !edge.condition || edge.condition === "success");
const outcomeEdges = outs.filter((edge) => edge.condition?.startsWith("outcome:"));
if (mainEdges.length !== 1) {
return new WorkflowCompileError(`seam '${node.id}' must have exactly one success path`);
}
if (failureEdges.length > 1) {
return new WorkflowCompileError(`seam '${node.id}' has multiple failure edges`);
}
if (failureEdges[0] && failureEdges[0].to !== endNode.id) {
return new WorkflowCompileError(`seam '${node.id}' failure edge must target the end node`);
}
const nonTerminalOutcomeEdge = outcomeEdges.find((edge) => edge.to !== endNode.id);
if (nonTerminalOutcomeEdge) {
return new WorkflowCompileError(`seam '${node.id}' outcome edge must target the end node`);
}
continue;
}
// start or a user node (prompt/script/gate): exactly one outgoing edge.
if (outs.length === 0) {
return new WorkflowCompileError(`node '${node.id}' has no outgoing edge`);
}
if (outs.length > 1) {
// NOTE: WORKFLOW_INTERPRETER_DEFERRED_SUFFIX is matched by the dashboard
// editor/routes (KTD-4) to render an info-tone "interpreter-only" banner
// instead of an error. Keep interpreter-deferred messages carrying this
// exact suffix in sync.
return new WorkflowCompileError(
`node '${node.id}' branches into ${outs.length} edges — graphs with branches ${WORKFLOW_INTERPRETER_DEFERRED_SUFFIX}`,
);
}
}
// Reachability: the single main path must reach end and cover every node.
// While walking, enforce the canonical seam pipeline: each of planning/
// execute/workflow-step/review/merge may appear at most once and only in that
// order. The compiler treats seams as a fixed lifecycle boundary (merge flips
// pre- to post-merge), so out-of-order or duplicate seams would compile
// inconsistently with the runtime contract.
const expectedSeamOrder = ["planning", "execute", "workflow-step", "review", "merge"] as const;
const seenSeams = new Set<string>();
let nextExpectedSeamIndex = 0;
const visited = new Set<string>();
let reachedTerminal = false;
let cursor: string | undefined = startNode.id;
while (cursor && !visited.has(cursor)) {
visited.add(cursor);
const node = nodesById.get(cursor);
if (node && isMergeRegionKind(node)) {
reachedTerminal = true;
break;
}
const seam = node ? seamOf(node) : undefined;
if (seam) {
if (seenSeams.has(seam)) {
return new WorkflowCompileError(`seam '${seam}' appears more than once`);
}
while (
nextExpectedSeamIndex < expectedSeamOrder.length &&
expectedSeamOrder[nextExpectedSeamIndex] !== seam
) {
nextExpectedSeamIndex += 1;
}
if (expectedSeamOrder[nextExpectedSeamIndex] !== seam) {
return new WorkflowCompileError(
"seams must follow the planning -> execute -> workflow-step -> review -> merge order",
);
}
seenSeams.add(seam);
nextExpectedSeamIndex += 1;
}
if (cursor === endNode.id || (node && isEnginePrimitive(node))) {
reachedTerminal = true;
break;
}
cursor = mainEdge(outgoing.get(cursor) ?? [])?.to;
}
if (!reachedTerminal) {
return new WorkflowCompileError("workflow main path does not reach the end node");
}
const unreached = ir.nodes.filter((node) => !visited.has(node.id) && node.kind !== "end" && !isEnginePrimitive(node));
if (unreached.length > 0) {
return new WorkflowCompileError(
`node '${unreached[0].id}' is not on the main path — disconnected nodes ${WORKFLOW_INTERPRETER_DEFERRED_SUFFIX}`,
);
}
return null;
}
function defaultGateMode(node: WorkflowIrNode, mode: "prompt" | "script"): WorkflowStepGateMode {
if (node.kind === "gate") return "gate";
const explicit = node.config?.gateMode;
if (explicit === "gate" || explicit === "advisory") return explicit;
return mode === "script" ? "gate" : "advisory";
}
/**
* Map a single user IR node onto a WorkflowStepInput. This is the forward half
* of the steps↔IR round-trip contract (workflow-editor-consolidation R4/KTD-2);
* its exact inverse is `stepInputToNode` in `workflow-steps-to-ir.ts`. Parity is
* pinned by `__tests__/workflow-steps-to-ir.test.ts` over exactly the
* compiler-visible fields: name / mode / phase / gateMode / prompt / scriptName /
* toolMode / modelProvider / modelId. `enabled` / `defaultOn` / `templateId` are
* NOT compiler-visible and are handled by migration policy, not the converter.
*
* INVERSION CONTRACT: when you add a field here, extend `stepInputToNode` (and
* the parity test) in `workflow-steps-to-ir.ts` to keep the round-trip exact.
*/
function nodeToStepInput(node: WorkflowIrNode, phase: "pre-merge" | "post-merge"): WorkflowStepInput {
const scriptName = configString(node, "scriptName");
const mode: "prompt" | "script" = node.kind === "script" || (node.kind === "gate" && scriptName) ? "script" : "prompt";
const gateMode = defaultGateMode(node, mode);
const input: WorkflowStepInput = {
name: configString(node, "name") ?? node.id,
description: configString(node, "description") ?? "",
mode,
phase,
gateMode,
};
if (mode === "script") {
input.scriptName = scriptName;
} else {
input.prompt = configString(node, "prompt") ?? "";
input.toolMode = node.config?.toolMode === "coding" ? "coding" : "readonly";
const provider = configString(node, "modelProvider");
const modelId = configString(node, "modelId");
if (provider && modelId) {
input.modelProvider = provider;
input.modelId = modelId;
}
}
return input;
}
/**
* Compile a workflow graph into an ordered list of WorkflowStep inputs ready to
* persist and run on the existing engine. User prompt/script/gate nodes become
* steps; execute/review seams are skipped; the merge seam is the pre-/post-merge
* boundary; merge-policy primitives form a terminal engine-owned region that is
* skipped and never emitted as steps. Throws WorkflowCompileError for non-linear
* graphs.
*
* The returned array order is the execution order (it maps directly onto a
* task's `enabledWorkflowSteps`).
*/
export function compileWorkflowToSteps(ir: WorkflowIr): WorkflowStepInput[] {
const parsed = parseWorkflowIr(ir);
const error = validateLinearity(parsed);
if (error) throw error;
const nodesById = new Map(parsed.nodes.map((node) => [node.id, node]));
const outgoing = buildOutgoing(parsed);
const startNode = parsed.nodes.find((node) => node.kind === "start")!;
const steps: WorkflowStepInput[] = [];
let phase: "pre-merge" | "post-merge" = "pre-merge";
const visited = new Set<string>();
let cursor: string | undefined = startNode.id;
while (cursor && !visited.has(cursor)) {
visited.add(cursor);
const node = nodesById.get(cursor);
if (!node) break;
if (isMergeRegionKind(node)) {
break;
}
const seam = seamOf(node);
if (isEnginePrimitive(node)) {
break;
}
if (seam === "merge") {
phase = "post-merge";
} else if (!seam && node.kind !== "start" && node.kind !== "end") {
steps.push(nodeToStepInput(node, phase));
}
if (node.kind === "end") break;
cursor = mainEdge(outgoing.get(cursor) ?? [])?.to;
}
return steps;
}