Skip to content

fix(plugin-report): derive report chart category colours and order (objectui#4906) - #5310

Merged
os-support-ai merged 1 commit into
mainfrom
claude/issue-4906-report-chart-option-colors
Aug 19, 2026
Merged

fix(plugin-report): derive report chart category colours and order (objectui#4906)#5310
os-support-ai merged 1 commit into
mainfrom
claude/issue-4906-report-chart-option-colors

Conversation

@os-support-ai

Copy link
Copy Markdown
Collaborator

Fixes#4906

What changed

A report chart derived neither its category dimension's option colours nor its declared category order — the same dimension on a dashboard chart got both. This wires buildOptionColorMap and buildCategoryOrder (@object-ui/core) into the report chart path via useDatasetDimensionMeta, the exact chain DatasetWidget (plugin-dashboard) already runs for its own chart. Per the triage ruling, this is cross-surface convergence onto an already-ruled behaviour (framework#3588's declared-picklist-order ruling), not new capability — no changes to packages/core.

This deliberately changes rendering — what visibly changes

For an existing report grouped by a select/lookup dimension:

  • A chart with no authored colors now paints each category in that dimension's own option colour (e.g. a health dimension now paints its own green/amber/red) instead of the renderer's positional palette.
  • A funnel/pyramid chart now orders its stages by the field's declared picklist order instead of sorting by value.

Precedence is unchanged: an authored colors record (objectui#4877) still wins over the derived per-category map — chartConfigPresentation's existing merge ({ ...fieldColors, ...authorColors }) already puts the author's map on top; the report path now just supplies the field-derived half it never used to.

Where

  • packages/plugin-report/src/DatasetReportRenderer.tsxDatasetReportChart now calls useDatasetDimensionMeta (not the label-only useDatasetDimensionLabels) and derives categoryColors/categoryOrder the same way DatasetWidget's own useMemo does (localizeFieldOptionsbuildOptionColorMap/buildCategoryOrder), passes categoryColors as chartConfigPresentation's second argument, and spreads categoryOrder onto the chart schema when derived.
  • packages/plugin-report/src/useDatasetDimensionLabels.ts — re-exports useDatasetDimensionMeta (the locale-free half) alongside the existing useDatasetDimensionLabels, since this is the one report call site that needs the metadata directly rather than only the label maps.
  • packages/plugin-report/src/__tests__/DatasetReportRenderer.chartCategoryConvergence.test.tsx — new. Pins the derived colours, the declared order, the precedence, and — the deliverable's real proof — that the report path's output is the literal output of the same @object-ui/core call chain DatasetWidget is written to make, over the same picklist.
  • .changeset/dataset-chart-category-colors-and-order.mdpatch on @object-ui/plugin-report.

Why "converges with the dashboard" isn't a live side-by-side render

DatasetWidget is plugin-dashboard's own internal implementation detail — it is not part of that package's public export surface (barrel or package.json#exports), the same shape DatasetReportChart has in this package. Reaching it from a plugin-report test would mean a deep, non-exported cross-package import that only resolves under this repo's root-vitest src alias and would not resolve at all through plugin-dashboard's published dist (no ./DatasetWidget subpath export) — plus a new plugin-report → plugin-dashboard dev dependency for one test. So the new test file pins convergence at the mechanism instead: the report chart's schema is asserted against the literal output of localizeFieldOptionsbuildOptionColorMap/buildCategoryOrder — the exact chain DatasetWidget's own useMemo is written to run — reproduced inline over the identical picklist, so agreement is provable rather than incidental.

Verification

Re-derived on current origin/main (de4e29a81, already includes #5304's CI fix) — no rebase needed.

Rebuild question: all tests run via the canonical pnpm exec vitest run packages/plugin-report/ from repo root. The root vitest.config.mts aliases @object-ui/core, @object-ui/react, and @object-ui/plugin-report directly to their src/ (not through package exports to dist), so buildOptionColorMap/buildCategoryOrder/useDatasetDimensionMeta resolve straight to source for this run — no stale-dist risk.

Reverse verification (predictions written before running, in the new test file's own header comment):

  • Committed the fix, then git checkout de4e29a81 -- packages/plugin-report/src/DatasetReportRenderer.tsx packages/plugin-report/src/useDatasetDimensionLabels.ts (source only; new test file kept).
  • Predicted 7 red / 2 green out of 9 its (2 green as decisions-not-pins: a pure fixture self-check that renders nothing, and the "no declared options → categoryOrder omitted" case, which held trivially before the fix too since the key was never spread under any input).
  • Observed: 7 failed / 2 passed, the same 2 named cases, matching case for case.
  • Restored via git checkout claude/issue-4906-report-chart-option-colors -- (the same two files); git status clean against HEAD.

Final commands, at HEAD 4bfb71054:

pnpm exec vitest run packages/plugin-report/ --maxWorkers=2
Test Files 14 passed (14)
Tests 161 passed (161)

(152 pre-existing + 9 new, all green.) Also ran, clean: pnpm --filter '@object-ui/plugin-report^...' build, pnpm --filter '@object-ui/plugin-report' build (both succeed — no type errors), node scripts/check-control-bytes.mjs, node scripts/check-phantom-dependencies.mjs, node scripts/check-changeset-fixed.mjs, node scripts/check-changeset-no-major.mjs, node scripts/check-changeset-presence.mjs, pnpm exec eslint on the three changed source/test files (0 errors, pre-existing-pattern warnings only).

Generated by Claude Code


Generated by Claude Code

…bjectui#4906)
Wires `buildOptionColorMap` and `buildCategoryOrder` (both already in
`@object-ui/core`, already consumed by `DatasetWidget`) into the report
chart path via `useDatasetDimensionMeta` — the exact chain the dashboard
already runs for the same dimension, reused rather than re-derived.
Authored `colors` (objectui#4877) keeps precedence, merged UNDER the
derived per-category map exactly as `chartConfigPresentation` already
does for the dashboard.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01RV6yuVCxymHYE16PL9vQkE
@github-actions

Copy link
Copy Markdown
Contributor

✅ Console Performance Budget

MetricValueBudget
Main entry (gzip)25.3 KB350 KB
Entry fileindex-Doli3p6i.js
StatusPASS

📦 Bundle Size Report

PackageSizeGzipped
app-shell (index.js)9.83KB3.70KB
app-shell (runtime-config.js)7.42KB2.32KB
app-shell (types.js)0.01KB0.04KB
app-shell (urlParams.js)8.92KB3.41KB
auth (AuthContext.js)0.31KB0.24KB
auth (AuthGuard.js)1.17KB0.53KB
auth (AuthProvider.js)29.33KB7.05KB
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)40.21KB10.79KB
auth (createAuthenticatedFetch.js)6.34KB2.43KB
auth (index.js)2.71KB1.22KB
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.02KB0.88KB
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)506.27KB113.31KB
core (index.js)4.11KB1.62KB
create-plugin (index.js)10.08KB3.26KB
data-objectstack (index.js)159.80KB44.34KB
fields (index.js)237.07KB59.46KB
i18n (LocalizationContext.js)1.76KB0.96KB
i18n (currency.js)1.22KB0.64KB
i18n (i18n.js)4.28KB1.75KB
i18n (index.js)3.42KB1.39KB
i18n (pickLocalized.js)3.69KB1.73KB
i18n (provider.js)23.13KB7.63KB
i18n (useDisplayLocale.js)2.85KB1.45KB
i18n (useObjectLabel.js)29.43KB7.15KB
i18n (useSafeTranslation.js)7.77KB3.13KB
layout (index.js)39.16KB10.97KB
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)9.35KB3.31KB
permissions (PermissionContext.js)0.31KB0.25KB
permissions (PermissionGuard.js)0.89KB0.45KB
permissions (PermissionProvider.js)4.42KB1.42KB
permissions (evaluator.js)5.12KB1.74KB
permissions (index.js)0.91KB0.41KB
permissions (store.js)0.91KB0.42KB
permissions (useFieldPermissions.js)1.28KB0.52KB
permissions (usePermissions.js)1.81KB0.83KB
plugin-ai (index.js)15.75KB3.80KB
plugin-calendar (index.js)46.62KB12.83KB
plugin-charts (index.js)64.75KB18.37KB
plugin-chatbot (index.js)181.21KB43.14KB
plugin-dashboard (index.js)127.97KB32.84KB
plugin-designer (index.js)212.39KB42.83KB
plugin-detail (index.js)241.46KB60.56KB
plugin-editor (index.js)2.46KB1.10KB
plugin-form (index.js)123.77KB30.07KB
plugin-gantt (index.js)164.10KB39.87KB
plugin-grid (index.js)198.22KB53.27KB
plugin-kanban (index.js)52.93KB14.60KB
plugin-list (index.js)111.66KB27.13KB
plugin-map (index.js)19.96KB6.56KB
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.34KB20.61KB
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.44KB0.22KB
providers (types.js)0.01KB0.04KB
react-runtime (index.js)5.62KB2.34KB
react (LazyPluginLoader.js)3.77KB1.33KB
react (SchemaRenderer.js)36.10KB12.26KB
react (data-invalidation.js)5.05KB2.08KB
react (index.js)1.33KB0.69KB
react (schema-input.js)1.45KB0.83KB
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)10.76KB3.17KB
sdui-parser (provenance.js)3.66KB1.82KB
sdui-parser (types.js)0.29KB0.24KB
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-retry.js)4.32KB2.02KB
types (index.js)3.08KB1.53KB
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

@os-support-ai
os-support-ai marked this pull request as ready for review August 19, 2026 12:11
@os-support-ai
os-support-ai added this pull request to the merge queueAug 19, 2026
Merged via the queue into main with commit cb5a7deAug 19, 2026
22 checks passed
@os-support-ai
os-support-ai deleted the claude/issue-4906-report-chart-option-colors branch August 19, 2026 12:11
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.

A report chart derives neither the dimension's option COLOURS nor its declared category order — the same dimension on a dashboard chart gets both

2 participants

@os-support-ai@claude