Skip to content

fix(console): spell the object sample's lookup target reference, and record what still blocks it - #6845

Merged
os-sam merged 1 commit into
mainfrom
claude/issue-6647-preview-sample-reference-key
Aug 30, 2026
Merged

fix(console): spell the object sample's lookup target reference, and record what still blocks it#6845
os-sam merged 1 commit into
mainfrom
claude/issue-6647-preview-sample-reference-key

Conversation

@claude

@claudeclaudeBot commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

Fixes#6647

The object preview sample declared its lookup target as reference_to. The defect the card is really about is the ledger: the sample is quarantined in preview-samples-spec-valid.test.ts under a reason naming only the array fields shape, so whoever fixed that half would have found the sample still red with no note.

Premise re-derived, not trusted (spec 17.2.0, installed)

Key isolated from the array-shape defect by using a record-shaped fields, so only the key varies:

documentresult
fields: { acct: { type:'lookup', label:'Account', reference_to:'account' } }success:falseunrecognized_keys at objects.0.fields.acct, keys:["reference_to"]
same, spelling the key referencesuccess:true — value survives as reference: "account", alongside the defaults (deleteBehavior:"set_null", …)

Exact refusal message, quoted verbatim:

Unrecognized key(s) on this field: reference_to. Did you mean reference_toreference? Until #4001 closed this shape these were dropped silently — the field was still created, minus whatever the key was meant to constrain, protect or compute.

The premise holds. Note the arrow the spec actually prints is , not ->.

Which of the two acceptable shapes, and why the card's own framing needed correcting

The card offered: re-spell the key and let the reason name only the remaining array-shape defect, or record both defects. Measurement says the first option would now UNDER-state, which is the same defect this card is about — so this PR re-spells the key and records everything that actually remains.

Measured on the real sample (issue counts scoped to objects):

variantissues
as authored (array fields + reference_to)1objects.0.fieldsinvalid_type "expected record, received array"
key re-spelled, array untouched1 — same array-shape issue, unchanged
array shape lifted to a record, key left reference_to4 — 3 × options, plus unrecognized_keys ["reference_to"]
array shape lifted, key fixed (this PR's sample)3objects.0.fields.status.options.0..2invalid_type "expected object, received string"

So the key defect was real and independent — and a third defect the card did not know about sits behind it: status.options are bare strings where FieldSchema wants { label, value } objects. Zod short-circuits at objects.0.fields, so today only the array shape is reported; the other two hid behind it.

What the ledger now says vs what is actually still true

The object row now reads: the array fields shape (deliberate — it covers readFields()'s array branch) andstatus.options as bare strings, "reported only once the array shape stops short-circuiting the parse". The final row of the table above is exactly that claim, measured. Nothing more, nothing less: after the key fix, unrecognized_keys is gone from that list.

The array fields shape is untouched, per its own recorded note.

The pin, and why a quarantined row needs one

RETIRED_KEYS gains ['object','reference_to', …] and its camelCase twin referenceTo (tombstoned in @object-ui/types with specEquivalent: 'reference', objectui#6041). For a SPEC_CLEAN sample that table is belt-and-braces; for a quarantined one it is the only guard there is — the reverse assertion asks for length > 0, which the array-shape defect satisfies forever, so a re-added retired key changes no test result at all. That is not hypothetical: it is how this sample carried reference_to through four spec releases.

Ablation (fix committed first, then mutated): re-introducing reference_to in the sample turns exactly one test red —

× object sample does not resurrect retired key `reference_to` (objectui#6647 — the spec spells it `reference`)
AssertionError: expected [ Array(8) ] to not include 'reference_to'
✓ object sample still fails as recorded (promote it to SPEC_CLEAN once fixed) <-- stays GREEN
Test Files 1 failed (1) · Tests 1 failed | 33 passed (34)

The reverse assertion staying green under the regression is the demonstration: without the new pin, that regression is invisible. Mutation confirmed on disk before the run (reference: grep 1 to 0, reference_to: grep 0 to 1; blob hash moved 59cdad2c to 0b46c87f); restore proved after, not assumed — worktree hash back to 59cdad2c = the HEAD blob, git diff HEAD empty. No rebuild leg applies: the test imports ../preview-samples as a relative source path, so no dist is in the resolution.

Also verified

  • The designer never read the old spelling either: ObjectFieldInspector seeds its Lookup-target box from def.reference, so reference_to rendered that box empty on the one sample that exists to demonstrate a lookup. The read door (object-fields-io.ts) strips the camelCase referenceTo but not the snake_case twin — that is its documented "add it on evidence, not defensively" contract, not a gap.
  • Out of fence and deliberately untouched: examples/schema-catalog/src/schemas/fields-lookup/*.json spell reference_to legitimately — they are { type:'form', fields:[…] } UI component schemas, not object metadata documents.

Verification (union re-run at fed9977d, after the final commit)

pnpm exec vitest run apps/console/ Test Files 85 passed (85) · Tests 948 passed (948)
check:control-bytes OK (5648 tracked text files)
check:designer-field-key-parity OK
check:spec-symbols OK
check:vi-mock-specifiers OK
check:shell-escape-residue OK
check-changeset-presence / -no-major both green (verdicts below)
apps/console tsc --noEmit + tsc -b + eslint . 0 errors (214 pre-existing warnings)

Executed test files named by the verbose reporter: src/__tests__/preview-samples-spec-valid.test.ts and src/__tests__/preview-samples-registry-resolvable.test.ts. Typecheck genuinely covers both edited files — tsc --listFiles lists them (they are not excluded), checked because a typecheck that excludes tests reads clean while measuring nothing.

No existing test moved: 85 files / 948 tests, all passing, no edits to any other test.

Changeset — the gate's own verdict decided it

preview-samples.ts is dev-only: its sole importer is preview-gallery.tsx, served from the standalone preview-gallery.html Vite entry, and apps/console/vite.config.ts declares no rollupOptions.input, so that entry is absent from the dist@object-ui/console publishes. Declared with an EMPTY frontmatter; the gate calls that "the explicit exemption and a complete answer to this gate":

✅ 2 source file(s) of 1 released package(s) changed, and this change declares 1 changeset(s)
Every one of them has an EMPTY frontmatter — declared as releasing nothing
✅ No changeset declares a `major` bump.

(The skip-changeset label is deliberately NOT applied — in this repo no workflow reads it.)

Out of scope, filed separately

#6844 — the status.options string form. Not addressed here: re-authoring those options means inventing the value codes the sample should demonstrate, which is a sample-content decision rather than a mechanical re-spelling. It is recorded in the ledger reason in the meantime.


Generated by Claude Code

…d record what still blocks it
`apps/console/src/preview-samples.ts`'s `object` sample declared its lookup
target as `reference_to`, which `FieldSchema` refuses BY NAME
(`unrecognized_keys`, with its own did-you-mean pointing at `reference`), and
which the designer never read either — `ObjectFieldInspector` seeds its
Lookup-target box from `def.reference`, so the old spelling rendered that box
empty on the one sample that exists to demonstrate a lookup.
The defect the card is really about is the ledger: the sample is quarantined in
`preview-samples-spec-valid.test.ts` under a reason naming only the array
`fields` shape, so whoever fixed that half would have found the sample still
red with no note. Measured against the installed spec 17.2.0, two blockers
actually remain once the key is fixed, and the reason now names both: the
deliberate array `fields` shape (it covers `readFields()`'s array branch), and
`status.options` as bare strings where the spec wants `{ label, value }`
objects — the latter reported only after the array shape stops
short-circuiting the parse.
Pinned in RETIRED_KEYS so it cannot drift back: for a quarantined sample the
reverse assertion asks only for `length > 0`, which the array-shape defect
satisfies forever, so a re-added retired key would change no test result at
all. Both spellings (`reference_to` and the tombstoned camelCase
`referenceTo`) are pinned.
Dev-only harness plus its test; declared as releasing nothing.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01CRJge11jso9TpXRWFt1Z49
@github-actions

Copy link
Copy Markdown
Contributor

✅ Console Performance Budget

MetricValueBudget
Eager closure (gzip, 45 chunks)3174.0 KB3222.7 KB
Main entry chunk (gzip)148.1 KB350 KB
Entry fileindex-BFe99tIZ.js
StatusPASS

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

PackageSizeGzipped
app-shell (consoleActionDispatch.js)0.20KB0.19KB
app-shell (index.js)11.89KB4.50KB
app-shell (runtime-config.js)20.61KB7.35KB
app-shell (types.js)0.01KB0.04KB
app-shell (urlParams.js)10.06KB3.86KB
auth (ActiveOrganizationStorage.js)25.05KB9.16KB
auth (AuthContext.js)0.31KB0.24KB
auth (AuthGuard.js)2.07KB1.00KB
auth (AuthProvider.js)40.18KB10.59KB
auth (AuthShell.js)3.49KB1.40KB
auth (ForgotPasswordForm.js)12.21KB3.45KB
auth (LoginForm.js)18.15KB5.39KB
auth (PreviewBanner.js)0.90KB0.50KB
auth (RegisterForm.js)6.65KB2.22KB
auth (SocialSignInButtons.js)9.61KB3.89KB
auth (UserMenu.js)3.41KB1.23KB
auth (auth-gate-events.js)1.29KB0.66KB
auth (authStyles.js)5.04KB1.72KB
auth (createAuthClient.js)40.21KB10.80KB
auth (createAuthenticatedFetch.js)8.46KB3.43KB
auth (index.js)3.19KB1.44KB
auth (invitation-status.js)1.22KB0.70KB
auth (org-roles.js)6.66KB2.78KB
auth (phone-identifier.js)1.11KB0.66KB
auth (types.js)0.59KB0.35KB
auth (useAuth.js)5.30KB1.02KB
auth (useWorkspaceAdminStatus.js)5.13KB2.35KB
collaboration (CommentThread.js)26.08KB7.56KB
collaboration (LiveCursors.js)3.17KB1.27KB
collaboration (PresenceAvatars.js)6.49KB2.64KB
collaboration (PresenceProvider.js)2.79KB1.13KB
collaboration (index.js)1.68KB0.73KB
collaboration (useCollaborationTranslation.js)6.05KB2.52KB
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)511.50KB116.32KB
core (index.js)5.30KB2.13KB
create-plugin (index.js)10.08KB3.26KB
data-objectstack (index.js)173.10KB47.96KB
fields (index.js)240.93KB60.76KB
i18n (LocalizationContext.js)1.76KB0.96KB
i18n (currency.js)1.22KB0.64KB
i18n (fallbackInterpolation.js)6.25KB2.77KB
i18n (i18n.js)4.28KB1.75KB
i18n (index.js)3.44KB1.39KB
i18n (pickLocalized.js)7.62KB3.26KB
i18n (provider.js)26.89KB9.04KB
i18n (useDisplayLocale.js)2.85KB1.45KB
i18n (useObjectLabel.js)33.40KB8.71KB
i18n (useSafeTranslation.js)5.60KB2.33KB
layout (index.js)38.95KB10.97KB
mobile (MobileProvider.js)0.92KB0.49KB
mobile (ResponsiveContainer.js)0.94KB0.38KB
mobile (breakpoints.js)1.51KB0.70KB
mobile (createOfflineDataSource.js)5.61KB1.75KB
mobile (index.js)1.55KB0.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)6.96KB1.98KB
mobile (useOfflineSync.js)1.99KB0.72KB
mobile (usePullToRefresh.js)2.53KB0.85KB
mobile (useResponsive.js)0.72KB0.42KB
mobile (useResponsiveConfig.js)1.37KB0.63KB
mobile (useSpecGesture.js)4.32KB1.64KB
mobile (useTouchTarget.js)1.01KB0.54KB
permissions (MePermissionsProvider.js)9.53KB3.38KB
permissions (PermissionContext.js)0.31KB0.25KB
permissions (PermissionGuard.js)0.89KB0.45KB
permissions (PermissionProvider.js)4.64KB1.50KB
permissions (evaluator.js)5.12KB1.74KB
permissions (index.js)0.93KB0.41KB
permissions (store.js)0.91KB0.42KB
permissions (useFieldPermissions.js)1.28KB0.53KB
permissions (usePermissions.js)1.93KB0.88KB
plugin-ai (index.js)15.75KB3.80KB
plugin-calendar (index.js)46.92KB12.93KB
plugin-charts (index.js)64.68KB18.35KB
plugin-chatbot (index.js)190.33KB45.10KB
plugin-dashboard (index.js)133.48KB34.51KB
plugin-designer (index.js)212.87KB43.19KB
plugin-detail (index.js)245.46KB62.46KB
plugin-editor (index.js)2.46KB1.10KB
plugin-form (index.js)133.03KB32.64KB
plugin-gantt (index.js)165.23KB40.37KB
plugin-grid (index.js)201.57KB54.55KB
plugin-kanban (index.js)53.14KB14.64KB
plugin-list (index.js)113.15KB27.59KB
plugin-map (index.js)20.20KB6.66KB
plugin-markdown (index.js)13.72KB4.69KB
plugin-report (index.js)43.51KB11.94KB
plugin-timeline (index.js)28.95KB8.33KB
plugin-tree (index.js)9.00KB3.08KB
plugin-view (index.js)85.87KB21.12KB
providers (DataSourceProvider.js)0.75KB0.39KB
providers (MetadataProvider.js)1.37KB0.59KB
providers (ThemeProvider.js)1.90KB0.85KB
providers (UploadProvider.js)11.66KB3.50KB
providers (index.js)0.45KB0.23KB
providers (types.js)0.01KB0.04KB
react-runtime (index.js)5.62KB2.34KB
react (LazyPluginLoader.js)4.47KB1.63KB
react (SchemaRenderer.js)76.75KB25.49KB
react (data-invalidation.js)5.05KB2.08KB
react (index.js)3.11KB1.48KB
react (schema-input.js)2.32KB1.24KB
react (spec-input.js)0.20KB0.18KB
sdui-parser (codegen.js)5.41KB2.34KB
sdui-parser (dashboard-widget-options.js)3.08KB1.30KB
sdui-parser (index.js)4.93KB2.24KB
sdui-parser (input-type.js)2.84KB1.40KB
sdui-parser (parse.js)20.57KB5.88KB
sdui-parser (provenance.js)3.66KB1.82KB
sdui-parser (types.js)0.28KB0.23KB
sdui-parser (validate.js)10.35KB3.60KB
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)2.74KB1.41KB
types (crud.js)0.20KB0.18KB
types (dashboard-filter-alias.js)6.23KB2.74KB
types (data-display.js)3.75KB1.85KB
types (data-protocol.js)0.20KB0.19KB
types (data.js)0.20KB0.18KB
types (designer.js)1.85KB0.85KB
types (disclosure.js)0.20KB0.18KB
types (error-code.js)1.54KB0.88KB
types (feedback.js)0.20KB0.18KB
types (field-types.js)0.20KB0.18KB
types (form.js)0.20KB0.18KB
types (http-inflight.js)8.87KB3.73KB
types (http-retry.js)4.32KB2.02KB
types (icon-key-migration.js)4.26KB1.63KB
types (index.js)4.72KB2.24KB
types (layout.js)0.20KB0.18KB
types (managed-by.js)0.19KB0.18KB
types (mobile.js)2.59KB1.31KB
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 (record-semantics.js)1.28KB0.67KB
types (registry.js)0.20KB0.18KB
types (reports.js)0.20KB0.18KB
types (spec-report.js)5.05KB1.93KB
types (spec-ui-namespace.js)0.20KB0.19KB
types (system-fields.js)3.33KB1.54KB
types (theme.js)6.28KB2.87KB
types (ui-action.js)3.40KB1.71KB
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-sam
os-sam marked this pull request as ready for review August 30, 2026 03:17
@os-sam
os-sam added this pull request to the merge queueAug 30, 2026
Merged via the queue into main with commit cb34bd9Aug 30, 2026
32 checks passed
@os-sam
os-sam deleted the claude/issue-6647-preview-sample-reference-key branch August 30, 2026 03:34
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.

finding(console): the object preview sample spells a lookup target reference_to, a second off-spec key its KNOWN_STALE reason does not record

2 participants

@os-sam@claude