Skip to content

fix(console): read the SETTINGS_LOCKED key from error.details, tolerating both shapes (objectstack#4224) - #3079

Merged
os-zhuang merged 1 commit into
mainfrom
claude/api-error-schema-keys-zxddk6
Jul 31, 2026
Merged

fix(console): read the SETTINGS_LOCKED key from error.details, tolerating both shapes (objectstack#4224)#3079
os-zhuang merged 1 commit into
mainfrom
claude/api-error-schema-keys-zxddk6

Conversation

@os-zhuang

Copy link
Copy Markdown
Contributor

The console half of objectstack-ai/objectstack#4224. This should land first — see Ordering.

What

SettingsView.onSave rendered its lock toast from err.payload.error.key:

if (err?.payload?.error?.code === 'SETTINGS_LOCKED') {
  toast.error(`Locked by environment: ${err.payload.error.key}`);
}

error.key was a sibling of code/message inside error — a position ApiErrorSchema never declared. It reached the console only because that schema is a plain z.object and strips undeclared keys instead of rejecting them, so nothing on either side of the wire ever flagged it. objectstack#4224 moves the key to error.details.key, the slot the contract does declare.

The change

A lockedKeyOf helper in settings/api.ts reads the declared slot first and falls back to the old position, so the toast keeps naming the locked key against servers on either side of that change rather than degrading to Locked by environment: undefined during the window where the two repos are on different versions. The fallback can go once the oldest supported server carries the fix.

It lives in api.ts rather than inline in the view for two reasons: that module already owns what the server's error body looks like (jsonOrThrow is what builds err.payload), and a compat shim no test exercises is one the next reader deletes half of. Both branches are pinned in api.test.ts, so removing either is a red test that names the server version it breaks — which is also the signal for when the old branch may legitimately go.

Also stops interpolating a missing key: with neither position carrying one, the toast now reads Locked by environment rather than appending undefined.

Ordering

Tolerant-read-first, the objectui#2869 pattern ADR-0112 records:

  1. this PR — console reads both positions
  2. objectstack#4224's PR — server moves the keys into error.details

Landing them the other way round shows Locked by environment: undefined to anyone on a console built before the server ships.

Scope

error.key was the only in-console reader of the four keys objectstack#4224 relocates. A repo-wide grep for namespace / reason / fields read from that position finds no consumer, so nothing else needs a dual-read.

Worth noting for later: extractFieldErrors (packages/react/src/utils/error-message.ts) already reads details.fields, and objectstack#4224 turns SETTINGS_VALIDATION's field map into the declared FieldError[] under exactly that path. Settings validation failures therefore become renderable per-field with no further change here — wiring the settings form to actually do that is a separate piece of work, not part of this compat fix.

Verification

  • pnpm --filter @object-ui/console test — 15 files, 111 tests, green (4 of them new)
  • tsc --noEmit reports nothing in the touched files; the remaining errors in this app are pre-existing unresolved @object-ui/* workspace imports (sibling packages not built in this environment), present on the base branch too

🤖 Generated with Claude Code


Generated by Claude Code

…rating both shapes (objectstack#4224)

`SettingsView.onSave` rendered its lock toast from `err.payload.error.key`.
That key was a SIBLING of `code`/`message` inside `error`, a position
`ApiErrorSchema` never declared — it reached the console only because the
schema is a plain `z.object` and strips undeclared keys instead of rejecting
them, so nothing on either side of the wire ever flagged it.

objectstack#4224 moves it to `error.details.key`, the slot the contract does
declare. This is the console's half and ships FIRST: the read is now the
declared slot with the old position as fallback, so the toast keeps naming the
locked key against servers on either side of that change rather than degrading
to "Locked by environment: undefined" during the window where the two repos are
on different versions. The fallback goes once the oldest supported server
carries the fix.

It lives in `settings/api.ts` as `lockedKeyOf` rather than inline in the view,
because that module already owns what the server's error body looks like
(`jsonOrThrow` is what builds `err.payload`) and because a compat shim no test
exercises is one the next reader deletes half of. Both branches are pinned, so
removing either is a red test naming the server version it breaks.

Also stops interpolating a missing key: with neither position carrying one the
toast reads "Locked by environment" rather than appending `undefined`.

This was the only in-console reader of the four keys objectstack#4224
relocated — a repo-wide grep for `namespace` / `reason` / `fields` in that
position finds no consumer.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Tv2NYMBTrzVVRWiWWuyec5
@vercel

vercel Bot commented Jul 30, 2026

Copy link
Copy Markdown

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

1 Skipped Deployment
Project Deployment Actions Updated (UTC)
objectui Ignored Ignored Jul 30, 2026 4:58pm

Request Review

@github-actions

Copy link
Copy Markdown
Contributor

✅ Console Performance Budget

Metric Value Budget
Main entry (gzip) 27.9 KB 350 KB
Entry file index-BIeFFEcs.js
Status PASS

📦 Bundle Size Report

Package Size Gzipped
app-shell (index.js) 8.26KB 2.99KB
app-shell (runtime-config.js) 7.42KB 2.32KB
app-shell (types.js) 0.01KB 0.04KB
app-shell (urlParams.js) 7.57KB 2.97KB
auth (AuthContext.js) 0.31KB 0.24KB
auth (AuthGuard.js) 1.17KB 0.53KB
auth (AuthProvider.js) 22.10KB 4.37KB
auth (AuthShell.js) 3.49KB 1.40KB
auth (ForgotPasswordForm.js) 12.12KB 3.41KB
auth (LoginForm.js) 17.86KB 5.29KB
auth (PreviewBanner.js) 0.90KB 0.50KB
auth (RegisterForm.js) 6.43KB 2.09KB
auth (SocialSignInButtons.js) 9.60KB 3.89KB
auth (UserMenu.js) 3.40KB 1.22KB
auth (auth-gate-events.js) 1.29KB 0.66KB
auth (authStyles.js) 5.04KB 1.72KB
auth (createAuthClient.js) 35.76KB 9.11KB
auth (createAuthenticatedFetch.js) 4.37KB 1.69KB
auth (index.js) 2.35KB 1.07KB
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) 4.91KB 0.87KB
auth (useIsWorkspaceAdmin.js) 1.61KB 0.85KB
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.79KB 1.13KB
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) 471.25KB 102.82KB
core (index.js) 2.16KB 0.78KB
create-plugin (index.js) 9.28KB 2.98KB
data-objectstack (index.js) 135.63KB 34.47KB
fields (index.js) 222.07KB 54.35KB
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.70KB 0.83KB
i18n (provider.js) 5.37KB 1.72KB
i18n (useObjectLabel.js) 25.17KB 5.80KB
i18n (useSafeTranslation.js) 3.26KB 1.44KB
layout (index.js) 38.45KB 10.67KB
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) 6.96KB 1.98KB
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) 4.05KB 1.53KB
mobile (useTouchTarget.js) 1.01KB 0.54KB
permissions (MePermissionsProvider.js) 8.76KB 3.06KB
permissions (PermissionContext.js) 0.31KB 0.25KB
permissions (PermissionGuard.js) 0.89KB 0.45KB
permissions (PermissionProvider.js) 3.67KB 1.12KB
permissions (evaluator.js) 4.41KB 1.44KB
permissions (index.js) 0.91KB 0.41KB
permissions (retry.js) 3.48KB 1.61KB
permissions (store.js) 0.91KB 0.42KB
permissions (useFieldPermissions.js) 1.28KB 0.52KB
permissions (usePermissions.js) 1.55KB 0.71KB
plugin-ai (index.js) 15.71KB 3.79KB
plugin-calendar (index.js) 44.90KB 12.35KB
plugin-charts (index.js) 60.52KB 17.11KB
plugin-chatbot (index.js) 180.09KB 42.72KB
plugin-dashboard (index.js) 111.59KB 28.74KB
plugin-designer (index.js) 210.51KB 42.50KB
plugin-detail (index.js) 221.81KB 54.28KB
plugin-editor (index.js) 2.46KB 1.10KB
plugin-form (index.js) 110.71KB 26.67KB
plugin-gantt (index.js) 162.26KB 39.53KB
plugin-grid (index.js) 182.21KB 48.24KB
plugin-kanban (index.js) 47.82KB 13.18KB
plugin-list (index.js) 104.07KB 24.88KB
plugin-map (index.js) 16.80KB 5.24KB
plugin-markdown (index.js) 13.65KB 4.67KB
plugin-report (index.js) 40.32KB 10.53KB
plugin-timeline (index.js) 25.75KB 7.32KB
plugin-tree (index.js) 8.36KB 2.81KB
plugin-view (index.js) 85.95KB 21.02KB
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.71KB 3.53KB
providers (index.js) 0.44KB 0.22KB
providers (types.js) 0.01KB 0.04KB
react-runtime (index.js) 5.67KB 2.37KB
react (LazyPluginLoader.js) 3.77KB 1.33KB
react (SchemaRenderer.js) 19.28KB 6.38KB
react (data-invalidation.js) 5.05KB 2.08KB
react (index.js) 1.02KB 0.55KB
sdui-parser (codegen.js) 4.09KB 1.74KB
sdui-parser (index.js) 3.47KB 1.54KB
sdui-parser (parse.js) 10.04KB 2.82KB
sdui-parser (types.js) 0.29KB 0.24KB
sdui-parser (validate.js) 4.69KB 1.48KB
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) 1.87KB 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 (index.js) 2.07KB 0.99KB
types (layout.js) 0.20KB 0.18KB
types (managed-by.js) 0.19KB 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 (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 (system-fields.js) 3.33KB 1.54KB
types (theme.js) 0.20KB 0.18KB
types (ui-action.js) 1.08KB 0.64KB
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

@os-zhuang
os-zhuang marked this pull request as ready for review July 31, 2026 00:39
@os-zhuang
os-zhuang merged commit 0fcd4a9 into main Jul 31, 2026
16 checks passed
@os-zhuang
os-zhuang deleted the claude/api-error-schema-keys-zxddk6 branch July 31, 2026 00:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants