← Complete Projects

阅读中文版本

Build a Backpressure Queue Service

Backpressure Queue Service — a complete walkthrough of flow control, covering bounded queue, watermark monitor, producer signal, and testing.

intermediate~5 hbackpressurequeueflow-controloverload

Project goal

Implement flow control that solves propagating overload as backpressure so a fast producer slows down instead of overwhelming a slow consumer, with each component independently testable.

Final features

  • Bounded queue
  • Watermark monitor
  • Producer signal
  • Consumer pool
  • Shed load handler

Architecture

The system is organized around bounded queue, watermark monitor, producer signal, and consumer pool ties them together. Data flows as a bounded queue with high and low watermarks that signal the producer to pause and resume, shedding load only when full.

Prerequisites

  • Node.js 20 LTS or later
  • Familiarity with flow control fundamentals
  • A local environment to run the test suite

Dependencies

  • fastify ^5.0.0 — Queue API
  • redis ^4.7.0 — Distributed queue

Directory structure

backpressure_queue_service/
├── src/index.ts
├── src/bounded-queue.ts
├── src/watermark-monitor.ts
├── tests/backpressure_queue_service.test.ts
└── package.json

Phases

1. Bounded queue

Build the bounded queue that anchors flow control and defines the core data shape.

// Bounded queue: flow control core
export function boundedqueue(input: BoundedqueueInput): BoundedqueueResult {
  // Build the bounded queue that anchors flow control and defines the core data shape.
  return processBoundedqueue(input);
}

Expected behavior: After this phase the bounded queue works in isolation and is covered by a unit test.

2. Watermark monitor

Add the watermark monitor so flow control can propagating overload as backpressure correctly.

// Watermark monitor — handles flow control Add the watermark monitor so
export class Watermarkmonitor {
  constructor(private opts: WatermarkmonitorOptions) {}
  async run(ctx: Context): Promise<WatermarkmonitorOutput> {
    return this.execute(ctx);
  }
}

Expected behavior: After this phase the watermark monitor works in isolation and is covered by a unit test.

3. Producer signal

Wire the producer signal to handle a producer that ignores without losing data.

// Producer signal: flow control stage
export const producersignal = (next: Next) => async (req: Request) => {
  const out = await transform(req);
  return next(out);
};

Expected behavior: After this phase the producer signal works in isolation and is covered by a unit test.

4. Consumer pool

Integrate the consumer pool to make flow control observable and testable end to end.

// Consumer pool for flow control
export async function consumerpool(stream: AsyncIterable<Chunk>): Promise<Aggregate> {
  let acc = init();
  for await (const c of stream) acc = merge(acc, c);
  return acc;
}

Expected behavior: After this phase the consumer pool works in isolation and is covered by a unit test.

5. Shed load handler

Finalize the shed load handler so the flow control system degrades gracefully under overload.

// Shed load handler: flow control finalization
export function shedloadhandler(state: State): Result {
  validate(state);
  return finalize(state);
}

Expected behavior: After this phase the shed load handler works in isolation and is covered by a unit test.

Testing

Each phase has a focused test: bounded queue, watermark monitor, producer signal are exercised in isolation, then an integration test drives the full flow control pipeline and asserts the a producer that ignores case is handled.

Troubleshooting

A producer that ignores the pause signal and keeps pushing, forcing the queue to shed and drop messages

Reproduce with a minimal fixture, then add a guard test so the flow control system rejects the condition loudly.

Performance regresses under load

Profile with the sampling analyzer, locate the hot path, and add a targeted benchmark to lock the regression.

Deployment

Run two instances behind a load balancer, share state in Redis, and set resource limits so overload surfaces as backpressure rather than failure.

Known limitations

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

Project overview

This project builds a flow control system whose reason for existing is propagating overload as backpressure so a fast producer slows down instead of overwhelming a slow consumer. The temptation in flow control 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 producer that ignores the pause signal and keeps pushing, forcing the queue to shed and drop messages as the first thing designed, not the last.

You will implement Bounded queue, Watermark monitor, Producer signal, Consumer pool, and Shed load handler, each as a module with one responsibility and a test that proves it in isolation. The flow control pipeline is then the wiring that composes them, and the integration test is where the composition is shown to survive a producer that ignores the pause signal and keeps pushing, forcing the queue to shed and drop messages.

The walkthrough is written for a developer who has used a flow control 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 bounded queue that returns the right shape, a watermark monitor that rejects bad input, an integration test that goes green — so you can stop at any point and still have a flow control system that works for the cases covered so far.

What you will build

The finished flow control system exposes five capabilities, each with a focused test:

  • Bounded queue
  • Watermark monitor
  • Producer signal
  • Consumer pool
  • Shed load handler

Bounded queue is the foundation that every later stage assumes; Watermark monitor is where flow control correctness lives; Producer signal handles a producer that ignores the pause signal and keeps pushing, forcing the queue to shed and drop messages; Consumer pool makes the system observable; and Shed load handler is the graceful-degradation layer that keeps overload from becoming corruption.

The build keeps the flow control 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 Bounded queue, Watermark monitor, and Producer signal, with Consumer pool tying them together. Data flows as a bounded queue with high and low watermarks that signal the producer to pause and resume, shedding load only when full.

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 Producer signal does not need to stand up Bounded queue and Watermark monitor to exercise the interesting branch.

The data model is deliberately explicit. A bounded queue with high and low watermarks that signal the producer to pause and resume, shedding load only when full 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 flow control 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 Producer signal is designed before the happy path is finished, because a producer that ignores the pause signal and keeps pushing, forcing the queue to shed and drop messages is the case that distinguishes a flow control 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 flow control setup is not blocked by a missing tool:

  • Node.js 20 LTS or later
  • Familiarity with flow control fundamentals
  • A local environment to run the test suite

The runtime dependencies are chosen to keep the flow control datapath legible:

  • fastify (^5.0.0) — Queue API
  • redis (^4.7.0) — Distributed queue
# setup for backpressure-queue-service
pnpm init
pnpm add fastify redis
pnpm add -D typescript tsx vitest

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

Directory structure

Keep each flow control component in its own file so it can be tested without starting the others:

backpressure_queue_service/
├── src/index.ts
├── src/bounded-queue.ts
├── src/watermark-monitor.ts
├── tests/backpressure_queue_service.test.ts
└── package.json

Phase 1: Bounded queue

Build the bounded queue that anchors flow control and defines the core data shape.

// Bounded queue: flow control core
export function boundedqueue(input: BoundedqueueInput): BoundedqueueResult {
  // Build the bounded queue that anchors flow control and defines the core data shape.
  return processBoundedqueue(input);
}

After this phase the bounded queue works in isolation and is covered by a unit test. The bounded queue 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 bounded queue as the single source of truth for the flow control data shape. Validate inputs at the boundary and reject early, so a malformed value never reaches Watermark monitor or Producer signal where its effect would be harder to localize.

Phase 2: Watermark monitor

Add the watermark monitor so flow control can propagating overload as backpressure correctly.

// Watermark monitor — handles flow control Add the watermark monitor so
export class Watermarkmonitor {
  constructor(private opts: WatermarkmonitorOptions) {}
  async run(ctx: Context): Promise<WatermarkmonitorOutput> {
    return this.execute(ctx);
  }
}

After this phase the watermark monitor works in isolation and is covered by a unit test. This is where flow control correctness lives: the watermark monitor is what makes propagating overload as backpressure so a fast producer slows down instead of overwhelming a slow consumer true, and its test is the proof.

Keep the watermark monitor 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 watermark monitor about the transformation.

Phase 3: Producer signal

Wire the producer signal to handle a producer that ignores without losing data.

// Producer signal: flow control stage
export const producersignal = (next: Next) => async (req: Request) => {
  const out = await transform(req);
  return next(out);
};

After this phase the producer signal works in isolation and is covered by a unit test. The producer signal is the difference between a flow control system that works on the happy path and one that survives a producer that ignores the pause signal and keeps pushing, forcing the queue to shed and drop messages.

Design the failure before the success. Decide what producer signal does when a producer that ignores the pause signal and keeps pushing, forcing the queue to shed and drop messages: reject, retry, shed, or degrade — and write that test first. A flow control system whose failure behavior is unspecified will pick one at random under pressure, and it is usually the wrong one.

Phase 4: Consumer pool

Integrate the consumer pool to make flow control observable and testable end to end.

// Consumer pool for flow control
export async function consumerpool(stream: AsyncIterable<Chunk>): Promise<Aggregate> {
  let acc = init();
  for await (const c of stream) acc = merge(acc, c);
  return acc;
}

After this phase the consumer pool works in isolation and is covered by a unit test. Observability is not a finishing touch; it is how you know the flow control 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 consumer pool is what turns “something is slow” into “the watermark monitor is slow for inputs matching this shape,” which is the difference between an alert and an investigation.

Phase 5: Shed load handler

Finalize the shed load handler so the flow control system degrades gracefully under overload.

// Shed load handler: flow control finalization
export function shedloadhandler(state: State): Result {
  validate(state);
  return finalize(state);
}

After this phase the shed load handler works in isolation and is covered by a unit test. The shed load handler is what keeps overload from becoming corruption: when the flow control 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 shed load handler — shed, queue, or backpressure — and make it explicit in code and in a test. Leaving the behavior to chance is how a flow control traffic spike becomes a data loss incident.

Testing

Each phase has a focused test: bounded queue, watermark monitor, and producer signal are exercised in isolation, then an integration test drives the full flow control pipeline and asserts the a producer that ignores case is handled.

Start with unit tests that pin each component’s contract: the bounded queue returns the documented shape, the watermark monitor transforms correctly, and the producer signal 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 flow control scenario end to end. Assert the happy path first, then deliberately trigger a producer that ignores the pause signal and keeps pushing, forcing the queue to shed and drop messages and assert the system degrades rather than corrupts. Because the components are pure where practical, the integration test stays deterministic rather than flaky.

A flow control 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 flow control 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 producer signal failure-mode assertions live as tests rather than as a manual checklist that drifts out of date.

# run the flow control test suite
pnpm vitest run

Deployment and operations

Run at least two flow control instances behind a load balancer and share state in Redis. Set resource limits so flow control 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 flow control behavior is global rather than per instance. Size limits so the system sheds load before it runs out of memory, because a flow control 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 flow control 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 flow control 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 flow control inputs at the boundary, reject oversized payloads before buffering them, and keep secrets in the environment rather than the repository.

The flow control system is a choke point, so it is the right place to reject malformed input before it reaches watermark monitor or producer signal. 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 flow control 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 flow control system, and the lockfile is what makes the audit meaningful.

Observability

Emit one structured event per flow control 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 flow control decision and to the component log entry for the same operation. Without it, an investigation starts from a timestamp and a guess.

Watch the producer signal failure rate separately from the overall error rate. A jump in producer signal failures usually means a producer that ignores the pause signal and keeps pushing, forcing the queue to shed and drop messages, not a bug in watermark monitor, and the two have different owners and different fixes.

Chart the share of flow control 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 producer that ignores the pause signal and keeps pushing, forcing the queue to shed and drop messages. Reproduce with a minimal fixture, then add a guard test so the flow control system rejects the condition loudly.

Performance regresses under flow control load. Profile with the sampling analyzer, locate the hot path in watermark monitor, and add a targeted benchmark to lock the regression.

Keep the flow control dashboards separate from dependency dashboards. When an operation fails, the correlation id lets you decide in seconds whether the fault is bounded queue, watermark monitor, or producer signal, instead of guessing from a timeout.

Limitations and next steps

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

The flow control system is single-region by design; extending to multi-region means making bounded queue shareable across regions, which is a real change to the consistency model rather than a config flag. The producer signal 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 flow control correctness that is the point.

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