Skip to content

fix(data-objectstack): a console page load reads sys_user_preference once, shared by the three preference adapters (objectui#12187) - #12241

Merged
objectstack-fleet[bot] merged 4 commits into
mainfrom
claude/issue-12187-user-preference-one-read
Oct 12, 2026
Merged

objectstack-fleet[bot] merged 4 commits into
mainfrom
claude/issue-12187-user-preference-one-read

Conversation

@objectstack-fleet

Copy link
Copy Markdown
Contributor

Fixes #12187

Clause-②: no

This is item 3 of objectui#12187, and the last one: one sys_user_preference read per console load. Items 1 (54159d3) and 2 (6eca5b5) landed earlier, and this PR does not touch their code. Claim 6119197321, amended for this item by 6122942302.

What changes

The change is to createObjectStackUserStateAdapter in @object-ui/data-objectstack (userState.ts). Its load() now joins an open read for its data source, resource and user. Every load in that scope that starts before the next microtask adds its key to that read. The read is then sent once, and each adapter takes its own row from the answer.

  • One key in the read: it sends the same per-key query the adapter has always sent (user_id = U and key = K, $top: 1).
  • Several keys in the read: it sends one query, user_id = U and key in (K1, K2, K3), with $top set to the number of keys.
  • Nothing is cached. The read closes as soon as it is sent. A later load() asks the server again, and a different user or data source never joins another one's read.
  • save() is unchanged. A write still finds and writes its own row: a per-key find, then an update or an insert.
  • Out of scope, untouched: the server, the stored rows and the row shape.

ConsoleShell.tsx does not change. Its UserStateBridge already builds the three adapters in one effect, so the providers' loads land in one read. No reader makes a read of its own, so no reader file changes.

Published surface:

  • index.ts is unchanged.
  • userState.ts has the same export lines as at the base (diff exit 0).
  • ObjectStackUserStateAdapterOptions is the same as at the base (diff exit 0).
  • The new functions and the SharedRead interface are module-private.
  • The only change that reaches dist/index.d.ts is one new paragraph of text in the module's header comment, which tsup copies into it.

Hence Clause-②: no and a patch changeset for @object-ui/data-objectstack. @object-ui/app-shell only changes a test.

H1: the reads per load, before and after

How it was measured: a jsdom boot of the real ConsoleShell providers and the real ConnectedShell over a counting global fetch. The shell includes the real AdapterProvider, ObjectStackAdapter, client and UserStateBridge. Two entries were booted: /apps/demo/page/welcome, and / with a metadata-gated redirect to that page. Only the session is stood in. The call sites come from a sync stack read at ObjectStackAdapter.find. The probe was a scratch file and is not committed. The committed pin is consoleUserPreferenceBudget.test.tsx (see Tests).

Before: at base adfbe3b (main, which contains 6eca5b5). Each entry made 3 GETs, each filtered by one key, not by the user's whole set:

# request (both entries) call site
1 GET /api/v1/data/sys_user_preference?top=1&filter=["and",["user_id","=","u1"],["key","=","ui.flow.palette.recents"]] FlowPaletteRecentsProvider hydrate effect, then adapter.load(), findExisting, ObjectStackAdapter.find
2 same, ["key","=","ui.recent"] RecentItemsProvider hydrate effect, same chain
3 same, ["key","=","ui.favorites"] FavoritesProvider hydrate effect, same chain

After: at this head, each entry made 1 GET:

GET /api/v1/data/sys_user_preference?top=3&filter=["and",["user_id","=","u1"],["key","in",["ui.flow.palette.recents","ui.recent","ui.favorites"]]]

The same three provider effects issue it, now joined into one read.

The / entry does not remount ConnectedShell on its redirect: the same element type sits at the same position. So it also reads once, before and after.

Browser reading: NOT MEASURED. Reason: this container has no runnable backend for a signed-in console. The jsdom boot is the instrument. The staging reading (cloud's pin carrying this merge) is the card's acceptance 3, and it stays with the seat.

H2: the shape chosen, and why

Chosen: the share lives inside userState.ts. A module-scope WeakMap holds the open reads, keyed by the data-source object and then by (resource, user). This adds no export, option or type.

Not chosen: one loader built in ConsoleShell and passed to the three adapters. That needs a new option on the factory, which widens the published surface.

Why key in the three keys, and not the user's whole set:

  • The whole set carries every other preference the user has. The object's own description names theme, locale and plugin settings.
  • A page cap on that larger set could drop one of the three keys.
  • The membership query reads exactly the rows the three per-key reads did. It uses the same user_id predicate.
  • The object's unique index on (user_id, key), per organization, allows at most one row per key. So a $top equal to the key count drops none.
  • The server's filter AST accepts in: it is an AST_OPERATOR_MAP key behind VALID_AST_OPERATORS in @objectstack/spec's data/filter.zod.ts, and driver-sql's operator switch has an in arm. I read these sources at objectstack 2e11d9006. No live server was run here.
  • objectui already sends $in reads through find with $top equal to the list length (AccessExplainPanel).

A row that carries no key: in an answer for several keys it cannot be assigned to one. When that happens, each adapter reads its own key as before. The pin a shared answer whose rows name no key is not attributed covers this.

H3: refresh and invalidation

When each adapter reads:

  • No provider re-reads on focus or visibility.
  • The hydrate effects in FavoritesProvider, RecentItemsProvider and FlowPaletteRecentsProvider re-run only when the attached adapter or the user id changes.
  • The bridge builds new adapters when the user id changes, when the data source changes, or when it remounts under MetadataProvider key={language} on a language switch.
  • A write reads nothing back.
  • Cross-tab sync goes through localStorage events only.

Readings (same jsdom boot; the "before" column was taken under the ablation below):

  • Account switch, u1 to u2: before, 6 GETs: 3 for u1 from the outgoing adapters, whose answers the providers' hydration token discards, plus 3 for u2. After, 2 GETs: 1 plus 1. The u2 read asks for u2's three keys, and every consumer ends on u2's rows.
  • A load after the read was sent: a new request. With one key, it is the per-key query.
  • Writes after boot: 3 writes, one PATCH to each adapter's own row id, and no extra GET.

H4

Neither GET /api/v1/runtime/config nor GET /api/v1/auth/me/localization appears in this boot reading. Their initiators (index.html applyEarlyBranding and app-shell initRuntimeConfig, called from main.tsx) are outside the mounted tree, so whether they double is not measured here.

This reverses an earlier reading

objectui#5544 and objectui#11797 recorded three reads per load as the correct budget ("three different questions"), and their pins held that. objectui#12187 rules the budget at one.

  • consoleUserPreferenceBudget.test.tsx (the objectui#5544 file) is rewritten.
    • It now boots the real shell instead of a copy of the bridge.
    • It pins one read, and keeps the payload half that objectui#5544 cared about: every consumer still gets its own row.
  • userState.inflightShare-11797.test.ts: the first case moves to the shared read. The other two cases (one key loaded twice at once is one request; a load after a save reaches the server) are unchanged.

Tests (at 55be3d7, through the verify lock)

  • Build: turbo run build --filter='@object-ui/data-objectstack^...' --filter='@object-ui/app-shell^...' --concurrency=2: 28 successful. @object-ui/data-objectstack was rebuilt at head.
  • Type-check: @object-ui/data-objectstack type-check (tsc --noEmit) and @object-ui/app-shell type-check (tsc --noEmit && tsc -p tsconfig.test.json). Both pass, and both scripts were echoed. --listFilesOnly shows that both programs compile the edited tests.
  • Targeted vitest: every test file that names createObjectStackUserStateAdapter, sys_user_preference or UserStateAdapters, including the new pins: Test Files 14 passed (14), Tests 161 passed (161).
  • The pins:
    • consoleUserPreferenceBudget.test.tsx, five cases: one read per boot asking for the three keys; every consumer gets its own row; each adapter writes only its own row; an account switch reads again for the new user; one key loaded twice at once is one request.
    • userState.sharedRead-12187.test.ts, six cases: user scope; nothing kept past the send; data-source scope; untagged rows; a failed read; writes unchanged.
  • Ablation, with the fix committed first, through objectstack scripts/ablation-replace.mjs:
    • The mutation was const row = await loadExisting(); to const row = await findExisting();, which turns the share off. Anchor 1 to 0, blob cc27d4d to bc3fb25.
    • Predicted direction: red. Result: 12 failed, 8 passed across the four files. Every count pin fails with three reads where it expects one ("expected … to have a length of 1 but got 3"). The cases that do not depend on the share stayed green: same-key coalescing, user scope, data-source scope, writes.
    • Restore: blob equals HEAD (cc27d4d), and git diff HEAD is empty.
    • The pins import source through the vitest alias, so no dist/ is on their resolution path.
  • Gates, all exit 0: check:eager-closure (Console eager closure is 3126.9 KB gzipped across 70 of 2253 chunks (budget: 3204.6 KB, headroom: 77.6 KB), membership exact, on a console vite build at head), check-changeset-presence, check:changeset-claims, check:pending-changeset-literals, check:control-bytes, check:new-line-citations (0 new), check:vi-mock-specifiers, check:vi-mock-inherit, check:vi-mock-override-shape, check:test-path-roots, changeset:check.
  • ESLint, narrowed and measured: eslint --no-inline-config --format json over the 4 changed .ts/.tsx files.
    • Result: 4 files, 0 errors, 1 warning. The warning is the existing DataSource typed with any on the options member; the base file has the same 1.
    • The **/*.{ts,tsx} block of eslint.config.js covers all four files.
    • The narrowing excludes nothing: linting is not type-aware (a grep for projectService|typeChecked|tsconfigRootDir|parserOptions exits 1), and no eslint-rules/*.js reads the filesystem. So the diff cannot change the verdict on an untouched file.
    • The repo-wide pnpm lint belongs to CI.

Acceptance notes

  • Pre-existing, unchanged in kind: on an account switch, the outgoing adapters still make one read for the previous user before the bridge attaches the new ones. The providers discard that answer through their hydration token, so no consumer shows it. The count drops from 3 to 1 with this PR. Nothing is filed: there is no wrong answer to show for it, and no carrier.
  • The share covers only reads in flight. A bridge remount after the read was sent, such as a language switch, costs one more read. That is a later load, and it has to read afresh.

Session: https://claude.ai/code/session_016djJF12Qt14ejKR5Vjt4sK


Generated by Claude Code

…s_user_preference read per load

createObjectStackUserStateAdapter's load() now joins an open read for its
(data source, resource, user). Every load of that scope issued before the
next microtask adds its key; the read is then sent once and each adapter
takes its own row. One key keeps the per-key query; several go as one
`key in (...)` query with `$top` equal to the key count. Nothing is kept
past the send, and save() still finds and writes its own row.

Claude-Session: https://claude.ai/code/session_016djJF12Qt14ejKR5Vjt4sK
Co-authored-by: Claude <noreply@anthropic.com>
…r console boot

consoleUserPreferenceBudget now boots the real ConsoleShell and
ConnectedShell over a fake framework that answers preference reads by
user_id and key (= or in): one read per boot asking for the three keys,
every consumer gets its own row, each adapter writes its own row, and a
user switch reads again for the new user. The 11797 wire pin's first case
moves to the shared read; userState.sharedRead-12187 pins the share's edges
(user and data-source scope, nothing kept past the send, untagged rows,
a failed read, writes unchanged).

Claude-Session: https://claude.ai/code/session_016djJF12Qt14ejKR5Vjt4sK
Co-authored-by: Claude <noreply@anthropic.com>
… options member, not a new any

Claude-Session: https://claude.ai/code/session_016djJF12Qt14ejKR5Vjt4sK
Co-authored-by: Claude <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
Contributor

✅ Console Performance Budget

Metric Value Budget
Eager closure (gzip, 70 chunks) 3128.6 KB 3204.6 KB
Main entry chunk (gzip) 73.1 KB 350 KB
Entry file index-DJqW15Az.js —
Status PASS —

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

Package Size Gzipped
app-shell (consoleActionDispatch.js) 0.20KB 0.19KB
app-shell (index.js) 20.69KB 7.62KB
app-shell (runtime-config.js) 22.59KB 7.89KB
app-shell (types.js) 0.01KB 0.04KB
app-shell (urlParams.js) 10.11KB 3.87KB
auth (ActiveOrganizationStorage.js) 27.95KB 10.04KB
auth (AuthContext.js) 0.31KB 0.24KB
auth (AuthGuard.js) 2.07KB 1.00KB
auth (AuthProvider.js) 40.22KB 10.61KB
auth (AuthShell.js) 3.49KB 1.40KB
auth (ForgotPasswordForm.js) 12.21KB 3.45KB
auth (LoginForm.js) 18.15KB 5.40KB
auth (PreviewBanner.js) 0.90KB 0.50KB
auth (RegisterForm.js) 6.72KB 2.24KB
auth (SocialSignInButtons.js) 9.70KB 3.93KB
auth (UserMenu.js) 3.39KB 1.21KB
auth (auth-gate-events.js) 1.29KB 0.66KB
auth (authStyles.js) 5.04KB 1.72KB
auth (createAuthClient.js) 41.19KB 11.12KB
auth (createAuthenticatedFetch.js) 8.54KB 3.46KB
auth (index.js) 3.63KB 1.64KB
auth (invitation-status.js) 1.22KB 0.70KB
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) 5.30KB 1.02KB
auth (useWorkspaceAdminStatus.js) 11.08KB 4.58KB
collaboration (CommentThread.js) 27.11KB 7.97KB
collaboration (LiveCursors.js) 3.17KB 1.27KB
collaboration (PresenceAvatars.js) 6.28KB 2.60KB
collaboration (PresenceProvider.js) 2.79KB 1.13KB
collaboration (index.js) 1.68KB 0.73KB
collaboration (useCollaborationTranslation.js) 6.50KB 2.52KB
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) 588.51KB 141.71KB
core (index.js) 10.18KB 4.04KB
create-plugin (index.js) 27.94KB 9.51KB
data-objectstack (index.js) 244.49KB 68.27KB
fields (index.js) 279.96KB 71.37KB
i18n (LocalizationContext.js) 2.92KB 1.42KB
i18n (builtinAggregateLabels.js) 0.86KB 0.49KB
i18n (currency.js) 2.59KB 1.22KB
i18n (fallbackInterpolation.js) 6.25KB 2.77KB
i18n (i18n.js) 8.87KB 3.64KB
i18n (index.js) 5.52KB 2.39KB
i18n (pickLocalized.js) 9.86KB 3.95KB
i18n (provider.js) 39.35KB 12.88KB
i18n (translateFn.js) 0.20KB 0.18KB
i18n (useDisplayLocale.js) 3.52KB 1.76KB
i18n (useObjectLabel.js) 36.87KB 9.88KB
i18n (useSafeTranslation.js) 7.14KB 2.92KB
layout (index.js) 40.26KB 11.71KB
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.75KB
mobile (index.js) 1.99KB 0.87KB
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) 6.62KB 2.45KB
mobile (useResponsive.js) 0.72KB 0.42KB
mobile (useSpecGesture.js) 5.52KB 2.10KB
mobile (useTouchTarget.js) 1.01KB 0.54KB
permissions (MePermissionsProvider.js) 15.35KB 5.51KB
permissions (PermissionContext.js) 0.31KB 0.25KB
permissions (PermissionGuard.js) 0.89KB 0.45KB
permissions (PermissionProvider.js) 6.82KB 2.38KB
permissions (discardProofCache.js) 1.04KB 0.55KB
permissions (evaluator.js) 8.33KB 3.07KB
permissions (index.js) 0.93KB 0.41KB
permissions (store.js) 0.91KB 0.42KB
permissions (useFieldPermissions.js) 1.28KB 0.53KB
permissions (usePermissions.js) 4.83KB 2.27KB
plugin-ai (index.js) 16.04KB 3.92KB
plugin-calendar (index.js) 54.31KB 15.86KB
plugin-charts (index.js) 84.72KB 23.27KB
plugin-chatbot (index.js) 201.72KB 48.07KB
plugin-dashboard (index.js) 144.20KB 38.95KB
plugin-designer (index.js) 233.77KB 50.02KB
plugin-detail (index.js) 251.02KB 66.27KB
plugin-editor (index.js) 2.23KB 1.05KB
plugin-form (index.js) 178.37KB 46.27KB
plugin-gantt (index.js) 178.63KB 45.19KB
plugin-grid (index.js) 255.09KB 70.91KB
plugin-kanban (index.js) 53.23KB 16.71KB
plugin-list (index.js) 123.03KB 31.28KB
plugin-map (index.js) 27.24KB 9.03KB
plugin-markdown (index.js) 13.88KB 4.80KB
plugin-report (index.js) 44.12KB 12.29KB
plugin-timeline (index.js) 39.21KB 11.85KB
plugin-tree (index.js) 15.07KB 5.33KB
plugin-view (index.js) 92.11KB 23.27KB
providers (DataSourceProvider.js) 0.75KB 0.39KB
providers (MetadataProvider.js) 1.37KB 0.59KB
providers (ThemeProvider.js) 1.90KB 0.85KB
providers (UploadProvider.js) 12.07KB 3.68KB
providers (index.js) 0.45KB 0.23KB
providers (types.js) 0.01KB 0.04KB
react-runtime (index.js) 5.62KB 2.34KB
react (LazyPluginLoader.js) 4.47KB 1.63KB
react (SchemaRenderer.js) 120.63KB 39.56KB
react (data-invalidation.js) 5.05KB 2.08KB
react (index.js) 4.50KB 2.06KB
react (schema-input.js) 4.31KB 2.07KB
react (spec-input.js) 0.20KB 0.18KB
sdui-parser (body-dialect.js) 4.50KB 1.99KB
sdui-parser (codegen.js) 9.45KB 3.76KB
sdui-parser (dashboard-widget-options.js) 3.07KB 1.30KB
sdui-parser (index.js) 7.30KB 3.12KB
sdui-parser (input-type.js) 2.84KB 1.40KB
sdui-parser (parse.js) 25.28KB 7.81KB
sdui-parser (provenance.js) 3.84KB 1.90KB
sdui-parser (types.js) 0.29KB 0.24KB
sdui-parser (validate.js) 23.87KB 7.83KB
types (ai.js) 4.39KB 2.17KB
types (api-types.js) 0.20KB 0.18KB
types (app.js) 4.12KB 1.61KB
types (authoring-nodes.js) 0.20KB 0.19KB
types (base.js) 0.20KB 0.18KB
types (blocks.js) 0.20KB 0.18KB
types (cloud.js) 0.20KB 0.18KB
types (complex.js) 4.44KB 2.07KB
types (crud.js) 0.20KB 0.18KB
types (dashboard-filter-alias.js) 6.23KB 2.74KB
types (dashboard-widget-layout.js) 2.06KB 0.96KB
types (data-display.js) 3.75KB 1.85KB
types (data-protocol.js) 0.20KB 0.19KB
types (data.js) 0.20KB 0.18KB
types (designer.js) 1.85KB 0.85KB
types (disclosure.js) 0.20KB 0.18KB
types (error-code.js) 1.54KB 0.88KB
types (expression.js) 0.20KB 0.18KB
types (feedback.js) 0.20KB 0.18KB
types (field-types.js) 1.13KB 0.65KB
types (form.js) 0.20KB 0.18KB
types (http-inflight.js) 8.87KB 3.73KB
types (http-retry.js) 4.32KB 2.02KB
types (icon-key-migration.js) 4.26KB 1.63KB
types (index.js) 5.78KB 2.70KB
types (layout.js) 0.20KB 0.18KB
types (managed-by.js) 0.19KB 0.18KB
types (mobile.js) 5.00KB 2.39KB
types (navigation.js) 0.20KB 0.18KB
types (node-slots.js) 7.18KB 2.34KB
types (objectql.js) 0.20KB 0.18KB
types (overlay.js) 0.20KB 0.18KB
types (permissions.js) 2.52KB 1.31KB
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 (select-option.js) 0.20KB 0.19KB
types (spec-report.js) 4.99KB 1.96KB
types (spec-ui-namespace.js) 0.20KB 0.19KB
types (strict-authoring-face.js) 19.93KB 7.26KB
types (system-fields.js) 3.33KB 1.54KB
types (theme.js) 6.28KB 2.87KB
types (ui-action.js) 8.48KB 3.50KB
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

@objectstack-fleet
objectstack-fleet Bot marked this pull request as ready for review October 12, 2026 12:00
@objectstack-fleet
objectstack-fleet Bot enabled auto-merge October 12, 2026 12:00
@objectstack-fleet
objectstack-fleet Bot added this pull request to the merge queue Oct 12, 2026
Merged via the queue into main with commit d48071e Oct 12, 2026
44 checks passed
@objectstack-fleet
objectstack-fleet Bot deleted the claude/issue-12187-user-preference-one-read branch October 12, 2026 12:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment