Skip to content

feat(studio): author the approval revise loop in the flow designer (ADR-0044) - #1954

Merged
os-zhuang merged 1 commit into
mainfrom
feat/flow-approval-revise-authoring
Jun 24, 2026
Merged

feat(studio): author the approval revise loop in the flow designer (ADR-0044)#1954
os-zhuang merged 1 commit into
mainfrom
feat/flow-approval-revise-authoring

Conversation

@os-zhuang

Copy link
Copy Markdown
Contributor

What & why

Implements the Studio flow-designer authoring for the ADR-0044 approval send-back-for-revision loop — closing the 4 authoring gaps from framework#1770. The engine / service / REST / inbox side is already merged in framework; only the visual authoring was missing, so the loop was reachable only by hand-editing flow JSON.

The loop shape (canonical showcase_budget_approval): an approval node's revise out-edge walks to a signal wait point where the submitter reworks the record; a declared type: 'back' edge re-enters the approval node (round N+1). DAG cycle validation runs on the graph minus declared back-edges; maxRevisions guards runaway loops.

The four gaps

  1. Revise branch — an approval node's out-edge offers approve / reject / revise via a new Approval-branch picker in the edge inspector (mirrors APPROVAL_BRANCH_LABELS). maxRevisions surfaces on the approval form — from the engine's published configSchema online, with a hardcoded fallback in flow-node-config.ts for offline / older backends.
  2. Back-edge authoring — a new Connection-type select marks an edge back (also fault / conditional). A back-edge renders distinctly as a dashed amber return arc (own #flow-arrow-back marker) and is excluded from the layered auto-layout — exactly as the engine excludes it from DAG validation — so the loop reads top-to-bottom instead of dragging its target below the wait point.
  3. Client-side DAG validation — the simulator preflight (validateFlowDraft) flags an UNmarked cycle as an error (graph minus declared back-edges must be a DAG, mirroring registerFlow); a declared revise loop passes; a self-loop is caught. Surfaces in the Debug panel and blocks Run.
  4. One-click "add revision loop" — an amber affordance on an approval node (only when it has no revise loop yet) drops the signal wait node + the revise edge + the declared back edge in one gesture, reproducing the canonical showcase shape.

Files

  • previews/flow-canvas-layout.ts — exclude type:'back' from layering; backEdgePath / rightAnchor / backEdgeLabelAnchor / isBackEdge.
  • previews/FlowCanvas.tsx — dashed amber back-edge rendering + marker; addReviseLoop() one-click mutation.
  • previews/flow-canvas-parts.tsx — the approval-node revise-loop affordance on NodeCard.
  • inspectors/FlowEdgeInspector.tsx — approval-branch picker + connection-type select (writes edge.type).
  • inspectors/flow-node-config.tsmaxRevisions on the approval group (fallback).
  • previews/simulator/flow-sim-validate.tsfindCycle() + DAG-modulo-back-edges rule; flow-sim-types.ts gains SimEdge.type.
  • i18n.ts — en + zh strings.

Verification

  • Browser-verified against a live engine + the showcase_budget_approval flow (Studio flow designer):
    • The revise edge shows the Approval-branch picker = 退回修改 (Revise); the approval node shows maxRevisions = 2 (from the engine configSchema).
    • The wait_revision -> manager_review edge renders as a dashed amber return arc; inspector Type = 回边(退回修改环) (back-edge), label resubmit.
    • The one-click affordance on Executive Review added a wait node (Signal / revision) + revise + back edges.
  • Unit tests (33 new/updated; full metadata-admin suite 383 green): DAG/back-edge validation (unmarked cycle -> error, declared loop -> passes, self-loop -> caught, findCycle); back-edge geometry + layout exclusion; maxRevisions field presence.
  • type-check clean; eslint clean (0 errors).

Refs framework#1770. Follows the flow-builder work in #1927 and #1930.

🤖 Generated with Claude Code

…DR-0044)
The ADR-0044 send-back-for-revision loop — an approval node's `revise`
out-edge to a wait point, closed by a declared `type: 'back'` edge that
re-enters the approval (round N+1) — was previously reachable only by
hand-editing flow JSON. The flow designer now authors all four pieces:
- Revise branch: an approval out-edge offers approve / reject / revise via a
new Approval-branch picker in the edge inspector; `maxRevisions` surfaces on
the approval node's form (engine configSchema online, hardcoded fallback off).
- Back-edge authoring: a new Connection-type select marks an edge `back`
(also fault / conditional). A back-edge renders as a dashed amber return arc
and is excluded from the layered auto-layout — exactly as the engine excludes
it from DAG validation — so the loop reads top-to-bottom.
- Client-side DAG validation: the simulator preflight flags an UNmarked cycle
(graph minus declared back-edges must be a DAG, mirroring registerFlow);
a declared revise loop passes; a self-loop is caught.
- One-click "add revision loop": an affordance on an approval node drops the
signal wait node + the revise edge + the declared back edge in one gesture,
reproducing the canonical showcase_budget_approval shape.
Refs framework#1770. Follows the flow-builder work in #1927 and #1930.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@vercel

vercelBot commented Jun 24, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
ProjectDeploymentActionsUpdated (UTC)
objectuiIgnoredIgnoredJun 24, 2026 6:17am

Request Review

@os-zhuang
os-zhuang merged commit d23ed60 into mainJun 24, 2026
10 checks passed
@os-zhuang
os-zhuang deleted the feat/flow-approval-revise-authoring branch June 24, 2026 06:17
@github-actions

Copy link
Copy Markdown
Contributor

✅ Console Performance Budget

MetricValueBudget
Main entry (gzip)58.8 KB350 KB
Entry fileindex-CZDNEpar.js
StatusPASS

📦 Bundle Size Report

PackageSizeGzipped
app-shell (index.js)6.59KB2.34KB
app-shell (runtime-config.js)4.72KB1.69KB
app-shell (types.js)0.01KB0.04KB
auth (AuthContext.js)0.31KB0.24KB
auth (AuthGuard.js)1.17KB0.53KB
auth (AuthProvider.js)17.16KB3.44KB
auth (AuthShell.js)3.49KB1.40KB
auth (ForgotPasswordForm.js)4.79KB1.88KB
auth (LoginForm.js)5.11KB1.92KB
auth (PreviewBanner.js)0.90KB0.50KB
auth (RegisterForm.js)6.63KB2.15KB
auth (SocialSignInButtons.js)8.89KB3.61KB
auth (UserMenu.js)3.40KB1.22KB
auth (authStyles.js)5.04KB1.72KB
auth (createAuthClient.js)24.74KB6.00KB
auth (createAuthenticatedFetch.js)3.33KB1.32KB
auth (index.js)1.75KB0.76KB
auth (types.js)0.59KB0.35KB
auth (useAuth.js)4.01KB0.79KB
auth (useIsWorkspaceAdmin.js)1.28KB0.70KB
collaboration (CommentThread.js)18.38KB4.49KB
collaboration (LiveCursors.js)3.17KB1.27KB
collaboration (PresenceAvatars.js)3.65KB1.42KB
collaboration (PresenceProvider.js)2.42KB0.96KB
collaboration (index.js)1.25KB0.53KB
collaboration (useCommentSearch.js)1.98KB0.88KB
collaboration (useConflictResolution.js)7.75KB1.86KB
collaboration (useMentionNotifications.js)1.81KB0.68KB
collaboration (usePresence.js)6.33KB1.84KB
collaboration (useRealtimeSubscription.js)7.91KB2.01KB
components (index.js)415.53KB88.47KB
core (index.js)1.52KB0.55KB
create-plugin (index.js)9.28KB2.98KB
data-objectstack (index.js)99.69KB24.89KB
fields (index.js)166.21KB40.08KB
i18n (LocalizationContext.js)1.76KB0.96KB
i18n (currency.js)1.22KB0.64KB
i18n (i18n.js)4.32KB1.77KB
i18n (index.js)2.46KB0.96KB
i18n (pickLocalized.js)1.31KB0.67KB
i18n (provider.js)5.37KB1.72KB
i18n (useObjectLabel.js)21.15KB4.68KB
i18n (useSafeTranslation.js)2.68KB0.98KB
layout (index.js)36.30KB10.04KB
mobile (MobileProvider.js)0.92KB0.49KB
mobile (ResponsiveContainer.js)0.94KB0.38KB
mobile (breakpoints.js)1.51KB0.70KB
mobile (createOfflineDataSource.js)5.61KB1.74KB
mobile (index.js)1.50KB0.62KB
mobile (offlineQueue.js)3.91KB1.35KB
mobile (pwa.js)0.97KB0.49KB
mobile (serviceWorker.js)1.48KB0.62KB
mobile (serviceWorkerSource.js)3.41KB1.48KB
mobile (useBreakpoint.js)1.54KB0.65KB
mobile (useGesture.js)4.42KB1.27KB
mobile (useOfflineSync.js)1.99KB0.72KB
mobile (usePullToRefresh.js)2.53KB0.85KB
mobile (useResponsive.js)0.71KB0.42KB
mobile (useResponsiveConfig.js)1.36KB0.63KB
mobile (useSpecGesture.js)1.77KB0.77KB
mobile (useTouchTarget.js)1.01KB0.54KB
permissions (MePermissionsProvider.js)5.09KB1.84KB
permissions (PermissionContext.js)0.31KB0.25KB
permissions (PermissionGuard.js)0.89KB0.45KB
permissions (PermissionProvider.js)3.46KB1.03KB
permissions (evaluator.js)4.00KB1.23KB
permissions (index.js)0.91KB0.41KB
permissions (store.js)0.91KB0.42KB
permissions (useFieldPermissions.js)1.28KB0.52KB
permissions (usePermissions.js)1.50KB0.70KB
plugin-ai (index.js)15.71KB3.79KB
plugin-calendar (index.js)45.98KB12.65KB
plugin-charts (index.js)45.46KB12.78KB
plugin-chatbot (index.js)153.41KB37.19KB
plugin-dashboard (index.js)107.36KB26.65KB
plugin-designer (index.js)213.42KB42.94KB
plugin-detail (index.js)195.59KB47.19KB
plugin-editor (index.js)2.38KB1.06KB
plugin-form (index.js)93.24KB22.71KB
plugin-gantt (index.js)133.11KB32.92KB
plugin-grid (index.js)115.41KB31.01KB
plugin-kanban (index.js)48.82KB13.13KB
plugin-list (index.js)94.53KB22.32KB
plugin-map (index.js)16.02KB4.98KB
plugin-markdown (index.js)13.58KB4.64KB
plugin-report (index.js)37.83KB9.97KB
plugin-timeline (index.js)25.37KB7.20KB
plugin-tree (index.js)8.04KB2.70KB
plugin-view (index.js)84.45KB20.36KB
providers (DataSourceProvider.js)0.75KB0.39KB
providers (MetadataProvider.js)1.37KB0.59KB
providers (ThemeProvider.js)1.55KB0.67KB
providers (UploadProvider.js)11.71KB3.53KB
providers (index.js)0.44KB0.22KB
providers (types.js)0.01KB0.04KB
react (LazyPluginLoader.js)3.77KB1.33KB
react (SchemaRenderer.js)17.06KB5.59KB
react (index.js)0.76KB0.42KB
tenant (TenantContext.js)0.31KB0.25KB
tenant (TenantGuard.js)1.04KB0.43KB
tenant (TenantProvider.js)2.76KB0.98KB
tenant (TenantScopedQuery.js)0.77KB0.44KB
tenant (index.js)0.75KB0.38KB
tenant (resolver.js)2.64KB0.76KB
tenant (useTenant.js)0.50KB0.32KB
tenant (useTenantBranding.js)0.62KB0.39KB
types (ai.js)0.20KB0.17KB
types (api-types.js)0.20KB0.18KB
types (app.js)2.87KB0.99KB
types (base.js)0.20KB0.18KB
types (blocks.js)0.20KB0.18KB
types (complex.js)0.20KB0.18KB
types (crud.js)0.20KB0.18KB
types (data-display.js)0.20KB0.18KB
types (data-protocol.js)0.20KB0.19KB
types (data.js)0.20KB0.18KB
types (designer.js)0.77KB0.41KB
types (disclosure.js)0.20KB0.18KB
types (feedback.js)0.20KB0.18KB
types (field-types.js)0.20KB0.18KB
types (form.js)0.20KB0.18KB
types (index.js)1.54KB0.68KB
types (layout.js)0.20KB0.18KB
types (mobile.js)0.20KB0.18KB
types (navigation.js)0.20KB0.18KB
types (objectql.js)0.20KB0.18KB
types (overlay.js)0.20KB0.18KB
types (permissions.js)0.20KB0.18KB
types (plugin-scope.js)0.20KB0.18KB
types (record-components.js)0.20KB0.19KB
types (registry.js)0.20KB0.18KB
types (reports.js)0.20KB0.18KB
types (spec-report.js)5.26KB1.96KB
types (tenant.js)0.20KB0.18KB
types (theme.js)0.20KB0.18KB
types (ui-action.js)0.75KB0.46KB
types (views.js)0.20KB0.18KB
types (widget.js)0.20KB0.18KB

Size Limits

  • ✅ Core packages should be < 50KB gzipped
  • ✅ Component packages should be < 100KB gzipped
  • ⚠️ Plugin packages should be < 150KB gzipped

os-zhuang added a commit that referenced this pull request Jun 24, 2026
The designer-time flow simulator treated an `approval` node as a pass-through
that fanned out to every out-edge at once, so an ADR-0044 revise loop could not
be debugged — it walked approve/reject/revise simultaneously and tripped the
step ceiling on the back-edge.
Model an approval as a durable pause (like wait/screen): the run suspends at the
node, and the Debug panel offers its out-edge labels (approve/reject/revise) as
decision buttons. Resuming routes down ONLY the chosen branch, mirroring how the
engine resumes a suspended approval by branch label — so a full revise loop is
now walkable: revise -> wait -> resubmit (back-edge) -> round 2 -> approve. An
unmatched decision falls back to fanning out (engine label-fallback), logged.
- flow-simulator.ts: approval pause case; resume({screenOutputs?, decision?}) +
resumeApproval() routing by edge label.
- FlowSimulatorPanel.tsx: per-decision Continue buttons; Run no longer
blind-resumes an approval pause.
- Tests: simulator approval routing + full revise-loop walk; panel UI walk.
Follows #1954 (ADR-0044 revise-loop authoring).
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
@github-actionsgithub-actionsBot mentioned this pull request Jun 24, 2026
os-zhuang added a commit that referenced this pull request Jun 24, 2026
)
The flow designer's structural validation (un-declared cycle, missing entry,
duplicate ids, dangling edges, …) was only visible in the Debug panel. Surface
it INLINE on the canvas so a broken graph is obvious without opening Debug:
- An un-declared cycle paints its offending edges + nodes red (the same
`validateFlowDraft` the simulator preflight uses); the closing edge's tooltip
points at the fix (mark it as a back-edge). A declared revise loop (ADR-0044
back-edge) is excluded from cycle detection and stays un-flagged.
- An error banner on the canvas lists the structural-error messages.
The cycle Diagnostic now carries the closing node path so the canvas can derive
the exact edges/nodes to highlight. FlowPreview runs validation continuously and
passes `invalidNodeIds` / `invalidEdges` / `validationErrors` to FlowCanvas;
invalid edges/nodes also expose `data-invalid` for styling + tests.
Follows #1954, #1955.
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
@github-actionsgithub-actionsBot mentioned this pull request Jun 24, 2026
os-zhuang added a commit to objectstack-ai/objectstack that referenced this pull request Jun 24, 2026
…ocol (#2291)
`FlowCanvasEdgeStyleSchema` gains a `back` value alongside
solid/dashed/dotted/bold, marking an ADR-0044 declared back-edge (a `revise`
loop's resubmit edge). Flow-builder-protocol consumers can render it as a
distinct curved/dashed return arc, set apart from forward flow — matching the
objectui designer's canvas (objectstack-ai/objectui#1954).
Additive enum value: public API surface + factory signatures unchanged.
Part of #2274 (ADR-0044 AI/designer parity).
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
os-zhuang added a commit that referenced this pull request Jun 24, 2026
…ape (#1974)
The wait inspector read only `waitEventConfig.{eventType,signalName,…}`, but the
engine also accepts the looser `config.{eventType,…}` shape that the canonical
showcase_budget_approval (and AI-authored flows) use — so a showcase-shaped wait
node showed blank fields in the designer.
Flow config fields gain `fallbackPath`: tolerant read (loose shape displays +
dependent fields reveal), canonical write that prunes the fallback
(migrate-on-edit), and the fallback config key suppressed from Advanced. The
`wait` fields fall back to `config.*`. Designer now matches engine tolerance.
Refs #1954 (ADR-0044).
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@os-zhuang