阅读中文版本

Build a Document Version Store

Document Version Store — a complete walkthrough of document versioning, covering content-addressed blob, revision tree, diff serializer, and testing.

document_version_store/
├── src/index.ts
├── src/content-addressed-blob.ts
├── src/revision-tree.ts
├── tests/document_version_store.test.ts
└── package.json

// Content-addressed blob: document versioning core
export function contentaddressedblob(input: ContentaddressedblobInput): ContentaddressedblobResult {
  // Build the content-addressed blob that anchors document versioning and defines the core data shape.
  return processContentaddressedblob(input);
}

// Revision tree — handles document versioning Add the revision tree so
export class Revisiontree {
  constructor(private opts: RevisiontreeOptions) {}
  async run(ctx: Context): Promise<RevisiontreeOutput> {
    return this.execute(ctx);
  }
}

// Diff serializer: document versioning stage
export const diffserializer = (next: Next) => async (req: Request) => {
  const out = await transform(req);
  return next(out);
};

// Snapshot materializer for document versioning
export async function snapshotmaterializer(stream: AsyncIterable<Chunk>): Promise<Aggregate> {
  let acc = init();
  for await (const c of stream) acc = merge(acc, c);
  return acc;
}

// Garbage collector: document versioning finalization
export function garbagecollector(state: State): Result {
  validate(state);
  return finalize(state);
}

Project overview

This project builds a document versioning system whose reason for existing is keeping every revision of a mutable document addressable without storing full copies for each edit. The temptation in document versioning 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 long branch chain whose materialization requires walking thousands of diffs to reconstruct the current state as the first thing designed, not the last.

You will implement Content-addressed blob, Revision tree, Diff serializer, Snapshot materializer, and Garbage collector, each as a module with one responsibility and a test that proves it in isolation. The document versioning pipeline is then the wiring that composes them, and the integration test is where the composition is shown to survive a long branch chain whose materialization requires walking thousands of diffs to reconstruct the current state.

The walkthrough is written for a developer who has used a document versioning 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 content-addressed blob that returns the right shape, a revision tree that rejects bad input, an integration test that goes green — so you can stop at any point and still have a document versioning system that works for the cases covered so far.

What you will build

The finished document versioning system exposes five capabilities, each with a focused test:

• Content-addressed blob
• Revision tree
• Diff serializer
• Snapshot materializer
• Garbage collector

Content-addressed blob is the foundation that every later stage assumes; Revision tree is where document versioning correctness lives; Diff serializer handles a long branch chain whose materialization requires walking thousands of diffs to reconstruct the current state; Snapshot materializer makes the system observable; and Garbage collector is the graceful-degradation layer that keeps overload from becoming corruption.

The build keeps the document versioning 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 Content-addressed blob, Revision tree, and Diff serializer, with Snapshot materializer tying them together. Data flows as a tree of revision nodes pointing at content-addressed blobs, where each node stores a diff against its parent.

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 Diff serializer does not need to stand up Content-addressed blob and Revision tree to exercise the interesting branch.

The data model is deliberately explicit. A tree of revision nodes pointing at content-addressed blobs, where each node stores a diff against its parent 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 document versioning 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 Diff serializer is designed before the happy path is finished, because a long branch chain whose materialization requires walking thousands of diffs to reconstruct the current state is the case that distinguishes a document versioning 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 document versioning setup is not blocked by a missing tool:

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

The runtime dependencies are chosen to keep the document versioning datapath legible:

• express (^4.21.0) — Document API surface
• blake3 (^0.2.0) — Content addressing hash
• level (^8.0.0) — Key-value blob store

# setup for document-version-store
pnpm init
pnpm add express blake3 level
pnpm add -D typescript tsx vitest

Versions are pinned to a major range so the document versioning install is reproducible; commit the lockfile. The content-addressed blob reads its operational parameters from the environment and validates them at startup, so a missing value fails the boot rather than the first document versioning request.

Directory structure

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

document_version_store/
├── src/index.ts
├── src/content-addressed-blob.ts
├── src/revision-tree.ts
├── tests/document_version_store.test.ts
└── package.json

Phase 1: Content-addressed blob

Build the content-addressed blob that anchors document versioning and defines the core data shape.

// Content-addressed blob: document versioning core
export function contentaddressedblob(input: ContentaddressedblobInput): ContentaddressedblobResult {
  // Build the content-addressed blob that anchors document versioning and defines the core data shape.
  return processContentaddressedblob(input);
}

After this phase the content-addressed blob works in isolation and is covered by a unit test. The content-addressed blob 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 content-addressed blob as the single source of truth for the document versioning data shape. Validate inputs at the boundary and reject early, so a malformed value never reaches Revision tree or Diff serializer where its effect would be harder to localize.

Phase 2: Revision tree

Add the revision tree so document versioning can keeping every revision of correctly.

// Revision tree — handles document versioning Add the revision tree so
export class Revisiontree {
  constructor(private opts: RevisiontreeOptions) {}
  async run(ctx: Context): Promise<RevisiontreeOutput> {
    return this.execute(ctx);
  }
}

After this phase the revision tree works in isolation and is covered by a unit test. This is where document versioning correctness lives: the revision tree is what makes keeping every revision of a mutable document addressable without storing full copies for each edit true, and its test is the proof.

Keep the revision tree 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 revision tree about the transformation.

Phase 3: Diff serializer

Wire the diff serializer to handle a long branch chain without losing data.

// Diff serializer: document versioning stage
export const diffserializer = (next: Next) => async (req: Request) => {
  const out = await transform(req);
  return next(out);
};

After this phase the diff serializer works in isolation and is covered by a unit test. The diff serializer is the difference between a document versioning system that works on the happy path and one that survives a long branch chain whose materialization requires walking thousands of diffs to reconstruct the current state.

Design the failure before the success. Decide what diff serializer does when a long branch chain whose materialization requires walking thousands of diffs to reconstruct the current state: reject, retry, shed, or degrade — and write that test first. A document versioning system whose failure behavior is unspecified will pick one at random under pressure, and it is usually the wrong one.

Phase 4: Snapshot materializer

Integrate the snapshot materializer to make document versioning observable and testable end to end.

// Snapshot materializer for document versioning
export async function snapshotmaterializer(stream: AsyncIterable<Chunk>): Promise<Aggregate> {
  let acc = init();
  for await (const c of stream) acc = merge(acc, c);
  return acc;
}

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

Phase 5: Garbage collector

Finalize the garbage collector so the document versioning system degrades gracefully under overload.

// Garbage collector: document versioning finalization
export function garbagecollector(state: State): Result {
  validate(state);
  return finalize(state);
}

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

Testing

Each phase has a focused test: content-addressed blob, revision tree, and diff serializer are exercised in isolation, then an integration test drives the full document versioning pipeline and asserts the a long branch chain case is handled.

Start with unit tests that pin each component’s contract: the content-addressed blob returns the documented shape, the revision tree transforms correctly, and the diff serializer 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 document versioning scenario end to end. Assert the happy path first, then deliberately trigger a long branch chain whose materialization requires walking thousands of diffs to reconstruct the current state and assert the system degrades rather than corrupts. Because the components are pure where practical, the integration test stays deterministic rather than flaky.

A document versioning 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 document versioning 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 diff serializer failure-mode assertions live as tests rather than as a manual checklist that drifts out of date.

# run the document versioning test suite
pnpm vitest run

Deployment and operations

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

The document versioning system is a choke point, so it is the right place to reject malformed input before it reaches revision tree or diff serializer. 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 document versioning 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 document versioning system, and the lockfile is what makes the audit meaningful.

Observability

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

Watch the diff serializer failure rate separately from the overall error rate. A jump in diff serializer failures usually means a long branch chain whose materialization requires walking thousands of diffs to reconstruct the current state, not a bug in revision tree, and the two have different owners and different fixes.

Chart the share of document versioning 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 long branch chain whose materialization requires walking thousands of diffs to reconstruct the current state. Reproduce with a minimal fixture, then add a guard test so the document versioning system rejects the condition loudly.

Performance regresses under document versioning load. Profile with the sampling analyzer, locate the hot path in revision tree, and add a targeted benchmark to lock the regression.

Keep the document versioning dashboards separate from dependency dashboards. When an operation fails, the correlation id lets you decide in seconds whether the fault is content-addressed blob, revision tree, or diff serializer, instead of guessing from a timeout.

Limitations and next steps

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

The document versioning system is single-region by design; extending to multi-region means making content-addressed blob shareable across regions, which is a real change to the consistency model rather than a config flag. The diff serializer 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 document versioning correctness that is the point.

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