Skip to content

feat(studio): on-canvas validation badges + Problems panel for the flow builder - #1972

Merged
os-zhuang merged 1 commit into
mainfrom
feat/flow-validation-badges
Jun 24, 2026
Merged

feat(studio): on-canvas validation badges + Problems panel for the flow builder#1972
os-zhuang merged 1 commit into
mainfrom
feat/flow-validation-badges

Conversation

@os-zhuang

Copy link
Copy Markdown
Contributor

Implements #1945 — on-canvas validation badges + a Problems panel for the Studio flow builder.

Problem

Flow validation surfaced only as a top banner ("…N error(s)") that didn't point to the offending node/edge. Detection already existed in the simulator's validateFlowDraft; this was a surfacing gap, not a detection one.

What's in this PR

  • Per-node / per-edge badges — an error/warning icon on each offending element, with the issue message(s) in its tooltip.
  • Problems panel — lists every issue; clicking a row selects + reveals (pans to) the node/edge.
  • Two sources, one list — structural (validateFlowDraft) + the server _diagnostics already attached to the layered record.
  • Badges + rows derive from the live draft, so they clear as issues are resolved.

Changes

  • flow-sim-validate.ts — dangling-edge errors now carry their endpoints so they key to the offending edge (per-element, not flow-level).
  • flow-problems.ts (new) — maps both sources onto node/edge/flow targets; indexProblemBadges folds per-element badges (errors dominate warnings). Unit-tested (flow-problems.test.ts, 12 cases).
  • FlowCanvas.tsx / flow-canvas-parts.tsx — per-element badges + a reveal-to-element pan driven by the panel.
  • ProblemsPanel.tsx (new) — the panel.
  • FlowPreview.tsx — live problems memo, Problems toggle (with count), reveal handshake.
  • preview-registry.ts / ResourceEditPage.tsx — new optional diagnostics prop threads the server _diagnostics (errors track live client Zod issues; warnings server-sourced).
  • Restored the MockResults type accidentally dropped from flow-sim-types.ts (build fix — it's imported by flow-simulator.ts).

Verification

  • pnpm --filter @object-ui/app-shell build (tsc) — clean.
  • vitest — 12 new + 183 existing previews/simulator tests pass.
  • Changeset included (@object-ui/app-shell patch).

Closes#1945

🤖 Generated with Claude Code

…ow builder
Flow validation only surfaced as a top banner ("…N error(s)") that didn't point
to the offending element. Detection already existed in the simulator's
`validateFlowDraft` (no resolvable entry, unreachable nodes, decision with no
default branch, duplicate ids, dangling edges, un-declared cycles) — it just
wasn't shown on the canvas. This is the surfacing layer.
- flow-sim-validate: tag dangling-edge errors with their endpoints so they key
to the offending connection (per-element issues, not flow-level)
- flow-problems: new module mapping structural validation + the server
`_diagnostics` onto concrete node/edge/flow targets (+ unit tests)
- FlowCanvas / NodeCard: per-node + per-edge badges (icon + message tooltip)
and a reveal-to-element pan driven by the Problems panel
- ProblemsPanel: new panel listing every issue; click selects + reveals it
- FlowPreview: live problems memo, Problems toggle (with count), reveal handshake
- MetadataPreviewProps.diagnostics: thread the server `_diagnostics` through
ResourceEditPage (errors track live client Zod issues; warnings server-sourced)
- restore the MockResults type accidentally dropped from flow-sim-types (build fix)
Badges + rows derive from the live draft, so they clear as issues are resolved.
Closes#1945
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 2:48pm

Request Review

@os-zhuang
os-zhuang merged commit 17ba30d into mainJun 24, 2026
10 checks passed
@os-zhuang
os-zhuang deleted the feat/flow-validation-badges branch June 24, 2026 14:48
@github-actions

Copy link
Copy Markdown
Contributor

✅ Console Performance Budget

MetricValueBudget
Main entry (gzip)58.8 KB350 KB
Entry fileindex-DXSfZanR.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)418.42KB89.09KB
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.23KB22.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)18.23KB5.97KB
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
…s panel + canvas badges (#1934) (#1980)
Build on the inline data-picker validation (#1975 / #1978) by feeding
client-side expression issues into the unified flow-problems list (#1972), so
they show as Problems-panel rows and on-canvas node/edge badges — discoverable
at the flow level, not only when a node is open.
- New pure `flow-expr-problems.ts`: scans every CEL surface (decision conditions
+ branch expressions, screen visibleWhen, loop collection, edge guards) for
ADR-0032 brace / shape ERRORS (deterministic, scope-free) and scope-aware
unknown-reference WARNINGS. The START node is skipped for the ref check — its
entry condition references trigger-record fields bare, indistinguishable from
a typo without the object schema (the inline check, which fetches it, still
covers the start node). Template (`{var}`) values are left to the inline check.
- buildFlowProblems merges them as a third source ('expression'); ProblemsPanel
labels those rows "· expression".
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
os-zhuang added a commit that referenced this pull request Jun 24, 2026
…oblem list
Follow-up to #1972 (Problems panel + badges) and #1976 (clickable banner). The
flow preview still ran validateFlowDraft TWICE per render — once in
buildFlowProblems (badges / banner / panel) and again in a separate memo that
derived the red node/edge ring/stroke, with the cycle-highlight logic duplicated.
buildFlowProblems is now the single validation pass: a new
deriveInvalidElements(problems) produces the red error set (errors only; a cycle
paints its whole loop via a per-problem `highlight` set, while its badge + reveal
stay on the closing edge). The preview drops its second validateFlowDraft call.
The clickable banner (#1976), badges, and panel are unchanged — all four surfaces
now derive from one list, so they cannot drift.
Browser-verified on showcase_budget_approval (injected an un-declared cycle by
flipping the resubmit back-edge → normal): clickable banner, edge badge, full-loop
red paint (4 elements), and Problems count all in lock-step; reverting clears all.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
os-zhuang added a commit that referenced this pull request Jun 24, 2026
…oblem list (#1977)
Follow-up to #1972 (Problems panel + badges) and #1976 (clickable banner). The
flow preview still ran validateFlowDraft TWICE per render — once in
buildFlowProblems (badges / banner / panel) and again in a separate memo that
derived the red node/edge ring/stroke, with the cycle-highlight logic duplicated.
buildFlowProblems is now the single validation pass: a new
deriveInvalidElements(problems) produces the red error set (errors only; a cycle
paints its whole loop via a per-problem `highlight` set, while its badge + reveal
stay on the closing edge). The preview drops its second validateFlowDraft call.
The clickable banner (#1976), badges, and panel are unchanged — all four surfaces
now derive from one list, so they cannot drift.
Browser-verified on showcase_budget_approval (injected an un-declared cycle by
flipping the resubmit back-edge → normal): clickable banner, edge badge, full-loop
red paint (4 elements), and Problems count all in lock-step; reverting clears all.
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.

Flow builder: on-canvas validation badges + a Problems panel

1 participant

@os-zhuang