feat(studio): surface flow validation errors inline on the canvas by os-zhuang · Pull Request #1958 · objectstack-ai/objectui

os-zhuang · 2026-06-24T07:14:06Z

What & why

Third in the ADR-0044 revise-loop series (after #1954 authoring and #1955 debugger). The flow designer's structural validation — an un-declared cycle, missing entry node, duplicate ids, dangling edges — was only visible in the Debug panel, which the author has to open. Now it surfaces inline on the canvas.

Change

Un-declared cycle painted red on the canvas. The cycle's offending edges and nodes are highlighted (red stroke / red ring), using the samevalidateFlowDraft the simulator preflight runs (no second rule). The edge that closes the loop carries a tooltip pointing at the fix: "mark the edge that closes the loop as a back-edge". A declared revise loop (ADR-0044 type: 'back') is excluded from cycle detection and stays un-flagged.
Inline error banner on the canvas listing the structural-error messages — so even an off-screen cycle is discoverable.
The cycle Diagnostic now carries the closing node path, so FlowPreview can derive the exact edges/nodes to highlight. It runs validation continuously and passes invalidNodeIds / invalidEdges / validationErrors to FlowCanvas. Invalid edges/nodes also expose a data-invalid attribute (styling + tests).

Files

simulator/flow-sim-types.ts / flow-sim-validate.ts — Diagnostic.cycle (closing node path) set on the cycle error.
previews/FlowCanvas.tsx — red edge/marker/banner; invalidNodeIds / invalidEdges / validationErrors props; data-invalid.
previews/flow-canvas-parts.tsx — NodeCard red error ring (invalid prop).
previews/FlowPreview.tsx — continuous validateFlowDraft; derive + pass highlights (nodes/edges memoized for stable hook deps).

Verification

Component test (FlowCanvas.test.tsx): renders the real canvas with a cyclic flow → asserts the error banner shows the message and the cycle's edges + nodes carry data-invalid; a clean flow shows neither.
Unit: the cycle Diagnostic carries the closing node path (a → … → a).
Full metadata-admin suite 398 green; type-check 0 errors; eslint 0 errors.

Browser drivers (chrome-devtools / preview server) were occupied by parallel sessions this run, so the canvas rendering is covered by the component test (it mounts the real FlowCanvas) rather than a live screenshot.

Pairs with the canvas-validation direction noted in framework#1770.

🤖 Generated with Claude Code

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>

vercel · 2026-06-24T07:14:12Z

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

1 Skipped Deployment

Project	Deployment	Actions	Updated (UTC)
objectui	Ignored		Jun 24, 2026 7:14am

github-actions · 2026-06-24T07:17:46Z

✅ Console Performance Budget

Metric	Value	Budget
Main entry (gzip)	58.8 KB	350 KB
Entry file	`index-D0Lc-oCL.js`	—
Status	PASS	—

📦 Bundle Size Report

Package	Size	Gzipped
app-shell (index.js)	6.59KB	2.34KB
app-shell (runtime-config.js)	4.72KB	1.69KB
app-shell (types.js)	0.01KB	0.04KB
auth (AuthContext.js)	0.31KB	0.24KB
auth (AuthGuard.js)	1.17KB	0.53KB
auth (AuthProvider.js)	17.16KB	3.44KB
auth (AuthShell.js)	3.49KB	1.40KB
auth (ForgotPasswordForm.js)	4.79KB	1.88KB
auth (LoginForm.js)	5.11KB	1.92KB
auth (PreviewBanner.js)	0.90KB	0.50KB
auth (RegisterForm.js)	6.63KB	2.15KB
auth (SocialSignInButtons.js)	8.89KB	3.61KB
auth (UserMenu.js)	3.40KB	1.22KB
auth (authStyles.js)	5.04KB	1.72KB
auth (createAuthClient.js)	24.74KB	6.00KB
auth (createAuthenticatedFetch.js)	3.33KB	1.32KB
auth (index.js)	1.75KB	0.76KB
auth (types.js)	0.59KB	0.35KB
auth (useAuth.js)	4.01KB	0.79KB
auth (useIsWorkspaceAdmin.js)	1.28KB	0.70KB
collaboration (CommentThread.js)	18.38KB	4.49KB
collaboration (LiveCursors.js)	3.17KB	1.27KB
collaboration (PresenceAvatars.js)	3.65KB	1.42KB
collaboration (PresenceProvider.js)	2.42KB	0.96KB
collaboration (index.js)	1.25KB	0.53KB
collaboration (useCommentSearch.js)	1.98KB	0.88KB
collaboration (useConflictResolution.js)	7.75KB	1.86KB
collaboration (useMentionNotifications.js)	1.81KB	0.68KB
collaboration (usePresence.js)	6.33KB	1.84KB
collaboration (useRealtimeSubscription.js)	7.91KB	2.01KB
components (index.js)	418.42KB	89.09KB
core (index.js)	1.52KB	0.55KB
create-plugin (index.js)	9.28KB	2.98KB
data-objectstack (index.js)	99.69KB	24.89KB
fields (index.js)	166.21KB	40.08KB
i18n (LocalizationContext.js)	1.76KB	0.96KB
i18n (currency.js)	1.22KB	0.64KB
i18n (i18n.js)	4.32KB	1.77KB
i18n (index.js)	2.46KB	0.96KB
i18n (pickLocalized.js)	1.31KB	0.67KB
i18n (provider.js)	5.37KB	1.72KB
i18n (useObjectLabel.js)	21.15KB	4.68KB
i18n (useSafeTranslation.js)	2.68KB	0.98KB
layout (index.js)	36.30KB	10.04KB
mobile (MobileProvider.js)	0.92KB	0.49KB
mobile (ResponsiveContainer.js)	0.94KB	0.38KB
mobile (breakpoints.js)	1.51KB	0.70KB
mobile (createOfflineDataSource.js)	5.61KB	1.74KB
mobile (index.js)	1.50KB	0.62KB
mobile (offlineQueue.js)	3.91KB	1.35KB
mobile (pwa.js)	0.97KB	0.49KB
mobile (serviceWorker.js)	1.48KB	0.62KB
mobile (serviceWorkerSource.js)	3.41KB	1.48KB
mobile (useBreakpoint.js)	1.54KB	0.65KB
mobile (useGesture.js)	4.42KB	1.27KB
mobile (useOfflineSync.js)	1.99KB	0.72KB
mobile (usePullToRefresh.js)	2.53KB	0.85KB
mobile (useResponsive.js)	0.71KB	0.42KB
mobile (useResponsiveConfig.js)	1.36KB	0.63KB
mobile (useSpecGesture.js)	1.77KB	0.77KB
mobile (useTouchTarget.js)	1.01KB	0.54KB
permissions (MePermissionsProvider.js)	5.09KB	1.84KB
permissions (PermissionContext.js)	0.31KB	0.25KB
permissions (PermissionGuard.js)	0.89KB	0.45KB
permissions (PermissionProvider.js)	3.46KB	1.03KB
permissions (evaluator.js)	4.00KB	1.23KB
permissions (index.js)	0.91KB	0.41KB
permissions (store.js)	0.91KB	0.42KB
permissions (useFieldPermissions.js)	1.28KB	0.52KB
permissions (usePermissions.js)	1.50KB	0.70KB
plugin-ai (index.js)	15.71KB	3.79KB
plugin-calendar (index.js)	45.98KB	12.65KB
plugin-charts (index.js)	45.46KB	12.78KB
plugin-chatbot (index.js)	153.41KB	37.19KB
plugin-dashboard (index.js)	107.36KB	26.65KB
plugin-designer (index.js)	213.42KB	42.94KB
plugin-detail (index.js)	195.59KB	47.19KB
plugin-editor (index.js)	2.38KB	1.06KB
plugin-form (index.js)	93.24KB	22.71KB
plugin-gantt (index.js)	133.11KB	32.92KB
plugin-grid (index.js)	115.41KB	31.01KB
plugin-kanban (index.js)	48.82KB	13.13KB
plugin-list (index.js)	94.53KB	22.32KB
plugin-map (index.js)	16.02KB	4.98KB
plugin-markdown (index.js)	13.58KB	4.64KB
plugin-report (index.js)	37.83KB	9.97KB
plugin-timeline (index.js)	25.37KB	7.20KB
plugin-tree (index.js)	8.04KB	2.70KB
plugin-view (index.js)	84.45KB	20.36KB
providers (DataSourceProvider.js)	0.75KB	0.39KB
providers (MetadataProvider.js)	1.37KB	0.59KB
providers (ThemeProvider.js)	1.55KB	0.67KB
providers (UploadProvider.js)	11.71KB	3.53KB
providers (index.js)	0.44KB	0.22KB
providers (types.js)	0.01KB	0.04KB
react (LazyPluginLoader.js)	3.77KB	1.33KB
react (SchemaRenderer.js)	18.23KB	5.97KB
react (index.js)	0.76KB	0.42KB
tenant (TenantContext.js)	0.31KB	0.25KB
tenant (TenantGuard.js)	1.04KB	0.43KB
tenant (TenantProvider.js)	2.76KB	0.98KB
tenant (TenantScopedQuery.js)	0.77KB	0.44KB
tenant (index.js)	0.75KB	0.38KB
tenant (resolver.js)	2.64KB	0.76KB
tenant (useTenant.js)	0.50KB	0.32KB
tenant (useTenantBranding.js)	0.62KB	0.39KB
types (ai.js)	0.20KB	0.17KB
types (api-types.js)	0.20KB	0.18KB
types (app.js)	2.87KB	0.99KB
types (base.js)	0.20KB	0.18KB
types (blocks.js)	0.20KB	0.18KB
types (complex.js)	0.20KB	0.18KB
types (crud.js)	0.20KB	0.18KB
types (data-display.js)	0.20KB	0.18KB
types (data-protocol.js)	0.20KB	0.19KB
types (data.js)	0.20KB	0.18KB
types (designer.js)	0.77KB	0.41KB
types (disclosure.js)	0.20KB	0.18KB
types (feedback.js)	0.20KB	0.18KB
types (field-types.js)	0.20KB	0.18KB
types (form.js)	0.20KB	0.18KB
types (index.js)	1.54KB	0.68KB
types (layout.js)	0.20KB	0.18KB
types (mobile.js)	0.20KB	0.18KB
types (navigation.js)	0.20KB	0.18KB
types (objectql.js)	0.20KB	0.18KB
types (overlay.js)	0.20KB	0.18KB
types (permissions.js)	0.20KB	0.18KB
types (plugin-scope.js)	0.20KB	0.18KB
types (record-components.js)	0.20KB	0.19KB
types (registry.js)	0.20KB	0.18KB
types (reports.js)	0.20KB	0.18KB
types (spec-report.js)	5.26KB	1.96KB
types (tenant.js)	0.20KB	0.18KB
types (theme.js)	0.20KB	0.18KB
types (ui-action.js)	0.75KB	0.46KB
types (views.js)	0.20KB	0.18KB
types (widget.js)	0.20KB	0.18KB

Size Limits

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

The inline structural-error banner (ADR-0044 cycle surfacing) was display-only, duplicating the newer Problems-panel data via a separate `validationErrors` string[]. Drive it from the unified `problems` list instead and make each row with a concrete target a button: clicking selects + pans-to-reveal the offending node/edge (reusing the Problems panel's reveal handler), so the always-visible banner is actionable without opening the panel. The `validationErrors` prop + its duplicate validateFlowDraft-message derivation are removed; the red edge/node highlighting stays. Refs #1958 (ADR-0044 inline cycle surfacing). Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>

github-actionsBot added the tests label Jun 24, 2026

os-zhuang merged commit 4c2f910 into mainJun 24, 2026
10 checks passed

os-zhuang deleted the feat/flow-canvas-cycle-highlight branch June 24, 2026 07:14

Navigation Menu

Uh oh!

feat(studio): surface flow validation errors inline on the canvas - #1958

feat(studio): surface flow validation errors inline on the canvas#1958
os-zhuang merged 1 commit into
mainfrom
feat/flow-canvas-cycle-highlight

os-zhuang commented Jun 24, 2026

Uh oh!

vercelBot commented Jun 24, 2026

Uh oh!

Uh oh!

github-actionsBot commented Jun 24, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

os-zhuang commented Jun 24, 2026

What & why

Change

Files

Verification

Uh oh!

vercelBot commented Jun 24, 2026

Uh oh!

Uh oh!

github-actionsBot commented Jun 24, 2026

✅ Console Performance Budget

📦 Bundle Size Report

Size Limits

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant