Skip to content

fix(objectql)!: engine.find/findOne refuse a dotted projection instead of widening to every field (#7589) - #8327

Merged
os-zhuang merged 4 commits into
mainfrom
claude/issue-7589-dotted-projection-refusal
Aug 13, 2026
Merged

fix(objectql)!: engine.find/findOne refuse a dotted projection instead of widening to every field (#7589)#8327
os-zhuang merged 4 commits into
mainfrom
claude/issue-7589-dotted-projection-refusal

Conversation

@os-zhuang

Copy link
Copy Markdown
Contributor

Fixes #7589

Implements the maintainer ruling recorded 2026-08-12 (issue comment 5266074163): Option B, verbatim — a dotted fields entry the engine cannot resolve is refused loudly at the engine's head-only projection filter, and the false populate comment is deleted in the same change.

What changed

engine.find() / engine.findOne() now throw 400 INVALID_FIELD (ADR-0112 envelope: code + status, plus field/fields/object) on any fields entry carrying a dot. The head-only known.has(head) keep — justified by a comment claiming the engine resolves relationship paths "via populate", which #7601 measured does not exist (it was the last such assertion in the repo after PR #7617) — is gone; the plain-name filter now matches whole names. The refusal sits before the formula planner, on the caller's own spellings, in both verbs.

The measured chain (issue comment 5263464190) reaches both verbs: flow get_record config goes to data.find(...) when limit is greater than 1 and to data.findOne(...) otherwise — a flow authoring fields: ['name','account.name'] now gets a loud node failure carrying the remedy instead of a silent 200 with every column.

Explicitly KEPT (the ruling's carve-outs)

Every face reaching the filter, enumerated

  1. find — refusal added before planFormulaProjection.
  2. findOne — same refusal, same position (the inline head-split copy of the filter is rewritten too).
  3. Expand sub-reads — route through this.find, so the refusal fires there — inside expandRelatedRecords' pre-existing graceful-degradation catch: outcome is an observable warning + retained FK ids, not a refusal. Pinned, with a plain-nested-fields control; same posture the sort axis (engine.find() still drops a formula ORDER BY silently — decide whether the engine refuses or keeps its internal-caller tolerance #7095) records for the same catch.
  4. Formula planner — never invents or removes dotted entries (passes caller entries verbatim, injects only plain schema names + id); judged before it runs.
  5. Search expansion (expandSearchOnAst) — writes only where; no projection face.
  6. count / aggregate / update / delete — carry no fields option (ENGINE_OPTION_KEY_SETS); no projection face.
  7. Protocol ingress (findData) — already refused at ingress since PR fix(metadata-protocol): refuse a dotted projection instead of widening the response to every field (#7532) #7588; the engine door is the second line behind it. All existing ingress pins stay green.
  8. plugin-reports — forwards a saved report's query.fields verbatim into engine.find; an author-reachable surface that now fails loudly with the remedy (recorded in the ADR-0087 entry).

Semantics notes

  • All dotted entries are refused, including one with an unknown head (no_such.name). Deliberate divergence from the ingress door's unknown before dotted precedence: the engine has no unknown-name refusal to defer to (unknown plains are tolerated by the kept carve-out), and a dotted entry with an unknown head still widened through the empty-projection fallback when it was the only entry. Pinned with the reasoning in the test.
  • The refusal wording shares its core sentence and both remedies (expand, denormalise onto a stored field) with the ingress door's dotted refusal — duplicated because metadata-protocol is assembled from an engine (importing would invert the layering), kept honest by a cross-door agreement pin, same mechanism as the sort axis' remedy pin.

Changeset + ADR-0087

Breaking changeset (minor bump + bang title per check-changeset-no-major convention) with the disposition marker registered engine-dotted-projection-refused, and the semantic migration entry added under packages/spec/src/migrations/entries/semantic/ — mirroring #7095's engine-find-formula-order-by-refused (same door, same class: silent degradation becomes a refusal). Registry region, spec-changes.json and the upgrade guide regenerated; check:generated reports all 13 artifacts current.

Declared delta beyond the dispatch's file surface (engine.ts + its tests): the ADR-0087 registration kit above. It is the mechanical accompaniment check:adr-0087-registration requires of a declared-breaking changeset — data-only, no spec schema or behavior change. Flagged here and in the dev report rather than silently included.

Verification

  • @objectstack/objectql: full suite 3466/3466 green (196 files); conformance file 145/145; typecheck clean.
  • Reverse verification, from committed state, direction predicted before running (red): with origin/main's engine.ts restored and the new pins kept, exactly the 9 new refusal/agreement/expand pins go red and all 136 others — every control and every KEPT-tolerance guard — stay green. Fix restored from its commit, byte-identical (git diff against the fix commit: empty).
  • Downstream consumers (prefix filter, consumer direction): @objectstack/service-automation 955/955, @objectstack/metadata-protocol 1117/1117 — green after building their dependency closures (the first lap's 4 file-level failures were unbuilt service-job dist, the known missing-build false red).
  • Gates: all 7 dispatch-named families green (check:adr-anchors, check:durability-log-level, check:engine-double-contract, check:stack-collection-maps, check-engine-split-ratio informational, check:error-code-casing, check:nul-bytes re-run after the final tree), plus all 16 families re-derived from the actual changed paths (dispatch-gates.mjs) — check:i18n and check-dev-prereqs went green after a full workspace build; their first reds were unbuilt-dist prerequisites, named as such by the gates' own output.

Out of scope, untouched, and staying open on their own terms: the driver-side ladder in driver-sql (#3821 behaviour is unchanged; a carve-out there is measured-need only), and the dotted SORT leg on direct engine calls (a different axis; noted in the updated scope docblock). #7532 is the merged ingress half and is not modified here.

Generated by Claude Code


Generated by Claude Code

claude added 3 commits August 13, 2026 04:40
…d of widening to every field (#7589)

The head-only known.has(head) filter kept dotted entries on the strength of
a comment claiming the engine resolves them via populate; #7601 measured no
populate step exists. A dotted entry is now 400 INVALID_FIELD at the engine
boundary; the unknown-plain-column tolerance is explicitly kept.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01RDTnVvsgA6cUZ4xFVtPZRy
…the kept plain tolerance, and the cross-door wording agreement

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01RDTnVvsgA6cUZ4xFVtPZRy
…emantic entry + changeset (#7589)

One entry file under entries/semantic/, registry region + spec-changes.json +
upgrade guide regenerated. Breaking changeset per the #7095 precedent: same
door (engine public API), same class (silent degradation becomes a refusal).

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

vercel Bot commented Aug 13, 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 Aug 13, 2026 5:45am

Request Review

@github-actions

Copy link
Copy Markdown
Contributor

📓 Docs Drift Check

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

109 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 @objectstack/objectql, 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 packages/objectql, @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/migration-from-objectql.mdx (via @objectstack/objectql)
  • 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/deployment/vercel.mdx (via @objectstack/objectql)
  • 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/objectql, @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 packages/objectql, @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/objectql, @objectstack/spec)
  • content/docs/kernel/services.mdx (via @objectstack/objectql, @objectstack/spec)
  • content/docs/permissions/authentication.mdx (via @objectstack/objectql)
  • 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/permissions/system-context.mdx (via packages/objectql, packages/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/objectql, @objectstack/spec)
  • content/docs/plugins/packages.mdx (via @objectstack/objectql, @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/objectql, @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 packages/objectql, @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/objectql, @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/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)

7 release-owned page(s) also reference the affected code. These are read-only:

  • content/docs/releases/implementation-status.mdx (via @objectstack/objectql, @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/releases/ is RELEASE-OWNED (AGENTS.md "Documentation Guardrails"): release
notes are written centrally at release time, and a code PR that edits them is the exact PR
that guardrail exists to stop. They are still audited — read-only. If one of them is actually
wrong, file an issue or open a dedicated docs-only PR; do not edit it here.

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.

…lookup's related column (#7589)

types.mdx's lookup query example was the populate premise itself — the
spelling both doors now refuse. Replaced with the expand form, reference
column kept projected (#7537), refusal + remedy stated inline.

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

Copy link
Copy Markdown
Contributor Author

Patch round 1 (PM review): 5065b357 corrects content/docs/protocol/objectql/types.mdx — the lookup "Query behavior" example was the populate premise itself (fields: ['name', 'account.company_name'] // Expands account), i.e. the last hand-written doc teaching of the spelling this PR makes throw. Replaced with the expand form, reference column kept projected (#7537), refusal + remedy stated inline. Swept content/docs (releases excluded) for other dotted-projection teachings: this was the only occurrence — the old example's head (account) did not even match the page's own declared field (account_id); the corrected example uses account_id.

content/docs/releases/v17.mdx:977 (the removed-object-form row prescribing "a dotted path for a single related column") is release-owned and deliberately NOT touched here — filed as unassigned docs-only card #8329 with the correction spelled out.

Gates for the docs delta, re-derived via dispatch-gates.mjs (4 families) plus the two run on principle: doc-formula-expressions (lint-filter form) ✓ (after building lint's dep closure in the re-created worktree — first red was the unbuilt-dist prerequisite shape again), docs-audit-scope ✓, quick-reference-counts ✓, role-word ✓, doc-authoring ✓, nul-bytes ✓. engine.ts untouched this round.

Generated by Claude Code


Generated by Claude Code

@os-zhuang
os-zhuang marked this pull request as ready for review August 13, 2026 06:14
@os-zhuang
os-zhuang added this pull request to the merge queue Aug 13, 2026
Merged via the queue into main with commit 1b2eb1b Aug 13, 2026
27 checks passed
@os-zhuang
os-zhuang deleted the claude/issue-7589-dotted-projection-refusal branch August 13, 2026 06:31
os-zhuang pushed a commit that referenced this pull request Aug 13, 2026
…8315)

The merge with main was textually conflict-free, but a conflict-free merge of
two independently-regenerated projections is not the generator's output.
Measured on this tree: the plain merge result was MISSING two sibling PRs'
entries from `spec-changes.json` and `docs/protocol-upgrade-guide.md` —
`view-export-options-pdf-removed` (#8010 / PR #8324) and
`engine-dotted-projection-refused` (#7589 / PR #8327). Both are present in
origin/main's copies of those artifacts; git dropped them while reporting no
conflict.

`registry.ts` spliced correctly and regenerated byte-identical (78 semantic
entries) — the loss was confined to the two prose projections.

Not a silent class: against the un-regenerated merge, `check:spec-changes` and
`check:upgrade-guide` both FAIL (exit 1) while `check:migration-registry`
passes. So this would have been caught — in the merge queue, as an ejection.
Regenerating before arming is what makes it cost nothing.

Ran on the merged tree, merge committed first:
  pnpm --filter @objectstack/spec gen:migration-registry
  pnpm --filter @objectstack/spec gen:spec-changes
  pnpm --filter @objectstack/spec gen:upgrade-guide

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01PEVB6w7D7uCszR9Mw1BL73
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 size/l tests tooling

Projects

None yet

Development

Successfully merging this pull request may close these issues.

finding: SqlDriver's #3821 recovery ladder widens an unresolvable projection to every field

2 participants