Skip to content

fix(app-shell): command palette idempotent open + locators (ADR-0054 Phase 1)#1879

Merged
xuyushun441-sys merged 2 commits into
mainfrom
fix/cmdk-idempotent-open
Jun 22, 2026
Merged

fix(app-shell): command palette idempotent open + locators (ADR-0054 Phase 1)#1879
xuyushun441-sys merged 2 commits into
mainfrom
fix/cmdk-idempotent-open

Conversation

@xuyushun441-sys

Copy link
Copy Markdown
Contributor

What & why

ADR-0054 "UI testability contract" — Phase 1 (the reference fix). The top-bar "Search… ⌘K" button did not open the command palette under automation: it re-emitted a synthetic ⌘K KeyboardEvent and relied on CommandPalette's global listener being mounted and the browser not reserving ⌘K. The open path was also a non-idempotent toggle and open state lived only in useState (not URL-addressable).

This makes the palette deterministic for AI browser testing by fixing the shared primitive — every generated app inherits it.

Changes (invariants C1 / C3 / C4)

  • C1 — idempotent, direct triggers. New CommandPaletteProvider / useCommandPalette() owns open state and a shared idempotent openCommandPalette() (setOpen(true)). The header search buttons call it directly; the synthetic dispatchEvent(new KeyboardEvent(...)) is deleted. ⌘K stays a keyboard accelerator (may toggle for close-on-repeat); the OPEN path used by buttons/links/programmatic callers is idempotent.
  • C3 — URL-addressable state. Open state is the ?palette=1 search param (?cmdk=1 alias on read) → deep-linkable, restores on reload, works with back/forward.
  • C4 — stable locators + ARIA. Dialog: data-testid="overlay:command-palette" + a visually-hidden Radix DialogTitle (accessible role="dialog"/name). Trigger: data-testid="action:command-palette:open" (:open-mobile for the compact header). CommandDialog gains contentProps (forward a locator onto the dialog element) and title/description (accessible-by-construction).
  • Tests. Added useRecordSearch unit tests for the $search query path (trimmed query, exact { $search, $top } payload, re-fire on query change).
  • Docs. New "Command palette" section in the app-shell README.

Verification (browser, agent-browser / CDP-real keystrokes)

Worktree console (packages/*/src via HMR) on :5182 → framework app-showcase backend on :3000:

  • (a) The original bug — fixed: clicking the top-bar search trigger opens the palette under automation (overlay count 0→1, URL gains ?palette=1).
  • (b) Record search: real keystrokes drive the controlled+debounced input → $search fan-out to the backend (/api/v1/data/showcase_*?top=3&search=…, all 200) → "Records" group renders real hits.
  • (c) Deep-link: ?palette=1 (and legacy ?cmdk=1) open the palette on fresh page load.
  • Also verified: ⌘K toggles, Escape closes + clears the URL param, no Radix dialog a11y errors.

Unit/type: @object-ui/{i18n,components,react,app-shell} test suites green; tsc build green for touched packages.

🤖 Generated with Claude Code

os-zhuang and others added 2 commits June 22, 2026 12:01
…Phase 1)

The top-bar "Search… ⌘K" button did not open the command palette under
automation: it re-emitted a synthetic ⌘K KeyboardEvent and relied on
CommandPalette's global listener being mounted and the browser not reserving
⌘K. The open path was also a non-idempotent toggle (`setOpen(p => !p)`) and the
open state lived only in component `useState`.

Implements ADR-0054 invariants C1/C3/C4 for the command palette (Phase 1, the
reference fix):

- C1 (idempotent, direct triggers): new `CommandPaletteProvider` /
  `useCommandPalette()` owns the open state and a shared idempotent
  `openCommandPalette()` (`setOpen(true)`). The header search buttons call it
  directly — the synthetic `dispatchEvent(new KeyboardEvent(...))` is deleted.
  ⌘K stays an accelerator and may toggle (close-on-repeat); the OPEN path used
  by buttons/links/programmatic callers is idempotent.
- C3 (URL-addressable state): open state is the `?palette=1` search param
  (`?cmdk=1` alias on read), so the palette is deep-linkable, restores on
  reload, and works with back/forward.
- C4 (stable locators): the dialog carries
  `data-testid="overlay:command-palette"` + an ARIA name; the trigger carries
  `data-testid="action:command-palette:open"` (`:open-mobile` for the compact
  header). `CommandDialog` gains a `contentProps` passthrough so the locator/ARIA
  land on the underlying dialog element.

Also adds `useRecordSearch` unit tests covering the `$search` query path
(trimmed query, exact `{ $search, $top }` payload, re-fire on query change) and
documents the palette's testability contract in the app-shell README.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Radix `DialogContent` requires a `DialogTitle` for an accessible name; the
palette previously rendered none (console error + no SR name). `CommandDialog`
now renders a visually-hidden `DialogTitle` (default "Command Palette",
overridable) and an optional `DialogDescription`, so every CommandDialog is
screen-reader accessible by construction (ADR-0054 C4). CommandPalette passes the
translated title + placeholder; the redundant `aria-label` is dropped (the
DialogTitle now provides the name via `aria-labelledby`).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@vercel

vercel Bot commented Jun 22, 2026

Copy link
Copy Markdown

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

1 Skipped Deployment
Project Deployment Actions Updated (UTC)
objectui Ignored Ignored Jun 22, 2026 4:10am

Request Review

@github-actions github-actions Bot added documentation Improvements or additions to documentation package: react package: components tests labels Jun 22, 2026
@github-actions

Copy link
Copy Markdown
Contributor

✅ Console Performance Budget

Metric Value Budget
Main entry (gzip) 58.8 KB 350 KB
Entry file index-CfG7ZNDX.js
Status PASS

📦 Bundle Size Report

Package Size Gzipped
app-shell (index.js) 5.99KB 2.10KB
app-shell (runtime-config.js) 4.72KB 1.69KB
app-shell (types.js) 0.01KB 0.04KB
auth (AuthContext.js) 0.31KB 0.24KB
auth (AuthGuard.js) 1.17KB 0.53KB
auth (AuthProvider.js) 17.16KB 3.44KB
auth (AuthShell.js) 3.49KB 1.40KB
auth (ForgotPasswordForm.js) 4.79KB 1.88KB
auth (LoginForm.js) 5.11KB 1.92KB
auth (PreviewBanner.js) 0.90KB 0.50KB
auth (RegisterForm.js) 6.63KB 2.15KB
auth (SocialSignInButtons.js) 8.89KB 3.61KB
auth (UserMenu.js) 3.40KB 1.22KB
auth (authStyles.js) 5.04KB 1.72KB
auth (createAuthClient.js) 24.74KB 6.00KB
auth (createAuthenticatedFetch.js) 3.33KB 1.32KB
auth (index.js) 1.75KB 0.76KB
auth (types.js) 0.59KB 0.35KB
auth (useAuth.js) 4.01KB 0.79KB
auth (useIsWorkspaceAdmin.js) 1.28KB 0.70KB
collaboration (CommentThread.js) 18.38KB 4.49KB
collaboration (LiveCursors.js) 3.17KB 1.27KB
collaboration (PresenceAvatars.js) 3.65KB 1.42KB
collaboration (PresenceProvider.js) 2.42KB 0.96KB
collaboration (index.js) 1.25KB 0.53KB
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) 414.79KB 88.11KB
core (index.js) 1.48KB 0.54KB
create-plugin (index.js) 9.28KB 2.98KB
data-objectstack (index.js) 97.65KB 24.24KB
fields (index.js) 166.14KB 40.06KB
i18n (LocalizationContext.js) 1.76KB 0.96KB
i18n (currency.js) 1.22KB 0.64KB
i18n (i18n.js) 4.32KB 1.77KB
i18n (index.js) 2.46KB 0.96KB
i18n (pickLocalized.js) 1.31KB 0.67KB
i18n (provider.js) 5.37KB 1.72KB
i18n (useObjectLabel.js) 21.15KB 4.68KB
i18n (useSafeTranslation.js) 2.68KB 0.98KB
layout (index.js) 36.30KB 10.04KB
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.74KB
mobile (index.js) 1.50KB 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) 4.42KB 1.27KB
mobile (useOfflineSync.js) 1.99KB 0.72KB
mobile (usePullToRefresh.js) 2.53KB 0.85KB
mobile (useResponsive.js) 0.71KB 0.42KB
mobile (useResponsiveConfig.js) 1.36KB 0.63KB
mobile (useSpecGesture.js) 1.77KB 0.77KB
mobile (useTouchTarget.js) 1.01KB 0.54KB
permissions (MePermissionsProvider.js) 4.87KB 1.77KB
permissions (PermissionContext.js) 0.31KB 0.25KB
permissions (PermissionGuard.js) 0.89KB 0.45KB
permissions (PermissionProvider.js) 3.11KB 0.87KB
permissions (evaluator.js) 4.00KB 1.23KB
permissions (index.js) 0.91KB 0.41KB
permissions (store.js) 0.91KB 0.42KB
permissions (useFieldPermissions.js) 1.28KB 0.52KB
permissions (usePermissions.js) 1.42KB 0.68KB
plugin-ai (index.js) 15.71KB 3.79KB
plugin-calendar (index.js) 45.98KB 12.65KB
plugin-charts (index.js) 42.55KB 12.00KB
plugin-chatbot (index.js) 147.52KB 35.90KB
plugin-dashboard (index.js) 104.31KB 25.91KB
plugin-designer (index.js) 213.42KB 42.94KB
plugin-detail (index.js) 195.59KB 47.19KB
plugin-editor (index.js) 2.38KB 1.06KB
plugin-form (index.js) 93.07KB 22.68KB
plugin-gantt (index.js) 122.48KB 30.19KB
plugin-grid (index.js) 114.67KB 30.78KB
plugin-kanban (index.js) 48.82KB 13.13KB
plugin-list (index.js) 93.15KB 21.90KB
plugin-map (index.js) 16.02KB 4.98KB
plugin-markdown (index.js) 13.58KB 4.64KB
plugin-report (index.js) 35.93KB 9.50KB
plugin-timeline (index.js) 25.37KB 7.20KB
plugin-view (index.js) 84.13KB 20.27KB
providers (DataSourceProvider.js) 0.75KB 0.39KB
providers (MetadataProvider.js) 1.37KB 0.59KB
providers (ThemeProvider.js) 1.55KB 0.67KB
providers (UploadProvider.js) 11.71KB 3.53KB
providers (index.js) 0.44KB 0.22KB
providers (types.js) 0.01KB 0.04KB
react (LazyPluginLoader.js) 3.77KB 1.33KB
react (SchemaRenderer.js) 15.64KB 5.08KB
react (index.js) 0.76KB 0.42KB
tenant (TenantContext.js) 0.31KB 0.25KB
tenant (TenantGuard.js) 1.04KB 0.43KB
tenant (TenantProvider.js) 2.76KB 0.98KB
tenant (TenantScopedQuery.js) 0.77KB 0.44KB
tenant (index.js) 0.75KB 0.38KB
tenant (resolver.js) 2.64KB 0.76KB
tenant (useTenant.js) 0.50KB 0.32KB
tenant (useTenantBranding.js) 0.62KB 0.39KB
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 (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) 0.77KB 0.41KB
types (disclosure.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 (index.js) 1.54KB 0.68KB
types (layout.js) 0.20KB 0.18KB
types (mobile.js) 0.20KB 0.18KB
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 (registry.js) 0.20KB 0.18KB
types (reports.js) 0.20KB 0.18KB
types (spec-report.js) 5.26KB 1.96KB
types (tenant.js) 0.20KB 0.18KB
types (theme.js) 0.20KB 0.18KB
types (ui-action.js) 0.75KB 0.46KB
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

@xuyushun441-sys
xuyushun441-sys merged commit 6c0c92c into main Jun 22, 2026
10 checks passed
@xuyushun441-sys
xuyushun441-sys deleted the fix/cmdk-idempotent-open branch June 22, 2026 04:17
xuyushun441-sys added a commit that referenced this pull request Jun 22, 2026
…ADR-0054 Phase 5) (#1890)

Locks in the testability contract so it can't regress ("counts can only go down").

- **Conformance test** (`adr0054-ratchet.test.ts`, runs in the gating `pnpm test`
  job): fails the build if a new synthetic-event trigger
  (`dispatchEvent(new KeyboardEvent/MouseEvent/PointerEvent)`) appears anywhere in
  `packages/*/src` or `apps/*/src`. Legitimate `CustomEvent`/`PopStateEvent`
  dispatch (event bus / history nudge) stays allowed.
- **Local ESLint rule** `object-ui/no-synthetic-event-trigger` flags the same
  pattern in-editor (the repo `Lint` workflow is manual `workflow_dispatch`, so
  the test — not lint — is the CI gate). Plain-JS RuleTester unit test.
- **Last two offenders fixed**: the sidebar swipe-to-open gestures
  (`UnifiedSidebar`, `AppSidebar`) dispatched a synthetic click on the trigger;
  now call the idempotent `setOpenMobile(true)` directly (C1). Tree is clean at
  zero.
- Docs: README "Testability ratchet" section; ADR-0054 marked all five phases
  shipped.

Completes the ADR-0054 rollout (Phases 1 #1879, 2 #1882, 3 #1883, 4 #1887, 5).

Co-authored-by: Jack Zhuang <277994282+os-zhuang@users.noreply.github.com>
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation package: components package: react tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants