Repository navigation
Add per-cookie template cache policy - #1150
Conversation
ChristianPavilonis
left a comment
There was a problem hiding this comment.
Summary
Approved. The implementation is sound; one non-blocking code-smell note is attached inline.
aram356
left a comment
There was a problem hiding this comment.
Summary
Grows the cookie-independence boolean into a per-cookie policy: named key cookies become sorted, length-prefixed dimensions of the shared template key, named bypass cookies force the inline path, and the assertion narrows to unlisted cookies. The runtime logic holds up under tracing: one decision drives lookup, reservation, and store, so a bypass cookie can never read or populate a template; Vary: Cookie refusal is untouched; empty dimensions preserve legacy keys; the fingerprint picks up the new fields through settings serialization; Debug output redacts values. Tests cover the evaluator matrix, key isolation, both finalizers, EC withdrawal on warm hits, and the harness negative control, and CI runs both harness modes.
Nothing here is blocking on its own. The findings below are hit-rate, operator-safety, and readability improvements.
4 of the inline comments below carry a one-click GitHub
suggestion. Use Commit suggestion (or Add suggestion to batch) to apply them. Each was applied in isolation and as a batch in a scratch worktree and passedcargo fmt --check, all six clippy aliases, all four adapter test aliases, the parity suite, and prettier. The remaining comments describe the fix in prose because the change spans ranges outside one hunk.
Non-blocking
♻️ refactor
- Log the cookie bypass reason at the request gate — see inline at
crates/trusted-server-core/src/publisher.rs:4304 - Reject TS identity cookie names in the key list — see inline at
crates/trusted-server-core/src/cookies/template_cache_policy.rs:28
🤔 thinking
- Duplicate unlisted names need not bypass under an independence assertion — see inline at
crates/trusted-server-core/src/cookies/template_cache_policy.rs:73
⛏ nitpick
- Doc sentence for
template_cache_bypass_cookies— see inline atcrates/trusted-server-core/src/creative_opportunities.rs:344 - Unformatted 230-character assert — see inline at
crates/trusted-server-core/src/cookies/template_cache_policy.rs:335 - Primary docs example pairs the lists with
false— see inline atdocs/guide/configuration.md:1912 CookieForwardedvariant name is stale — see inline atcrates/trusted-server-core/src/publisher.rs:5727
Cross-cutting / body-level findings
- 🌱 No bound on key-cookie value length.
is_cookie_valueaccepts any cookie-octet run of any length, so a mistakenly keyed token or ID enters the key unchecked. The spec scopes cardinality controls out, but a cheap bypass above a fixed byte length (64 is generous for experiment arms and region buckets) would catch the accidental case without limiting real variant labels. Future work, not this PR. - 🤔 Named-policy strictness for unlisted values. Under a named policy with independence
true, every unlisted cookie value is still framing-checked inis_ignored_cookie_value: a raw space, a non-ASCII byte, or a backslash in any third-party cookie bypasses the whole request. That is stricter than the legacy boolean path and partially reintroduces the "nearly inert" problem this feature targets. The origin-parser rationale is documented in the spec and the guide, so this is a heads-up on expected hit rate during the canary rather than a request to change it.
CI Status
- browser integration tests: PASS
- integration tests: PASS
- integration tests (Fastly EC lifecycle): PASS
- CodeQL: PASS
- cargo test (ts CLI, native): PASS
- format-typescript: PASS (required)
- cargo check (cloudflare native + wasm32-unknown-unknown): PASS
- Analyze (javascript-typescript): PASS
- Analyze (actions): PASS
- cargo test (axum native): PASS
- cargo test: PASS (required)
- format-docs: PASS (required)
- Analyze (rust): PASS
- cargo fmt: PASS (required)
- cargo check/build/test (spin native + wasm32-wasip1): PASS
- cargo test (cross-adapter parity): PASS
- prepare integration artifacts: PASS
- vitest: PASS
Resolve five conflicting files plus the semantic conflicts the textual merge could not mark. Adopt main's removal of the legacy consent KV path (#903): the Fastly adapter no longer opens a consent store per request, so the branch's timed wrapper around it, its route call sites, and the test asserting consent-store reads land in ts-kv are dropped. TimedKvStore keeps both trait impls; its module doc and the design spec no longer describe a consent-store read. Forward the EcKvStore::list_keys_with_prefix method main added for EID write-conflict reduction (#1157) through TimedKvStore with the same ts-kv span. Give main's new admin cache-purge named route (#1150) a RouteClass::Other classification so access telemetry carries a template for it. Union the remaining hunks: the Axum adapter keeps dev_server_service and routes_with_server_timing_flag beside main's routes_with_settings_and_services; the Fastly route tests keep the RouteMetadata assertions beside main's EID sync-source dispatch tests, with the short-circuit test renamed to main's name; the configuration guide's section table takes main's layout with the observability row and the access-telemetry wording restored. Update tests main added that build branch-extended structs: AuctionCollectDeps initializers gain timings and placement, the Settings debug-redaction fixture gains auction_enabled, and the EC finalize freeze-point test marks its context as a navigation now that returning- user EID persistence is gated on the request source.
Summary
Vary: Cookierefusal.Changes
crates/trusted-server-core/src/creative_opportunities.rscrates/trusted-server-core/src/cookies.rscrates/trusted-server-core/src/cookies/template_cache_policy.rscrates/trusted-server-core/src/platform/template_cache.rscrates/trusted-server-core/src/platform/mod.rscrates/trusted-server-core/src/publisher.rscrates/trusted-server-adapter-fastly/src/template_cache.rsscripts/template-cache-local-test.shtrusted-server.example.tomldocs/guide/configuration.mddocs/superpowers/specs/2026-09-08-1138-per-cookie-template-cache-policy-design.mddocs/superpowers/plans/2026-09-08-1138-per-cookie-template-cache-policy.mdIgnored-value tolerance applies only when independence is asserted. Names, key values, and cookie framing remain validated; unmatched quotes, unsafe bytes, and comma-delimited cookie assignments still bypass. The origin must treat ignored values as opaque and parse semicolon-separated cookies independently; parsers that stop at nonstandard values cannot safely make this assertion.
Closes
Closes #1138
Test plan
Fresh review-readiness validation on 2026-09-10 used
1f56ee08cb25a35d79cccc19a442a698334a398cplus the harness/documentation follow-up in191380f0. Production Rust and JavaScript are unchanged by that follow-up.cargo build --package trusted-server-adapter-fastly --release --target wasm32-wasip1.BID_DELAY=3 ./scripts/template-cache-local-test.sh esi— 22 harness checks passed, including all 17 cookie-matrix requests.BID_DELAY=3 ./scripts/template-cache-local-test.sh inline— 9 harness checks passed, including all 17 cookie-matrix requests with an origin fetch on every request.cargo test-fastly— 2,902 tests/doc-tests passed; 10 existing tests ignored.cargo test-axum,cargo test-cloudflare,cargo test-spin— 41, 44, and 86 tests passed respectively.cargo test --manifest-path crates/trusted-server-integration-tests/Cargo.toml --test parity— 13 passed.cargo fmt --all -- --check.crates/trusted-server-js/lib— 45 files, 901 tests passed; JS and docs formatting.bash -n scripts/template-cache-local-test.shandgit diff --check.The harness now returns distinguishable cookie-selected HTML and
Vary: X-Exp-Variantwithout a client variant header. Both modes verify A/B isolation, absent/empty buckets, ignored compact JSON/comma-list cookies, warm session bypass including empty sessions, and cold session bypass without populating anonymous templates. Each request checks content, cache diagnostics, origin fetch counts, private response policy, and winning-bid assembly. Existing CI runs both harness modes.These runtime runs invoke Viceroy directly, not
fastly compute serve. The earlier headless-browser/Viceroy smoke test reported separate A/Bmiss-stored→hitsequences and sessionbypass-request, all HTTP 200, with page JavaScript disabled to keep cookies stable. Its exact tested commit was not recorded in the previous description; it is historical evidence, not a fresh browser run at the current head.Viceroy/Fastly tests and Axum socket tests passed after granting the local certificate/keychain and loopback access needed outside the sandbox. An initial Vitest invocation used an incompatible Node environment; rerunning with the pinned Node executable from the library directory passed.
Checklist
unwrap()in production code.logmacros, notprintln!, per project conventions.