refactor: strip Phase/Plan/R-number references from source comments

This commit is contained in:
2026-05-13 09:51:45 +02:00
parent 075b729266
commit 17ae157365
66 changed files with 980 additions and 647 deletions

View File

@@ -44,80 +44,79 @@ export const CONTRACT_PAGES_SEED: Page[] = [
* must return a repo pre-loaded with CONTRACT_PAGES_SEED (two pages:
* one published with slug "about", one draft with slug "draft-page").
*/
export const pagesRepositoryContract =
defineContractSuite<IPagesRepository>(
"IPagesRepository",
({ buildSubject, getTracer }) => {
let repo: IPagesRepository;
export const pagesRepositoryContract = defineContractSuite<IPagesRepository>(
"IPagesRepository",
({ buildSubject, getTracer }) => {
let repo: IPagesRepository;
beforeEach(async () => {
repo = await buildSubject();
beforeEach(async () => {
repo = await buildSubject();
});
// --- getPageBySlug ---
it("getPageBySlug returns the published page by slug", async () => {
const result = await repo.getPageBySlug("about");
expect(result).toBeDefined();
expect(result?.slug).toBe("about");
expect(result?.status).toBe("published");
expect(result?.id).toBeDefined();
});
it("getPageBySlug returns undefined for an unknown slug", async () => {
expect(await repo.getPageBySlug("no-such-page")).toBeUndefined();
});
// --- getPages ---
it("getPages with no filter returns all seeded pages", async () => {
const list = await repo.getPages();
expect(list).toHaveLength(2);
for (const page of list) {
expect(page.id).toBeDefined();
expect(page.slug).toBeDefined();
expect(["draft", "published"]).toContain(page.status);
}
});
it("getPages({ status: 'published' }) returns only published pages", async () => {
const published = await repo.getPages({ status: "published" });
expect(published).toHaveLength(1);
for (const page of published) {
expect(page.status).toBe("published");
}
});
it("getPages({ status: 'draft' }) returns only draft pages", async () => {
const drafts = await repo.getPages({ status: "draft" });
expect(drafts).toHaveLength(1);
for (const page of drafts) {
expect(page.status).toBe("draft");
}
});
describe("span emission", () => {
it("getPageBySlug emits pages.getPageBySlug span with slug attribute", async () => {
if (!getTracer) return;
const tracer = getTracer();
tracer.reset();
await repo.getPageBySlug("about");
const span = tracer.findSpan("pages.getPageBySlug");
expect(span).toBeDefined();
expect(span!.op).toBe("repository");
expect(span!.attributes.slug).toBe("about");
});
// --- getPageBySlug ---
it("getPageBySlug returns the published page by slug", async () => {
const result = await repo.getPageBySlug("about");
expect(result).toBeDefined();
expect(result?.slug).toBe("about");
expect(result?.status).toBe("published");
expect(result?.id).toBeDefined();
it("getPages emits pages.getPages span with op=repository", async () => {
if (!getTracer) return;
const tracer = getTracer();
tracer.reset();
await repo.getPages({ status: "published" });
const span = tracer.findSpan("pages.getPages");
expect(span).toBeDefined();
expect(span!.op).toBe("repository");
expect(span!.attributes.status).toBe("published");
});
it("getPageBySlug returns undefined for an unknown slug", async () => {
expect(await repo.getPageBySlug("no-such-page")).toBeUndefined();
});
// --- getPages ---
it("getPages with no filter returns all seeded pages", async () => {
const list = await repo.getPages();
expect(list).toHaveLength(2);
for (const page of list) {
expect(page.id).toBeDefined();
expect(page.slug).toBeDefined();
expect(["draft", "published"]).toContain(page.status);
}
});
it("getPages({ status: 'published' }) returns only published pages", async () => {
const published = await repo.getPages({ status: "published" });
expect(published).toHaveLength(1);
for (const page of published) {
expect(page.status).toBe("published");
}
});
it("getPages({ status: 'draft' }) returns only draft pages", async () => {
const drafts = await repo.getPages({ status: "draft" });
expect(drafts).toHaveLength(1);
for (const page of drafts) {
expect(page.status).toBe("draft");
}
});
describe("span emission (R50)", () => {
it("getPageBySlug emits pages.getPageBySlug span with slug attribute", async () => {
if (!getTracer) return;
const tracer = getTracer();
tracer.reset();
await repo.getPageBySlug("about");
const span = tracer.findSpan("pages.getPageBySlug");
expect(span).toBeDefined();
expect(span!.op).toBe("repository");
expect(span!.attributes.slug).toBe("about");
});
it("getPages emits pages.getPages span with op=repository", async () => {
if (!getTracer) return;
const tracer = getTracer();
tracer.reset();
await repo.getPages({ status: "published" });
const span = tracer.findSpan("pages.getPages");
expect(span).toBeDefined();
expect(span!.op).toBe("repository");
expect(span!.attributes.status).toBe("published");
});
});
},
);
});
},
);

View File

@@ -35,7 +35,7 @@ export const siteSettingsRepositoryContract =
).toBe(true);
});
describe("span emission (R50)", () => {
describe("span emission", () => {
it("getSiteSettings emits site-settings.getSiteSettings span with op=repository", async () => {
if (!getTracer) return;
const tracer = getTracer();

View File

@@ -18,7 +18,7 @@ describe("getPageBySlugUseCase", () => {
expect(result).toBeUndefined();
});
it("(R25) throws ZodError when repository returns malformed page data", async () => {
it("throws ZodError when repository returns malformed page data", async () => {
const repo = new MockPagesRepository([
{
id: "p-bad",
@@ -34,6 +34,8 @@ describe("getPageBySlugUseCase", () => {
} as never,
]);
const useCase = getPageBySlugUseCase(repo);
await expect(useCase({ slug: "bad-page" })).rejects.toBeInstanceOf(ZodError);
await expect(useCase({ slug: "bad-page" })).rejects.toBeInstanceOf(
ZodError,
);
});
});

View File

@@ -11,7 +11,7 @@ describe("getSiteSettingsUseCase", () => {
expect(result.siteName).toBe("My App");
});
it("(R25) throws ZodError when repository returns malformed site settings", async () => {
it("throws ZodError when repository returns malformed site settings", async () => {
const malformedRepo = {
getSiteSettings: async () => ({ siteName: "" }),
};

View File

@@ -4,7 +4,7 @@ export type { MarketingPagesRouter } from "./integrations/api/router";
export { PageNotFoundError } from "./entities/errors/page";
export { InputParseError } from "./entities/errors/common";
// Use case schemas + types (Plan 9 R18)
// Use case schemas + types
export {
getPageBySlugInputSchema,
getPageBySlugOutputSchema,
@@ -26,4 +26,7 @@ export type { IGetSiteSettingsController } from "./interface-adapters/controller
// <gen:events>
// <gen:realtime-channels>
export { marketingPagesManifest, type MarketingPagesManifest } from "./feature.manifest";
export {
marketingPagesManifest,
type MarketingPagesManifest,
} from "./feature.manifest";

View File

@@ -1,9 +1,12 @@
import { describe, it, expect } from "vitest";
import { RecordingTracer, RecordingLogger } from "@repo/core-testing/instrumentation";
import {
RecordingTracer,
RecordingLogger,
} from "@repo/core-testing/instrumentation";
import { MockPagesRepository } from "@/infrastructure/repositories/pages.repository.mock";
// Mock repo also wraps in spans (R42).
describe("MockPagesRepository emits spans (R42)", () => {
// Mock repo also wraps in spans.
describe("MockPagesRepository emits spans", () => {
it("getPageBySlug emits one span with op='repository'", async () => {
const tracer = new RecordingTracer();
const logger = new RecordingLogger();
@@ -24,6 +27,8 @@ describe("MockPagesRepository emits spans (R42)", () => {
await repo.getPages({ limit: 10 });
expect(tracer.findSpan("pages.getPages")).toBeDefined();
expect(tracer.findSpan("pages.getPages")!.attributes.limit).toBe(10);
expect(tracer.findSpan("pages.getPages")!.attributes.count).toBeGreaterThanOrEqual(0);
expect(
tracer.findSpan("pages.getPages")!.attributes.count,
).toBeGreaterThanOrEqual(0);
});
});

View File

@@ -1,9 +1,12 @@
import { describe, it, expect } from "vitest";
import { RecordingTracer, RecordingLogger } from "@repo/core-testing/instrumentation";
import {
RecordingTracer,
RecordingLogger,
} from "@repo/core-testing/instrumentation";
import { MockSiteSettingsRepository } from "@/infrastructure/repositories/site-settings.repository.mock";
// Mock repo also wraps in spans (R42).
describe("MockSiteSettingsRepository emits spans (R42)", () => {
// Mock repo also wraps in spans.
describe("MockSiteSettingsRepository emits spans", () => {
it("getSiteSettings emits one span with op='repository'", async () => {
const tracer = new RecordingTracer();
const logger = new RecordingLogger();

View File

@@ -33,7 +33,7 @@ describe("marketingPagesRouter", () => {
});
});
describe("marketingPagesRouter (R26 error mapping)", () => {
describe("marketingPagesRouter error mapping", () => {
beforeEach(() => {
marketingPagesContainer.unbindAll();
marketingPagesContainer.load(MarketingPagesModule);