阅读中文版本

Build a Dependency Graph CLI

Dependency Graph CLI — a complete walkthrough of dependency analysis, covering manifest reader, graph builder, cycle detector, and testing.

dependency_graph_cli/
├── src/index.ts
├── src/manifest-reader.ts
├── src/graph-builder.ts
├── tests/dependency_graph_cli.test.ts
└── package.json

// Manifest reader: dependency analysis core
export function manifestreader(input: ManifestreaderInput): ManifestreaderResult {
  // Build the manifest reader that anchors dependency analysis and defines the core data shape.
  return processManifestreader(input);
}

// Graph builder — handles dependency analysis Add the graph builder so
export class Graphbuilder {
  constructor(private opts: GraphbuilderOptions) {}
  async run(ctx: Context): Promise<GraphbuilderOutput> {
    return this.execute(ctx);
  }
}

// Cycle detector: dependency analysis stage
export const cycledetector = (next: Next) => async (req: Request) => {
  const out = await transform(req);
  return next(out);
};

// Reachability analyzer for dependency analysis
export async function reachabilityanalyzer(stream: AsyncIterable<Chunk>): Promise<Aggregate> {
  let acc = init();
  for await (const c of stream) acc = merge(acc, c);
  return acc;
}

// Report renderer: dependency analysis finalization
export function reportrenderer(state: State): Result {
  validate(state);
  return finalize(state);
}

Project overview

This project builds a dependency analysis system whose reason for existing is building a graph of package dependencies and reporting cycles and orphans. The temptation in dependency analysis 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 cycle that the detector reports but the renderer truncates, hiding which edge to break as the first thing designed, not the last.

You will implement Manifest reader, Graph builder, Cycle detector, Reachability analyzer, and Report renderer, each as a module with one responsibility and a test that proves it in isolation. The dependency analysis pipeline is then the wiring that composes them, and the integration test is where the composition is shown to survive a cycle that the detector reports but the renderer truncates, hiding which edge to break.

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

What you will build

The finished dependency analysis system exposes five capabilities, each with a focused test:

• Manifest reader
• Graph builder
• Cycle detector
• Reachability analyzer
• Report renderer

Manifest reader is the foundation that every later stage assumes; Graph builder is where dependency analysis correctness lives; Cycle detector handles a cycle that the detector reports but the renderer truncates, hiding which edge to break; Reachability analyzer makes the system observable; and Report renderer is the graceful-degradation layer that keeps overload from becoming corruption.

The build keeps the dependency analysis 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 Manifest reader, Graph builder, and Cycle detector, with Reachability analyzer tying them together. Data flows as a directed graph of package nodes with dependency edges, analyzed for cycles and nodes unreachable from the entry.

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 Cycle detector does not need to stand up Manifest reader and Graph builder to exercise the interesting branch.

The data model is deliberately explicit. A directed graph of package nodes with dependency edges, analyzed for cycles and nodes unreachable from the entry 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 dependency analysis 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 Cycle detector is designed before the happy path is finished, because a cycle that the detector reports but the renderer truncates, hiding which edge to break is the case that distinguishes a dependency analysis 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 dependency analysis setup is not blocked by a missing tool:

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

The runtime dependencies are chosen to keep the dependency analysis datapath legible:

• commander (^12.1.0) — CLI framework
• graphlib (^2.1.8) — Graph algorithms

# setup for dependency-graph-cli
pnpm init
pnpm add commander graphlib
pnpm add -D typescript tsx vitest

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

Directory structure

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

dependency_graph_cli/
├── src/index.ts
├── src/manifest-reader.ts
├── src/graph-builder.ts
├── tests/dependency_graph_cli.test.ts
└── package.json

Phase 1: Manifest reader

Build the manifest reader that anchors dependency analysis and defines the core data shape.

// Manifest reader: dependency analysis core
export function manifestreader(input: ManifestreaderInput): ManifestreaderResult {
  // Build the manifest reader that anchors dependency analysis and defines the core data shape.
  return processManifestreader(input);
}

After this phase the manifest reader works in isolation and is covered by a unit test. The manifest reader 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 manifest reader as the single source of truth for the dependency analysis data shape. Validate inputs at the boundary and reject early, so a malformed value never reaches Graph builder or Cycle detector where its effect would be harder to localize.

Phase 2: Graph builder

Add the graph builder so dependency analysis can building a graph of correctly.

// Graph builder — handles dependency analysis Add the graph builder so
export class Graphbuilder {
  constructor(private opts: GraphbuilderOptions) {}
  async run(ctx: Context): Promise<GraphbuilderOutput> {
    return this.execute(ctx);
  }
}

After this phase the graph builder works in isolation and is covered by a unit test. This is where dependency analysis correctness lives: the graph builder is what makes building a graph of package dependencies and reporting cycles and orphans true, and its test is the proof.

Keep the graph builder 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 graph builder about the transformation.

Phase 3: Cycle detector

Wire the cycle detector to handle a cycle that the without losing data.

// Cycle detector: dependency analysis stage
export const cycledetector = (next: Next) => async (req: Request) => {
  const out = await transform(req);
  return next(out);
};

After this phase the cycle detector works in isolation and is covered by a unit test. The cycle detector is the difference between a dependency analysis system that works on the happy path and one that survives a cycle that the detector reports but the renderer truncates, hiding which edge to break.

Design the failure before the success. Decide what cycle detector does when a cycle that the detector reports but the renderer truncates, hiding which edge to break: reject, retry, shed, or degrade — and write that test first. A dependency analysis system whose failure behavior is unspecified will pick one at random under pressure, and it is usually the wrong one.

Phase 4: Reachability analyzer

Integrate the reachability analyzer to make dependency analysis observable and testable end to end.

// Reachability analyzer for dependency analysis
export async function reachabilityanalyzer(stream: AsyncIterable<Chunk>): Promise<Aggregate> {
  let acc = init();
  for await (const c of stream) acc = merge(acc, c);
  return acc;
}

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

Phase 5: Report renderer

Finalize the report renderer so the dependency analysis system degrades gracefully under overload.

// Report renderer: dependency analysis finalization
export function reportrenderer(state: State): Result {
  validate(state);
  return finalize(state);
}

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

Testing

Each phase has a focused test: manifest reader, graph builder, and cycle detector are exercised in isolation, then an integration test drives the full dependency analysis pipeline and asserts the a cycle that the case is handled.

Start with unit tests that pin each component’s contract: the manifest reader returns the documented shape, the graph builder transforms correctly, and the cycle detector 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 dependency analysis scenario end to end. Assert the happy path first, then deliberately trigger a cycle that the detector reports but the renderer truncates, hiding which edge to break and assert the system degrades rather than corrupts. Because the components are pure where practical, the integration test stays deterministic rather than flaky.

A dependency analysis 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 dependency analysis 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 cycle detector failure-mode assertions live as tests rather than as a manual checklist that drifts out of date.

# run the dependency analysis test suite
pnpm vitest run

Deployment and operations

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

The dependency analysis system is a choke point, so it is the right place to reject malformed input before it reaches graph builder or cycle detector. 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 dependency analysis 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 dependency analysis system, and the lockfile is what makes the audit meaningful.

Observability

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

Watch the cycle detector failure rate separately from the overall error rate. A jump in cycle detector failures usually means a cycle that the detector reports but the renderer truncates, hiding which edge to break, not a bug in graph builder, and the two have different owners and different fixes.

Chart the share of dependency analysis 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 cycle that the detector reports but the renderer truncates, hiding which edge to break. Reproduce with a minimal fixture, then add a guard test so the dependency analysis system rejects the condition loudly.

Performance regresses under dependency analysis load. Profile with the sampling analyzer, locate the hot path in graph builder, and add a targeted benchmark to lock the regression.

Keep the dependency analysis dashboards separate from dependency dashboards. When an operation fails, the correlation id lets you decide in seconds whether the fault is manifest reader, graph builder, or cycle detector, instead of guessing from a timeout.

Limitations and next steps

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

The dependency analysis system is single-region by design; extending to multi-region means making manifest reader shareable across regions, which is a real change to the consistency model rather than a config flag. The cycle detector 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 dependency analysis correctness that is the point.

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