Skip to content

docs(spec): lifecycle.storage rotation 文案补上方言限定 — O(1) 分片 DROP 仅 SQLite (#6631) - #6789

Merged
os-project-manager merged 1 commit into
mainfrom
claude/issue-6631-rotation-dialect-caveat
Aug 8, 2026
Merged

docs(spec): lifecycle.storage rotation 文案补上方言限定 — O(1) 分片 DROP 仅 SQLite (#6631)#6789
os-project-manager merged 1 commit into
mainfrom
claude/issue-6631-rotation-dialect-caveat

Conversation

@os-project-manager

Copy link
Copy Markdown
Collaborator

Fixes#6631

缺陷

packages/spec/src/data/object.zod.tslifecycle.storage 块有三处无条件表述,实际只在 SQLite 上为真(实测行号,基于 origin/main @ a5d25734c):

  • :735-737maxAge guidance:"Rotation does not reap by age — it retains shards × unit of history and DROPs the oldest shard whole."
  • :740strategy: z.literal('rotation').describe():"Time-shard the table; rotate by DROPping the oldest shard (O(1) reclaim)."
  • :603 — 模块 TSDoc:"Rotator (time-shard + DROP oldest)"。

权威(逐条实测)

  • packages/drivers/driver-sql/src/sql-driver.ts:4128-4130:get supportsRotation() { return this.isSqlite; };:4173-4175:rotateShards 在其他方言直接 throw。:4121-4123 驱动注释本身已把分野写对——"SQLite-only; on other dialects the LifecycleService falls back to an age-based reap, so the declared bound holds everywhere — only the reclamation mechanics differ."
  • packages/objectql/src/lifecycle/lifecycle-service.ts:925-937:else if (lc.storage?.strategy === 'rotation' && !rotated && !lc.ttl) 分支调用 reap(engine, object, lc, 'rotation-fallback', 'created_at', windowMs, report) —— 按 created_at年龄 reap,恰是旧 guidance 宣称 rotation 不使用的机制;outcome 枚举自己就叫 'rotation-fallback'
  • 驱动普查:packages/drivers/ 五个驱动中,supportsRotation 只在 driver-sql 声明、只在 isSqlite 下为 true;其余驱动无 rotateShards

修改(纯文案,一个从句的代价)

三处均改为驱动注释已有的表述:保留窗口(shards × unit)在所有方言一致——声明的边界处处成立;回收机制不一致——SQLite 整分片 DROP(O(1) 回收),其他方言按年龄从 created_at reap 同一窗口。maxAge guidance 的路由建议("Set the window with shards/unit, or use retention instead of rotation.")逐字保留

接受面零变化:未触碰任何 superRefine/.refine/类型/枚举/可选性;retention.onlyWhen × rotation 的拒绝(理由同样是方言特定的)按 issue 划定明确不动。content/docs/references/data/object.mdx 不含这三段文案(生成器只渲染顶层 property 表),check:docs 绿,无需再生成。

Pin(批 20 新增两条,反空洞 + 按惯用语匹配)

  • guidance 侧:lifecycle.storage.maxAge 的拒绝文案必须点名两条腿(/SQLite/ + 按龄 reap 惯用语),路由建议句作反空洞锚(guidance 条目整体消失即红),兄弟未知键作对照(证明匹配的是本键的 guidance 而非 surface 通用文案),并钉死旧句 "does not reap by age" 不得以原文回归。
  • describe 侧:strategy.description 非空、仍描述分片机制(反空洞),同样双腿匹配,旧无条件句钉死。

逆向验证(方向先行)

预测:回退三处文案(保留 pin)→ 恰好两条新 pin 红(红点落在 SQLite/按龄断言,反空洞守卫在回退文案上保持绿),其余 45 条测试不动;恢复 → 全绿。
实测:完全一致 —— 回退后 2 failed | 45 passed,失败断言分别在 :295(guidance 侧 /SQLite/)与 :312(describe 侧 /SQLite/),均位于反空洞守卫之后;恢复后该文件 47 条全绿,spec 全套 345 files / 8848 tests 全绿。

验证

  • pnpm --filter @objectstack/spec test — 345 passed / 8848 passed
  • pnpm --filter @objectstack/spec typecheck — 绿(test-typecheck-debt.json 批 20 条目 2 → 1:pin 引用了此前未使用的 LifecycleSchema import,消掉一条 TS6133;按 ratchet 要求重录)
  • node scripts/check-type-check-coverage.mjs --re-measure(先按 lint.yml 构建 closure)— OK,34 entries re-measured,无一上漂
  • check:docs / check:generated / check:api-surface / check:authorable-surface / check:spec-changes / check:upgrade-guide — 绿(api-surface 的 stale 为未建 dist 的本地伪象,干净 main 同样报;dist 构建后绿)
  • node scripts/check-nul-bytes.mjs — OK;changed files ESLint — 0 problems

Changeset:.changeset/lifecycle-rotation-dialect-caveat.md(@objectstack/spec patch —— .describe() 为已发布文案)。

🤖 Generated with Claude Code

https://claude.ai/code/session_018ffcE95NaMJcL9XJ9VDYgk


Generated by Claude Code

…te (#6631)
The maxAge guidance, the strategy .describe() and the module TSDoc stated
the SQLite-only shard-DROP mechanism as an unconditional property of the
rotation strategy. Measured authority: driver-sql gates physical rotation
behind supportsRotation (isSqlite only) and rotateShards throws elsewhere;
the LifecycleService then takes its 'rotation-fallback' leg — an age-based
reap from created_at, exactly the mechanism the old guidance said rotation
does not use.
All three sites now carry the split the driver note already states: the
retained window (shards x unit) is identical on every dialect; only the
reclamation mechanics differ (SQLite DROPs the oldest shard whole, O(1);
other dialects reap the same window by age). The maxAge guidance's routing
advice survives verbatim. Text-only: LifecycleSchema's acceptance surface
is unchanged and the superRefine is untouched.
Two pins added in batch 20 (both with anti-vacuity guards, matched by
idiom): the guidance bullet and the strategy description must each name
both legs; reverse-verified red on the reverted text, green on this one.
test-typecheck-debt re-recorded 2 -> 1 for the batch-20 file (LifecycleSchema
is now imported, retiring its unused-import entry).
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_018ffcE95NaMJcL9XJ9VDYgk
@vercel

vercelBot commented Aug 8, 2026

Copy link
Copy Markdown

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

1 Skipped Deployment
ProjectDeploymentActionsUpdated (UTC)
objectstackIgnoredIgnoredAug 8, 2026 5:40pm

Request Review

@github-actions

Copy link
Copy Markdown
Contributor

📓 Docs Drift Check

This PR changes 1 package(s): @objectstack/spec.

112 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 @objectstack/spec)
  • content/docs/automation/connectors.mdx(via @objectstack/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 @objectstack/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/tenancy-modes.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 @objectstack/spec)
  • content/docs/kernel/index.mdx(via packages/spec)
  • content/docs/kernel/runtime-services/data-service.mdx(via @objectstack/spec)
  • content/docs/kernel/runtime-services/email-service.mdx(via packages/spec)
  • content/docs/kernel/runtime-services/examples.mdx(via @objectstack/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 @objectstack/spec)
  • content/docs/kernel/runtime-services/sms-service.mdx(via packages/spec)
  • content/docs/kernel/runtime-services/storage-service.mdx(via @objectstack/spec)
  • content/docs/kernel/services-checklist.mdx(via @objectstack/spec)
  • content/docs/kernel/services.mdx(via @objectstack/spec)
  • content/docs/permissions/authorization.mdx(via @objectstack/spec)
  • 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/http-protocol.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/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/apps.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/field-grouping-and-order.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.

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationImprovements or additions to documentationprotocol:datasize/mteststooling

Projects

None yet

2 participants

@os-project-manager@claude