Skip to content

fix(auth): stop ActiveOrganizationStorage.clear() swallowing a failed removal - #5764

Merged
os-zhuang merged 1 commit into
mainfrom
claude/issue-5731-clear-must-not-swallow
Aug 23, 2026
Merged

fix(auth): stop ActiveOrganizationStorage.clear() swallowing a failed removal#5764
os-zhuang merged 1 commit into
mainfrom
claude/issue-5731-clear-must-not-swallow

Conversation

@os-zhuang

Copy link
Copy Markdown
Contributor

Fixes#5731

The file the card names is not the file the code is in

Both the card and its triage line say packages/auth/src/createAuthenticatedFetch.ts. That was true when they were written. #5664 / PR #5744 moved ActiveOrganizationStorage into its own module at 03:56Z the same day; createAuthenticatedFetch.ts now only re-exports it, and that re-export is untouched here. The asymmetry was re-derived on the post-#5664 code rather than taken from the card's quote, and it survives the move intact.

The asymmetry, on origin/main at 9850c6e

clear(): void{this._memoryValue=null;// unconditional — always sticksconstkey=scopedActiveOrgKey();if(key)removePersisted(key);// best-effort — failure swallowedremovePersisted(LEGACY_ACTIVE_ORG_KEY);}

get() prefers a non-null persisted read and only falls through to _memoryValue (the #5703 read order). So clear()'s two halves are not equally strong: nulling memory always sticks, while a removal that does not stick leaves the key readable — and the read order prefers it. The memory null is shadowed by the surviving persisted value. Sign-out is one of five callers, so the failure mode is "sign-out does not stick", silently, with the cleared org back on the wire as X-Tenant-ID.

Distinguishing the accidental swallow from the deliberate one

set()/writePersisted swallows a failing setItem one function away. That is #5703's memory-fallback design and it is not touched here. The test that tells them apart is not "which one catches" but does the swallow leave a path that still upholds the method's postcondition:

postconditionon failureverdict
set()get() reads back what was set_memoryValue holds it, and get()'s fallback is built to consult itupheld — deliberate
clear()get() answers null_memoryValue is null but the surviving persisted value outranks itnot upheld — accidental

A case in the new file pins that the deliberate one still behaves as #5703 designed it.

What changed

1. The verdict is a read-back, not a caught throw.removePersisted now returns whether the key is still readable. get() can only answer with what getItem hands back, so "did this removal stick" is "is the key still readable". Deciding it from the throw would be wrong in both directions:

  • too narrow — a wrapped or proxied localStorage whose removeItem is a silent no-op never throws and leaves identical residue. That was the only candidate the filer could name, and it is now covered; a throw-based guard would have missed it entirely.
  • too wide — SSR, and the partitioned-iframe browser where every operation throws, have nothing readable to resurrect. The card explicitly ruled both out as the defect. Reporting them as failures is how a report earns a reputation for crying wolf.

2. The invariant is restored inside clear(). A key whose removal cannot be verified is quarantined in memory for the rest of the page-load; get() skips the persisted branch for it and answers from _memoryValue — which clear() just nulled, and which a later set() refills with the value that write was meant to persist. Correct in both directions with no release step of its own. The quarantine is released as soon as a removal on that key sticks, so it describes the last attempt rather than a permanent verdict on the browser. What it gives up is cross-tab freshness for one key in a browser that has just proved it cannot delete from storage: an unstamped X-Tenant-ID is a documented state of the edge contract (#5279), a re-stamped signed-out org is not.

3. The failure is reported, not thrown and not returned.clear()'s callers were enumerated first, and the shape follows from what they can do:

callerstate when it callscan it act on a failure?
purgeSignedOutClientCaches (sign-out)session already endedno — sign-out cannot be refused
switchOrganizationserver already switched/clearedno — a throw reports a successful switch as failed
deleteOrganization / leaveOrganizationorg already deleted / leftno
purgePreviousUserClientState via SessionUserScope.adoptsign-in path, inside an effectno — a throw breaks the arriving user's boot

Not one of them can act on it, so a boolean return only moves the problem: five call sites with nothing to write in the failure branch, and a return value every caller ignores reads as handled when it is not. console.warn is the channel this package already uses for intentional diagnostics ([AuthProvider] Failed to load organizations:) and eslint's no-console allows it.

Rejected third shape: re-writing the key with an empty value. It relocates the fix into every consumer's truthiness test (createAuthenticatedFetch does if (activeOrgId)) — the lenient consumer AGENTS.md #0.1 forbids — and leaves a signed-out browser holding a live key.

Tests

packages/auth/src/__tests__/activeOrgClearRemovalFailure-5731.test.tsx, 10 cases. Per triage, no browser state is reproduced: a localStorage double is the instrument, and the headline assertions are outcomes (get() is null; the header is absent from the wire), not "did it warn".

Both failing-removal shapes are driven — removeItemthrows and removeItem is a silent no-op — and each case asserts its own premise (the value really reached the persisted layer; the removal really did not stick), so a green case cannot be explained by a double that quietly deleted the key.

Controls, without which the pins would pass on an implementation that always returns null: a working store where the removal sticks and the key is gone; a set() after a failed clear() that must be readable again; and the release-on-recovery case.

Ablation

Committed first, mutated, confirmed on disk by single-line anchored counts in both directions, restored under trap ... EXIT INT TERM, restored tree re-run green.

legmutationanchored counts (baseline → mutated → restored)result
Adelete the get() quarantine guard_unremovedKeys.has(key) 1 → 0 → 14 failed / 6 passed
BremovePersisted stops verifying (return true)readPersisted(key) === null 1 → 0 → 1; bare return true; 0 → 1 → 07 failed / 3 passed
restored treecounts back to baseline, git status clean10 passed

The two legs separate the mechanism from its input, which is why both are pinned. Under A the three outcome pins die while the mechanism pins surviveclear() still populates the quarantine correctly, and the bookkeeping alone does nothing; the get() guard is what turns it into the outcome. Under B the mechanism pins die too, because verification is upstream of everything.

Three cases survive both legs, and that is the point of them: "stays quiet when the removal sticks", "stays quiet when there is no storage at all", and the set()-swallow case. They assert behaviour on stores where nothing fails and on the swallow this card deliberately leaves alone. Had any of them died, the change would have been over-reaching — reporting on a healthy store, crying wolf on SSR, or breaking #5703's memory fallback. Their survival is the evidence that the change is scoped to measured failures.

Verification — union run at 0610ca74b (final commit, clean tree)

checkresult
vitest run packages/auth/exit 0 — 24 files, 246 tests passed
vitest run app-shell MetadataProvider.{firstBootOrgScope,orgScopedCache,crossPrincipalSeed}exit 0 — 3 files, 13 tests passed
pnpm --filter @object-ui/auth type-checkexit 0 (tsc --noEmitandtsc -p tsconfig.test.json)
pnpm --filter @object-ui/auth lintexit 0 — ✖ 29 problems (0 errors, 29 warnings), all pre-existing and none in the changed files
check-control-bytesexit 0 — OK (scanned 4805 tracked text file(s))
check-changeset-presenceexit 0 — 2 source file(s) of 1 released package(s) changed ... declares 1 changeset(s)
check-changeset-no-major · check-changeset-fixedexit 0
check-lint-coverage · check-type-check-coverageexit 0 — 46/46 packages linted; 41/41 packages compile their tests
check-package-self-import · check-phantom-dependenciesexit 0

Both load-bearing pins in the blast radius are green and unmodified: activeOrgStorageFallback-5703.test.tsx (9 cases) and sessionUserChangePurge-5664.test.tsx (12 cases).

Narrowed lint, declared.pnpm lint is turbo run lint (per-package eslint .); the run above is the whole @object-ui/auth package — a superset of the diff — measured at 46 files from --format json, with the population decided by eslint's own config rather than by a guess. The invariance that makes the narrowing a measurement: eslint.config.js extends tseslint.configs.recommended, not the type-checked preset, and carries no projectService / parserOptions / project: (each grepped with the exit code captured before any pipe: grep_exit=1, 0 hits, against control terms in the same file that hit — languageOptions 1, rules 10, files: 6). With no type-aware linting, a diff confined to packages/auth cannot move the verdict on any untouched file. The rest of the farm is CI's run.

@object-ui/auth is vitest-aliased to packages/auth/src, so every run above — the consumer tests and both ablation legs included — exercises the edited source directly. No dist/ is in the resolution path, and no stale-artifact false green is possible.

Out of scope

createAuthenticatedFetch.ts is untouched — the re-export still resolves, and no signature moved. One neighbouring finding is filed separately and stays out of this PR: #5763 (open, unassigned) — sweepStore's try wraps the whole loop, so one throwing removeItem silently cancels the rest of the session-user purge. Same class, different function and different callers, and it needs a partial-failure test of its own.


Generated by Claude Code

…ed removal (#5731)
`clear()` nulled `_memoryValue` and then removed the persisted key inside a
`try`/`catch` that discarded any failure. Since #5703 `get()` prefers a
non-null `localStorage` read, so a removal that did not stick left the key
readable, the read order preferred it, and sign-out silently did not stick —
the cleared org went back on the wire as `X-Tenant-ID`.
The removal is now judged by a read-back rather than by catching the throw,
which also covers a wrapped `localStorage` whose `removeItem` is a silent
no-op, and does not misreport SSR or a fully-throwing store as a failure. A
key whose removal cannot be verified is quarantined in memory for the rest of
the page-load: `get()` skips its persisted branch and answers from
`_memoryValue`. The quarantine is released as soon as a removal on that key
sticks.
Not thrown and not returned: all five callers arrive after the transition
they follow up on has already happened and none can act on a storage failure,
so the invariant is restored inside `clear()` and the failure is reported to
the console.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EuPCi56cnGyykygi3z9w4m
@github-actions

Copy link
Copy Markdown
Contributor

✅ Console Performance Budget

MetricValueBudget
Eager closure (gzip, 52 chunks)3917.8 KB3990.2 KB
Main entry chunk (gzip)152.5 KB350 KB
Entry fileindex-Bgw4kA1C.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)10.04KB3.72KB
app-shell (runtime-config.js)12.80KB4.47KB
app-shell (types.js)0.01KB0.04KB
app-shell (urlParams.js)10.06KB3.86KB
auth (ActiveOrganizationStorage.js)22.94KB8.44KB
auth (AuthContext.js)0.31KB0.24KB
auth (AuthGuard.js)2.07KB1.00KB
auth (AuthProvider.js)33.99KB8.57KB
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)510.39KB114.67KB
core (index.js)4.92KB1.97KB
create-plugin (index.js)10.08KB3.26KB
data-objectstack (index.js)164.55KB45.67KB
fields (index.js)238.40KB59.89KB
i18n (LocalizationContext.js)1.76KB0.96KB
i18n (currency.js)1.22KB0.64KB
i18n (i18n.js)4.28KB1.75KB
i18n (index.js)3.44KB1.39KB
i18n (pickLocalized.js)7.62KB3.26KB
i18n (provider.js)23.13KB7.63KB
i18n (useDisplayLocale.js)2.85KB1.45KB
i18n (useObjectLabel.js)33.40KB8.71KB
i18n (useSafeTranslation.js)7.77KB3.13KB
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.62KB12.83KB
plugin-charts (index.js)64.65KB18.32KB
plugin-chatbot (index.js)181.41KB43.22KB
plugin-dashboard (index.js)128.41KB32.95KB
plugin-designer (index.js)212.30KB42.80KB
plugin-detail (index.js)242.34KB60.98KB
plugin-editor (index.js)2.46KB1.10KB
plugin-form (index.js)125.63KB30.64KB
plugin-gantt (index.js)164.10KB39.87KB
plugin-grid (index.js)200.79KB54.26KB
plugin-kanban (index.js)52.93KB14.60KB
plugin-list (index.js)111.80KB27.20KB
plugin-map (index.js)20.06KB6.62KB
plugin-markdown (index.js)13.72KB4.69KB
plugin-report (index.js)43.49KB11.93KB
plugin-timeline (index.js)26.68KB7.66KB
plugin-tree (index.js)8.50KB2.88KB
plugin-view (index.js)84.61KB20.74KB
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)3.77KB1.33KB
react (SchemaRenderer.js)44.39KB14.99KB
react (data-invalidation.js)5.05KB2.08KB
react (index.js)1.33KB0.69KB
react (schema-input.js)2.32KB1.24KB
react (spec-input.js)0.20KB0.18KB
sdui-parser (codegen.js)5.41KB2.34KB
sdui-parser (index.js)4.77KB2.16KB
sdui-parser (input-type.js)2.84KB1.40KB
sdui-parser (parse.js)12.13KB3.65KB
sdui-parser (provenance.js)3.66KB1.82KB
sdui-parser (types.js)0.28KB0.23KB
sdui-parser (validate.js)6.92KB2.40KB
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 (dashboard-filter-alias.js)6.23KB2.74KB
types (data-display.js)0.20KB0.18KB
types (data-protocol.js)0.20KB0.19KB
types (data.js)0.20KB0.18KB
types (designer.js)1.87KB0.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 (index.js)3.88KB1.85KB
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)3.40KB1.68KB
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

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.

ActiveOrganizationStorage.clear() swallows a failed removeItem, so a cleared org can stay readable — asymmetry noted, reachability NOT demonstrated

2 participants

@os-zhuang@claude