阅读中文版本

Build an HTTP Cache Layer

HTTP Cache Layer — a complete walkthrough of http response caching, covering key normalizer, freshness checker, validation revalidate, and testing.

http_cache_layer/
├── src/index.ts
├── src/key-normalizer.ts
├── src/freshness-checker.ts
├── tests/http_cache_layer.test.ts
└── package.json

// Key normalizer: http response caching core
export function keynormalizer(input: KeynormalizerInput): KeynormalizerResult {
  // Build the key normalizer that anchors http response caching and defines the core data shape.
  return processKeynormalizer(input);
}

// Freshness checker — handles http response caching Add the freshness checker so
export class Freshnesschecker {
  constructor(private opts: FreshnesscheckerOptions) {}
  async run(ctx: Context): Promise<FreshnesscheckerOutput> {
    return this.execute(ctx);
  }
}

// Validation revalidate: http response caching stage
export const validationrevalidate = (next: Next) => async (req: Request) => {
  const out = await transform(req);
  return next(out);
};

// Vary splitter for http response caching
export async function varysplitter(stream: AsyncIterable<Chunk>): Promise<Aggregate> {
  let acc = init();
  for await (const c of stream) acc = merge(acc, c);
  return acc;
}

// Purge endpoint: http response caching finalization
export function purgeendpoint(state: State): Result {
  validate(state);
  return finalize(state);
}

Project overview

This project builds a http response caching system whose reason for existing is honoring cache-control and etag semantics so cached responses stay fresh without stale reads. The temptation in http response caching is to bolt the interesting part onto a working prototype and discover the hard cases in production; this build inverts that order and treats a response with a missing vary header that returns one content type to a client that expected another as the first thing designed, not the last.

You will implement Key normalizer, Freshness checker, Validation revalidate, Vary splitter, and Purge endpoint, each as a module with one responsibility and a test that proves it in isolation. The http response caching pipeline is then the wiring that composes them, and the integration test is where the composition is shown to survive a response with a missing vary header that returns one content type to a client that expected another.

The walkthrough is written for a developer who has used a http response caching system but has not had to make one honest. It favors explicit data shapes over clever abstractions, and it names the failure each design choice prevents rather than presenting the choice as a style preference.

Each phase ends with something observable — a key normalizer that returns the right shape, a freshness checker that rejects bad input, an integration test that goes green — so you can stop at any point and still have a http response caching system that works for the cases covered so far.

What you will build

The finished http response caching system exposes five capabilities, each with a focused test:

• Key normalizer
• Freshness checker
• Validation revalidate
• Vary splitter
• Purge endpoint

Key normalizer is the foundation that every later stage assumes; Freshness checker is where http response caching correctness lives; Validation revalidate handles a response with a missing vary header that returns one content type to a client that expected another; Vary splitter makes the system observable; and Purge endpoint is the graceful-degradation layer that keeps overload from becoming corruption.

The build keeps the http response caching logic in ordinary modules you can read in one sitting, and pulls in dependencies only for the parts that are genuinely tedious to hand-roll. That keeps the diff between the tutorial and a real codebase small, and keeps the failure modes visible in code rather than hidden behind a framework.

Architecture and data model

The system is organized around Key normalizer, Freshness checker, and Validation revalidate, with Vary splitter tying them together. Data flows as a key-value store of responses keyed by method and normalized URL, with vary headers splitting entries per representation.

Each component is a module with a pure interface where practical: the same input produces the same output, and side effects are pushed to the edges. That discipline is what makes the phases independently testable, because a test for Validation revalidate does not need to stand up Key normalizer and Freshness checker to exercise the interesting branch.

The data model is deliberately explicit. A key-value store of responses keyed by method and normalized URL, with vary headers splitting entries per representation Keeping the shape written down — in a schema, a type, or a fixture — means a change to the shape is a visible diff rather than a silent runtime shift, and it means the integration test can assert against a concrete shape instead of guessing.

Configuration and code are kept apart: the configuration says what http response caching should do, the modules say how. A reviewer can change a threshold or a policy without reading the implementation, which keeps the risky changes small and lets the diff stand as the review.

The failure path through Validation revalidate is designed before the happy path is finished, because a response with a missing vary header that returns one content type to a client that expected another is the case that distinguishes a http response caching system from a demo. Every component declares what it does when its inputs are wrong, and the integration test asserts each of those declarations.

Prerequisites and dependencies

Have these ready before you install anything, so the http response caching setup is not blocked by a missing tool:

• Node.js 20 LTS or later
• Familiarity with http response caching fundamentals
• A local environment to run the test suite

The runtime dependencies are chosen to keep the http response caching datapath legible:

• express (^4.21.0) — Cache middleware
• lru-cache (^11.0.0) — In-memory store
• undici (^6.19.0) — Origin fetch

# setup for http-cache-layer
pnpm init
pnpm add express lru-cache undici
pnpm add -D typescript tsx vitest

Versions are pinned to a major range so the http response caching install is reproducible; commit the lockfile. The key normalizer reads its operational parameters from the environment and validates them at startup, so a missing value fails the boot rather than the first http response caching request.

Directory structure

Keep each http response caching component in its own file so it can be tested without starting the others:

http_cache_layer/
├── src/index.ts
├── src/key-normalizer.ts
├── src/freshness-checker.ts
├── tests/http_cache_layer.test.ts
└── package.json

Phase 1: Key normalizer

Build the key normalizer that anchors http response caching and defines the core data shape.

// Key normalizer: http response caching core
export function keynormalizer(input: KeynormalizerInput): KeynormalizerResult {
  // Build the key normalizer that anchors http response caching and defines the core data shape.
  return processKeynormalizer(input);
}

After this phase the key normalizer works in isolation and is covered by a unit test. The key normalizer defines the data shape that every later stage assumes, so getting it right first means the later phases compile against a stable contract.

Treat the key normalizer as the single source of truth for the http response caching data shape. Validate inputs at the boundary and reject early, so a malformed value never reaches Freshness checker or Validation revalidate where its effect would be harder to localize.

Phase 2: Freshness checker

Add the freshness checker so http response caching can honoring cache-control and etag correctly.

// Freshness checker — handles http response caching Add the freshness checker so
export class Freshnesschecker {
  constructor(private opts: FreshnesscheckerOptions) {}
  async run(ctx: Context): Promise<FreshnesscheckerOutput> {
    return this.execute(ctx);
  }
}

After this phase the freshness checker works in isolation and is covered by a unit test. This is where http response caching correctness lives: the freshness checker is what makes honoring cache-control and etag semantics so cached responses stay fresh without stale reads true, and its test is the proof.

Keep the freshness checker pure where you can. A function that takes an input and returns an output is trivial to test and impossible to mock wrong; a class with hidden state is the opposite. Push side effects to the caller and keep the freshness checker about the transformation.

Phase 3: Validation revalidate

Wire the validation revalidate to handle a response with a without losing data.

// Validation revalidate: http response caching stage
export const validationrevalidate = (next: Next) => async (req: Request) => {
  const out = await transform(req);
  return next(out);
};

After this phase the validation revalidate works in isolation and is covered by a unit test. The validation revalidate is the difference between a http response caching system that works on the happy path and one that survives a response with a missing vary header that returns one content type to a client that expected another.

Design the failure before the success. Decide what validation revalidate does when a response with a missing vary header that returns one content type to a client that expected another: reject, retry, shed, or degrade — and write that test first. A http response caching system whose failure behavior is unspecified will pick one at random under pressure, and it is usually the wrong one.

Phase 4: Vary splitter

Integrate the vary splitter to make http response caching observable and testable end to end.

// Vary splitter for http response caching
export async function varysplitter(stream: AsyncIterable<Chunk>): Promise<Aggregate> {
  let acc = init();
  for await (const c of stream) acc = merge(acc, c);
  return acc;
}

After this phase the vary splitter works in isolation and is covered by a unit test. Observability is not a finishing touch; it is how you know the http response caching system is doing what it claims in production.

Emit one structured event per meaningful action, with enough context to localize a failure without a second round-trip. The vary splitter is what turns “something is slow” into “the freshness checker is slow for inputs matching this shape,” which is the difference between an alert and an investigation.

Phase 5: Purge endpoint

Finalize the purge endpoint so the http response caching system degrades gracefully under overload.

// Purge endpoint: http response caching finalization
export function purgeendpoint(state: State): Result {
  validate(state);
  return finalize(state);
}

After this phase the purge endpoint works in isolation and is covered by a unit test. The purge endpoint is what keeps overload from becoming corruption: when the http response caching system is asked for more than it can do, it degrades in a defined way instead of failing in an undefined one.

Pick a degradation strategy for purge endpoint — shed, queue, or backpressure — and make it explicit in code and in a test. Leaving the behavior to chance is how a http response caching traffic spike becomes a data loss incident.

Testing

Each phase has a focused test: key normalizer, freshness checker, and validation revalidate are exercised in isolation, then an integration test drives the full http response caching pipeline and asserts the a response with a case is handled.

Start with unit tests that pin each component’s contract: the key normalizer returns the documented shape, the freshness checker transforms correctly, and the validation revalidate fails in the documented way. These tests are fast and they localize regressions to the component that broke.

Then add an integration test that composes the components and drives a realistic http response caching scenario end to end. Assert the happy path first, then deliberately trigger a response with a missing vary header that returns one content type to a client that expected another and assert the system degrades rather than corrupts. Because the components are pure where practical, the integration test stays deterministic rather than flaky.

A http response caching suite must also prove the negative: bad input is rejected at the boundary, overload is shed rather than queued indefinitely, and a partial failure does not leave the system in an inconsistent state. These are the tests that catch the regressions a happy-path suite never would.

The entire http response caching suite runs with no external service; every dependency is either in-process or stubbed, so every case is reproducible in CI. That is what lets the validation revalidate failure-mode assertions live as tests rather than as a manual checklist that drifts out of date.

# run the http response caching test suite
pnpm vitest run

Deployment and operations

Run at least two http response caching instances behind a load balancer and share state in Redis. Set resource limits so http response caching overload surfaces as backpressure rather than failure.

Run at least two stateless instances behind a load balancer, and move any shared state into a shared store so the http response caching behavior is global rather than per instance. Size limits so the system sheds load before it runs out of memory, because a http response caching system that OOMs under load fails in a way that is hard to reason about.

Drain on deploy: stop accepting new work, let in-flight http response caching operations finish, then exit. Because the system holds no state that cannot be reconstructed, a rollout is a matter of cycling instances one at a time while watching the error rate.

When a dependency is unavailable, decide explicitly whether the http response caching system fails closed or degrades. Leaving that choice to chance is how a dependency outage becomes a silent data loss, so make the choice visible in code and in a test.

Security considerations

Validate all http response caching inputs at the boundary, reject oversized payloads before buffering them, and keep secrets in the environment rather than the repository.

The http response caching system is a choke point, so it is the right place to reject malformed input before it reaches freshness checker or validation revalidate. Validate the shape and the size at the edge, and let the inner components assume what they receive is well-formed.

Never log secrets or full payloads; log enough to localize a failure without recording data that should not be on disk. Treat any external call as untrusted and validate its response before using it, because a http response caching system that trusts its inputs blindly is one malformed response away from corruption.

Keep dependencies pinned and run an audit in CI. A transitive dependency with a known vulnerability is still a vulnerability in your http response caching system, and the lockfile is what makes the audit meaningful.

Observability

Emit one structured event per http response caching operation with the inputs’ shape, the outcome, and a correlation id. Track error rate and latency per component and alert on a step change rather than a single spike.

The correlation id is the thread that ties a user-visible symptom to the http response caching decision and to the component log entry for the same operation. Without it, an investigation starts from a timestamp and a guess.

Watch the validation revalidate failure rate separately from the overall error rate. A jump in validation revalidate failures usually means a response with a missing vary header that returns one content type to a client that expected another, not a bug in freshness checker, and the two have different owners and different fixes.

Chart the share of http response caching operations that shed, queue, or succeed. A change in the mix points at the cause faster than an aggregate latency can, because each class has a different root.

Troubleshooting

A response with a missing vary header that returns one content type to a client that expected another. Reproduce with a minimal fixture, then add a guard test so the http response caching system rejects the condition loudly.

Performance regresses under http response caching load. Profile with the sampling analyzer, locate the hot path in freshness checker, and add a targeted benchmark to lock the regression.

Keep the http response caching dashboards separate from dependency dashboards. When an operation fails, the correlation id lets you decide in seconds whether the fault is key normalizer, freshness checker, or validation revalidate, instead of guessing from a timeout.

Limitations and next steps

• Single-region; multi-region replication is out of scope.
• The key normalizer is in-process and not horizontally shared by default.
• No auth layer; assume deployment behind an edge that enforces identity.

The http response caching system is single-region by design; extending to multi-region means making key normalizer shareable across regions, which is a real change to the consistency model rather than a config flag. The validation revalidate is in-process, which is correct for one instance but must move to a shared store before scaling out.

There is no authentication or authorization layer; the system assumes it is deployed behind an edge that enforces identity. Adding one is straightforward but out of scope for this build, and doing it here would distract from the http response caching correctness that is the point.

The natural next step, once the http response caching pipeline is trusted in production, is to add a short-TTL cache for idempotent reads and a richer vary splitter that exports histograms rather than counters. Both are additive and neither changes the contracts this build establishes.