feat(engine)!: findOne, update and delete declare what they answer, and their hook seams are guarded (#16231) - #16783
Conversation
…s measurement leg Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01ADLdAs2pVcH17h9tZKWMBg
…heir hook seams Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01ADLdAs2pVcH17h9tZKWMBg
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01ADLdAs2pVcH17h9tZKWMBg
…clare-engine-verb-results
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01ADLdAs2pVcH17h9tZKWMBg
…codes Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01ADLdAs2pVcH17h9tZKWMBg
…prose Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01ADLdAs2pVcH17h9tZKWMBg
…he off-contract driver doubles Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01ADLdAs2pVcH17h9tZKWMBg
📓 Docs Drift CheckThis PR changes 5 package(s): 37 hand-written doc(s) name something this change touched — list omitted above 15 rows. Re-derive on the tree named below: ⛔ 4 release-owned page(s) also affected — read-only, see AGENTS.md Documentation Guardrails. What this run could not see
Coarse fallback — 136 page(s) merely mention a changed package (the pre-#9192 predicate, kept for the deliberately-wide backstop): Which tree this was computed onThis run read A worktree cut from an older # while this PR is open — GitHub drops the merge commit once it closes
git fetch origin 223f889a0977c0efee9ee8ec4e162551912d17d6 && git checkout 223f889a0977c0efee9ee8ec4e162551912d17d6
# afterwards, rebuild it from the two parents, which stay fetchable
git fetch origin ed7243d52bbc1b6d00a3b621b0dcea4925df32b5 c5935b2445a301181271767e9b2718242eec1dd9 && git checkout -B drift-repro ed7243d52bbc1b6d00a3b621b0dcea4925df32b5 && git merge --no-ff c5935b2445a301181271767e9b2718242eec1dd9
node scripts/docs-audit/affected-docs.mjs --json ed7243d52bbc1b6d00a3b621b0dcea4925df32b5
|
Contract review (
|
| verb | origin/main |
head | driver exit(s) actually reached |
|---|---|---|---|
IDataEngine.findOne / ObjectQL.findOne / IScopedObjectRepository.findOne |
Promise<any> |
Promise<Record<string, any> | null> |
driver.findOne → Record<string, unknown> | null |
IDataEngine.update / ObjectQL.update / IScopedObjectRepository.update |
Promise<any> |
Promise<Record<string, any> | number | null> |
by-id driver.update → record-or-null; predicate driver.updateMany → count (only two result = assignments exist inside update(), engine.ts:11839 and :12047) |
IDataEngine.delete / ObjectQL.delete |
Promise<any> |
Promise<boolean | number> |
by-id driver.delete → boolean; predicate driver.deleteMany → count |
No throw arm was added to the declarations; the guards add one runtime arm each. "Hook seams are guarded" in code: verb-hook-result-shape.ts exports three typeof/Array.isArray container predicates (isFindOneResultShape, isUpdateResultShape, isDeleteResultShape — identity-free, so in-place mutation and reassignment to a legal shape stay legal; false/0/null are admitted where declared; undefined refused everywhere), and engine.ts calls each immediately after the after* dispatch and before maskSecretFields/stripSearchCompanion*/realtime publish (:9819, :12105, :13585), throwing an error class with code+status (500) — the same placement and envelope as #15823's find() guard.
Consumers (in-repo, non-test, head): packages/metadata/src/loaders/database-loader.ts (3 sites), packages/metadata-protocol/src/protocol.ts (4 by-id engine.update sites + updateData), packages/plugins/plugin-auth/src/objectql-adapter.ts (2), packages/runtime/src/sandbox/body-runner.ts (2), packages/objectql/src/lifecycle/lifecycle-service.ts (2), packages/objectql/src/validation/rule-validator.ts, packages/core/src/utils/{bulk-write,metadata-activation-store}.ts, packages/platform-objects/src/system/migration-flag.ts, packages/metadata-protocol/src/migrations/recorded-by-sentinel.ts, spec migration entries (prose examples), examples/app-showcase (3 ql.update calls, result discarded), examples/app-todo (its own engine shape on the action ctx, not IDataEngine). apps/* and examples/* are workspace members (pnpm-workspace.yaml) and were inside the turbo run typecheck census. Compiled types move only where a result is read without a null check or where the number limb reaches a record slot — the three non-test files the census names, plus 15 test files; I found no fourth. Runtime behaviour on the published doors: yes (Clause-②) — three new 500 refusal paths at the seams. Against every in-repo driver (memory results[0] || null, sql results[0] || null / formatOutput(...) || null / count > 0, mongodb ?? null / deletedCount > 0, turso ?? null / rowsAffected > 0) every exit is on-contract, so no in-repo caller's runtime output changes; the only measured runtime effects were the seven off-contract test doubles the PR repairs. The consumer repairs are no-ops on reachable paths (number limb unreachable from by-id calls) — verified against resolveEngineUpdateDispatch's use at :11252.
4. Changeset
.changeset/engine-verb-result-declarations.md: @objectstack/spec: minor, @objectstack/objectql: minor, @objectstack/metadata: patch, @objectstack/metadata-protocol: patch, @objectstack/plugin-auth: patch. **BREAKING** banner present; <!-- adr-0087: not-required (no-migration-prescription) … --> parses — check-adr-0087-registration on the head logs [BREAKING+bang] not-required (no-migration-prescription); the ! commit owes both and both are present. major correctly refused/absent. But the level axis is red — see F1. Type FROM/TO per door is stated; runtime FROM/TO is stated once for all three doors — see F3.
5. Tests
packages/objectql/src/engine-verb-hook-result-shape.test.ts: 29 cases (9/9/9 per verb + 2 vocabulary), counted independently; 15 refusal cases assert instanceof + code + status + event + object + observed via an outcomeOf capture (no bare toThrow()), 14 answerability/shaping cases exercise the real engine over an on-contract driver. Refusal cases redden if any guard is removed (consistent with the PR's 15/14 ablation; the 14 greens are held by the engine/driver, correctly). The { deleted: 1 } envelope has its own pin; the sanitizeRowError SQL-verb constraint is pinned. ErrorCode.safeParse control rejects a near-miss spelling. No it.skip/.only/.todo/xit in any changed test file (scanned all 17). Typecheck coverage: tsconfig.test.json includes src/**/*, typecheck chains check:test-typecheck; CI Type Check · workspace / debt ledger green. The seven double repairs (data-engine.test.ts, engine.test.ts, plugin.integration.test.ts, engine-filter-tokens.test.ts, seed-loader.test.ts) are as described. Gap: the declarations themselves have no pin — see F2.
6. ADR-0112 / vocabulary ledger
FIND_ONE_HOOK_RESULT_NOT_RECORD, UPDATE_HOOK_RESULT_NOT_WRITE_SHAPE, DELETE_HOOK_RESULT_NOT_WRITE_SHAPE are registered in ERROR_CODE_LEDGER (error-code-ledger.zod.ts) with owner/meaning comments, carry readonly status = 500 (what check:error-status-conformance derives from), and the generated contract.mdx / error-code-ledger.mdx are regenerated (+3). The registration footprint is byte-for-byte the precedent's: the six non-test files naming FIND_HOOK_RESULT_NOT_ARRAY on main are exactly the six naming the new codes on the head. ADR-0130 in this repo is the release-artifact co-ownership boundary and has no interplay with these codes; the runtime vocabulary these must be in is ADR-0112 D3/D4's ledger, and they are.
7. CI on head c5935b2445
38 check runs: failure 2 (Check Changeset, both workflow runs — same cause, F1), success 30, skipped 6 (Auto Label/Check PR Size duplicates, Packed-tarball smoke (opt-in) ×2, Console Pin Gate), in_progress 0. mergeable_state: unstable. Head is 17 commits behind origin/main (dd2184ae), merge-base 8ccf7a1d.
Findings
F1 — BLOCKING. Check Changeset is red on the level axis. Log, verbatim: ⛔ This PR declares clause-② YES and grades a package it grew patch. naming @objectstack/metadata: patch and @objectstack/metadata-protocol: patch. @objectstack/plugin-auth: patch is the same case and escapes only through the gate's packages/*/src/** blind spot the PR body itself cites (#16713). The PR body's "111 derived, 111 run, all exit 0" is not a reading of this axis: run locally, check-changeset-no-major has no $GITHUB_EVENT_PATH, reads no declaration, and reports NOT MEASURED with exit 0. Expectation: raise the three consumer entries to minor (the fixed group versions in lockstep, so the published version outcome is identical) — or, if the seat rules the declaration wrong for consumer repairs, have that ruled rather than tolerated in the gate; and correct the body's gate claim to say the level axis was NOT MEASURED locally.
F2 — The three declarations have no pin; only the guards do. Reverting findOne/update/delete to Promise<any> while keeping the guards reddens nothing: every census repair (if (!row), typeof x === 'number' ? … : …, result!.assignee) and the one new typed helper (writtenRow(result: Record<string, any> | number | null)) compiles identically against any. Ruling A's declaration half is therefore unenforced (ADR-0049). Expectation: a type-level pin under check:test-typecheck in packages/spec/src/contracts/data-engine.test.ts — e.g. // @ts-expect-error on an un-null-checked property read of findOne's result and on delete's result used as a record, and a number-limb narrowing that fails to compile if update widens back to any.
F3 — Changeset runtime FROM/TO is aggregated, not per door. The type FROM/TO is per verb, but the runtime change ("a host that installs after* handlers … now receives a refusal") is one sentence for three doors, and omits the second source the PR's own developerMessage names: an off-contract driver answer now trips the refusal too. Expectation: three FROM/TO lines (per door: FROM whatever the dispatch left, returned silently → TO 500 <CODE>), each naming both sources.
F4 — byIdUpdateRecord (metadata-protocol/src/protocol.ts) throws a bare Error with no ADR-0112 code on the number limb. Unreachable by construction today, so acceptable as an invariant assertion; note that if it ever fires at an HTTP door it demotes to a generic 500 with no branchable code.
F5 — Observation, no change owed. The update guard checks the batch hookContext after the per-row afterUpdate fan-out; per-row contexts are separate objects (buildPerRowAfterContexts), so a per-row handler's ctx.result reassignment never reaches the seam. That matches the ruling (the batch context is what the call returns) but the engine.ts:12117 comment "a per-row handler can reassign it" overstates it, and no pin covers the per-row path.
F6 — Reported gap is real; needs a card number before landing. ScopedContext.object(name): ObjectRepository (engine.ts:14728) returns the class, whose five verbs still declare Promise<any> (:14571–:14612), so the hook author's door ctx.api.object(x).findOne() is not narrowed. The PR reports it and the PM seat said it will file; no card is referenced yet on the PR or #16231. Expectation: the follow-up card numbers (this and the type-surface-only gate defect) appear on the PR before it leaves draft.
F7 — 17 commits behind main; mergeable_state: unstable. Bring the branch up to date after F1 so the gate re-reads on a current merge-base.
Seat boundaries: no approval/review action, no label, title, body or branch change, no merge, no file edited; throwaway review refs deleted.
Generated by Claude Code
Fixes #16231
Clause-②: yes
Executes the maintainer ruling on #16231 — option A, 「同意」, director seat summon #17, decision batch #2, comment
5572153316. Options B (declare only, no enforcement) and C (recordanyas intended) were refused there and nothing here reopens them.Angle brackets do not survive this body's sanitizer, so declared types are spelled with square brackets, the same convention the card uses:
Promise[Record[string, any] | null]is the real generic.What this changes
engine.tshas fourreturn hookContext.resultsites, one per hook-bearing verb. #15823 closed thefind()one — anafterFindhandler that replaced the array made a method declaredPromise[any[]]resolve to an envelope, silently — and recorded that it could close only that one, because the other three declaredPromise[any]and carried nothing a handler could break. A guard cannot exist before a declaration worth guarding does. This PR writes the three declarations down and then closes their seams.findOnePromise[any]Promise[Record[string, any] | null]driver.findOne→Promise[Record[string, unknown] | null]updatePromise[any]Promise[Record[string, any] | number | null]driver.update→ record-or-null; predicatedriver.updateMany→ affected count (#4639)deletePromise[any]Promise[boolean | number]driver.delete→ boolean; predicatedriver.deleteMany→ affected count⭐ The shapes were derived from the code, not from an assumed symmetry with
findOne.updateanddeleteeach have TWO driver exits and the dispatch ladder (resolveEngineUpdateDispatch/ its delete twin) picks between them, which is exactly why their declaration is a UNION andfindOne's is not.engine.tsstates the predicate half in its own prose at the branch that feeds the realtime publish — the sentence cites #4639 and reads: "A predicate update … an affected-row COUNT, which the strip skips as a non-object." (The verb between those two words is a closing keyword, so it is elided here rather than parked beside a card number.)Record[string, any], notRecord[string, unknown]). That is #15823's precedent extended exactly rather than softened:find()declaresPromise[any[]], so the CONTAINER is the contract and the rows inside areany. It is also the only spelling that can state "record or null" at all, sinceany | nullcollapses toanyin TypeScript. The strict alternative was measured and is reported on the card as a strictly larger option.The census — done FIRST, posted on the card before any declaration shipped
The maintainer accepted ruling A on a stated precondition: count the consumers whose compilation the narrowing breaks, and post the number on the card. Discharged in comment 5578614790.
18 files · 92 compile errors, measured by compiling all 31 workspace packages twice:
turbo run typecheck --continueon the unmodified worktree atorigin/main5e53d73d83: 142 tasks, 142 successful, exit 0. A clean baseline, so every treatment error is attributable.srcfiles / 9 sites; 15 test-and-pin files / 83 errors. ⭐ A census scoped to non-test sources would have said 3 files and been wrong by a factor of six — the pins are where this contract is encoded.TS18047: 'row' is possibly 'null': the null check the declaration exists to force.objectstack-ai/objectui, cloned at67299bf43b: 0 consumers (386 files import@objectstack/spec— the positive control fires — and zero nameIDataEngine,IObjectQLEngine,IScopedObjectRepositoryorIScopedContext).objectstack-ai/cloudis not reachable by this session and is unmeasured; so are npm consumers outside the org.Every one of the 92 is repaired here.
A second drift class the GUARD found, that the type could not
Four test doubles answered shapes their own
IDataDrivercontract does not have, invisible while the engine door saidany:{ deleted: 1 }/{ deleted: 0 }fromdelete/deleteMany—packages/spec/src/contracts/data-engine.test.ts,packages/runtime/src/seed-loader.test.ts,packages/objectql/src/engine-filter-tokens.test.tsupdateMany, which declaresPromise[number]—packages/objectql/src/plugin.integration.test.ts(two doubles)undefinedfrom a barevi.fn()onupdate/delete—packages/objectql/src/engine.test.ts(two doubles)All repaired to the declared shapes, and the
{ deleted: n }envelope now has a pin of its own so it cannot come back.find()'s refusal can say "your handler replacedctx.result" because the value at that seam always comes fromdriver.find, which every driver answers with an array. These three verbs have exits that can answer off-contract themselves, so the sentence now names the SEAM and accuses nobody — "after the 'afterUpdate' dispatch 'ctx.result' is undefined" — anddeveloperMessagenames BOTH possible sources. A sentence blaming the handler would have sent four of the repairs above to the wrong file.Symbols re-derived on
origin/main, with firing controlsThe card's own anchors (
:9565/:9784/:12103/:13537, atbdc02182b) had all drifted, so everything was re-derived by symbol viagit show origin/main:..., never from a working tree.hookContextoccurs 116 times inengine.ts, which is 15,020 lines — both matching the dispatch's stated readings exactly.return hookContext.resultsites::9599,:9818,:12137,:13572find :9439→Promise[any[]];findOne :9705,update :10871,delete :13089→ allPromise[any]packages/spec/src/contracts/data-engine.ts:276/:278/:279;scoped-context.ts:148/:164The surface the ruling does not name — reported, not absorbed
ObjectRepositoryatengine.ts:14498+is the same contract, not a separate one:export class ObjectRepository implements IScopedObjectRepository, the very interface the ruling names atscoped-context.ts:148/164. But narrowing the interface does not narrow the class, because TypeScript'simplementsacceptsPromise[any]against any declared return —anyis assignable in both directions.That matters because
ScopedContext.object(name): ObjectRepositoryreturns the class, andScopedContextISHookContext.api. ⇒ a hook author writingctx.api.object('task').findOne(...)still readsanyafter this PR; only a consumer who annotates the api asIScopedContextgets the narrowed answer. ⛔ Not fixed here — it needs its own consumer census, and widening this PR to take it is what the dispatch forbade. Same forIScopedObjectRepository.updateById(scoped-context.ts:167), stillPromise[any]; the ruling names:148/164and not:167.Verification
Two-leg ablation, blob-hash-verified restore. The three shape predicates in
verb-hook-result-shape.tswere mutated to always answer "legal".TS6133, an unused symbol), sodistnever carried it andablation-dist-preflightcorrectly said ABSENT. The second compiled but carried its marker in a//comment, which the bundler strips — again ABSENT. Only the third, whose marker is a live string literal read through.length, is the measurement below.eb59c5c9…→352bd54d…·pnpm --filter @objectstack/objectql buildexit 0 ·ablation-dist-preflight … ABLATION_16231_GUARD_DISABLED→✓ marker present in 4 built files, exit 0 · pin suite 15 failed | 14 passed (29).git checkout HEAD -- PATH·RESTORE ok: blob eb59c5c9e87e67ceb0371bb3084d85ec70338310 == HEAD·git diff HEADfor the path EMPTY · preflight--absent→✓ marker absent from all 14 built filesand✓ tree: working tree clean against HEAD, exit 0 · pin suite 29 passed (29).Tests, all re-run after the final commit —
git rev-parse --short HEAD=c5935b2445, working tree clean:@objectstack/objectql@objectstack/spec@objectstack/metadata@objectstack/metadata-protocol@objectstack/plugin-auth@objectstack/plugin-approvals@objectstack/rest@objectstack/runtime@objectstack/service-automationOS_TEST_MYSQL_URLand unrelated to this change:src/migrations/seed-tenancy-backfill.live-mysql.test.ts(5) andsrc/migrations/sys-setting-identity-index.live-mysql.test.ts(5), bothdescribe.skipIf(!MYSQL_URL).typecheck legs.
tsc --noEmitand the per-packagecheck:test-typecheckratchet both ran. The ratchet is the leg that matters here, because it sees the test layer the plain build does not:@objectstack/objectqlOK (44 files / 242 errors / 69 pinned signatures held),@objectstack/specOK (54 / 261 / 145),@objectstack/runtimeOK (27 / 191 / 69).@objectstack/service-automationcompiles its tests through plaintsc --noEmit, which went from 30 errors to exit 0.Gate reconciliation, verbatim — derived and re-run in full on the FINAL head
c5935b2445(node scripts/pm/dispatch-gates.mjs --repo objectstack-ai/objectstack --ran RANFILE, exit 0), with all 111 exiting 0:check:type-check-debt,check:type-check-coverage,check:test-source-alias,check:cross-package-test-inputs,check:dual-build-cjs-loads,check:engine-double-contract) measure the tree, so a late commit moves exactly the readings a stale run would have quoted.The first derivation named 88; regenerating
content/docs/references/**(the error-code ledger gained three codes) grew the change set and the re-derivation named 111. The extra 23 were run and reconciled. Two went red and were fixed rather than argued:@objectstack/spec check:docs(generated docs out of date — regenerated withgen:schema && gen:docs) andcheck:doc-authoring(a tracker id had landed inside a runtime string, which reaches operators who cannot resolve one). ⛔ Neithercheck:type-check-debtnorcheck:dual-build-cjs-loadsrefused withPREREQUISITE NOT MET: both ran on a fully built closure and reported real measurements (5 ledger entries re-measured, 55 raw tsc errors, none above its recorded number;entries/packages/cjsFiles/probes 104/67/620/1 vs floors 90/58/520/1).Changeset level, and the text it is based on
minorfor@objectstack/specand@objectstack/objectql,patchfor the three repaired consumers, with the**BREAKING**banner and an ADR-0087 disposition..github/workflows/pr-automation.yml: "During the launch windowmajorstays refused bycheck-changeset-no-majorand breaking-ness is carried by the BREAKING banner plus the ADR-0087 disposition, not by the level", and "A purely additive widening of a published package's public surface … takes at leastminor" — which this PR is on its own, since it adds three exported error classes, their codes and their shape predicates to@objectstack/objectql's index.AGENTS.md's "a bug fix in a released package takes a patch changeset — never none". That is the floor againstnone, not a ceiling, and reading it as one would have shipped this atpatch.check-changeset-no-majoris not by itself the justification: its level axis has a measured blind spot for nested package dirs (carded as [finding] The changeset LEVEL axis is blind to every NESTED package:packages/*/src/**matches one segment, so 51 of 74 workspace packages (all drivers/services/adapters) can pairClause-②: yeswithpatchand stay green #16713).packages/spec/*andpackages/objectql/*do match it, so it genuinely grades this one — but the argument above is the reason, not the gate.not-required (no-migration-prescription). Nothing authorable moves — no spec key, no authored metadata property, no accepted request shape, nothing forobjectstack migrate metato rewrite.type-surface-onlyis the category built for exactly this class and it is not claimed, because its predicate 2 (no-spec-diff) is mechanically false here: the surface the ruling names ISpackages/spec/src/contracts/**. Reported below rather than worked around, and ⛔ the**BREAKING**token is carried rather than dropped — dropping it is the erosion [finding] check-adr-0087-registration has no honest disposition for a published TYPE-surface narrowing — every category is refused, so the class is pushed to drop the**BREAKING**token instead #13080 was filed to stop.验收备注
Findings met on the way, recorded here rather than fixed in this PR:
ScopedContext.object(name)returns the CLASS, so the ruled narrowing does not reachctx.api. Detailed above. A one-line annotation change plus its own consumer census.IScopedObjectRepository.updateById(scoped-context.ts:167) staysPromise[any]while itsupdatesibling narrows. Not named by the ruling.@objectstack/metadata-protocoldeclaresrecord/datanon-null on its row receipts, whileengine.update's by-id exit can answernull—updateData's own comment states the mechanism ("the post-write readback … is alsonullwhen the row still exists but the write moved it out of the caller's row scope"). While the door saidanythis was invisible. This PR preserves the behaviour exactly and writes the disagreement down atbyIdUpdateRecordrather than widening a shipped response shape as a rider.check-adr-0087-registration'stype-surface-onlycategory cannot be claimed by the class it was built for when the narrowed declaration lives inpackages/spec/src/contracts/**. Predicate 2 isno-spec-diff, and a spec-owned contract narrowing is the most likely shape of a published type-surface narrowing in this repo. The category's own header says the alternative an author reaches for is dropping the**BREAKING**token, which [finding] check-adr-0087-registration has no honest disposition for a published TYPE-surface narrowing — every category is refused, so the class is pushed to drop the**BREAKING**token instead #13080 exists to prevent.core-boundary.ratchet.test.tsflags a forbidden package name in any QUOTED string incore.ts's closure, import or not. Prose in adeveloperMessagenaming the metadata protocol package reddened it. Correct-by-construction for the ratchet's purpose, surprising to hit from a message string; worked around in-file with a comment naming why.⛔ #15267 does not ride along. It is the driver-layer twin (
driver-sql/driver-tursopublishingPromise[any]on fiveIDataDriverdoors). Neither card contains the other, and ⛔ neither closes as a duplicate of the other.Draft only. ⛔ Never ready, never auto-merge, never queue — the in-seat contract-tier review runs before anything lands, and
needs:contract-reviewis hung on this PR.Generated by Claude Code