Skip to content

fix(plugin-form): block page unload while a modal/drawer form has unsaved input - #2998

Merged
baozhoutao merged 1 commit into
mainfrom
fix/form-beforeunload-guard
Jul 30, 2026
Merged

fix(plugin-form): block page unload while a modal/drawer form has unsaved input#2998
baozhoutao merged 1 commit into
mainfrom
fix/form-beforeunload-guard

Conversation

@baozhoutao

Copy link
Copy Markdown
Contributor

Problem

The in-app discard guard (#2028) only intercepts Radix close paths — backdrop click, Escape, the X. A browser refresh or tab close never reaches them: beforeunload fired with nobody calling preventDefault(), so a dirty create/edit overlay silently lost everything the user had typed. Worse, the overlay itself is restored afterwards via the ?recordId= URL param — but empty, which reads as data loss with no warning at any point.

Verified live: dispatching beforeunload on a dirty edit modal returned defaultPrevented === false; a refresh dropped all entered values with zero confirmation.

Fix

Register a beforeunload listener while the overlay is open and dirty (and confirmOnDiscard hasn't been opted out), in both ModalForm and DrawerForm — mirroring the existing StudioDesignSurface pillar guard (#2606). The listener is removed as soon as the form is pristine again, so normal navigation never prompts.

Tests

6 new cases in discardGuard.test.tsx (describe.each over both overlays):

  • pristine form → unload not blocked
  • dirty form → unload blocked (defaultPrevented)
  • dirty + confirmOnDiscard: false → unload not blocked

pnpm vitest run packages/plugin-form: 224 passed. type-check: clean.

🤖 Generated with Claude Code

@vercel

vercelBot commented Jul 30, 2026

Copy link
Copy Markdown

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

1 Skipped Deployment
ProjectDeploymentActionsUpdated (UTC)
objectuiIgnoredIgnoredJul 30, 2026 8:32am

Request Review

@github-actions

Copy link
Copy Markdown
Contributor

✅ Console Performance Budget

MetricValueBudget
Main entry (gzip)27.9 KB350 KB
Entry fileindex-Br1xwqP4.js
StatusPASS

📦 Bundle Size Report

PackageSizeGzipped
app-shell (index.js)8.20KB2.97KB
app-shell (runtime-config.js)7.42KB2.32KB
app-shell (types.js)0.01KB0.04KB
app-shell (urlParams.js)7.57KB2.97KB
auth (AuthContext.js)0.31KB0.24KB
auth (AuthGuard.js)1.17KB0.53KB
auth (AuthProvider.js)22.10KB4.37KB
auth (AuthShell.js)3.49KB1.40KB
auth (ForgotPasswordForm.js)12.12KB3.41KB
auth (LoginForm.js)17.86KB5.29KB
auth (PreviewBanner.js)0.90KB0.50KB
auth (RegisterForm.js)6.43KB2.09KB
auth (SocialSignInButtons.js)9.60KB3.89KB
auth (UserMenu.js)3.40KB1.22KB
auth (auth-gate-events.js)1.29KB0.66KB
auth (authStyles.js)5.04KB1.72KB
auth (createAuthClient.js)35.76KB9.11KB
auth (createAuthenticatedFetch.js)4.37KB1.69KB
auth (index.js)2.25KB1.01KB
auth (org-roles.js)6.72KB2.85KB
auth (phone-identifier.js)1.11KB0.66KB
auth (types.js)0.59KB0.35KB
auth (useAuth.js)4.91KB0.87KB
auth (useIsWorkspaceAdmin.js)1.61KB0.85KB
collaboration (CommentThread.js)18.38KB4.49KB
collaboration (LiveCursors.js)3.17KB1.27KB
collaboration (PresenceAvatars.js)3.65KB1.42KB
collaboration (PresenceProvider.js)2.79KB1.13KB
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)454.32KB99.14KB
core (index.js)2.16KB0.78KB
create-plugin (index.js)9.28KB2.98KB
data-objectstack (index.js)134.67KB34.24KB
fields (index.js)221.10KB54.18KB
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.70KB0.83KB
i18n (provider.js)5.37KB1.72KB
i18n (useObjectLabel.js)25.17KB5.80KB
i18n (useSafeTranslation.js)3.26KB1.44KB
layout (index.js)38.45KB10.67KB
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)6.84KB2.42KB
permissions (PermissionContext.js)0.31KB0.25KB
permissions (PermissionGuard.js)0.89KB0.45KB
permissions (PermissionProvider.js)3.67KB1.12KB
permissions (evaluator.js)4.41KB1.44KB
permissions (index.js)0.91KB0.41KB
permissions (store.js)0.91KB0.42KB
permissions (useFieldPermissions.js)1.28KB0.52KB
permissions (usePermissions.js)1.55KB0.71KB
plugin-ai (index.js)15.71KB3.79KB
plugin-calendar (index.js)44.90KB12.35KB
plugin-charts (index.js)57.26KB16.24KB
plugin-chatbot (index.js)180.09KB42.72KB
plugin-dashboard (index.js)110.24KB28.47KB
plugin-designer (index.js)210.56KB42.56KB
plugin-detail (index.js)216.52KB53.02KB
plugin-editor (index.js)2.46KB1.10KB
plugin-form (index.js)103.79KB25.15KB
plugin-gantt (index.js)162.26KB39.53KB
plugin-grid (index.js)180.26KB47.25KB
plugin-kanban (index.js)47.82KB13.18KB
plugin-list (index.js)98.89KB23.41KB
plugin-map (index.js)16.80KB5.24KB
plugin-markdown (index.js)13.65KB4.67KB
plugin-report (index.js)40.24KB10.51KB
plugin-timeline (index.js)25.03KB7.11KB
plugin-tree (index.js)8.36KB2.81KB
plugin-view (index.js)85.88KB20.99KB
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-runtime (index.js)5.67KB2.37KB
react (LazyPluginLoader.js)3.77KB1.33KB
react (SchemaRenderer.js)19.28KB6.38KB
react (data-invalidation.js)5.05KB2.08KB
react (index.js)1.02KB0.55KB
sdui-parser (codegen.js)4.09KB1.74KB
sdui-parser (index.js)3.47KB1.54KB
sdui-parser (parse.js)10.04KB2.82KB
sdui-parser (types.js)0.29KB0.24KB
sdui-parser (validate.js)4.69KB1.48KB
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 (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 (index.js)1.94KB0.95KB
types (layout.js)0.20KB0.18KB
types (managed-by.js)0.19KB0.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 (record-semantics.js)1.28KB0.67KB
types (registry.js)0.20KB0.18KB
types (reports.js)0.20KB0.18KB
types (spec-report.js)5.04KB1.93KB
types (system-fields.js)2.39KB1.17KB
types (theme.js)0.20KB0.18KB
types (ui-action.js)0.82KB0.48KB
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

@baozhoutao
baozhoutao merged commit bbdb498 into mainJul 30, 2026
16 checks passed
@baozhoutao
baozhoutao deleted the fix/form-beforeunload-guard branch July 30, 2026 08:39
os-zhuang added a commit that referenced this pull request Jul 30, 2026
…ord on screen (#3005)
`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: Jack Zhuang <277994282+os-zhuang@users.noreply.github.com>
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
…aved input
The in-app discard guard (#2028) only intercepts Radix close paths —
backdrop, Escape, the X. A browser refresh or tab close never reaches
them: beforeunload fired with nobody calling preventDefault, so a dirty
create/edit overlay silently lost everything the user had typed (the
dialog itself is even restored afterwards via the ?recordId= URL param,
but empty).
Register a beforeunload listener while the overlay is open and dirty
(and confirmOnDiscard hasn't been opted out), mirroring the existing
StudioDesignSurface pillar guard.
Co-Authored-By: Claude Fable 5 <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.

1 participant

@baozhoutao