Skip to content

refactor(data): master-detail 保存统一走原子 batchTransaction,把非原子回退隔离进适配器 (#2679)#2684

Merged
os-zhuang merged 1 commit into
mainfrom
claude/master-detail-atomic-adapter-2679
Jul 19, 2026
Merged

refactor(data): master-detail 保存统一走原子 batchTransaction,把非原子回退隔离进适配器 (#2679)#2684
os-zhuang merged 1 commit into
mainfrom
claude/master-detail-atomic-adapter-2679

Conversation

@os-zhuang

@os-zhuang os-zhuang commented Jul 19, 2026

Copy link
Copy Markdown
Contributor

背景

承接 framework#1604 / framework ADR-0034 item 4。masterDetailTx → batchTransaction → POST /api/v1/batch 的接线已存在且工作正常;本 PR 按 issue #2679 首选的**方案 A(契约先行)**清理非原子客户端回退路径。

Issue 点名的三块"回退清理":canBatch 方法嗅探门、handleParentSaved 的 best-effort 补偿删除、applyDetail 的 created 簿记。关键发现:canBatch 是方法嗅探而非端点嗅探——ObjectStackAdapter 永远有该方法,所以旧后端(无 /batch)场景今天其实是 404 直接失败,表单回退分支从不触发。真正的旧后端保护必须做在适配器内。

改动

  • @object-ui/types:batchTransaction? 提升为 DataSource 契约的一等(可选)方法,类型 BatchTransactionOperation / BatchRef,去掉 (dataSource as any) 嗅探。可选而非必选,避免在 minor 里破坏外部实现方。
  • @object-ui/core:新增 emulateBatchTransaction(顺序执行 + $ref 解析 + 失败时逆序 best-effort 补偿删除)与 runBatchTransaction(有适配器方法则用,否则模拟)。ApiDataSource / ValueDataSource / MockDataSource 均以该 helper 实现 batchTransaction。
  • @object-ui/data-objectstack:ObjectStackAdapter.batchTransaction 优先用已发布客户端的 client.data.batchTransaction(framework #3271,特性探测),否则走 POST /api/v1/batch;仅当端点缺失(404/405)或运行时不支持事务(501,framework rest-server 对此返回 501)时降级到客户端模拟。400/401/403/409/500 等真实错误照常抛出。抽出 emitBatchMutations 共用,缓存探测结果避免重复探测。这是非原子回退唯一、有测试的落点。
  • @object-ui/plugin-form:从 masterDetailTx.ts 删除 applyDetail / createMany / ApplyDetailResult;MasterDetailForm 与 LineItemsPanel 一律构建 ops 交给 runBatchTransaction,表单不再有主子表专属编排/补偿代码。LineItemsPanel 保存 + rollup 在有能力后端上现在也原子(rollup 并进同一批的父 op)。

行为差异(注意)

  • 编辑态子创建现在也会被补偿(旧 handleParentSaved 仅 !isEdit 补偿)。
  • 模拟走顺序 create,替代旧 bulk('create') 分组($ref 解析与有序语义所需;行项目量小)。
  • 当前 ObjectStack 后端(有 /batch)无行为变化;旧/受限后端保留可用但明确非原子的保存路径。硬删除模拟卡在"discovery 广播 batch 能力"这一前提上(尚未广播)。

测试 / 验证

  • 新增 core/adapters/__tests__/batchTransaction.test.ts(顺序/索引对齐、$ref id/_id/recordId 解析与前向 ref 抛错+补偿、逆序仅补偿 created、runBatchTransaction 委托/回退、驱动真 ValueDataSource 断言事件不双发)。
  • MasterDetailForm.test.tsx 新增两例无 batchTransaction 的模拟路径(端到端 $ref 解析、子失败→父补偿删除+错误 toast);现有三例原子测试不变。
  • 新增 LineItemsPanel.test.tsx(op0=含 rollup 的父 update + 子 diff;无 batchTransaction 仍可保存)。
  • onMutation.test.ts 新增适配器回退用例(404/501 warn 一次+原语保存+缓存;400 抛错不回退;SDK-present 走 SDK 不裸 fetch、事件恰一轮);masterDetailTx.test.ts 删 applyDetail 用例,补 rollup 折入 op0 验收 pin。
  • 全绿:@object-ui/core 89、@object-ui/plugin-form 205、@object-ui/data-objectstack 89、@object-ui/runner 6;5 个受改包 build 全过。
  • 变更文档:content/docs/guide/data-source.md、docs/adr/0001 addendum、rest-data-source.ts 示例注释;changeset(minor,通过 fixed-group 校验)。

说明:data-objectstack 仓库既有的 7 个 lint error(no-useless-catch / preserve-caught-error,均在本 PR 未触及的 index.ts L2025+/integration.ts)与 exportDownload.test.ts 的 type-check error 属存量问题(已用 stash 对照确认,本 PR 未新增 error)。

后续(不在本 PR)

  • framework PR #3271 发版后,适配器的 SDK 特性探测自动生效(已埋好)。
  • discovery 广播 batch 能力后,按 issue 验收第 4 条评估硬删除模拟(另开 issue)。

🤖 Generated with Claude Code

Generated by Claude Code

@zhuangjianguo @claude
feat(data): unify master-detail saves behind DataSource.batchTransact…
0385802 
…ion; isolate non-atomic fallback in the adapter (#2679)

Master-detail saves (MasterDetailForm, LineItemsPanel) now always persist
through dataSource.batchTransaction(operations) — one ordered cross-object
operation list with { $ref: <op index> } linking a child to a parent created
in the same batch. The form no longer contains any client-side orchestration
or best-effort compensation-delete; that atomicity anti-pattern is gone from
the UI layer (framework #1604 / framework ADR-0034 item 4).

- types: batchTransaction? is a first-class (optional) DataSource method,
  typed via BatchTransactionOperation / BatchRef (replaces (ds as any) sniffing)
- core: new emulateBatchTransaction (sequential + $ref resolution + best-effort
  reverse-order compensation) and runBatchTransaction (prefer adapter, emulate
  otherwise); ApiDataSource / ValueDataSource / MockDataSource implement it
- data-objectstack: ObjectStackAdapter.batchTransaction prefers the SDK
  client.data.batchTransaction when present, uses POST /api/v1/batch otherwise,
  and degrades to emulation ONLY on 404/405/501 (endpoint/ runtime missing);
  400/401/403/409/500 still surface. Extracted emitBatchMutations; cached
  detection avoids re-probing
- plugin-form: removed applyDetail/createMany/ApplyDetailResult from
  masterDetailTx.ts; MasterDetailForm + LineItemsPanel build ops and call
  runBatchTransaction. LineItemsPanel saves + rollup are now atomic on a
  capable backend
- tests: new core emulation suite, MasterDetailForm emulation-fallback +
  compensation cases, LineItemsPanel suite, adapter 404/501/400/SDK-detect
  fallback cases; docs (data-source guide, ADR-0001 addendum, rest example),
  changeset

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

vercel Bot commented Jul 19, 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 19, 2026 1:21pm

Request Review

@github-actions

github-actions Bot commented Jul 19, 2026

Copy link
Copy Markdown
Contributor

✅ Console Performance Budget

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

📦 Bundle Size Report

Package Size Gzipped
app-shell (index.js) 8.17KB 2.95KB
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.82KB 0.62KB
create-plugin (index.js) 9.28KB 2.98KB
data-objectstack (index.js) 120.81KB 30.10KB
fields (index.js) 208.98KB 51.09KB
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) 117.37KB 29.18KB
plugin-designer (index.js) 213.43KB 42.95KB
plugin-detail (index.js) 213.28KB 51.94KB
plugin-editor (index.js) 2.46KB 1.10KB
plugin-form (index.js) 102.94KB 24.95KB
plugin-gantt (index.js) 165.40KB 40.20KB
plugin-grid (index.js) 174.72KB 46.05KB
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) 1.67KB 0.75KB
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 (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 (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 marked this pull request as ready for review July 19, 2026 16:14
@os-zhuang
os-zhuang merged commit 62b9ab5 into main Jul 19, 2026
30 of 32 checks passed
@os-zhuang
os-zhuang deleted the claude/master-detail-atomic-adapter-2679 branch July 19, 2026 16:14
This was referenced Jul 19, 2026
Closed
Open
Closed
Merged
os-zhuang added a commit that referenced this pull request Jul 20, 2026
@os-zhuang @claude
fix(site): make docs build resilient to remote badge fetch failures (#…
dd8b72c 
…2695) (#2718)

`Build Docs` (@object-ui/site#build) runs fumadocs' remark-image plugin,
which fetches every remote image at build time to inline its width/height.
For remote badges (shields.io / skills.sh) this turns an external service's
availability into a hard build dependency: a shields.io hiccup (Cloudflare
520 / 1200 "Too many requests") throws and fails the entire docs build,
unrelated to the PR under test (observed on #2684).

Configure remark-image via source.config.ts:
- external: { timeout: 10_000 } — bound each remote fetch so a hung
  connection can't stall CI.
- onError — warn (don't fail the build) when a remote image can't be sized,
  while re-throwing for local/authored images so broken in-repo paths stay
  fatal.

The only live remote badge triggering a build-time fetch is the skills.sh
badge in content/docs/guide/agent-skills.md; the shields.io references live
inside code fences and are never fetched.

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

Reviewers

No reviews

Assignees

No one assigned

Labels

data-adapter documentation Improvements or additions to documentation package: core package: types plugin tests

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@os-zhuang @zhuangjianguo