Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/diagnostics-provider-conflicts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@croco/diagnostics-core": patch
---

Reject duplicate diagnostics provider names instead of silently overwriting an existing provider.
3 changes: 3 additions & 0 deletions docs/troubleshooting/diagnostics.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,9 @@ const app = createApp({

각 `DiagnosticsProvider`는 다음과 같은 정보를 수집합니다.

Provider `name`은 collector 안에서 유일해야 합니다. 같은 인스턴스를 다시 등록하는 것은 no-op이지만,
같은 `name`을 가진 다른 provider를 등록하면 `DuplicateDiagnosticsProviderProblem`이 발생합니다.

### TelemetryDiagnosticsProvider

- **수집 정보**: OTel SDK 초기화 여부(`isInitialized`), 현재 샘플링 확률(`probability`)
Expand Down
4 changes: 3 additions & 1 deletion packages/diagnostics-core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@
"test": "vitest run",
"typecheck": "tsc --noEmit"
},
"dependencies": {},
"dependencies": {
"@croco/problems-core": "workspace:*"
},
"devDependencies": {}
}
1 change: 1 addition & 0 deletions packages/diagnostics-core/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

export { DiagnosticsCollector } from "./libs/DiagnosticsCollector";
export { ErrorHistoryRingBuffer } from "./libs/ErrorHistoryRingBuffer";
export { DuplicateDiagnosticsProviderProblem } from "./libs/problems/DiagnosticsProblems";
export type {
DiagnosticsProvider,
HealthStatus,
Expand Down
11 changes: 11 additions & 0 deletions packages/diagnostics-core/src/libs/DiagnosticsCollector.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import type { DiagnosticsProvider, HealthStatus, ErrorRecord, DiagnosticsReport } from "./types";
import { ErrorHistoryRingBuffer } from "./ErrorHistoryRingBuffer";
import { DuplicateDiagnosticsProviderProblem } from "./problems/DiagnosticsProblems";

function capMessage(message: string, maxLength: number): string {
if (message.length <= maxLength) {
Expand All @@ -26,6 +27,16 @@ export class DiagnosticsCollector {
private readonly errors = new ErrorHistoryRingBuffer();

registerProvider(provider: DiagnosticsProvider): void {
const existingProvider = this.providers.get(provider.name);

if (existingProvider !== undefined) {
if (existingProvider === provider) {
return;
}

throw new DuplicateDiagnosticsProviderProblem(provider.name);
}

this.providers.set(provider.name, provider);
}

Expand Down
18 changes: 18 additions & 0 deletions packages/diagnostics-core/src/libs/problems/DiagnosticsProblems.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import { Problem, ProblemCategory } from "@croco/problems-core";

/**
* 같은 이름으로 서로 다른 diagnostics provider가 등록될 때 발생하는 Problem입니다.
*/
export class DuplicateDiagnosticsProviderProblem extends Problem {
readonly code = "diagnostics-core/duplicate-provider";
readonly category = ProblemCategory.InternalServerError;

constructor(providerName: string) {
super(undefined, undefined, `Diagnostics provider '${providerName}' is already registered`, {
extensions: {
providerName,
retryable: false,
},
});
}
}
40 changes: 40 additions & 0 deletions packages/diagnostics-core/src/tests/DiagnosticsIntegration.spec.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { beforeEach, describe, expect, it } from "vitest";
import { DiagnosticsCollector } from "../libs/DiagnosticsCollector";
import { DuplicateDiagnosticsProviderProblem } from "../libs/problems/DiagnosticsProblems";
import type { DiagnosticsProvider, HealthStatus, ErrorRecord } from "../libs/types";

class MockDiagnosticsProvider implements DiagnosticsProvider {
Expand Down Expand Up @@ -132,6 +133,45 @@ describe("DiagnosticsCollector Integration", () => {
expect(providers[1].name).toBe("cache");
});

it("should keep the original provider when a different provider uses the same name", async () => {
const provider1 = new MockDiagnosticsProvider("db", {
status: "healthy",
component: "db",
lastChecked: new Date().toISOString(),
});
const provider2 = new MockDiagnosticsProvider("db", {
status: "unhealthy",
component: "db",
lastChecked: new Date().toISOString(),
});

collector.registerProvider(provider1);

expect(() => collector.registerProvider(provider2)).toThrow(
DuplicateDiagnosticsProviderProblem,
);

const providers = collector.getProviders();
const report = await collector.getReport();

expect(providers).toEqual([provider1]);
expect(report.components).toHaveLength(1);
expect(report.components[0].status).toBe("healthy");
});

it("should treat registering the same provider instance as idempotent", () => {
const provider = new MockDiagnosticsProvider("db", {
status: "healthy",
component: "db",
lastChecked: new Date().toISOString(),
});

collector.registerProvider(provider);
collector.registerProvider(provider);

expect(collector.getProviders()).toEqual([provider]);
});

it("should handle provider that throws in getHealth()", async () => {
const failingProvider = new MockDiagnosticsProvider("failing-service", {
status: "healthy",
Expand Down
6 changes: 5 additions & 1 deletion pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading