fix(cache)+docs(adr-0005): D15 — expand cache key composition to include max_tokens/top_p/stop/tool_choice

cold-audit catch from 2026-05-23

Cold-audit Finding 7 (P2 cache correctness). ADR 0005 § Cache key
composition (v1.0) listed 7 fields. ADR 0003 § Optional fields added
`max_tokens`, `top_p`, `stop`, `tool_choice` as IR-carried fields
that affect model output. Pre-D15 cache key omitted those 4 —
identical IRs differing only in those fields collided on the same
cache key but produced legitimately different outputs. Concrete
hazard: a request with `max_tokens: 100` could receive a cached
response generated by `max_tokens: 4000` — wrong content (truncated
or unexpectedly extended).

Coordinated change across two layers, single commit per the ADR-with-
code pattern established by D11:

1. docs/adr/0005-cache-cross-provider.md — Amendment 2 (top of doc,
   matching D11 Amendment 1 placement convention)
   - Documents the 4 missing fields + concrete failure mode
   - Expands the v1.0 cache key composition spec
   - Documents the `?? null` collapsing semantics (explicit-null
     equals absent — consistent with existing temperature/response_format)
   - Adds forward-looking note: future IR field additions must be
     evaluated for cache-key inclusion at addition time; default is
     include unless explicit rationale documents safe omission

2. lib/cache/keys.mjs — append the 4 fields to `keyObj` after the
   existing 7 (preserves field ordering; pre-D15 cache entries are
   forced misses on first request — schema forward-compatible)
   - `max_tokens: ir.max_tokens ?? null`
   - `top_p: ir.top_p ?? null`
   - `stop: ir.stop ?? null`
   - `tool_choice: ir.tool_choice ?? null`
   - Updated file-level docblock + function-level JSDoc + @param ir
     enumeration to reflect new schema (the @param fix also closes a
     pre-existing partial-list issue that omitted cache_control)

3. test-features.mjs — 5 new tests in Suite 9:
   - max_tokens differs → different key
   - top_p differs → different key
   - stop differs → different key
   - tool_choice differs → different key (covers string-form
     `'auto'` vs `'none'`; object-form coverage left for future
     defense-in-depth — slot existence is verified by the string case)
   - Both-absent stability check (`?? null` collapsing produces
     identical keys for omitted-vs-omitted)

Tests: 292 → 297 (+5). No hash constants pinned in existing tests
(grep verified) so no pre-D15 tests required updating; assertions
were already shape-based (`assert.equal` / `assert.notEqual` on
hash strings, never specific hex values).

Authority:
- ADR 0003 § Optional fields — source of the 4 IR field definitions
  https://github.com/dtzp555-max/olp/blob/main/docs/adr/0003-intermediate-representation.md
- ADR 0005's stated invariant: "different output → different cache
  entry" — the addition restores compliance with this invariant
- OpenAI /v1/chat/completions spec — confirms the 4 fields affect
  output:
  https://platform.openai.com/docs/api-reference/chat/create
- ALIGNMENT.md Rule 2(c) spirit — ADR amendment + code change land
  in same merge (D11 precedent established this pattern for
  Provider-contract changes; D15 applies same pattern for cache-key
  schema changes)
- CC 开发铁律 v1.6 § 10.x — Cold Audit caught this; diff-review pass
  that approved original ADR 0005 did not cross-reference all ADR
  0003 optional fields

Reviewer (Iron Rule v1.6 § 10.x Mode A, fresh-context opus, independent
of drafter): APPROVE_WITH_MINOR. Folded the one minor (`@param ir`
JSDoc stale partial list) before commit — same JSDoc precision logic
that drove D11's B1 fold-in. Two remaining non-blocking suggestions
(tool_choice object-form test coverage; D11-vs-D15 amendment structure
template) tracked as defense-in-depth opportunities, not required for
spec compliance.

Reviewer's highest-value verification: field ordering preserved.
keyObj at lib/cache/keys.mjs:203-217 reads exactly:
`{provider, model, messages, tools, temperature, response_format,
cache_control, max_tokens, top_p, stop, tool_choice}` — existing 7
in unchanged positions, 4 new appended at end. JSON.stringify on
Node 18+ preserves insertion order; SHA-256 hash deterministic
across runs.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
2026-05-24 11:24:12 +10:00
co-authored by Claude Opus 4.7
parent a7085d9718
commit 8ae77c3ae3
3 changed files with 79 additions and 5 deletions
+16 -4
View File
@@ -1,7 +1,7 @@
/**
* lib/cache/keys.mjs — Cache key generation for OLP
*
* Authority: ADR 0005 § Cache key composition (v1.0)
* Authority: ADR 0005 § Cache key composition (v1.0) — amended 2026-05-24 by Amendment 2 (D15)
*
* Cache keys are computed over the IR (ADR 0003), not over the raw OpenAI
* request shape, so key stability is governed by OLP's own release cadence.
@@ -15,6 +15,11 @@
* temperature: ir.temperature ?? null,
* response_format: ir.response_format ?? null,
* cache_control: extractCacheControlMarkers(ir.messages),
* // Added by D15 (Amendment 2) — ADR 0003 § Optional fields that affect output:
* max_tokens: ir.max_tokens ?? null,
* top_p: ir.top_p ?? null,
* stop: ir.stop ?? null,
* tool_choice: ir.tool_choice ?? null,
* }))
*
* Per ADR 0005 § Per-model isolation: (provider, model) is part of the key.
@@ -162,9 +167,10 @@ export function hasCacheControl(ir) {
/**
* Computes a content-addressed SHA-256 cache key over the IR request.
*
* Per ADR 0005 § Cache key composition (v1.0):
* Per ADR 0005 § Cache key composition (v1.0) — amended 2026-05-24 by Amendment 2 (D15):
* key = sha256(JSON.stringify({
* provider, model, messages, tools, temperature, response_format, cache_control
* provider, model, messages, tools, temperature, response_format, cache_control,
* max_tokens, top_p, stop, tool_choice
* }))
*
* The key is deterministic: same inputs → same key. No random, no timestamp.
@@ -174,7 +180,7 @@ export function hasCacheControl(ir) {
*
* @param {string} provider — provider name, e.g. 'anthropic'
* @param {string} model — model string, e.g. 'claude-haiku-4-5'
* @param {object} ir — IR request (ADR 0003): { messages, tools?, temperature?, response_format? }
* @param {object} ir — IR request (ADR 0003): { messages, tools?, temperature?, response_format?, cache_control?, max_tokens?, top_p?, stop?, tool_choice? }
* @param {object} [_options] — reserved for future options (not used at D5)
* @returns {string} — 64-character hex SHA-256 digest
*/
@@ -202,6 +208,12 @@ export function computeCacheKey(provider, model, ir, _options = {}) {
temperature: ir.temperature ?? null,
response_format: ir.response_format ?? null,
cache_control: cacheControlMarkers.length > 0 ? cacheControlMarkers : null,
// D15 (ADR 0005 Amendment 2): IR fields from ADR 0003 § Optional fields that affect output.
// Appended after the existing seven fields to avoid invalidating ordering-dependent keys.
max_tokens: ir.max_tokens ?? null,
top_p: ir.top_p ?? null,
stop: ir.stop ?? null,
tool_choice: ir.tool_choice ?? null,
};
return createHash('sha256').update(JSON.stringify(keyObj)).digest('hex');