fraqtal/agentic-dev
Template
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

feat(marketing-pages): wire instrumentation — site-settings + pages spans + use-case/controller withSpan

Browse Source 
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
Danijel Martinek
2026-05-07 00:26:45 +02:00
parent 64ffb009e1
commit 404cb07e79
10 changed files with 411 additions and 83 deletions
Download Patch File Download Diff File Expand all files Collapse all files

55
packages/marketing-pages/src/infrastructure/repositories/pages.repository.mock.ts
View File

@@ -1,5 +1,11 @@
import "reflect-metadata";
import { injectable } from "inversify";
import {
NoopTracer,
NoopLogger,
type ITracer,
type ILogger,
} from "@repo/core-shared/instrumentation";
import type { IPagesRepository } from "../../application/repositories/pages.repository.interface";
import type { Page } from "../../entities/models/page";
@@ -24,13 +30,29 @@ const DEFAULT_SEED: Page[] = [
@injectable()
export class MockPagesRepository implements IPagesRepository {
private _pages: Page[];
private tracer: ITracer;
private logger: ILogger;
constructor(initialPages: Page[] = DEFAULT_SEED) {
constructor(
initialPages: Page[] = DEFAULT_SEED,
tracer: ITracer = new NoopTracer(),
logger: ILogger = new NoopLogger(),
) {
this._pages = [...initialPages];
this.tracer = tracer;
this.logger = logger;
void this.logger; // currently unused; reserved for future mock-thrown captures
}
async getPageBySlug(slug: string): Promise<Page | undefined> {
return this._pages.find((p) => p.slug === slug);
return this.tracer.startSpan(
{ name: "pages.getPageBySlug", op: "repository", attributes: { slug } },
async (span) => {
const found = this._pages.find((p) => p.slug === slug);
span.setAttribute("found", Boolean(found));
return found;
},
);
}
async getPages(options?: {
@@ -38,12 +60,27 @@ export class MockPagesRepository implements IPagesRepository {
limit?: number;
offset?: number;
}): Promise<Page[]> {
let result = [...this._pages];
if (options?.status) {
result = result.filter((p) => p.status === options.status);
}
const offset = options?.offset ?? 0;
const limit = options?.limit ?? 50;
return result.slice(offset, offset + limit);
return this.tracer.startSpan(
{
name: "pages.getPages",
op: "repository",
attributes: {
status: options?.status ?? null,
limit: options?.limit ?? null,
offset: options?.offset ?? null,
},
},
async (span) => {
let result = [...this._pages];
if (options?.status) {
result = result.filter((p) => p.status === options.status);
}
const offset = options?.offset ?? 0;
const limit = options?.limit ?? 50;
const page = result.slice(offset, offset + limit);
span.setAttribute("count", page.length);
return page;
},
);
}
}

29
packages/marketing-pages/src/infrastructure/repositories/pages.repository.span.test.ts Normal file
View File

@@ -0,0 +1,29 @@
import { describe, it, expect } from "vitest";
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)", () => {
it("getPageBySlug emits one span with op='repository'", async () => {
const tracer = new RecordingTracer();
const logger = new RecordingLogger();
const repo = new MockPagesRepository([], tracer, logger);
await repo.getPageBySlug("about");
expect(tracer.spans).toHaveLength(1);
expect(tracer.spans[0]).toMatchObject({
name: "pages.getPageBySlug",
op: "repository",
});
expect(tracer.spans[0]!.attributes.slug).toBe("about");
expect(tracer.spans[0]!.attributes.found).toBe(false);
});
it("getPages emits a span with count attribute", async () => {
const tracer = new RecordingTracer();
const repo = new MockPagesRepository(undefined, tracer);
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);
});
});

100
packages/marketing-pages/src/infrastructure/repositories/pages.repository.ts
View File

@@ -2,6 +2,12 @@ import "reflect-metadata";
import { injectable } from "inversify";
import { getPayload } from "payload";
import type { SanitizedConfig } from "payload";
import {
NoopTracer,
NoopLogger,
type ITracer,
type ILogger,
} from "@repo/core-shared/instrumentation";
import type { IPagesRepository } from "../../application/repositories/pages.repository.interface";
import type { Page } from "../../entities/models/page";
@@ -54,24 +60,49 @@ function mapDoc(doc: PayloadPageDoc): Page {
};
}
const FEATURE = "marketing-pages" as const;
const REPO = "pages" as const;
@injectable()
export class PagesRepository implements IPagesRepository {
private config: SanitizedConfig;
private tracer: ITracer;
private logger: ILogger;
constructor(config: SanitizedConfig) {
constructor(
config: SanitizedConfig,
tracer: ITracer = new NoopTracer(),
logger: ILogger = new NoopLogger(),
) {
this.config = config;
this.tracer = tracer;
this.logger = logger;
}
async getPageBySlug(slug: string): Promise<Page | undefined> {
const payload = await getPayload({ config: this.config });
const result = await payload.find({
collection: "pages",
where: { slug: { equals: slug } },
limit: 1,
overrideAccess: true,
});
const doc = result.docs[0] as PayloadPageDoc | undefined;
return doc ? mapDoc(doc) : undefined;
return this.tracer.startSpan(
{ name: "pages.getPageBySlug", op: "repository", attributes: { slug } },
async (span) => {
try {
const payload = await getPayload({ config: this.config });
const result = await payload.find({
collection: "pages",
where: { slug: { equals: slug } },
limit: 1,
overrideAccess: true,
});
const doc = result.docs[0] as PayloadPageDoc | undefined;
span.setAttribute("found", Boolean(doc));
return doc ? mapDoc(doc) : undefined;
} catch (err) {
this.logger.captureException(err, {
tags: { feature: FEATURE, repo: REPO, method: "getPageBySlug" },
});
span.setStatus("error", err instanceof Error ? err.message : String(err));
throw err;
}
},
);
}
async getPages(options?: {
@@ -79,18 +110,41 @@ export class PagesRepository implements IPagesRepository {
limit?: number;
offset?: number;
}): Promise<Page[]> {
const payload = await getPayload({ config: this.config });
const where: Record<string, { equals: string }> = {};
if (options?.status) where.status = { equals: options.status };
const result = await payload.find({
collection: "pages",
where: where as never,
limit: options?.limit ?? 50,
page: options?.offset
? Math.floor(options.offset / (options.limit ?? 50)) + 1
: 1,
overrideAccess: true,
});
return result.docs.map((d) => mapDoc(d as PayloadPageDoc));
return this.tracer.startSpan(
{
name: "pages.getPages",
op: "repository",
attributes: {
status: options?.status ?? null,
limit: options?.limit ?? null,
offset: options?.offset ?? null,
},
},
async (span) => {
try {
const payload = await getPayload({ config: this.config });
const where: Record<string, { equals: string }> = {};
if (options?.status) where.status = { equals: options.status };
const result = await payload.find({
collection: "pages",
where: where as never,
limit: options?.limit ?? 50,
page: options?.offset
? Math.floor(options.offset / (options.limit ?? 50)) + 1
: 1,
overrideAccess: true,
});
const pages = result.docs.map((d) => mapDoc(d as PayloadPageDoc));
span.setAttribute("count", pages.length);
return pages;
} catch (err) {
this.logger.captureException(err, {
tags: { feature: FEATURE, repo: REPO, method: "getPages" },
});
span.setStatus("error", err instanceof Error ? err.message : String(err));
throw err;
}
},
);
}
}

32
packages/marketing-pages/src/infrastructure/repositories/site-settings.repository.mock.ts
View File

@@ -1,15 +1,39 @@
import "reflect-metadata";
import { injectable } from "inversify";
import {
NoopTracer,
NoopLogger,
type ITracer,
type ILogger,
} from "@repo/core-shared/instrumentation";
import type { ISiteSettingsRepository } from "../../application/repositories/site-settings.repository.interface";
import type { SiteSettings } from "../../entities/models/site-settings";
@injectable()
export class MockSiteSettingsRepository implements ISiteSettingsRepository {
private tracer: ITracer;
private logger: ILogger;
constructor(
tracer: ITracer = new NoopTracer(),
logger: ILogger = new NoopLogger(),
) {
this.tracer = tracer;
this.logger = logger;
void this.logger; // currently unused; reserved for future mock-thrown captures
}
async getSiteSettings(): Promise<SiteSettings> {
return {
siteName: "My App",
siteDescription: "A vertical-feature monorepo template",
};
return this.tracer.startSpan(
{ name: "site-settings.getSiteSettings", op: "repository", attributes: {} },
async (span) => {
span.setAttribute("found", true);
return {
siteName: "My App",
siteDescription: "A vertical-feature monorepo template",
};
},
);
}
}

19
packages/marketing-pages/src/infrastructure/repositories/site-settings.repository.span.test.ts Normal file
View File

@@ -0,0 +1,19 @@
import { describe, it, expect } from "vitest";
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)", () => {
it("getSiteSettings emits one span with op='repository'", async () => {
const tracer = new RecordingTracer();
const logger = new RecordingLogger();
const repo = new MockSiteSettingsRepository(tracer, logger);
await repo.getSiteSettings();
expect(tracer.spans).toHaveLength(1);
expect(tracer.spans[0]).toMatchObject({
name: "site-settings.getSiteSettings",
op: "repository",
});
expect(tracer.spans[0]!.attributes.found).toBe(true);
});
});

51
packages/marketing-pages/src/infrastructure/repositories/site-settings.repository.ts
View File

@@ -2,6 +2,12 @@ import "reflect-metadata";
import { injectable } from "inversify";
import { getPayload } from "payload";
import type { SanitizedConfig } from "payload";
import {
NoopTracer,
NoopLogger,
type ITracer,
type ILogger,
} from "@repo/core-shared/instrumentation";
import type { ISiteSettingsRepository } from "../../application/repositories/site-settings.repository.interface";
import type { SiteSettings } from "../../entities/models/site-settings";
@@ -11,23 +17,48 @@ type PayloadSiteSettings = {
siteDescription?: string | null;
};
const FEATURE = "marketing-pages" as const;
const REPO = "site-settings" as const;
@injectable()
export class SiteSettingsRepository implements ISiteSettingsRepository {
private config: SanitizedConfig;
private tracer: ITracer;
private logger: ILogger;
constructor(config: SanitizedConfig) {
constructor(
config: SanitizedConfig,
tracer: ITracer = new NoopTracer(),
logger: ILogger = new NoopLogger(),
) {
this.config = config;
this.tracer = tracer;
this.logger = logger;
}
async getSiteSettings(): Promise<SiteSettings> {
const payload = await getPayload({ config: this.config });
const doc = (await payload.findGlobal({
slug: "site-settings",
overrideAccess: true,
})) as PayloadSiteSettings;
return {
siteName: doc.siteName ?? "My App",
siteDescription: doc.siteDescription ?? undefined,
};
return this.tracer.startSpan(
{ name: "site-settings.getSiteSettings", op: "repository", attributes: {} },
async (span) => {
try {
const payload = await getPayload({ config: this.config });
const doc = (await payload.findGlobal({
slug: "site-settings",
overrideAccess: true,
})) as PayloadSiteSettings;
span.setAttribute("found", true);
return {
siteName: doc.siteName ?? "My App",
siteDescription: doc.siteDescription ?? undefined,
};
} catch (err) {
this.logger.captureException(err, {
tags: { feature: FEATURE, repo: REPO, method: "getSiteSettings" },
});
span.setStatus("error", err instanceof Error ? err.message : String(err));
throw err;
}
},
);
}
}