Skip to content

feat(spec)!: 未知键在 flow / permission 授权 schema 上大声拒绝(#4001 Tier-A 切片) - #4071

Merged
os-zhuang merged 2 commits into
mainfrom
claude/unknown-key-stripping-strictness-h3a3zt
Jul 30, 2026
Merged

feat(spec)!: 未知键在 flow / permission 授权 schema 上大声拒绝(#4001 Tier-A 切片)#4071
os-zhuang merged 2 commits into
mainfrom
claude/unknown-key-stripping-strictness-h3a3zt

Conversation

@os-zhuang

Copy link
Copy Markdown
Contributor

#4001 的第一步落地:分类账本 + Tier-A 收紧 + 迁移/释放说明,赶在 v17 RC 窗口内(strict 收紧是破坏性变更,只能搭 major)。按 issue 自己的棘轮原则,不做全量收紧——只做有实锤证据、且逐项实证零破坏的切片。

做了什么

1. 分类账本(#4001 建议第 1 条)docs/audits/2026-07-unknown-key-strictness-ledger.md
「这个 schema 的输入由谁写」三分法(可授权 / 线上 / 开放),五个可授权目录逐文件triage(含暂定标记),其余目录粗分类,并列出棘轮下一步目标(app.zod.tsrls/sharingapproval 等)。

2. Tier-A 收紧(#3746 模板 → 共享工厂)

3. 闸门开启当天就抓到一个真 bugPermissionSetSchema 无法表达 description,但 plugin-security 的内置权限集一直在写它、Setup 投影(permission-set-projection.ts)一直在读它——此前每次 parse 都被静默剥离(ADR-0078 §3 逆向漂移类)。按 contract-first 修 spec:description 现已声明,liveness ledger 同步分类。这也证伪了「仓内元数据不带未知键」的推断——实证闸门不是流程仪式。

4. 迁移 / 释放说明 — changeset(major,含 FROM→TO 全表)+ content/docs/releases/v17.mdx 新增小节。

为什么迁移是行为保持的

被 strict 拒绝的键此前全部被静默丢弃——它们从未产生过任何运行时效果。所以对既有正常应用,删除或改名这些键不改变任何行为;变化只是 validate 不再说谎。错误消息本身携带修复方案,AI 作者走 ADR-0038 循环即可自修。

零破坏实证(#3746 同款证据链)

  • @objectstack/spec:266 文件 / 6960 用例全过,tsc --noEmit 干净
  • 下游:lint 545 / metadata 276 / platform-objects 239 / metadata-core 103 / metadata-protocol 99 / sdui-parser 6 / service-automation 440 / plugin-security 677 / core 415 / rest 505 / objectql 1179 / runtime 906 全过
  • 三个示例应用 objectstack validate 全过(showcase 29 流 + 8 权限集)
  • spec 全部 12 个 check:* 闸门 PASS(permission/description 已在 liveness ledger 分类)
  • 全部 content/docs/**/*.mdx 扫过:0 份文档在教会被新校验拒绝的键(state-machine 的 transitions、布局 DSL 的 tabs/steps 是别的 surface,不受影响)

踩坑对照(#4001「照做能省一轮 CI」清单)

  • 辅助代码块全部放在各文件首个 /** */ 之后,check:docs 一次过;permission.mdx 的再生成 diff 只有 description 一行(预期内的真实新键,非漂移)
  • check:api-surfacebuild 之后跑(新公共导出:strictUnknownKeyError / StrictUnknownKeyErrorOptions
  • 未触碰 .strict().transform() 管道,lazySchematoJSONSchema 隐患未触发(gen:schema 1783 个 schema 正常生成)

后续(不在本 PR)

按账本 verify-then-enforce:ui/app.zod.ts(导航递归 union 需要单独设计错误呈现)→ security/rls.zod.ts + sharing.zod.tsautomation/approval.zod.tsdata/hook/datasource;长尾在 minor 里先走 lint 告警(非破坏),v18 收口。账本本身后续可升级为机器校验闸门(check:liveness 模式)。

Refs #4001(不关闭——这是战役的第一个棘轮步)

🤖 Generated with Claude Code

https://claude.ai/code/session_0147tNF4Snk7Ry1KGt4a5PY4


Generated by Claude Code

…emas (#4001 Tier-A)

Zod's default .strip silently discarded undeclared keys on authorable
schemas — the instance kept parsing, so a mis-spelled or wrong-layer key
shipped as metadata that quietly ignored the author's config (#3405, #1535).
This lands the #4001 Tier-A slice inside the v17 breaking window:

- security/permission.zod.ts: PermissionSetSchema, ObjectPermissionSchema,
  FieldPermissionSchema, AdminScopeSchema are .strict() with fixable errors
  (semantic aliases, wrong-layer pointers, tombstones for the retired
  contextVariables / isProfile). EffectiveObjectPermissionSchema explicitly
  .strip()s back — response shapes stay wire-tolerant.
- automation/flow.zod.ts: FlowSchema, FlowNodeSchema, FlowEdgeSchema,
  FlowVariableSchema are .strict(); a node's config record stays open (the
  executor's configSchema, #4027/#4040, and the ADR-0087 conversion layer
  own it).
- shared/suggestions.zod.ts: new strictUnknownKeyError factory generalizing
  the #3746 hand-rolled map; ui/action.zod.ts re-homes onto it with
  byte-identical messages.
- PermissionSetSchema gains the declared `description` key — the strict
  gate's first catch: the built-in default sets author it and the Setup
  projection reads it, but the schema could not represent it, so it was
  silently stripped at every parse (ADR-0078 §3 inverse drift).
- docs/audits/2026-07-unknown-key-strictness-ledger.md: the authorable /
  wire / open triage (#4001 step 1) with the ratchet's next targets.

Verified zero breakage: spec 6960 tests + tsc clean; lint / metadata /
platform-objects / metadata-core / metadata-protocol / sdui-parser /
service-automation / plugin-security / core / rest / objectql / runtime
suites green; showcase / crm / todo `objectstack validate` clean; all 12
spec check gates pass; no doc teaches a now-rejected key.

Refs #4001 (Tier-A slice: ledger + first ratchet step; the long tail stays
verify-then-enforce per the ledger).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0147tNF4Snk7Ry1KGt4a5PY4
@vercel

vercel Bot commented Jul 30, 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)
objectstack Ignored Ignored Jul 30, 2026 8:29am

Request Review

@github-actions github-actions Bot added size/xl documentation Improvements or additions to documentation tests protocol:ui tooling labels Jul 30, 2026
@github-actions

github-actions Bot commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

📓 Docs Drift Check

This PR changes 2 package(s): packages/qa, @objectstack/spec.

106 hand-written doc(s) reference the affected code and may need an implementation-accuracy re-verification:

  • content/docs/ai/agents.mdx (via @objectstack/spec)
  • content/docs/ai/skills-reference.mdx (via @objectstack/spec)
  • content/docs/ai/skills.mdx (via @objectstack/spec)
  • content/docs/api/client-sdk.mdx (via @objectstack/spec)
  • content/docs/api/environment-routing.mdx (via @objectstack/spec)
  • content/docs/api/error-catalog.mdx (via @objectstack/spec)
  • content/docs/api/error-handling-client.mdx (via @objectstack/spec)
  • content/docs/api/error-handling-server.mdx (via @objectstack/spec)
  • content/docs/api/index.mdx (via @objectstack/spec)
  • content/docs/automation/approvals.mdx (via packages/spec)
  • content/docs/automation/flows.mdx (via @objectstack/spec)
  • content/docs/automation/hook-bodies.mdx (via packages/spec)
  • content/docs/automation/hooks.mdx (via @objectstack/spec)
  • content/docs/automation/index.mdx (via @objectstack/spec)
  • content/docs/automation/webhooks.mdx (via @objectstack/spec)
  • content/docs/automation/workflows.mdx (via @objectstack/spec)
  • content/docs/concepts/architecture.mdx (via @objectstack/spec)
  • content/docs/concepts/design-principles.mdx (via packages/spec)
  • content/docs/concepts/index.mdx (via @objectstack/spec)
  • content/docs/concepts/metadata-driven.mdx (via @objectstack/spec)
  • content/docs/concepts/metadata-lifecycle.mdx (via packages/spec)
  • content/docs/concepts/north-star.mdx (via packages/spec)
  • content/docs/data-modeling/analytics.mdx (via @objectstack/spec)
  • content/docs/data-modeling/drivers.mdx (via @objectstack/spec)
  • content/docs/data-modeling/external-datasources.mdx (via @objectstack/spec)
  • content/docs/data-modeling/field-types.mdx (via @objectstack/spec)
  • content/docs/data-modeling/fields.mdx (via @objectstack/spec)
  • content/docs/data-modeling/formulas.mdx (via @objectstack/spec)
  • content/docs/data-modeling/index.mdx (via @objectstack/spec)
  • content/docs/data-modeling/objects.mdx (via @objectstack/spec)
  • content/docs/data-modeling/queries.mdx (via @objectstack/spec)
  • content/docs/data-modeling/schema-design.mdx (via @objectstack/spec)
  • content/docs/data-modeling/seed-data.mdx (via @objectstack/spec)
  • content/docs/data-modeling/validation-rules.mdx (via @objectstack/spec)
  • content/docs/data-modeling/validation.mdx (via @objectstack/spec)
  • content/docs/deployment/cli.mdx (via @objectstack/spec)
  • content/docs/deployment/troubleshooting.mdx (via @objectstack/spec)
  • content/docs/deployment/validating-metadata.mdx (via @objectstack/spec)
  • content/docs/getting-started/build-with-claude-code.mdx (via @objectstack/spec)
  • content/docs/getting-started/common-patterns.mdx (via @objectstack/spec)
  • content/docs/getting-started/examples.mdx (via @objectstack/spec)
  • content/docs/getting-started/quick-reference.mdx (via @objectstack/spec)
  • content/docs/getting-started/quick-start.mdx (via @objectstack/spec)
  • content/docs/getting-started/your-first-project.mdx (via @objectstack/spec)
  • content/docs/kernel/cluster.mdx (via @objectstack/spec)
  • content/docs/kernel/contracts/auth-service.mdx (via packages/spec)
  • content/docs/kernel/contracts/cache-service.mdx (via packages/spec)
  • content/docs/kernel/contracts/data-engine.mdx (via @objectstack/spec)
  • content/docs/kernel/contracts/index.mdx (via @objectstack/spec)
  • content/docs/kernel/contracts/metadata-service.mdx (via packages/spec)
  • content/docs/kernel/contracts/storage-service.mdx (via packages/spec)
  • content/docs/kernel/index.mdx (via packages/spec)
  • content/docs/kernel/runtime-services/email-service.mdx (via packages/spec)
  • content/docs/kernel/runtime-services/index.mdx (via packages/spec)
  • content/docs/kernel/runtime-services/queue-service.mdx (via packages/spec)
  • content/docs/kernel/runtime-services/sharing-service.mdx (via packages/spec)
  • content/docs/kernel/runtime-services/sms-service.mdx (via packages/spec)
  • content/docs/kernel/runtime-services/storage-service.mdx (via packages/spec)
  • content/docs/kernel/services-checklist.mdx (via @objectstack/spec)
  • content/docs/permissions/authorization.mdx (via packages/qa, @objectstack/spec)
  • content/docs/permissions/delegated-administration.mdx (via packages/qa)
  • content/docs/permissions/permission-sets.mdx (via @objectstack/spec)
  • content/docs/permissions/permissions-matrix.mdx (via @objectstack/spec)
  • content/docs/permissions/positions.mdx (via @objectstack/spec)
  • content/docs/permissions/rls.mdx (via @objectstack/spec)
  • content/docs/permissions/sharing-rules.mdx (via @objectstack/spec)
  • content/docs/plugins/adding-a-metadata-type.mdx (via @objectstack/spec)
  • content/docs/plugins/development.mdx (via @objectstack/spec)
  • content/docs/plugins/index.mdx (via @objectstack/spec)
  • content/docs/plugins/packages.mdx (via @objectstack/spec)
  • content/docs/protocol/backward-compatibility.mdx (via @objectstack/spec)
  • content/docs/protocol/diagram.mdx (via packages/spec)
  • content/docs/protocol/kernel/config-resolution.mdx (via @objectstack/spec)
  • content/docs/protocol/kernel/i18n-standard.mdx (via @objectstack/spec)
  • content/docs/protocol/kernel/index.mdx (via @objectstack/spec)
  • content/docs/protocol/kernel/lifecycle.mdx (via @objectstack/spec)
  • content/docs/protocol/kernel/plugin-spec.mdx (via @objectstack/spec)
  • content/docs/protocol/kernel/runtime-capabilities.mdx (via @objectstack/spec)
  • content/docs/protocol/knowledge.mdx (via @objectstack/spec)
  • content/docs/protocol/objectql/index.mdx (via @objectstack/spec)
  • content/docs/protocol/objectql/query-syntax.mdx (via @objectstack/spec)
  • content/docs/protocol/objectql/schema.mdx (via @objectstack/spec)
  • content/docs/protocol/objectql/security.mdx (via packages/spec)
  • content/docs/protocol/objectql/state-machine.mdx (via @objectstack/spec)
  • content/docs/protocol/objectui/actions.mdx (via @objectstack/spec)
  • content/docs/protocol/objectui/concept.mdx (via @objectstack/spec)
  • content/docs/protocol/objectui/index.mdx (via @objectstack/spec)
  • content/docs/protocol/objectui/layout-dsl.mdx (via @objectstack/spec)
  • content/docs/protocol/objectui/record-alert.mdx (via @objectstack/spec)
  • content/docs/protocol/objectui/widget-contract.mdx (via @objectstack/spec)
  • content/docs/releases/implementation-status.mdx (via @objectstack/spec)
  • content/docs/releases/index.mdx (via @objectstack/spec)
  • content/docs/releases/v12.mdx (via @objectstack/spec)
  • content/docs/releases/v13.mdx (via @objectstack/spec)
  • content/docs/releases/v16.mdx (via @objectstack/spec)
  • content/docs/releases/v17.mdx (via @objectstack/spec)
  • content/docs/releases/v9.mdx (via @objectstack/spec)
  • content/docs/ui/actions.mdx (via @objectstack/spec)
  • content/docs/ui/create-vs-edit-form.mdx (via @objectstack/spec)
  • content/docs/ui/dashboards.mdx (via @objectstack/spec)
  • content/docs/ui/forms.mdx (via @objectstack/spec)
  • content/docs/ui/index.mdx (via @objectstack/spec)
  • content/docs/ui/public-data-collection.mdx (via @objectstack/spec)
  • content/docs/ui/setup-app.mdx (via @objectstack/spec)
  • content/docs/ui/translations.mdx (via @objectstack/spec)
  • content/docs/ui/views.mdx (via @objectstack/spec)

Advisory only. To re-verify, run the docs-accuracy-audit workflow scoped to these files:
node scripts/docs-audit/affected-docs.mjs origin/main → pass the list as args.docs.

…; drop a dead flow key

The dogfood gate caught two more instances of the exact class #4001 targets —
both invisible until the .strict() gate made them loud:

- PermissionSetSchema could not represent the ADR-0010 runtime protection
  envelope. MetadataPlugin's artifact loader calls applyProtection on EVERY
  metadata type, and getMetaItemLayered -> saveMetaItem round-trips a body
  carrying the stamped _packageId/_provenance; every sibling registered type
  (object/view/app/dashboard/report/dataset/flow/agent/tool/skill/
  email_template) spreads MetadataProtectionFields and permission was the
  outlier, so the envelope was stripped at every parse. Now declared, with the
  author-facing `protection` block alongside it. Without this a package-owned
  set cannot round-trip through an ADR-0094 environment overlay.
- flow-touch-fixture.ts declared `sharingModel` on a FLOW — an object-level OWD
  key copy-pasted with an ADR-0090 grandfather-stamp comment describing a gate
  flows do not have. Authored in good faith, silently discarded, believed to be
  in effect. Removed; the identical stamp on the fixture's object is real.

Verified: dogfood 71 files / 410 tests pass locally; spec 6961 tests; all 12
spec check gates green.

Refs #4001

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0147tNF4Snk7Ry1KGt4a5PY4

Copy link
Copy Markdown
Contributor Author

Dogfood gate 的两个失败已修复并推送(5501533)。两个都是真问题,而且都是 #4001 针对的那一类——在 strict 闸门之前完全不可见:

1. PermissionSetSchema 无法表达 ADR-0010 运行时保护信封(红在 showcase-permission-projection 的 422)
MetadataPlugin 的制品加载循环对每一种元数据类型调用 applyProtection,而 getMetaItemLayered → saveMetaItem 会把带 _packageId/_provenance 的 body 原样回传。所有同级已注册类型(object / view / app / dashboard / report / dataset / flow / agent / tool / skill / email_template)都 spread 了 MetadataProtectionFields唯独 permission 是例外——所以信封在每次 parse 时被静默剥离。现已声明,并按同级惯例一并补上作者侧的 protection 块。没有这一条,package 持有的权限集根本无法走完 ADR-0094 的环境 overlay 往返。

2. dogfood fixture 在一个 flow 上写了 sharingModel(红在 flow-node.dogfood.test.ts
对象级 OWD 键被复制到了 flowTouch 上,还附着一句 ADR-0090「grandfather stamp」注释——描述的是 flow 根本不存在的那道闸门。善意写下、被静默丢弃、作者以为生效了:教科书级的 #4001 现场。已删除;同一 fixture 的对象上那份同样的 stamp 是真的,保留。

连同首轮的 description,闸门开启至今已抓到 3 个真实缺陷,其中 2 个是逆向漂移(运行时在写、spec 无法表达)——这个方向恰恰是 liveness ledger 的逐属性视角看不见的。三个都写进了账本的 findings log。

顺带记录一个同类隐患(本 PR 不扩大范围):identity/position.zod.ts 作为另一个已注册的 security 类型,同样漏了 MetadataProtectionFields。今天无害(schema 未 strict,键被静默剥离,和之前的 permission 一样),但在 position 进入棘轮之前必须先声明——已记在账本里。

本地验证:dogfood 71 文件 / 410 用例全过,spec 6961 用例,12 个 check:* 闸门全绿。

docs-drift-check 那条是 advisory(@objectstack/spec 一动就列出全部 105 篇),无需处理。


Generated by Claude Code

@os-zhuang
os-zhuang marked this pull request as ready for review July 30, 2026 08:55
@os-zhuang
os-zhuang merged commit 8f81731 into main Jul 30, 2026
18 checks passed
@os-zhuang
os-zhuang deleted the claude/unknown-key-stripping-strictness-h3a3zt branch July 30, 2026 08:55
os-zhuang added a commit that referenced this pull request Jul 30, 2026
…positions (#4001 step 2) (#4099)

Second click of the unknown-key strictness ratchet (first: flow + permission,
#4071), covering the remaining small security-class authoring surfaces from
the ledger's next-target list:

- security/rls.zod.ts: RowLevelSecurityPolicySchema is .strict() — a silently
  dropped key meant a row-level restriction was never compiled into the
  filter. The runtime shapes stay tolerant; the retired `priority` keeps its
  tombstone.
- security/sharing.zod.ts: the sharing-rule base, criteria extension, and
  sharedWith recipient are .strict() (strictness and the error map ride the
  base into the extension).
- identity/position.zod.ts: PositionSchema is .strict() and gains the
  protection block + ADR-0010 runtime envelope, closing the sibling gap the
  #4071 ledger flagged.

Fourth ledger finding: position.test.ts asserted a fictional hierarchy — a
pre-ADR-0090 `parent` key that only ever "passed" because .strip ate it.
Rewritten to assert rejection with the flatness guidance.

Verified: spec 6973 tests + tsc clean; all 12 check gates; plugin-security
677 / lint 546 / metadata 276 / platform-objects 239 / metadata-protocol 99;
dogfood 72 files / 418 tests; showcase / crm / todo validate clean.
os-zhuang added a commit that referenced this pull request Jul 30, 2026
…4001 step 3) (#4119)

Third click of the unknown-key strictness ratchet (flow + permission in
#4071, RLS / sharing / position in #4099). Approval is a v17-new authoring
surface — tightened while young, before stored volume exists:

- ApprovalNodeConfigSchema, ApprovalNodeApproverSchema,
  ApprovalEscalationSchema and DecisionOutputDefSchema are .strict() with
  fixable errors via the shared strictUnknownKeyError factory.
- ApprovalNodeConfig's guidance is the ADR-0019 re-home map: steps ->
  successive approval nodes on the canvas, entryCriteria -> the entering
  edge's condition, onApprove/onReject -> the approve/reject out-edges,
  rejectionBehavior -> a declared back-edge (ADR-0044) with maxRevisions.
- The published JSON schema (getApprovalNodeConfigJsonSchema) carries
  additionalProperties:false into the Studio property form AND registerFlow's
  per-node config validation (#4027/#4040). Verified the #3746 hazard:
  z.toJSONSchema on the strict lazySchema does not throw.

Verified: spec 6995 tests + tsc clean; all 12 check gates; plugin-approvals
326 / service-automation 457; dogfood 72 files / 418 tests; showcase / crm /
todo validate clean.
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 protocol:ui size/xl tests tooling

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants