Skip to content

feat(settings): give SETTINGS_CRYPTO_UNAVAILABLE a wire spelling - #8396

Merged
hotlong merged 2 commits into
mainfrom
claude/issue-8273-settings-crypto-wire-code
Aug 13, 2026
Merged

feat(settings): give SETTINGS_CRYPTO_UNAVAILABLE a wire spelling#8396
hotlong merged 2 commits into
mainfrom
claude/issue-8273-settings-crypto-wire-code

Conversation

@hotlong

@hotlong hotlong commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

Fixes #8273

The #8026 fail-closed settings refusal (a declared-encrypted value refused when nothing able to encrypt it is wired) answered over REST on the generic 500 INTERNAL_ERROR arm, so a client could not distinguish "the deployment cannot encrypt secrets, reconfigure it" from "the server crashed". Every sibling SETTINGS_* error class already had a registered wire code; this one was the odd one out.

What changed

  • Ledger (packages/spec/src/api/error-code-ledger.zod.ts): SETTINGS_CRYPTO_UNAVAILABLE registered under @objectstack/service-settings, alphabetized with the other SETTINGS_* rows, comment carrying the 500-not-503 rationale and the operator fix (ADR-0112: no silent fourth state).
  • Mapping (settings-routes.ts PUT handler): SettingsCryptoUnavailableError now answers 500 SETTINGS_CRYPTO_UNAVAILABLE with details: { namespace, key } — the located refusal, never the value. Mirrors the sibling SETTINGS_* mappings; the generic arm keeps catching everything else.
  • Status stays 500 per the PM ruling on the issue (the filer's own recommendation): a server-side misconfiguration, deliberately not 503 — no retry succeeds until an operator wires a cryptoProvider, so inviting one would be dishonest. The registered code carries the meaning; the status stays honest. Implementation surfaced no reason to prefer 503 (the ledger carries no status/retry-semantics contract on 5xx rows; statuses live at the mapping sites).
  • Pin re-pointed (settings-crypto-fail-closed.test.ts "the refusal on the REST boundary"): now asserts BOTH code: 'SETTINGS_CRYPTO_UNAVAILABLE' AND status: 500 on the wire envelope, plus details, the operator's fix in the message, the no-secret-leak check and the nothing-persisted check.
  • Docs regenerated via check:generated --fix (only gen:docs was stale: the new code in the ledger reference, envelope enum count 264 to 265).
  • TSDoc on SettingsCryptoUnavailableError (settings-service.types.ts): the "Wire spelling" section said "not mapped, registration out of scope" — updated to describe the shipped mapping. One doc-comment-only edit beyond the dispatched file surface, made so the class does not document the pre-SETTINGS_CRYPTO_UNAVAILABLE has no wire spelling — the fail-closed settings refusal answers a generic 500 a client cannot branch on #8273 behavior as current.
  • Changeset: minor for @objectstack/spec + @objectstack/service-settings. Additive wire refinement, not breaking — no ADR-0087 disposition needed (gate green).

Verification

  • @objectstack/spec tests: 389 files / 10325 passed. @objectstack/service-settings: 23 files / 451 passed + tsc --noEmit clean. @objectstack/rest (downstream envelope path): 110 files / 1817 passed.
  • Reverse verification (committed fix, predicted direction red): respelling the code SETTINGS_CRYPTO_UNAVAILABLE_X in the handler fails tsc with not assignable to parameter of type 'ErrorCode' — proving the consumer reads the rebuilt spec .d.ts; restored from the branch.
  • Gates: check:generated all 13 green (docs regenerated), check:error-code-casing, check:route-envelope, check:nul-bytes, check:adr-anchors, check:i18n, check:merge-driver, check:adr-0087-registration, changeset gates, and the full re-derived family list from dispatch-gates.mjs — all pass locally.

Out of scope, as dispatched: the Setup UI consumer branch (objectui) is untouched; rendering on the new code is filed as objectstack-ai/objectui#4570.


Generated by Claude Code

claude added 2 commits August 13, 2026 10:17
Register the code in ERROR_CODE_LEDGER under @objectstack/service-settings,
map SettingsCryptoUnavailableError in settings-routes.ts's PUT handler to
500 SETTINGS_CRYPTO_UNAVAILABLE with details { namespace, key }, and re-point
the #8026 wire refusal pin to assert both code and status. Status stays 500
per the PM ruling: server misconfiguration, deliberately not 503 (no retry
succeeds until an operator wires a cryptoProvider).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Euoy6wyfzgiWtgCg4s6JK2
gen:docs via check:generated --fix — the one artifact it proved stale.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Euoy6wyfzgiWtgCg4s6JK2
@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 11:04am

Request Review

@github-actions

Copy link
Copy Markdown
Contributor

📓 Docs Drift Check

This PR changes 2 package(s): @objectstack/service-settings, @objectstack/spec.

108 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/audit-service.mdx (via packages/services/service-settings)
  • 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/services/service-settings, packages/spec)
  • content/docs/kernel/runtime-services/queue-service.mdx (via packages/spec)
  • content/docs/kernel/runtime-services/settings-service.mdx (via packages/services/service-settings)
  • 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/permissions/system-context.mdx (via 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/spec)
  • content/docs/plugins/packages.mdx (via @objectstack/service-settings, @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/service-settings, @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/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/service-settings, @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/service-settings, @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.

@github-actions github-actions Bot added documentation Improvements or additions to documentation tests tooling labels Aug 13, 2026
@github-actions github-actions Bot added size/m and removed size/s labels Aug 13, 2026
@hotlong
hotlong marked this pull request as ready for review August 13, 2026 11:31
@hotlong
hotlong added this pull request to the merge queue Aug 13, 2026
Merged via the queue into main with commit e9cb9ab Aug 13, 2026
27 checks passed
@hotlong
hotlong deleted the claude/issue-8273-settings-crypto-wire-code branch August 13, 2026 11:52
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/m tests tooling

Projects

None yet

Development

Successfully merging this pull request may close these issues.

SETTINGS_CRYPTO_UNAVAILABLE has no wire spelling — the fail-closed settings refusal answers a generic 500 a client cannot branch on

2 participants