Skip to content

test(app-shell): value-shape parity net for action params (#2714)#2720

Merged
os-zhuang merged 1 commit into
mainfrom
test/2714-param-value-shape-parity
Jul 20, 2026
Merged

test(app-shell): value-shape parity net for action params (#2714)#2720
os-zhuang merged 1 commit into
mainfrom
test/2714-param-value-shape-parity

Conversation

@os-zhuang

Copy link
Copy Markdown
Contributor

Closes #2714.

Why

Since ADR-0059 (#2700 / #2704), ActionParamDialog routes every param through the shared form field-widget renderer (paramToField()getLazyFieldWidget). That was the whole win — but it also means each param now emits its widget's own value shape on confirm, and those shapes differ (number→number, boolean→boolean, date→string, select→string / select+multiplestring[], lookup/user→id(s), file/image→fileId(s)). #2700's acceptance called for value-shape parity coverage, but no test net pinned it — so a future widget swap could silently change a param's emitted shape and break an endpoint's input contract with no failing test.

What

The contract (packages/app-shell/src/utils/paramValueShape.ts)

  • PARAM_VALUE_SHAPES — one entry per FORM_FIELD_TYPES widget key, describing the shape the dialog POSTs (i.e. after serializeParamValues, so file/image are already their fileId string).
  • expectedParamShape(param) — resolves a concrete ActionParamDef to its emitted shape by reusing the same paramToField() the dialog renders with, so the contract can't drift from the dialog's own type resolution; it then folds in multiple and the fileId serialization.
  • classifyValueShape(value) — runtime classifier backing the render proofs.

The net (paramValueShape.test.ts, mirroring the paramToField drift test)

  • Coverage / drift guard: every FORM_FIELD_TYPES key has a declared shape — a new widget can't land without stating what a param of that type POSTs.
  • Pinned contracts: number→number, boolean→boolean, date/datetime/time→string, select→string, select+multiplestring[] (feat(fields): select+multiple → multi-value chip picker; restore fields/core lint gates #2709), lookup/user→id(s), file→fileId(s), multiselect/tagsstring[], object/address→object, gridobject[], computed types (formula/summary/auto_number/vector)→none.

Reality tie (ActionParamDialog.test.tsx)

  • Contract-tied render proofs that drive the real widget (number / datetime / time / select+multiple / file) and assert the value the dialog resolves classifies to the declared contract — so a silent widget-onChange swap fails at the render layer too, not just in the table.

Docs

Out of scope (owned elsewhere)

The file/image → fileId serialization itself is #2698 / #2710 (serializeParamValues). This net adopts that (asserts the post-serialize endpoint shape) rather than duplicating it.

Test / verify

  • paramValueShape.test.ts — 54 pass (unit project, node env).
  • ActionParamDialog.test.tsx — 28 pass (dom project), incl. the 5 new contract-tied proofs.
  • paramToField.test.ts — still green.
  • turbo run build --filter=@object-ui/app-shell — 29/29 successful (app-shell tsc executed clean); eslint clean on new lines.

No changeset: internal test-net + contract module (not exported from the package's public index.ts) + docs; no runtime or public-API change.

🤖 Generated with Claude Code

Since ADR-0059 ActionParamDialog routes every param through the shared form
field-widget renderer, so each param emits its widget's own value shape on
confirm and those shapes differ per type. Nothing pinned that contract, so a
future widget swap could silently change a param's emitted shape and break an
endpoint's input contract with no failing test.

Add the value-shape parity net:

- `paramValueShape.ts` — the emitted-shape contract (`PARAM_VALUE_SHAPES`, one
  entry per FORM_FIELD_TYPES widget key) plus `expectedParamShape()`, which
  reuses the SAME `paramToField()` the dialog renders with (so it can't drift
  from the dialog's own type resolution) and folds in `multiple` and the
  file/image fileId serialization. `classifyValueShape()` backs the render proofs.
- `paramValueShape.test.ts` — the drift guard (mirrors paramToField.test.ts's
  style): coverage of every FORM_FIELD_TYPES key, and the endpoint contracts
  pinned by value (number→number, boolean→boolean, date→string,
  select→string / select+multiple→string[], lookup→id(s), file→fileId(s)).
- ActionParamDialog.test.tsx — contract-tied render proofs that drive the REAL
  widget (number/datetime/time/select+multiple/file) and assert the value the
  dialog resolves classifies to the declared contract, so a silent onChange swap
  fails at the render layer too, not just in the table.
- Document the emitted-shape table in ADR-0059 and the app-shell README.

The file/image → fileId serialization itself is owned by #2698/#2710
(`serializeParamValues`); this net asserts the post-serialize endpoint shape and
the general contract for the non-upload types.

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

vercel Bot commented Jul 20, 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 Jul 20, 2026 2:59am

Request Review

@github-actions github-actions Bot added documentation Improvements or additions to documentation tests labels Jul 20, 2026
@github-actions

Copy link
Copy Markdown
Contributor

✅ Console Performance Budget

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

📦 Bundle Size Report

Package Size Gzipped
app-shell (index.js) 8.19KB 2.96KB
app-shell (runtime-config.js) 7.42KB 2.32KB
app-shell (types.js) 0.01KB 0.04KB
app-shell (urlParams.js) 7.57KB 2.97KB
auth (AuthContext.js) 0.31KB 0.24KB
auth (AuthGuard.js) 1.17KB 0.53KB
auth (AuthProvider.js) 21.70KB 4.21KB
auth (AuthShell.js) 3.49KB 1.40KB
auth (ForgotPasswordForm.js) 12.12KB 3.41KB
auth (LoginForm.js) 17.86KB 5.29KB
auth (PreviewBanner.js) 0.90KB 0.50KB
auth (RegisterForm.js) 6.43KB 2.09KB
auth (SocialSignInButtons.js) 9.60KB 3.89KB
auth (UserMenu.js) 3.40KB 1.22KB
auth (auth-gate-events.js) 1.29KB 0.66KB
auth (authStyles.js) 5.04KB 1.72KB
auth (createAuthClient.js) 33.74KB 8.53KB
auth (createAuthenticatedFetch.js) 3.93KB 1.55KB
auth (index.js) 1.83KB 0.79KB
auth (phone-identifier.js) 1.11KB 0.66KB
auth (types.js) 0.59KB 0.35KB
auth (useAuth.js) 4.86KB 0.85KB
auth (useIsWorkspaceAdmin.js) 1.61KB 0.85KB
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) 450.03KB 97.83KB
core (index.js) 1.86KB 0.63KB
create-plugin (index.js) 9.28KB 2.98KB
data-objectstack (index.js) 120.81KB 30.10KB
fields (index.js) 209.46KB 51.35KB
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.70KB 0.83KB
i18n (provider.js) 5.37KB 1.72KB
i18n (useObjectLabel.js) 21.22KB 4.69KB
i18n (useSafeTranslation.js) 2.87KB 1.28KB
layout (index.js) 38.45KB 10.67KB
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) 5.90KB 2.15KB
permissions (PermissionContext.js) 0.31KB 0.25KB
permissions (PermissionGuard.js) 0.89KB 0.45KB
permissions (PermissionProvider.js) 3.46KB 1.03KB
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.50KB 0.70KB
plugin-ai (index.js) 15.71KB 3.79KB
plugin-calendar (index.js) 45.12KB 12.34KB
plugin-charts (index.js) 46.31KB 13.06KB
plugin-chatbot (index.js) 179.58KB 42.81KB
plugin-dashboard (index.js) 113.58KB 28.77KB
plugin-designer (index.js) 213.43KB 42.95KB
plugin-detail (index.js) 213.25KB 51.88KB
plugin-editor (index.js) 2.46KB 1.10KB
plugin-form (index.js) 102.94KB 24.95KB
plugin-gantt (index.js) 162.24KB 39.49KB
plugin-grid (index.js) 174.50KB 46.00KB
plugin-kanban (index.js) 47.23KB 12.88KB
plugin-list (index.js) 98.22KB 23.21KB
plugin-map (index.js) 16.80KB 5.24KB
plugin-markdown (index.js) 13.65KB 4.67KB
plugin-report (index.js) 37.81KB 9.98KB
plugin-timeline (index.js) 25.37KB 7.20KB
plugin-tree (index.js) 8.36KB 2.81KB
plugin-view (index.js) 85.72KB 20.86KB
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-runtime (index.js) 3.19KB 1.38KB
react (LazyPluginLoader.js) 3.77KB 1.33KB
react (SchemaRenderer.js) 18.70KB 6.09KB
react (data-invalidation.js) 5.05KB 2.08KB
react (index.js) 0.76KB 0.42KB
sdui-parser (codegen.js) 4.09KB 1.74KB
sdui-parser (index.js) 2.16KB 0.94KB
sdui-parser (parse.js) 10.04KB 2.82KB
sdui-parser (types.js) 0.29KB 0.24KB
sdui-parser (validate.js) 4.69KB 1.48KB
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) 2.02KB 0.95KB
types (layout.js) 0.20KB 0.18KB
types (managed-by.js) 0.17KB 0.17KB
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 (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.26KB 1.96KB
types (system-fields.js) 2.39KB 1.17KB
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

@os-zhuang
os-zhuang merged commit 16bcffc into main Jul 20, 2026
14 checks passed
@os-zhuang
os-zhuang deleted the test/2714-param-value-shape-parity branch July 20, 2026 03:03
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 tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[P2] Action-param value-shape parity net: assert every FORM_FIELD_TYPES param round-trips to the endpoint contract

1 participant