Skip to content

fix(plugin-form): swapping recordId no longer leaves the previous record on screen - #3005

Merged
os-zhuang merged 1 commit into
mainfrom
claude/recordid-swap-loading
Jul 30, 2026
Merged

fix(plugin-form): swapping recordId no longer leaves the previous record on screen#3005
os-zhuang merged 1 commit into
mainfrom
claude/recordid-swap-loading

Conversation

@os-zhuang

Copy link
Copy Markdown
Contributor

Follow-up to #2991, which had to defend against this path. It turned out to be a defect of its own.

The bug

loading in ModalForm / DrawerForm / TabbedForm / SplitForm is only ever set true once — by useState(true) — and thereafter only ever set false. A recordId change re-enters the fetch effect without going back through the loading branch, so:

  • the form stays mounted showing, and accepting edits to, record A's values;
  • nothing indicates a different record was asked for;
  • when B lands it replaces them in place.

Anything typed in that window read as A's on screen but would have been submitted against B.

Reading the same effect closely surfaced a second defect: no staleness guard, so two overlapping reads land in completion order rather than request order. Ask for B then C, and a slow B arriving last leaves the form showing B while the caller asked for C.

Both are the same thing from the user's side — the form displays a record nobody asked for — so both are fixed here.

ObjectForm already re-enters loading before its fetch (ObjectForm.tsx:460), which is why this only ever reproduced on the four sectioned variants.

The fix

  • Re-enter the loading state on a change of record, so the previous record is off screen while the next is in flight. Gated on the record actually changing — the effect also re-runs on initialData/initialValues identity churn (callers rebuild those objects every render), and flashing the loading state for that would thrash.
  • Mark the read stale in the effect's cleanup, so a response that is no longer awaited is dropped instead of overwriting a newer record.

Also fixed — a consequence of the above

Hiding the form unmounts the inner renderer, and that renderer is the only thing that reports dirtiness via onDirtyChange; it gets no chance to report false on the way out. Without clearing the flag, the overlay's unsaved-input guards from #2998 would stay armed for input belonging to a record no longer on screen — a plain refresh would prompt, and closing would offer to discard nothing.

I caught this only because #2998 landed hours earlier; it is exactly the kind of interaction a "just add setLoading(true)" change would have shipped silently.

Verification

  • New recordSwapLoading.test.tsx drives each of the four containers through a real swap with a findOne the test resolves by record id, so both the stale-record and the out-of-order cases are deterministic rather than timing-dependent. Against the previous code all 11 fail — the two core assertions read expected 'Record One' not to be 'Record One' and expected 'Record Two' to be 'Record Three'.
  • The dirty-flag guard is mutation-verified: dropping only that one line fails its two tests with expected true to be false.
  • npx vitest run packages/plugin-form/ packages/components/ packages/app-shell/315 files / 2627 tests pass.
  • @object-ui/plugin-form type-check clean; lint 0 errors (the 2 unused-disable warnings are pre-existing, in EmbeddableForm/MasterDetailForm).

🤖 Generated with Claude Code

…ord on screen

`loading` in ModalForm / DrawerForm / TabbedForm / SplitForm was only ever set
`true` once, by `useState(true)`, and thereafter only ever set `false`. A
`recordId` change therefore re-entered the fetch effect WITHOUT going back
through the loading branch: the form stayed mounted showing — and accepting
edits to — record A's values, with nothing indicating a different record had
been asked for, until B's response landed and replaced them in place. Anything
typed in that window read as A's on screen and would have been submitted
against B.

The same effect had no staleness guard either, so two overlapping reads landed
in COMPLETION order rather than request order: ask for B then C, and a slow B
arriving last left the form showing B while the caller had asked for C.

Both are the same defect from the user's side — the form displays a record
nobody asked for — so both are fixed:

  - a change of record re-enters the loading state before the read, so the
    previous record is off screen while the next one is in flight. Gated on the
    record actually changing: the effect also re-runs on
    `initialData`/`initialValues` identity churn (callers rebuild those objects
    every render), and flashing the loading state for that would thrash;
  - the effect's cleanup marks its read stale, so a response that is no longer
    the one being awaited is dropped instead of overwriting a newer record.

ObjectForm already re-entered loading before its fetch, which is why this only
ever reproduced on the four sectioned variants.

Also fixed, a consequence of the above: hiding the form unmounts the inner
renderer, and that renderer is the only thing that reports dirtiness via
`onDirtyChange` — it gets no chance to report `false` on the way out. Without
clearing the flag, the overlay's unsaved-input guards (#2998) would stay armed
for input belonging to a record no longer on screen: a plain refresh would
prompt, and closing would offer to discard nothing. Verified by mutation —
dropping only that line fails the two guard tests with `expected true to be
false`.

New `recordSwapLoading.test.tsx` drives each container through a real record
swap with a `findOne` the test resolves by id, so both the stale-record and the
out-of-order cases are deterministic rather than timing-dependent; all 11 fail
against the previous code (8 of them on the two core assertions).

Verified: `npx vitest run packages/plugin-form/ packages/components/
packages/app-shell/` — 315 files / 2627 tests pass; `@object-ui/plugin-form`
type-check clean, lint 0 errors (the 2 unused-disable warnings are pre-existing,
in EmbeddableForm/MasterDetailForm).

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@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 9:10am

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-CWJjyLFP.js
Status PASS

📦 Bundle Size Report

Package Size Gzipped
app-shell (index.js) 8.20KB 2.97KB
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.25KB 1.01KB
auth (org-roles.js) 6.72KB 2.85KB
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) 454.35KB 99.16KB
core (index.js) 2.16KB 0.78KB
create-plugin (index.js) 9.28KB 2.98KB
data-objectstack (index.js) 134.67KB 34.24KB
fields (index.js) 221.10KB 54.18KB
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) 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) 6.84KB 2.42KB
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 (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) 57.26KB 16.24KB
plugin-chatbot (index.js) 180.09KB 42.72KB
plugin-dashboard (index.js) 110.24KB 28.47KB
plugin-designer (index.js) 210.56KB 42.56KB
plugin-detail (index.js) 216.52KB 53.02KB
plugin-editor (index.js) 2.46KB 1.10KB
plugin-form (index.js) 104.48KB 25.29KB
plugin-gantt (index.js) 162.26KB 39.53KB
plugin-grid (index.js) 180.80KB 47.40KB
plugin-kanban (index.js) 47.82KB 13.18KB
plugin-list (index.js) 99.43KB 23.54KB
plugin-map (index.js) 16.80KB 5.24KB
plugin-markdown (index.js) 13.65KB 4.67KB
plugin-report (index.js) 40.24KB 10.51KB
plugin-timeline (index.js) 25.03KB 7.11KB
plugin-tree (index.js) 8.36KB 2.81KB
plugin-view (index.js) 85.88KB 20.99KB
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-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) 0.77KB 0.41KB
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.00KB 0.96KB
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.04KB 1.93KB
types (system-fields.js) 2.39KB 1.17KB
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 merged commit e339d60 into main Jul 30, 2026
16 checks passed
@os-zhuang
os-zhuang deleted the claude/recordid-swap-loading branch July 30, 2026 09:17
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.

1 participant