Skip to content

fix(plugin-dashboard): route DatasetWidget's option-color probe through the host apiFetch - #4134

Merged
yinlianghui merged 1 commit into
mainfrom
claude/issue-4121-datasetwidget-apifetch
Aug 10, 2026
Merged

fix(plugin-dashboard): route DatasetWidget's option-color probe through the host apiFetch#4134
yinlianghui merged 1 commit into
mainfrom
claude/issue-4121-datasetwidget-apifetch

Conversation

@yinlianghui

Copy link
Copy Markdown
Collaborator

Fixes#4121

Branched off origin/main @ bcd3e0219 — that tip is PR #4122's merge commit, so the ObjectChart sibling is already on main and this is not stacked. Different package, no shared code; the two fixes only share a pattern.

Premise: verified, still valid

The bare read is exactly where the issue said, at the unchanged line number on bcd3e0219:

589: const res = await fetch(`/api/v1/meta/object/${encodeURIComponent(object)}`, { headers: { accept: 'application/json' }, credentials: 'include' });

Both halves of the claim hold:

  • Silent-failure shape — the effect's body is wrapped in try { … } catch { … setCategoryColors(null); setDimensionLabels(null); setCategoryOrder(null); }. Every failure, including a 401, is swallowed into "no colors, no labels", never an error state. Note it also nulls categoryOrder, so a third product of this one document (the declared category order, framework#3588) was silently lost too.
  • One bare fetch, not more — grepping fetch across the whole file, and then across all of packages/plugin-dashboard/src (non-test), returns exactly this one call site. The card said to measure rather than trust the cited line; measured, one is the true count.

The card's one real decision: where the channel comes from

The filing dev flagged that unlike ObjectChart, DatasetWidget consults no context today — it takes dataSource as a prop (DatasetWidget({ widget, dataSource }), and DashboardRenderer passes it down). So there was nothing to hang apiFetch off.

The component's structure does not prevent the family convention — the fetch happens inside a normal useEffect in a normal function component — so the default applies and no second channel was invented:

constapiFetch=useContext(SchemaRendererContext)?.apiFetch;constdoFetch=apiFetch??fetch;

Two details taken from the references rather than invented:

  • The context is read directly, not via useSchemaContext() — that hook throws with no provider mounted. This matters more here than it did for ObjectChart: every existing suite in this package mounts the widget bare, so the throwing hook would have turned a routing fix into a package-wide red.
  • apiFetch joins the effect's dependency array, as it does in useRecordEditable's.

The effect-deps question, checked against THIS file

This file does carry a documented refetch concern, but it is on the other effect and it does not transfer. The query effect is keyed on a hand-built signature string precisely because the resolved filter carries a render-time now; that is a value the component recomputes every render, which is what would loop.

apiFetch is not that kind of value: it arrives from SchemaRendererProvider's useMemo'd context value (SchemaRendererContext.tsx:42-43), and this widget's own setState cannot re-render the provider — so the identity is stable across the effect's own updates. The sole in-repo host settles it outright by holding the function at module scope: ConsoleShell.tsx:187:245. No restructuring was needed.

Behavior boundary — the fallback half is pinned, not assumed

Standalone embeds keep working on the global fetch, and there are two distinct no-channel shapes, both pinned:

  1. no provider at all — the shape every existing test in this package uses;
  2. a provider that supplies dataSource but no apiFetch. Presence of a host is not presence of a channel.

Tests

Three pins added to DatasetWidget.relabel.test.tsx — the file the card named, which already answers this exact endpoint from a double — in a new objectui#4121 block. Extended, not duplicated: no new test file, and the existing double is untouched. Routing is read off two separate recorders, the global stub plus a standalone recorder handed in as the provider's apiFetch:

  • host-mounted → the probe is in the host recorder, the global recorder is empty, the request init survives the hop (accept: application/json), and the routed answer is consumed — both products of the document reach the renderer (the value→label relabeling and the first dimension's semantic categoryColors);
  • no provider → global recorder holds the probe;
  • provider without apiFetch → global recorder holds the probe.

Both recorders answer the same document, so the data path stays green either way and the only thing these pins can go red on is the routing itself.

No existing test changed in meaning. The two cloud#667 relabeling tests are untouched — which follows from the behavior boundary above: they mount no provider, so the routing change genuinely moves nothing for them.

Verification

Repo root, both packages, per AGENTS.md:

pnpm exec vitest run packages/plugin-dashboard/ packages/plugin-charts/ --maxWorkers=2
Test Files 54 passed (54)
Tests 449 passed (449) # 446 on main + 3 new
$ wc -c stderr => 0
$ grep -c ECONNREFUSED stderr => 0

stderr stays entirely empty — the #4115/#4106 no-live-request guarantee survives the routing change.

Reverse verification, direction predicted before running: revert only the product routing (git checkout origin/main -- DatasetWidget.tsx, new tests held) and exactly one pin goes red — the host-mounted one — while the two fallback pins and both cloud#667 tests stay green, because with no channel supplied pre-fix and post-fix code do the identical thing.

× rides the host apiFetch when a provider supplies one, and never the global fetch
AssertionError: expected [] to deeply equal [ '/api/v1/meta/object/tk5f_customer' ]
Tests 1 failed | 4 passed (5)

Exactly as predicted, 1 red / 4 green, and the failure names the host recorder holding nothing — the escape landing in the global recorder instead. Restored afterwards; git diff matches the pre-revert diffstat.

Gates: pnpm --filter @object-ui/plugin-dashboard type-check green (after pnpm --filter '@object-ui/plugin-dashboard^...' build, the fresh-worktree dependency closure). eslint on both changed files 0 errors; warning counts measured against origin/main file-by-file — DatasetWidget.tsx is 11 before and 11 after, the test file 6 before and 6 after, so the new pins add zero. check:control-bytes green, plus a control-byte self-scan over the three changed files.

Changeset

@object-ui/plugin-dashboardpatch — a real behavior fix on a released package.


Generated by Claude Code

…gh the host apiFetch
The widget's `GET /api/v1/meta/object/{object}` read — which feeds
`buildOptionColorMap` (per-category colors for the first dimension) and
`buildDimensionLabelMap` (the value -> label maps for the axis/series) — went
out on the bare global `fetch`, bypassing whatever the host supplies on
`SchemaRendererContext.apiFetch`. The effect is best-effort and swallows every
failure, so a hosted console got no error at all: semantic colors and option
labels simply never applied.
DatasetWidget takes its `dataSource` as a prop and read no context, so the
channel is added here as a direct `useContext(SchemaRendererContext)` read (not
`useSchemaContext()`, which throws with no provider mounted) and used as
`apiFetch ?? fetch`, keeping the global fallback for standalone embeds.
The plugin-dashboard twin of #4114 / PR #4122.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017Qqyix2QcnpUC9XeYVDzx3
@vercel

vercelBot commented Aug 10, 2026

Copy link
Copy Markdown

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

1 Skipped Deployment
ProjectDeploymentActionsUpdated (UTC)
objectuiIgnoredIgnoredAug 10, 2026 12:01pm

Request Review

@github-actions

Copy link
Copy Markdown
Contributor

✅ Console Performance Budget

MetricValueBudget
Main entry (gzip)28.3 KB350 KB
Entry fileindex-750lV4DE.js
StatusPASS

📦 Bundle Size Report

PackageSizeGzipped
app-shell (index.js)8.66KB3.13KB
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.21KB3.45KB
auth (LoginForm.js)18.13KB5.39KB
auth (PreviewBanner.js)0.90KB0.50KB
auth (RegisterForm.js)6.64KB2.21KB
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.35KB1.07KB
auth (org-roles.js)6.66KB2.78KB
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)26.07KB7.56KB
collaboration (LiveCursors.js)3.17KB1.27KB
collaboration (PresenceAvatars.js)6.49KB2.64KB
collaboration (PresenceProvider.js)2.79KB1.13KB
collaboration (index.js)1.65KB0.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)485.06KB107.21KB
core (index.js)3.04KB1.15KB
create-plugin (index.js)10.08KB3.26KB
data-objectstack (index.js)140.66KB36.25KB
fields (index.js)229.40KB56.93KB
i18n (LocalizationContext.js)1.76KB0.96KB
i18n (currency.js)1.22KB0.64KB
i18n (i18n.js)4.32KB1.77KB
i18n (index.js)2.65KB1.06KB
i18n (pickLocalized.js)1.70KB0.83KB
i18n (provider.js)9.48KB3.27KB
i18n (useObjectLabel.js)27.59KB6.63KB
i18n (useSafeTranslation.js)4.52KB1.96KB
layout (index.js)38.87KB10.80KB
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)6.96KB1.98KB
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)4.32KB1.64KB
mobile (useTouchTarget.js)1.01KB0.54KB
permissions (MePermissionsProvider.js)8.75KB3.06KB
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)45.23KB12.45KB
plugin-charts (index.js)61.52KB17.49KB
plugin-chatbot (index.js)180.33KB42.79KB
plugin-dashboard (index.js)118.52KB30.68KB
plugin-designer (index.js)210.51KB42.51KB
plugin-detail (index.js)237.80KB59.48KB
plugin-editor (index.js)2.46KB1.10KB
plugin-form (index.js)114.58KB27.68KB
plugin-gantt (index.js)162.81KB39.67KB
plugin-grid (index.js)188.04KB49.91KB
plugin-kanban (index.js)48.60KB13.41KB
plugin-list (index.js)110.04KB26.67KB
plugin-map (index.js)17.00KB5.32KB
plugin-markdown (index.js)13.72KB4.69KB
plugin-report (index.js)40.58KB10.58KB
plugin-timeline (index.js)26.21KB7.52KB
plugin-tree (index.js)8.50KB2.88KB
plugin-view (index.js)84.03KB20.55KB
providers (DataSourceProvider.js)0.75KB0.39KB
providers (MetadataProvider.js)1.37KB0.59KB
providers (ThemeProvider.js)1.90KB0.85KB
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)23.71KB7.95KB
react (data-invalidation.js)5.05KB2.08KB
react (index.js)1.23KB0.66KB
react (spec-input.js)0.20KB0.18KB
sdui-parser (codegen.js)4.09KB1.74KB
sdui-parser (index.js)4.47KB2.03KB
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)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-retry.js)4.32KB2.02KB
types (index.js)2.71KB1.34KB
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 (system-fields.js)3.33KB1.54KB
types (theme.js)0.20KB0.18KB
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

2 participants

@yinlianghui@claude