Skip to content

fix(plugin-timeline): gate the record query on the settled object definition (objectui#7895) - #7905

Merged
os-sam merged 1 commit into
mainfrom
claude/issue-7895-timeline-settled-schema-gate
Sep 6, 2026
Merged

fix(plugin-timeline): gate the record query on the settled object definition (objectui#7895)#7905
os-sam merged 1 commit into
mainfrom
claude/issue-7895-timeline-settled-schema-gate

Conversation

@claude

@claude claude Bot commented Sep 6, 2026

Copy link
Copy Markdown
Contributor

Fixes #7895

ObjectTimeline takes the settled-schema gate objectui#6482 converged the record views on. The local useState for the object definition and its hand-written metadata effect are replaced by the shared useSettledSchema from @object-ui/react, and the record-fetch effect now waits on that resolution instead of listing the definition in its dependency array and re-running once it lands.

ObjectGantt (objectui#7225 ask 2) is the worked example this follows; ObjectCalendar (objectui#6453) is the other. No third shape was designed — the set was deliberately converged and this was its last unconverted member, with nothing marking it a deliberate exclusion.

The measurement — a green run with no hold is zero evidence here

This container settles the metadata read and the record read together by default, so the defect is invisible unperturbed. The lever is the metadata fetch, so getObjectSchema was held by a fixed delay and the writes into an instrumented renderer counted per SINGLE mount, with ObjectCalendar and ObjectGantt in the same vitest run as positive controls. Grid: 0/1/2/3/4/5/6/7/8/9/10/15/25/50/100 ms, one mount per hold. This is PR #7892's measurement shape, re-run on both sides of the change.

BeforeObjectTimeline, 2 find calls, expand sets [null, ['owner']] at every hold:

hold paints at green paints total late writes first paint
+0 ms 1 1 0 (warm-up)
+1 ms 1 1 0 5 ms
+2 ms 1 2 1 5 ms
+3 ms 1 4 3 3 ms
+4 … +100 ms 1 4 3 3-7 ms

The card's expected N=3 at +25 ms reproduced exactly, and the refined grid located its lower edge: nothing at +0/+1, one late write at +2, the full three from +3 ms up. The unperturbed rows show nothing, which is the reading objectui#7466 paid for.

After — one find, carrying ['owner'], at every hold:

hold paints at green paints total late writes first paint
+3 ms 1 1 0 8 ms
+10 ms 1 1 0 19 ms
+25 ms 1 1 0 30 ms
+50 ms 1 1 0 55 ms
+100 ms 1 1 0 105 ms

First paint tracks the hold. That is the signature that the gate is live, not an absence of observation: before the change the first paint sat at a flat 3-7 ms whatever the hold, i.e. it arrived before the metadata; after it moves with the hold the way both gated siblings already did.

Positive controls, same runs. ObjectCalendar and ObjectGantt read 1 paint / 0 late writes / 1 expanded find at every hold, before and after, with their first paint tracking the hold throughout (calendar 29 ms at +25 and 103 ms at +100; gantt 29 ms and 104 ms). They are what make the timeline's zeroes readable: the instrument does fire, in this container, on this day, in those same runs.

Second-order reading — the objectui#7466 fixture no longer reddens

The double paint is what made the timeline ladder fixture intermittently red, so the question was put to the same instrument: does the fixture still redden under the pre-#7521 harness shape — module global, arity-only predicate, no unmount, a re-read of the global — with two renders inside one it? Measured in the 1-9 ms window, 10 repetitions per hold, the fix reverted and then restored:

pre-#7521 harness, rung 2 +1 +2 +3 +4 +5 +6 +7 +8 +9 total
fix reverted 8 5 9 9 6 1 1 1 0 40 fail / 90
fix in place 0 0 0 0 0 0 0 0 0 0 fail / 90

Failures carry the card's exact signature — second=["#abc"] where ["#123456"] was authored, the first render's colour read back out of the module global by the second. The answer is that it no longer reddens there, which is this card's second delivered reading rather than a claim that no second mechanism exists: the window swept is 1-9 ms and the shape swept is that one fixture.

No guard was deleted or relaxed because of it. A guard's value does not depend on there currently being a live trigger, and ObjectTimeline.colorFieldLadder-7243.test.tsx is untouched by this PR.

Reverse verification

The fix was committed first, then reverted with git checkout pinned to the base commit d9580f464 (never to a moving remote-tracking name), the mutation confirmed on disk by blob hash (1b4575d, against HEAD's 6eae2ef), and restored from HEAD under a trap. Restoration proved by an empty git diff HEAD and a matching blob hash, not by an exit code.

With the fix reverted, the new pin reads 4 failed / 2 passed. The two that stay green are the two whose behaviour the gate does not change: the adapter that exposes no getObjectSchema (one query either way) and the authored-items timeline (no query either way). Predicted before running: the first two cases red. Observed: those two plus the held-paint case (the mechanism itself) and the rejecting-read case, the latter because the replaced effect logged through console.warn with its own wording where the shared hook logs [useSettledSchema] through console.error. Direction as predicted, magnitude higher, reported rather than adjusted.

Two deliberate departures from the sibling conversions

  1. The metadata read is NOT disabled for an inline/authored path. ObjectCalendar and ObjectGantt pass hasInlineData ? undefined : dataSource, because they read metadata only to expand a record query. This component also reads the definition's fields in effectiveItems — option colours and field labels — on the authored-items path, where no query is issued at all. Their recipe would take that read away; a fetch-sequencing change must not.
  2. The key is schema.objectName, not resolveRecordSourceObjectName. That is the object the record query itself names (dataSource.find(schema.objectName, …)) and the one the replaced effect read. This component resolves no data block to take a second name from, and gating on a key the query does not use is the stale-key mismatch the hook's render-time comparison exists to make unrepresentable.

Scope

Internal fetch sequencing only. No schema key, no zod, no validator accept/reject behaviour, no gate predicate and no scan population moved. useTimelineTranslation.ts (objectui#7874 / PR #7887's surface, since landed on main) is untouched; the $expand set and its FLS gate are objectui#7429's concern and are untouched; ObjectGantt and ObjectCalendar are untouched.

Filed while here, deliberately out of scope for this PR: objectui#7903 — ObjectGallery in packages/plugin-list carries the identical pre-gate shape, including the same log wording. Out of this card's binding file surface, so it is an unassigned finding rather than a rider on this PR.

Changeset

node scripts/check-changeset-presence.mjs, verbatim (the verdict line is prefixed with a green check in the real output; transcribed here as OK so the character survives):

Compared the working tree with d9580f464 (merge-base with origin/main): 2 file(s) changed, 1 of them published source of a package the release covers, 0 of them a manifest whose published contract moved, 0 under a package changesets ignores, 1 changeset(s) added.
OK  2 source file(s) of 1 released package(s) changed, and this change declares 1 changeset(s): .changeset/7895-timeline-settled-schema-gate.md.

Scored patch: one fewer round trip per load and no three-step paint is user-visible, so the empty-frontmatter form would have declared something untrue.

Verification

Re-run after the final commit, on the pushed SHA aca81f48a, with git diff HEAD empty:

  • pnpm exec vitest run packages/plugin-timeline/24 files / 297 tests passed (23 pre-existing files plus the new pin; the pin's 6 cases verified by name in a verbose run)
  • pnpm --filter @object-ui/plugin-timeline run type-check — Done (tsc --noEmit && tsc -p tsconfig.test.json). Not vacuous: tsc -p tsconfig.test.json --listFiles names both src/ObjectTimeline.tsx and src/ObjectTimeline.fetchGate-7895.test.tsx, so it is a real reading about them
  • pnpm --filter @object-ui/plugin-timeline run lint0 errors (109 pre-existing warnings)
  • check-changeset-presence, check-changeset-no-major, check-changeset-overwrite, check-changeset-fixed, check-control-bytes, check-vi-mock-specifiers, check-vi-mock-inherit, check-unreferenced-sources, check-lint-coverage, check-type-check-coverage, check-package-self-import, check-i18n-call-site-keys, check-i18n-dead-keys, check-side-effects-array, check-entry-guard — all exit 0
  • check-governed-queue-guard --test on all three changed paths — NOT GOVERNED, 3 path(s) checked against 5 governed surface(s); none matched
  • NOT MEASURED, and reported as such: check-readme-exports and check-sdui-registration-pins both exit non-zero here for a missing prerequisite, not a finding — they say so themselves (its type entry ./dist/index.d.ts is not on disk -- run pnpm build first, and No console build to weigh at apps/console/dist/assets). Neither is in the family derived from these paths, and CI builds before running them.

Repo-wide pnpm lint is left to CI; plugin-timeline was linted in full and the config is not type-aware, so this change cannot move a judgement on a file it does not touch.

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


Generated by Claude Code

…inition (objectui#7895)

`ObjectTimeline` was the last member of the set objectui#6482 converged on the
shared settled-schema gate, and nothing marked it a deliberate exclusion. It
held the object definition in a local `useState` fed by its own metadata effect
and listed that definition in the record-fetch effect's dependency array, so
every object-bound load issued two `find` calls — the first unexpanded, before
the definition landed — and, whenever the metadata read was the slower of the
two, painted three times.

The resolution half is now `useSettledSchema` (`@object-ui/react`), which
settles on every exit; the gate holds only the branch that issues the query.
The metadata read is deliberately NOT disabled for an authored-items timeline:
unlike the two sibling conversions, this component reads the definition's
fields for option colours and labels on that path.

Measured with an instrumented renderer, one mount per hold, `getObjectSchema`
held over a refined grid, `ObjectCalendar` and `ObjectGantt` as positive
controls in the same vitest run: before, 2 finds with expand sets
`[null, ['owner']]`, 1 paint plus 3 late writes at every hold from +3ms up;
after, 1 expanded find, 1 paint, 0 late writes, first paint tracking the hold.

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

github-actions Bot commented Sep 6, 2026

Copy link
Copy Markdown
Contributor

✅ Console Performance Budget

Metric Value Budget
Eager closure (gzip, 50 chunks) 3187.2 KB 3191.4 KB
Main entry chunk (gzip) 143.4 KB 350 KB
Entry file index-BdGb1UvH.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) 15.67KB 5.75KB
app-shell (runtime-config.js) 20.68KB 7.36KB
app-shell (types.js) 0.01KB 0.04KB
app-shell (urlParams.js) 10.06KB 3.86KB
auth (ActiveOrganizationStorage.js) 25.05KB 9.16KB
auth (AuthContext.js) 0.31KB 0.24KB
auth (AuthGuard.js) 2.07KB 1.00KB
auth (AuthProvider.js) 40.18KB 10.59KB
auth (AuthShell.js) 3.49KB 1.40KB
auth (ForgotPasswordForm.js) 12.21KB 3.45KB
auth (LoginForm.js) 18.15KB 5.39KB
auth (PreviewBanner.js) 0.90KB 0.50KB
auth (RegisterForm.js) 6.65KB 2.22KB
auth (SocialSignInButtons.js) 9.61KB 3.89KB
auth (UserMenu.js) 3.41KB 1.23KB
auth (auth-gate-events.js) 1.29KB 0.66KB
auth (authStyles.js) 5.04KB 1.72KB
auth (createAuthClient.js) 40.21KB 10.80KB
auth (createAuthenticatedFetch.js) 8.46KB 3.43KB
auth (index.js) 3.19KB 1.44KB
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) 5.13KB 2.35KB
collaboration (CommentThread.js) 26.08KB 7.56KB
collaboration (LiveCursors.js) 3.17KB 1.27KB
collaboration (PresenceAvatars.js) 6.49KB 2.64KB
collaboration (PresenceProvider.js) 2.79KB 1.13KB
collaboration (index.js) 1.68KB 0.73KB
collaboration (useCollaborationTranslation.js) 6.05KB 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) 510.60KB 116.20KB
core (index.js) 6.96KB 2.79KB
create-plugin (index.js) 10.08KB 3.26KB
data-objectstack (index.js) 182.08KB 50.62KB
fields (index.js) 242.44KB 61.25KB
i18n (LocalizationContext.js) 1.76KB 0.96KB
i18n (builtinAggregateLabels.js) 0.86KB 0.49KB
i18n (currency.js) 1.22KB 0.64KB
i18n (fallbackInterpolation.js) 6.25KB 2.77KB
i18n (i18n.js) 4.28KB 1.75KB
i18n (index.js) 3.65KB 1.47KB
i18n (pickLocalized.js) 7.62KB 3.26KB
i18n (provider.js) 26.89KB 9.04KB
i18n (useDisplayLocale.js) 2.85KB 1.45KB
i18n (useObjectLabel.js) 34.34KB 9.17KB
i18n (useSafeTranslation.js) 5.60KB 2.33KB
layout (index.js) 38.98KB 10.98KB
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) 2.53KB 0.85KB
mobile (useResponsive.js) 0.72KB 0.42KB
mobile (useSpecGesture.js) 4.39KB 1.66KB
mobile (useTouchTarget.js) 1.01KB 0.54KB
permissions (MePermissionsProvider.js) 11.71KB 4.29KB
permissions (PermissionContext.js) 0.31KB 0.25KB
permissions (PermissionGuard.js) 0.89KB 0.45KB
permissions (PermissionProvider.js) 6.24KB 2.16KB
permissions (discardProofCache.js) 1.04KB 0.55KB
permissions (evaluator.js) 5.12KB 1.74KB
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) 15.75KB 3.80KB
plugin-calendar (index.js) 47.87KB 13.31KB
plugin-charts (index.js) 70.92KB 19.75KB
plugin-chatbot (index.js) 196.19KB 46.37KB
plugin-dashboard (index.js) 132.88KB 34.69KB
plugin-designer (index.js) 212.86KB 43.19KB
plugin-detail (index.js) 250.55KB 64.06KB
plugin-editor (index.js) 2.46KB 1.10KB
plugin-form (index.js) 132.87KB 32.66KB
plugin-gantt (index.js) 167.26KB 41.00KB
plugin-grid (index.js) 209.29KB 56.78KB
plugin-kanban (index.js) 52.71KB 14.55KB
plugin-list (index.js) 113.76KB 27.75KB
plugin-map (index.js) 20.44KB 6.78KB
plugin-markdown (index.js) 13.93KB 4.81KB
plugin-report (index.js) 43.59KB 11.97KB
plugin-timeline (index.js) 30.40KB 8.76KB
plugin-tree (index.js) 9.20KB 3.19KB
plugin-view (index.js) 85.24KB 20.94KB
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.66KB 3.50KB
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) 81.07KB 26.86KB
react (data-invalidation.js) 5.05KB 2.08KB
react (index.js) 4.63KB 2.18KB
react (schema-input.js) 2.32KB 1.24KB
react (spec-input.js) 0.20KB 0.18KB
sdui-parser (codegen.js) 5.41KB 2.34KB
sdui-parser (dashboard-widget-options.js) 3.08KB 1.30KB
sdui-parser (index.js) 4.93KB 2.24KB
sdui-parser (input-type.js) 2.84KB 1.40KB
sdui-parser (parse.js) 20.57KB 5.88KB
sdui-parser (provenance.js) 3.66KB 1.82KB
sdui-parser (types.js) 0.28KB 0.23KB
sdui-parser (validate.js) 10.35KB 3.60KB
types (ai.js) 0.20KB 0.17KB
types (api-types.js) 0.20KB 0.18KB
types (app.js) 2.87KB 1.00KB
types (base.js) 0.20KB 0.18KB
types (blocks.js) 0.20KB 0.18KB
types (complex.js) 2.74KB 1.41KB
types (crud.js) 0.20KB 0.18KB
types (dashboard-filter-alias.js) 6.23KB 2.74KB
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) 0.20KB 0.18KB
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) 4.74KB 2.25KB
types (layout.js) 0.20KB 0.18KB
types (managed-by.js) 0.19KB 0.18KB
types (mobile.js) 4.73KB 2.28KB
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 (select-option.js) 0.20KB 0.19KB
types (spec-report.js) 5.05KB 1.93KB
types (spec-ui-namespace.js) 0.20KB 0.19KB
types (system-fields.js) 3.33KB 1.54KB
types (theme.js) 6.28KB 2.87KB
types (ui-action.js) 8.11KB 3.32KB
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-sam
os-sam marked this pull request as ready for review September 6, 2026 02:42
@os-sam
os-sam added this pull request to the merge queue Sep 6, 2026
Merged via the queue into main with commit 37043cf Sep 6, 2026
34 checks passed
@os-sam
os-sam deleted the claude/issue-7895-timeline-settled-schema-gate branch September 6, 2026 02:57
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.

ObjectTimeline never took the settled-schema gate — 2 find calls and a second paint per load, the last unconverted member of #6482 / #7225

2 participants