Skip to content

feat(cli): validate prints the union arm the document selected, not a bare "Invalid input" - #7384

Merged
os-project-manager merged 1 commit into
mainfrom
claude/issue-7004-union-arm-diagnostics
Sep 2, 2026
Merged

feat(cli): validate prints the union arm the document selected, not a bare "Invalid input"#7384
os-project-manager merged 1 commit into
mainfrom
claude/issue-7004-union-arm-diagnostics

Conversation

@os-project-manager

Copy link
Copy Markdown
Collaborator

Fixes #7004

Implements the arm-selection half of objectui#7004, under the maintainer ruling of 2026-09-02 (comment 5507942045, option B). The mechanical root-path half landed earlier as PR #7038. Session that produced this branch: https://claude.ai/code/session_01EMrWaQw3XS5DxTHxp4yRyC

The defect

objectui validate checks a document against AnyComponentSchema, a z.union. When a document matches no arm, Zod 4 reports one top-level issue — invalid_union · Invalid input · path (root) — and hangs every arm's real diagnosis off that issue's errors array, which nothing read. So the remediation text objectui#6931 wrote into the retired menu-divider arm sat exactly one level below the only thing the CLI printed.

Two measurements first, because the ruling's mechanism depends on them

Both were asked for explicitly in the decision facets. Both came back favourable; the numbers are in the report comment on the card.

1 — is the arm derivable at all? AnyComponentSchema is a plain z.union of 14 members which resolve to 108 leaf arms, and all 108 declare a type literal with zero literals claimed by two arms — so "exactly one arm accepts that literal" is total and unambiguous at the document root. (The decision analysis estimated ~97; 108 is the measured count on this base.)

More usefully, an arm names the literals it accepts inside its own issues, and only two shapes do it: invalid_value at ['type'] carrying values, and a discriminated union's invalid_union at ['type'] carrying options. That makes the accepted-literal set derivable from the error tree alone — so the new module never imports or introspects the schema and cannot drift from it. Zod's errors array is positionally aligned with the union's options (14 entries for 14 members), but selection deliberately does not depend on that.

2 — does nested recursion terminate? Yes, by construction: Zod materialises errors eagerly as plain nested arrays at parse time, so each step strictly descends a finite acyclic tree with no lazy getters — true even for z.lazy schemas like MenuItemSchema, where the laziness is in the schema, not in the issue tree it produces. Measured maximum depth on this tree: 3.

⚠️ One measured trap that would have produced wrong output: paths inside errors are relative to their union's node. The nested union at ['items', 0] reports its arm issues at ['type'], not ['items', 0, 'type']. Printing those raw would have named the document's own type key. Every path is rebased onto its parent prefix.

What is printed now

case output
type selects exactly one arm that arm's issues as 1.1, 1.2 … with absolute paths and codes, and nothing from the other arms
no arm accepts the type No arm accepts type "dropdwn-menu". plus the nearest few of the accepted values
no type at all the note says so, and offers no candidates
union with no type discriminator every arm, labelled [arm k/n], capped
1. Invalid input
   Path: (root)
   Code: invalid_union
   1.1 RETIRED (objectui#6523) — dividers are `{ separator: true }`; …
       Path: items → 0 → type
       Code: invalid_type

The cap constant, and its distance function

MAX_UNION_ARMS_REPORTED = 5, pinned by a test as the ruling requires. Ranking the 108 arm names by unit-cost edit distance against four authored typos gave the same shape every time: the intended arm is rank 1 and alone in its distance band (dropdwn-menudropdown-menu at 1; dropdwon-menudropdown-menu at 2; Pagepage at 1; obect-gridobject-grid at 1), with the next band opening 1-6 edits further out holding 1-5 names. Five shows the winner plus the following band entire and stops well short of 108; a cap of 1 would print the winner alone and read as a confident answer rather than as a ranked list.

The ruling did not name a distance function. This uses unit-cost Levenshtein, ascending, ties broken lexicographically — the authored type and the arm names are short kebab-case identifiers whose realistic errors are a dropped, added or mistyped character. Damerau was considered and not taken: a transposition scores 2 here and still lands first.

⚠️ Not a widening of objectui#5247. That ruling made objectui check's suggestion case-only for a different surface over a different candidate set (KNOWN_SCHEMA_TYPES, the registry's keys). This surface's candidates are the schema union's arms, harvested from the error tree, and the 2026-09-02 ruling asks for the "nearest" ones. What is borrowed from #5247 is its refusal to guess: with no type authored there is nothing to be near, so no candidates are offered at all rather than an alphabetical slice presented as guidance.

The third branch, declared

The ruling partitions on "exactly one arm accepts" vs "no arm accepts". Both presuppose arms that declare a type contract, and MenuItemSchema — the union this card was filed about — has none: it is a two-arm z.union whose arms both declare type as an ADR-0049 retirement tombstone (z.never()), so neither names a literal. Routing it to "no arm accepts" would be literally true and exactly wrong — the candidate list would be empty and the objectui#6523 text, the very text this card exists to deliver, would be dropped.

So a union with no declaring arm takes the ruling's own named fallback, "A with a cap": every arm, capped by the same constant. This is not option A at the root, which the ruling rejected on the 108-arm noise argument — the root is always discriminated, and undiscriminated unions in this mirror are small. Flagged here for review because it completes a case the ruling did not name.

Tests

  • validate-union-arm-selection.test.ts (new, 10 cases): the menu-nested wrong item, the no-matching-arm case, the untyped case, arm exclusivity, the non-union control, the cap pin, and the selection module's own unit tests.
  • validate-root-path-line.test.ts: the boundary case is inverted. It was written deliberately to pin the pre-ruling semantics so this decision would land as an explicit edit against a red test rather than a silent widening; that is what happened, and the block now restates the new semantics with the root-path assertions it has always carried.

Reverse verification (ablation) at commit ce9e70b5d, validate.ts reverted to the base blob with the selection module and tests left in place: 6 failed / 10 passed of 16, the six being the inverted boundary case and the five validate-driven arm cases; the ten being the five root-path controls, the non-union control, and the four pure-module unit tests, which pass on base and are what makes them controls. Mutation confirmed on disk by blob-hash equality to the base blob and the anchor dropping 3 occurrences to 0; restore confirmed by on-disk blob equal to the HEAD blob and an empty git diff HEAD. No build is involved — the run resolves @object-ui/types/zod through the root Vitest alias to packages/types/src, and the ablation's red is itself the proof that src is what executes.

Scope

objectui check is untouched and deliberately so: it has no zod-issue printer, using safeValidateSchema(...).success as a boolean recogniser, and printing issues behind a negative recognition would flood its report with diagnoses of non-ObjectUI files — the failure objectui#5127 and objectui#6075 exist to prevent. validate.ts keeps every console.* call and stays the repository's only zod-issue printer; the new module performs selection only, so no second rendering surface is created and no shared renderer is warranted.

Nothing about which documents are ACCEPTED changes. Diagnostic output only.

Gates at ce9e70b5d: packages/cli Vitest 16 files / 246 tests passed, type-check exit 0 (tsc --listFiles confirms all four changed files are in the program), lint exit 0 with 11 pre-existing warnings and none in the changed files, lint:coverage 46/46 packages, and the changeset, control-byte, doc-fence, doc-type, vi-mock, phantom-dep, self-import and esm-specifier gates all exit 0. check:doc-snippets and check:readme-exports report PRECONDITION NOT MET / population-collapsed on this unbuilt worktree — a build precondition unrelated to this diff, left to CI, which builds.

🤖 Generated with Claude Code

https://claude.ai/code/session_01EMrWaQw3XS5DxTHxp4yRyC


Generated by Claude Code

…alid input"

`objectui validate` checks a document against `AnyComponentSchema`, a `z.union`.
When nothing matches, Zod reports ONE top-level issue — `invalid_union` ·
`Invalid input` · path `(root)` — and hangs every arm's real diagnosis off that
issue's `errors` array, which nothing read. The remediation text objectui#6931
wrote into the retired menu-divider arm therefore never reached an author.

Per the 2026-09-02 maintainer ruling (option B), the printer now narrows a
failing union to the single arm the document's `type` selects and prints that
arm's issues — paths rebased to absolute — and nothing from the other arms. When
no arm accepts the `type`, it says so and offers the nearest few of the accepted
values, capped by a named constant. A union with no `type` discriminator to
select on (`MenuItemSchema`, whose arms both declare `type` as an ADR-0049
tombstone) falls back to reporting every arm under the same cap, which is the
path that finally delivers the objectui#6523 guidance.

Selection lives in a new `utils/union-arm-diagnostics.ts` and reads only the
issue tree, never the schema; `commands/validate.ts` keeps every `console.*`
call and stays the repository's only zod-issue printer. `check.ts` is a boolean
recogniser and is untouched.

The boundary case in `validate-root-path-line.test.ts` was written to pin the
pre-ruling semantics so this decision would land as an explicit edit against a
red test; it is inverted here, deliberately.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EMrWaQw3XS5DxTHxp4yRyC
@github-actions github-actions Bot added documentation Improvements or additions to documentation tests labels Sep 2, 2026
@github-actions

github-actions Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

✅ Console Performance Budget

Metric Value Budget
Eager closure (gzip, 48 chunks) 3177.1 KB 3191.4 KB
Main entry chunk (gzip) 143.2 KB 350 KB
Entry file index-C0x5ZgYE.js
Status PASS

The eager closure is every chunk the entry reaches through static imports — what the browser fetches and parses before the app renders. The entry chunk on its own is a small fraction of it.


📦 Bundle Size Report

Package Size Gzipped
app-shell (consoleActionDispatch.js) 0.20KB 0.19KB
app-shell (index.js) 15.67KB 5.75KB
app-shell (runtime-config.js) 20.68KB 7.36KB
app-shell (types.js) 0.01KB 0.04KB
app-shell (urlParams.js) 10.06KB 3.86KB
auth (ActiveOrganizationStorage.js) 25.05KB 9.16KB
auth (AuthContext.js) 0.31KB 0.24KB
auth (AuthGuard.js) 2.07KB 1.00KB
auth (AuthProvider.js) 40.18KB 10.59KB
auth (AuthShell.js) 3.49KB 1.40KB
auth (ForgotPasswordForm.js) 12.21KB 3.45KB
auth (LoginForm.js) 18.15KB 5.39KB
auth (PreviewBanner.js) 0.90KB 0.50KB
auth (RegisterForm.js) 6.65KB 2.22KB
auth (SocialSignInButtons.js) 9.61KB 3.89KB
auth (UserMenu.js) 3.41KB 1.23KB
auth (auth-gate-events.js) 1.29KB 0.66KB
auth (authStyles.js) 5.04KB 1.72KB
auth (createAuthClient.js) 40.21KB 10.80KB
auth (createAuthenticatedFetch.js) 8.46KB 3.43KB
auth (index.js) 3.19KB 1.44KB
auth (invitation-status.js) 1.22KB 0.70KB
auth (org-roles.js) 6.66KB 2.78KB
auth (phone-identifier.js) 1.11KB 0.66KB
auth (types.js) 0.59KB 0.35KB
auth (useAuth.js) 5.30KB 1.02KB
auth (useWorkspaceAdminStatus.js) 5.13KB 2.35KB
collaboration (CommentThread.js) 26.08KB 7.56KB
collaboration (LiveCursors.js) 3.17KB 1.27KB
collaboration (PresenceAvatars.js) 6.49KB 2.64KB
collaboration (PresenceProvider.js) 2.79KB 1.13KB
collaboration (index.js) 1.68KB 0.73KB
collaboration (useCollaborationTranslation.js) 6.05KB 2.52KB
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) 514.87KB 117.50KB
core (index.js) 5.80KB 2.32KB
create-plugin (index.js) 10.08KB 3.26KB
data-objectstack (index.js) 178.20KB 49.60KB
fields (index.js) 244.25KB 61.73KB
i18n (LocalizationContext.js) 1.76KB 0.96KB
i18n (currency.js) 1.22KB 0.64KB
i18n (fallbackInterpolation.js) 6.25KB 2.77KB
i18n (i18n.js) 4.28KB 1.75KB
i18n (index.js) 3.44KB 1.39KB
i18n (pickLocalized.js) 7.62KB 3.26KB
i18n (provider.js) 26.89KB 9.04KB
i18n (useDisplayLocale.js) 2.85KB 1.45KB
i18n (useObjectLabel.js) 33.40KB 8.71KB
i18n (useSafeTranslation.js) 5.60KB 2.33KB
layout (index.js) 38.98KB 10.98KB
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.75KB
mobile (index.js) 1.55KB 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) 6.96KB 1.98KB
mobile (useOfflineSync.js) 1.99KB 0.72KB
mobile (usePullToRefresh.js) 2.53KB 0.85KB
mobile (useResponsive.js) 0.72KB 0.42KB
mobile (useResponsiveConfig.js) 1.37KB 0.63KB
mobile (useSpecGesture.js) 4.32KB 1.64KB
mobile (useTouchTarget.js) 1.01KB 0.54KB
permissions (MePermissionsProvider.js) 11.71KB 4.29KB
permissions (PermissionContext.js) 0.31KB 0.25KB
permissions (PermissionGuard.js) 0.89KB 0.45KB
permissions (PermissionProvider.js) 6.24KB 2.16KB
permissions (discardProofCache.js) 1.04KB 0.55KB
permissions (evaluator.js) 5.12KB 1.74KB
permissions (index.js) 0.93KB 0.41KB
permissions (store.js) 0.91KB 0.42KB
permissions (useFieldPermissions.js) 1.28KB 0.53KB
permissions (usePermissions.js) 4.83KB 2.27KB
plugin-ai (index.js) 15.75KB 3.80KB
plugin-calendar (index.js) 47.00KB 12.97KB
plugin-charts (index.js) 70.02KB 19.44KB
plugin-chatbot (index.js) 196.19KB 46.43KB
plugin-dashboard (index.js) 132.63KB 34.56KB
plugin-designer (index.js) 212.87KB 43.19KB
plugin-detail (index.js) 251.20KB 64.18KB
plugin-editor (index.js) 2.46KB 1.10KB
plugin-form (index.js) 132.87KB 32.66KB
plugin-gantt (index.js) 166.93KB 40.82KB
plugin-grid (index.js) 209.10KB 56.65KB
plugin-kanban (index.js) 53.21KB 14.66KB
plugin-list (index.js) 113.51KB 27.67KB
plugin-map (index.js) 20.20KB 6.66KB
plugin-markdown (index.js) 13.72KB 4.69KB
plugin-report (index.js) 43.51KB 11.94KB
plugin-timeline (index.js) 30.21KB 8.66KB
plugin-tree (index.js) 8.98KB 3.08KB
plugin-view (index.js) 85.90KB 21.12KB
providers (DataSourceProvider.js) 0.75KB 0.39KB
providers (MetadataProvider.js) 1.37KB 0.59KB
providers (ThemeProvider.js) 1.90KB 0.85KB
providers (UploadProvider.js) 11.66KB 3.50KB
providers (index.js) 0.45KB 0.23KB
providers (types.js) 0.01KB 0.04KB
react-runtime (index.js) 5.62KB 2.34KB
react (LazyPluginLoader.js) 4.47KB 1.63KB
react (SchemaRenderer.js) 81.07KB 26.86KB
react (data-invalidation.js) 5.05KB 2.08KB
react (index.js) 3.11KB 1.48KB
react (schema-input.js) 2.32KB 1.24KB
react (spec-input.js) 0.20KB 0.18KB
sdui-parser (codegen.js) 5.41KB 2.34KB
sdui-parser (dashboard-widget-options.js) 3.08KB 1.30KB
sdui-parser (index.js) 4.93KB 2.24KB
sdui-parser (input-type.js) 2.84KB 1.40KB
sdui-parser (parse.js) 20.57KB 5.88KB
sdui-parser (provenance.js) 3.66KB 1.82KB
sdui-parser (types.js) 0.28KB 0.23KB
sdui-parser (validate.js) 10.35KB 3.60KB
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) 2.74KB 1.41KB
types (crud.js) 0.20KB 0.18KB
types (dashboard-filter-alias.js) 6.23KB 2.74KB
types (data-display.js) 3.75KB 1.85KB
types (data-protocol.js) 0.20KB 0.19KB
types (data.js) 0.20KB 0.18KB
types (designer.js) 1.85KB 0.85KB
types (disclosure.js) 0.20KB 0.18KB
types (error-code.js) 1.54KB 0.88KB
types (feedback.js) 0.20KB 0.18KB
types (field-types.js) 0.20KB 0.18KB
types (form.js) 0.20KB 0.18KB
types (http-inflight.js) 8.87KB 3.73KB
types (http-retry.js) 4.32KB 2.02KB
types (icon-key-migration.js) 4.26KB 1.63KB
types (index.js) 4.74KB 2.25KB
types (layout.js) 0.20KB 0.18KB
types (managed-by.js) 0.19KB 0.18KB
types (mobile.js) 2.59KB 1.31KB
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 (record-semantics.js) 1.28KB 0.67KB
types (registry.js) 0.20KB 0.18KB
types (reports.js) 0.20KB 0.18KB
types (spec-report.js) 5.05KB 1.93KB
types (spec-ui-namespace.js) 0.20KB 0.19KB
types (system-fields.js) 3.33KB 1.54KB
types (theme.js) 6.28KB 2.87KB
types (ui-action.js) 8.11KB 3.32KB
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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation tests

Projects

None yet

2 participants