Files
agentic-dev/packages/blog/tests/r44-no-double-capture.test.ts
Danijel Martinek f0775d6ecc feat(instrumentation): close R44 gap — throw-site capture for use cases + controllers
Plan 10 documented R44 (capture at originating-throw layer) but only the
R43 repo leg was wired. captureException had zero call sites in any
controller or use-case body. This commit closes the gap.

Mechanism:
- Extract __sentryReported flag helpers into core-shared/instrumentation/
  reported-flag.ts. SentryLogger switches to importing them; RecordingLogger
  carries an inlined copy (tooling → core boundary disallows the import).
- Add withCapture(logger, tags, fn) higher-order wrapper paralleling
  withSpan. On throw: capture-with-tags, mark, re-throw. Bail if the flag
  was already set — covers the bubbled-from-repo case so each error
  surfaces in the logger exactly once with the inner-most layer's tags.
- Apply withSpan(withCapture(factory)) in every feature's bind-production
  and bind-dev-seed: auth (3 use cases × 3 controllers), blog (3×3),
  marketing-pages (2×2), navigation (1×1), media (3×3). Span is outermost
  so the errored span timing reflects the capture-and-rethrow.
- RecordingLogger.captureException now also honours the flag — test
  capture counts stay honest when both repo and outer layer wrap.

Tests:
- packages/core-shared/src/instrumentation/with-capture.test.ts —
  4 cases covering success, capture-on-throw, mark-on-capture, no-double
  via the flag.
- packages/blog/tests/r44-no-double-capture.test.ts — 3 cases: repo throw
  → 1 capture with repo tags; controller parse fail → 1 capture with
  controller tags; success → 0 captures.

Verification: pnpm test 26/26, pnpm lint 15/15, pnpm typecheck 14/14.

Docs: ADR-014 and the refactor log gain a "Post-merge follow-up" section
recording the gap, the fix, and the underlying lesson (don't describe
intent as shipped state — grep first).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-08 00:28:22 +02:00

142 lines
4.9 KiB
TypeScript

// R44 — verify the full chain (controller → use case → repo) wraps with
// withSpan + withCapture and never double-captures the same error.
//
// Each layer's withCapture catch checks the __sentryReported flag (set by
// the inner-most layer that captured first) and skips. End result: one
// error → one logger.captureException call, with the inner-most tags.
import { describe, it, expect } from "vitest";
import {
RecordingTracer,
RecordingLogger,
} from "@repo/core-testing/instrumentation";
import { withSpan, withCapture } from "@repo/core-shared/instrumentation";
import { MockArticlesRepository } from "../src/infrastructure/repositories/articles.repository.mock";
import { getArticleBySlugUseCase } from "../src/application/use-cases/get-article-by-slug.use-case";
import { getArticleBySlugController } from "../src/interface-adapters/controllers/get-article-by-slug.controller";
describe("R44 — no double-capture across span/capture-wrapped layers", () => {
it("an error originated in the repo is captured exactly once with repo tags", async () => {
const tracer = new RecordingTracer();
const logger = new RecordingLogger();
// Repo throws on getArticleBySlug for a special slug. We simulate the
// throw via a subclass — the production repos call captureException
// inside their own try/catch as part of the repo span body.
class ThrowingRepo extends MockArticlesRepository {
override getArticleBySlug = async (_slug: string) => {
const err = new Error("boom from repo");
// Mirror what the real repo does: capture with repo tags, mark the
// flag (RecordingLogger.captureException does this for us now).
logger.captureException(err, {
tags: { feature: "blog", repo: "articles", method: "getArticleBySlug" },
});
throw err;
};
}
const repo = new ThrowingRepo(tracer, logger);
// Wire the use case + controller exactly the way bind-production does.
const wrappedUC = withSpan(
tracer,
{ name: "blog.getArticleBySlug", op: "use-case" },
withCapture(
logger,
{ feature: "blog", layer: "use-case", name: "blog.getArticleBySlug" },
getArticleBySlugUseCase(repo),
),
);
const wrappedCtrl = withSpan(
tracer,
{ name: "blog.getArticleBySlug", op: "controller" },
withCapture(
logger,
{ feature: "blog", layer: "controller", name: "blog.getArticleBySlug" },
getArticleBySlugController(wrappedUC),
),
);
await expect(wrappedCtrl({ slug: "anything" })).rejects.toThrow("boom from repo");
// R44: exactly one capture. Outer wrappers saw the flag and skipped.
expect(logger.captures).toHaveLength(1);
const only = logger.captures[0];
expect(only?.kind).toBe("exception");
if (only?.kind !== "exception") return;
expect(only.ctx?.tags).toEqual({
feature: "blog",
repo: "articles",
method: "getArticleBySlug",
});
});
it("an error originated in the controller (parse failure) is captured once with controller tags", async () => {
const tracer = new RecordingTracer();
const logger = new RecordingLogger();
const repo = new MockArticlesRepository();
const wrappedUC = withSpan(
tracer,
{ name: "blog.getArticleBySlug", op: "use-case" },
withCapture(
logger,
{ feature: "blog", layer: "use-case", name: "blog.getArticleBySlug" },
getArticleBySlugUseCase(repo),
),
);
const wrappedCtrl = withSpan(
tracer,
{ name: "blog.getArticleBySlug", op: "controller" },
withCapture(
logger,
{ feature: "blog", layer: "controller", name: "blog.getArticleBySlug" },
getArticleBySlugController(wrappedUC),
),
);
// safeParse fails because slug is missing.
await expect(wrappedCtrl({})).rejects.toThrow();
expect(logger.captures).toHaveLength(1);
const only = logger.captures[0];
expect(only?.kind).toBe("exception");
if (only?.kind !== "exception") return;
expect(only.ctx?.tags).toEqual({
feature: "blog",
layer: "controller",
name: "blog.getArticleBySlug",
});
});
it("a successful call captures nothing", async () => {
const tracer = new RecordingTracer();
const logger = new RecordingLogger();
const repo = new MockArticlesRepository();
const wrappedUC = withSpan(
tracer,
{ name: "blog.getArticles", op: "use-case" },
withCapture(
logger,
{ feature: "blog", layer: "use-case", name: "blog.getArticles" },
async () => [],
),
);
const wrappedCtrl = withSpan(
tracer,
{ name: "blog.getArticles", op: "controller" },
withCapture(
logger,
{ feature: "blog", layer: "controller", name: "blog.getArticles" },
async () => wrappedUC(),
),
);
await expect(wrappedCtrl()).resolves.toEqual([]);
expect(logger.captures).toHaveLength(0);
void repo;
});
});