Skip to content

fix(app-shell): the page palette offers the canonical record:discussion, excludes the record:chatter alias - #5838

Merged
os-zhuang merged 1 commit into
mainfrom
claude/issue-5495-palette-canonical-discussion
Aug 23, 2026
Merged

fix(app-shell): the page palette offers the canonical record:discussion, excludes the record:chatter alias#5838
os-zhuang merged 1 commit into
mainfrom
claude/issue-5495-palette-canonical-discussion

Conversation

@os-zhuang

@os-zhuang os-zhuang commented Aug 23, 2026

Copy link
Copy Markdown
Contributor

Fixes #5495

Executes the maintainer ruling of 2026-08-22 — Option A, the palette offers the canonical name.

record:chatter and record:discussion are one renderer under two names: packages/plugin-detail/src/index.tsx registers both against RecordChatterRenderer, and the page palette deliberately carries one entry per renderer. It carried the alias and explicitly excluded the canonical spelling, so every page authored in Studio was written with the legacy name while the platform's own synthesiser (synth/buildDefaultPageSchema.ts) emitted the canonical one.

Two fragments in the first version of this description were eaten by GitHub's body sanitizer — it strips short angle-bracket fragments, backticks and code fences included. Rewritten below without them (AGENTS.md, "GitHub mutates body BYTES").

What changed

packages/app-shell/src/views/metadata-admin/previews/block-types.ts, three edits and their comment:

before after
BlockTypeId / BLOCK_TYPE_META record:chatter, label "Chatter feed" record:discussion, label "Discussion"
PALETTE_EXCLUSIONS record:discussion excluded record:chatter excluded, as the compatibility alias
icon / category MessageSquare, record unchanged

The exclusion comment was rewritten to record the ruling, the evidence behind it (core/src/registry/public-blocks.ts names record:chatter as record:discussion "under a Salesforce-familiar name"; the console's AI vocabulary already leaves the alias uncurated in DELIBERATELY_UNCURATED), and — first line of it — that excluded is not removed.

The alias stays renderable

This changes what Studio advertises, not what works. New test previews/__tests__/palette-discussion-alias.test.tsx pins both halves, and the second half is the one that matters: record:chatter is now absent from BLOCK_TYPE_META, so a later reader deleting its registration would break every in-the-wild schema spelling the block the Salesforce way, with nothing in the palette suite objecting — the palette is exactly where the type is supposed to be absent now. The new file asserts

  • the registry resolves the alias to the same renderer function object as the canonical name (identity, not "both defined" — two renderers that drifted apart pass the weaker check while authors of the two spellings silently get different blocks), and
  • an alias schema still renders the discussion panel, asserted on DOM, because a registration pointing at a renderer that throws is still a registration.

block-config.test.ts needed no edit, and that is the reason the new file exists: it derives palette coverage from PageComponentType, so offering record:chatter while excluding record:discussion satisfies every one of its assertions exactly as well as the reverse. The direction was a ruling, and a ruling nothing asserts is a comment.

Verification

All runs from the repo root. Union re-run on the final commit 85c289455, working tree clean at that sha.

Spec pin, counter-probed — the flip is only legitimate because the pinned @objectstack/spec declares the canonical name (it did not at the pin the palette entry was written against, #5328). Resolved version read from the installed package.json, PageComponentType.options = 34 members:

"record:discussion" => true      "record:details"  => true   (known-present)
"record:chatter"    => true      "element:filter"  => false  (genuinely retired)
                                 "zzNotARealType"  => false  (never existed)

Two true and two false from the same probe, so a broken probe cannot read as a passing one.

Tests

pnpm exec vitest run [the two palette suites]         Tests  35 passed (35)

pnpm exec vitest run packages/app-shell/.../previews \
    apps/console/src/__tests__/public-contract.test.ts \
    packages/app-shell/src/utils/__tests__/pageSchemaIntrospect.test.ts
                          Test Files 40 passed | Tests 481 passed (481)

pnpm --filter @object-ui/app-shell type-check                      exit 0
  (after `pnpm --filter '@object-ui/app-shell^...' build` — the first run failed
   only on an unbuilt dependency closure, TS2307/TS6305, not on this change)

Reverse verification, on the commit — not on uncommitted edits. Committed first, then reverted only block-types.ts to origin/main (mutation confirmed on disk by grepping for both the injected and the removed line: 0 and 1 respectively), re-ran, restored, confirmed git diff HEAD --stat empty, re-ran:

ablated   Tests  2 failed | 33 passed (35)
restored  Tests  35 passed (35)                exit 0

The two reds are the palette-direction cases. The legs that do NOT discriminate, named:

  • all 30 cases of block-config.test.ts stay green in both states — its coverage is derived and either direction of the pair satisfies it;
  • both spellings are real members of the pinned spec enum — a fact about the spec, not about this change;
  • both alias-renderability cases stay green in both states, deliberately. They assert the registry and the renderer, which this PR does not touch. That is what they are for: they must be green before and after, so that the day they go red the cause is a deleted registration, not this flip.

Gates (targeted; CI runs the farm)

check:control-bytes  OK (scanned 4855 tracked text file(s); skipped 85 binary)
check:spec-symbols   spec symbol derivation: 1298 files scanned against 4959 spec export names
check:phantom-deps   Every in-scope import is declared by the package that publishes it
check:i18n-keys      every in-scope call-site key resolves against the en pack (2928 keys)
node scripts/check-changeset-presence.mjs
                     1 source file(s) of 1 released package(s) changed, and this change
                     declares 1 changeset(s)

All five green, quoting each gate's own verdict line.

@object-ui/app-shell lint ran in full, not narrowed: eslint . in the package, 939 files linted, 0 errors, 2599 warnings (the repo-wide warning baseline .github/workflows/lint.yml documents as deliberately un-capped). The one new warning is an any type-argument on a React.ComponentType annotation in the new test. The other 39 packages' lint was not run locally; that is safe rather than assumed, because the root eslint.config.js enables no type-aware linting (tseslint.configs.recommended, no project / projectService in languageOptions), so an edit confined to packages/app-shell cannot move the verdict on a file in another package. CI runs all of them regardless.

Sibling check requested by the card: #4935's element:filter residue

Confirmed on this branch, as asked, without re-deleting anything: grepping the file for element:filter returns no hits. #5529 already removed that PALETTE_EXCLUSIONS entry when the enum member disappeared, exactly as #4935's 2026-08-22 unlock comment records. Nothing left in this file. #4935's remaining residue is a one-line comment in packages/components/src/renderers/basic/elements.tsx — a different file, a separate card, deliberately untouched here.

Known knock-on, disclosed in the changeset

The block-editor canvas draws a node's icon and tone from BLOCK_TYPE_META, so an existing record:chatter node now shows the generic unknown-block icon in the outline. This is the pre-existing behaviour for any renderable-but-unoffered type — until this change it was the canonical record:discussion that read this way, including in every page the platform generates itself — so this strictly reduces how often it is seen without closing it. Filed separately and unassigned as #5837 (finding); folding a fix in would need a new alias-display mechanism and would break block-config.test.ts's "no type is both offered and excluded", so it is out of scope for this S-size card.

Generated by Claude Code

…te, exclude the `record:chatter` alias (#5495)

`record:chatter` and `record:discussion` are one renderer under two names —
`@object-ui/plugin-detail` registers both against `RecordChatterRenderer` — and
the page-editor palette carries one entry per renderer. It carried the alias and
explicitly excluded the canonical name, so every page an author built in Studio
was written with the legacy spelling while the platform's own synthesiser
(`buildDefaultPageSchema`) emitted the canonical one.

Inverts that pair, per the maintainer ruling of 2026-08-22 (Option A):

  - `BLOCK_TYPE_META` offers `record:discussion`, labelled "Discussion"
  - `PALETTE_EXCLUSIONS` now excludes `record:chatter` as the compatibility alias
  - the exclusion comment records the ruling and the evidence behind it

The alias stays RENDERABLE. This changes what Studio advertises, not what works:
schemas in the wild that spell the block `record:chatter` render exactly as
before. `palette-discussion-alias.test.tsx` pins both halves — the palette
direction, and that the registry still resolves the alias to the same renderer
function as the canonical name and still renders the discussion panel from an
alias schema — so "no longer offered" cannot drift into "no longer rendered".

`block-config.test.ts` needed no edit: it derives palette coverage from the
spec's `PageComponentType` and is satisfied by either direction of this pair,
which is precisely why the new file exists.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EuPCi56cnGyykygi3z9w4m
@github-actions github-actions Bot added the tests label Aug 23, 2026
@github-actions

Copy link
Copy Markdown
Contributor

✅ Console Performance Budget

Metric Value Budget
Eager closure (gzip, 52 chunks) 3227.3 KB 3990.2 KB
Main entry chunk (gzip) 152.7 KB 350 KB
Entry file index-D9BauIll.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) 10.13KB 3.77KB
app-shell (runtime-config.js) 12.80KB 4.47KB
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) 503.98KB 113.95KB
core (index.js) 4.92KB 1.97KB
create-plugin (index.js) 10.08KB 3.26KB
data-objectstack (index.js) 164.55KB 45.67KB
fields (index.js) 238.40KB 59.89KB
i18n (LocalizationContext.js) 1.76KB 0.96KB
i18n (currency.js) 1.22KB 0.64KB
i18n (i18n.js) 4.28KB 1.75KB
i18n (index.js) 3.44KB 1.39KB
i18n (pickLocalized.js) 7.62KB 3.26KB
i18n (provider.js) 23.13KB 7.63KB
i18n (useDisplayLocale.js) 2.85KB 1.45KB
i18n (useObjectLabel.js) 33.40KB 8.71KB
i18n (useSafeTranslation.js) 7.77KB 3.13KB
layout (index.js) 38.95KB 10.97KB
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.55KB 0.62KB
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 (useResponsiveConfig.js) 1.37KB 0.63KB
mobile (useSpecGesture.js) 4.32KB 1.64KB
mobile (useTouchTarget.js) 1.01KB 0.54KB
permissions (MePermissionsProvider.js) 9.53KB 3.38KB
permissions (PermissionContext.js) 0.31KB 0.25KB
permissions (PermissionGuard.js) 0.89KB 0.45KB
permissions (PermissionProvider.js) 4.64KB 1.50KB
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) 1.93KB 0.88KB
plugin-ai (index.js) 15.75KB 3.80KB
plugin-calendar (index.js) 46.62KB 12.83KB
plugin-charts (index.js) 64.66KB 18.32KB
plugin-chatbot (index.js) 186.86KB 44.21KB
plugin-dashboard (index.js) 128.44KB 32.96KB
plugin-designer (index.js) 212.30KB 42.80KB
plugin-detail (index.js) 242.34KB 60.99KB
plugin-editor (index.js) 2.46KB 1.10KB
plugin-form (index.js) 125.63KB 30.64KB
plugin-gantt (index.js) 164.15KB 39.88KB
plugin-grid (index.js) 200.79KB 54.26KB
plugin-kanban (index.js) 52.93KB 14.60KB
plugin-list (index.js) 111.80KB 27.20KB
plugin-map (index.js) 20.06KB 6.62KB
plugin-markdown (index.js) 13.72KB 4.69KB
plugin-report (index.js) 43.49KB 11.93KB
plugin-timeline (index.js) 26.49KB 7.59KB
plugin-tree (index.js) 8.50KB 2.88KB
plugin-view (index.js) 84.51KB 20.72KB
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) 3.77KB 1.33KB
react (SchemaRenderer.js) 52.40KB 17.45KB
react (data-invalidation.js) 5.05KB 2.08KB
react (index.js) 1.33KB 0.69KB
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) 12.13KB 3.65KB
sdui-parser (provenance.js) 3.66KB 1.82KB
sdui-parser (types.js) 0.28KB 0.23KB
sdui-parser (validate.js) 7.54KB 2.63KB
types (ai.js) 0.20KB 0.17KB
types (api-types.js) 0.20KB 0.18KB
types (app.js) 2.87KB 0.99KB
types (base.js) 0.20KB 0.18KB
types (blocks.js) 0.20KB 0.18KB
types (complex.js) 0.20KB 0.18KB
types (crud.js) 0.20KB 0.18KB
types (dashboard-filter-alias.js) 6.23KB 2.74KB
types (data-display.js) 0.20KB 0.18KB
types (data-protocol.js) 0.20KB 0.19KB
types (data.js) 0.20KB 0.18KB
types (designer.js) 1.87KB 0.85KB
types (disclosure.js) 0.20KB 0.18KB
types (error-code.js) 1.54KB 0.88KB
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 (index.js) 3.88KB 1.85KB
types (layout.js) 0.20KB 0.18KB
types (managed-by.js) 0.19KB 0.18KB
types (mobile.js) 2.59KB 1.31KB
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 (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) 3.40KB 1.71KB
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-zhuang
os-zhuang marked this pull request as ready for review August 23, 2026 14:41
@os-zhuang
os-zhuang added this pull request to the merge queue Aug 23, 2026
Merged via the queue into main with commit 8b1a8f3 Aug 23, 2026
23 checks passed
@os-zhuang
os-zhuang deleted the claude/issue-5495-palette-canonical-discussion branch August 23, 2026 14:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

2 participants