Skip to content

refactor(data-objectstack): route batchTransaction through the client SDK only (#2694) - #2757

Merged
os-zhuang merged 2 commits into
mainfrom
claude/batchtransaction-sdk-dogfood-g699qo
Jul 20, 2026
Merged

os-zhuang merged 2 commits into
mainfrom
claude/batchtransaction-sdk-dogfood-g699qo

Conversation

@os-zhuang

@os-zhuang os-zhuang commented Jul 20, 2026 •

Copy link
Copy Markdown
Contributor

Closes #2694 (optional cleanup half).

Context

#2694 had two parts:

  1. (required) dogfood-verify the SDK path — already realized: @objectstack/client is bumped to ^16.0.0-rc.0 on main (changeset align-objectstack-deps-16-rc), and 16.0.0-rc.0 ships data.batchTransaction. The adapter's feature-detect already routed master-detail saves through the SDK, and onMutation.test.ts proves SDK path taken + one MutationEvent per committed op (no double-fire).
  2. (optional) remove the raw-fetch branch — this PR.

What

ObjectStackAdapter.batchTransaction now calls the typed SDK method
client.data.batchTransaction(operations) directly. The transitional
hand-rolled fetch('/api/v1/batch') mainline — a feature-detect shim kept while
the SDK method was unreleased — is deleted. Per AGENTS.md §7, adapter data
always flows through @objectstack/client, never a raw fetch. The change is
localized to the one method (net −40 lines) and also drops one as any cast (the
method is now a typed part of the @objectstack/client@^16 API).

No behavior change

  • The SDK still drives the server's atomic POST /api/v1/batch.
  • One MutationEvent per committed op, emitted once (no double-fire).
  • The server-side fallback stays: when this backend lacks the endpoint
    (404/405) or its runtime can't do transactions (501), the SDK method throws a
    status-decorated error and the adapter degrades to the non-atomic
    emulateBatchTransaction — exactly as before. Every other status
    (400/401/403/409/500) still surfaces to the caller.
  • The non-atomic emulation itself is untouched (still gated on a
    discovery-advertised batch capability, not yet advertised).

Tests / docs

  • Reworked the "no server atomicity" fallback tests to drive the path via the SDK
    method throwing (the raw-fetch mock is gone). 89/89 data-objectstack tests
    pass; type-check clean.
  • Updated the master-detail ADR (docs/adr/0001-…) + data-source guide to
    describe the SDK transport; added a changeset (patch).

Version-policy note (resolved)

The client dep is still a pre-release (^16.0.0-rc.0), and the merged version-bump
changeset had noted "the raw-fetch branch stays as a defensive fallback (removal
tracked in #2694)."
The caret range guarantees data.batchTransaction for any
resolved version and #2694 is the tracking issue for this removal, so the
maintainer approved proceeding now (merge on green CI) rather than waiting for a
stable 16.0.0.

🤖 Generated with Claude Code

https://claude.ai/code/session_01SyjBH45icswG9FKmCestH2

… SDK only (#2694)

@objectstack/client@^16 (framework #3271, the current dependency floor) ships
data.batchTransaction, so ObjectStackAdapter.batchTransaction now calls the
typed SDK method directly. Remove the transitional hand-rolled
fetch('/api/v1/batch') branch — a feature-detect shim kept while the SDK method
was unreleased. Per AGENTS.md §7, adapter data always flows through
@objectstack/client, never a raw fetch.

No behavior change: the SDK still drives the server's atomic POST /api/v1/batch,
one MutationEvent fires per committed op (no double-fire), and the adapter still
degrades to the non-atomic emulateBatchTransaction when this backend lacks the
endpoint (404/405) or its runtime can't do transactions (501). Every other
status still surfaces to the caller.

- Rework the fallback tests to drive the "no server atomicity" path via the SDK
  method throwing a status-decorated error (the raw-fetch mock is gone).
- Update the master-detail ADR + data-source guide to describe the SDK transport.
- Add a changeset.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01SyjBH45icswG9FKmCestH2
@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 1:02pm

Request Review

@os-zhuang
os-zhuang marked this pull request as ready for review July 20, 2026 12:50
…on-sdk-dogfood-g699qo

# Conflicts:
#	packages/data-objectstack/src/index.ts
@github-actions github-actions Bot added documentation Improvements or additions to documentation data-adapter 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-CnHAfMru.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) 4.37KB 1.69KB
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.79KB 1.13KB
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) 449.99KB 97.82KB
core (index.js) 1.86KB 0.63KB
create-plugin (index.js) 9.28KB 2.98KB
data-objectstack (index.js) 121.12KB 30.43KB
fields (index.js) 211.66KB 51.78KB
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) 24.31KB 5.34KB
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.37KB 12.48KB
plugin-charts (index.js) 46.75KB 13.23KB
plugin-chatbot (index.js) 179.53KB 42.79KB
plugin-dashboard (index.js) 108.56KB 27.97KB
plugin-designer (index.js) 210.92KB 42.69KB
plugin-detail (index.js) 214.78KB 52.42KB
plugin-editor (index.js) 2.46KB 1.10KB
plugin-form (index.js) 102.82KB 24.94KB
plugin-gantt (index.js) 162.33KB 39.53KB
plugin-grid (index.js) 174.13KB 45.90KB
plugin-kanban (index.js) 47.45KB 12.99KB
plugin-list (index.js) 98.18KB 23.20KB
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.64KB 20.85KB
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) 1.00KB 0.55KB
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.19KB 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 (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 0ea5036 into main Jul 20, 2026
14 checks passed
@os-zhuang
os-zhuang deleted the claude/batchtransaction-sdk-dogfood-g699qo branch July 20, 2026 13:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

data-adapter documentation Improvements or additions to documentation tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

@objectstack/client 发版后:dogfood 验证 batchTransaction 走 SDK path,并可选删除适配器裸 fetch 分支

2 participants