阅读中文版本

Build a Schema Registry Service

Schema Registry Service — a complete walkthrough of schema evolution governance, covering schema parser, compatibility checker, version store, and testing.

schema_registry_service/
├── src/index.ts
├── src/schema-parser.ts
├── src/compatibility-checker.ts
├── tests/schema_registry_service.test.ts
└── package.json

// Schema parser: schema evolution governance core
export function schemaparser(input: SchemaparserInput): SchemaparserResult {
  // Build the schema parser that anchors schema evolution governance and defines the core data shape.
  return processSchemaparser(input);
}

// Compatibility checker — handles schema evolution governance Add the compatibility checker so
export class Compatibilitychecker {
  constructor(private opts: CompatibilitycheckerOptions) {}
  async run(ctx: Context): Promise<CompatibilitycheckerOutput> {
    return this.execute(ctx);
  }
}

// Version store: schema evolution governance stage
export const versionstore = (next: Next) => async (req: Request) => {
  const out = await transform(req);
  return next(out);
};

// Subject resolver for schema evolution governance
export async function subjectresolver(stream: AsyncIterable<Chunk>): Promise<Aggregate> {
  let acc = init();
  for await (const c of stream) acc = merge(acc, c);
  return acc;
}

// Diff reporter: schema evolution governance finalization
export function diffreporter(state: State): Result {
  validate(state);
  return finalize(state);
}

Project overview

This project builds a schema evolution governance system whose reason for existing is coordinating backward-compatible schema changes across producers and consumers that evolve independently. The temptation in schema evolution governance 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 registers an incompatible schema and breaks consumers that already deployed against the prior version as the first thing designed, not the last.

You will implement Schema parser, Compatibility checker, Version store, Subject resolver, and Diff reporter, each as a module with one responsibility and a test that proves it in isolation. The schema evolution governance pipeline is then the wiring that composes them, and the integration test is where the composition is shown to survive a producer that registers an incompatible schema and breaks consumers that already deployed against the prior version.

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

What you will build

The finished schema evolution governance system exposes five capabilities, each with a focused test:

• Schema parser
• Compatibility checker
• Version store
• Subject resolver
• Diff reporter

Schema parser is the foundation that every later stage assumes; Compatibility checker is where schema evolution governance correctness lives; Version store handles a producer that registers an incompatible schema and breaks consumers that already deployed against the prior version; Subject resolver makes the system observable; and Diff reporter is the graceful-degradation layer that keeps overload from becoming corruption.

The build keeps the schema evolution governance 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 Schema parser, Compatibility checker, and Version store, with Subject resolver tying them together. Data flows as a subject mapped to a list of schema versions, each checked against the previous under a configurable compatibility rule.

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 Version store does not need to stand up Schema parser and Compatibility checker to exercise the interesting branch.

The data model is deliberately explicit. A subject mapped to a list of schema versions, each checked against the previous under a configurable compatibility rule 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 schema evolution governance 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 Version store is designed before the happy path is finished, because a producer that registers an incompatible schema and breaks consumers that already deployed against the prior version is the case that distinguishes a schema evolution governance 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 schema evolution governance setup is not blocked by a missing tool:

• Node.js 20 LTS or later
• Familiarity with schema evolution governance fundamentals
• A local environment to run the test suite

The runtime dependencies are chosen to keep the schema evolution governance datapath legible:

• fastify (^5.0.0) — Registry API
• ajv (^8.17.0) — JSON Schema validation
• level (^8.0.0) — Version store

# setup for schema-registry-service
pnpm init
pnpm add fastify ajv level
pnpm add -D typescript tsx vitest

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

Directory structure

Keep each schema evolution governance component in its own file so it can be tested without starting the others:

schema_registry_service/
├── src/index.ts
├── src/schema-parser.ts
├── src/compatibility-checker.ts
├── tests/schema_registry_service.test.ts
└── package.json

Phase 1: Schema parser

Build the schema parser that anchors schema evolution governance and defines the core data shape.

// Schema parser: schema evolution governance core
export function schemaparser(input: SchemaparserInput): SchemaparserResult {
  // Build the schema parser that anchors schema evolution governance and defines the core data shape.
  return processSchemaparser(input);
}

After this phase the schema parser works in isolation and is covered by a unit test. The schema parser 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 schema parser as the single source of truth for the schema evolution governance data shape. Validate inputs at the boundary and reject early, so a malformed value never reaches Compatibility checker or Version store where its effect would be harder to localize.

Phase 2: Compatibility checker

Add the compatibility checker so schema evolution governance can coordinating backward-compatible schema changes correctly.

// Compatibility checker — handles schema evolution governance Add the compatibility checker so
export class Compatibilitychecker {
  constructor(private opts: CompatibilitycheckerOptions) {}
  async run(ctx: Context): Promise<CompatibilitycheckerOutput> {
    return this.execute(ctx);
  }
}

After this phase the compatibility checker works in isolation and is covered by a unit test. This is where schema evolution governance correctness lives: the compatibility checker is what makes coordinating backward-compatible schema changes across producers and consumers that evolve independently true, and its test is the proof.

Keep the compatibility 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 compatibility checker about the transformation.

Phase 3: Version store

Wire the version store to handle a producer that registers without losing data.

// Version store: schema evolution governance stage
export const versionstore = (next: Next) => async (req: Request) => {
  const out = await transform(req);
  return next(out);
};

After this phase the version store works in isolation and is covered by a unit test. The version store is the difference between a schema evolution governance system that works on the happy path and one that survives a producer that registers an incompatible schema and breaks consumers that already deployed against the prior version.

Design the failure before the success. Decide what version store does when a producer that registers an incompatible schema and breaks consumers that already deployed against the prior version: reject, retry, shed, or degrade — and write that test first. A schema evolution governance system whose failure behavior is unspecified will pick one at random under pressure, and it is usually the wrong one.

Phase 4: Subject resolver

Integrate the subject resolver to make schema evolution governance observable and testable end to end.

// Subject resolver for schema evolution governance
export async function subjectresolver(stream: AsyncIterable<Chunk>): Promise<Aggregate> {
  let acc = init();
  for await (const c of stream) acc = merge(acc, c);
  return acc;
}

After this phase the subject resolver works in isolation and is covered by a unit test. Observability is not a finishing touch; it is how you know the schema evolution governance 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 subject resolver is what turns “something is slow” into “the compatibility checker is slow for inputs matching this shape,” which is the difference between an alert and an investigation.

Phase 5: Diff reporter

Finalize the diff reporter so the schema evolution governance system degrades gracefully under overload.

// Diff reporter: schema evolution governance finalization
export function diffreporter(state: State): Result {
  validate(state);
  return finalize(state);
}

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

Testing

Each phase has a focused test: schema parser, compatibility checker, and version store are exercised in isolation, then an integration test drives the full schema evolution governance pipeline and asserts the a producer that registers case is handled.

Start with unit tests that pin each component’s contract: the schema parser returns the documented shape, the compatibility checker transforms correctly, and the version store 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 schema evolution governance scenario end to end. Assert the happy path first, then deliberately trigger a producer that registers an incompatible schema and breaks consumers that already deployed against the prior version and assert the system degrades rather than corrupts. Because the components are pure where practical, the integration test stays deterministic rather than flaky.

A schema evolution governance 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 schema evolution governance 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 version store failure-mode assertions live as tests rather than as a manual checklist that drifts out of date.

# run the schema evolution governance test suite
pnpm vitest run

Deployment and operations

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

The schema evolution governance system is a choke point, so it is the right place to reject malformed input before it reaches compatibility checker or version store. 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 schema evolution governance 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 schema evolution governance system, and the lockfile is what makes the audit meaningful.

Observability

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

Watch the version store failure rate separately from the overall error rate. A jump in version store failures usually means a producer that registers an incompatible schema and breaks consumers that already deployed against the prior version, not a bug in compatibility checker, and the two have different owners and different fixes.

Chart the share of schema evolution governance 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 registers an incompatible schema and breaks consumers that already deployed against the prior version. Reproduce with a minimal fixture, then add a guard test so the schema evolution governance system rejects the condition loudly.

Performance regresses under schema evolution governance load. Profile with the sampling analyzer, locate the hot path in compatibility checker, and add a targeted benchmark to lock the regression.

Keep the schema evolution governance dashboards separate from dependency dashboards. When an operation fails, the correlation id lets you decide in seconds whether the fault is schema parser, compatibility checker, or version store, instead of guessing from a timeout.

Limitations and next steps

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

The schema evolution governance system is single-region by design; extending to multi-region means making schema parser shareable across regions, which is a real change to the consistency model rather than a config flag. The version store 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 schema evolution governance correctness that is the point.

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