Files
SnapOtter/tests/unit/api/tracing-bootstrap.test.ts
T
SnapOtterandGitHub 3fb8164fa5 feat: add OpenTelemetry distributed tracing (enterprise) (#232)
* feat(tracing): add OpenTelemetry dependencies and --import preload flag

* feat(enterprise): add distributed_tracing feature gate

* feat(tracing): add SDK bootstrap with enterprise gating

* fix(tracing): correct test coverage for enterprise-unavailable path and prevent double-init

Test 2 now mocks @snapotter/enterprise to throw an import error, exercising
the catch block in the preload. Test 3 imports with no endpoint so the preload
is a no-op, avoiding leaked SDK from double-initialization. Added idempotency
guard to initTracing() as a safety net.

* feat(tracing): add Pino trace mixin and shared logger

When OTel tracing is active, every Pino log line now includes traceId,
spanId, and traceFlags fields for log-to-trace correlation. The mixin
is a no-op when no SDK is registered (community users).

* feat(tracing): add _otel to ToolJobData and inject trace context at enqueue

Add optional _otel carrier field to ToolJobData for W3C trace context
propagation across BullMQ job boundaries. When an active OTel span exists,
propagation.inject() writes traceparent/tracestate into the job data before
queue.add(). When no SDK is registered (community edition), the carrier
stays empty and _otel remains undefined -- zero overhead.

* feat(tracing): extract trace context and create spans in BullMQ worker

* feat(tracing): inject trace context into Python sidecar calls

* feat(tracing): add trace context extraction to Python sidecar

* feat(tracing): add shutdownTracing to graceful shutdown sequence

* feat(tracing): enrich HTTP spans with tool_id and user_id attributes

* docs: add OpenTelemetry env var documentation to .env.example

* test(tracing): add lifecycle integration tests for trace propagation

* fix(tracing): inject trace context into pipeline and batch flow jobs

* fix(tracing): add sidecar.execute Node-side span and remove unnecessary comment

Wraps PythonDispatcher.run() with a sidecar.execute span on the Node
side so traces show the full round-trip (Node span -> Python span).
Also removes an obvious comment from logger.ts.
2026-06-15 12:53:06 +08:00

47 lines
1.7 KiB
TypeScript

import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
describe("tracing bootstrap", () => {
beforeEach(() => {
vi.unstubAllEnvs();
});
afterEach(async () => {
const { shutdownTracing } = await import("../../../apps/api/src/tracing.js");
await shutdownTracing();
vi.resetModules();
});
it("is inactive when OTEL_EXPORTER_OTLP_ENDPOINT is unset", async () => {
vi.stubEnv("OTEL_EXPORTER_OTLP_ENDPOINT", "");
const { isTracingActive } = await import("../../../apps/api/src/tracing.js");
expect(isTracingActive()).toBe(false);
});
it("is inactive when enterprise package is unavailable", async () => {
vi.stubEnv("OTEL_EXPORTER_OTLP_ENDPOINT", "http://localhost:4318");
vi.doMock("@snapotter/enterprise", () => {
throw new Error("Cannot find module '@snapotter/enterprise'");
});
const { isTracingActive } = await import("../../../apps/api/src/tracing.js");
expect(isTracingActive()).toBe(false);
});
it("initializes with valid config and enterprise license", async () => {
vi.stubEnv("OTEL_EXPORTER_OTLP_ENDPOINT", "");
vi.doMock("@snapotter/enterprise", () => ({
isFeatureEnabled: (f: string) => f === "distributed_tracing",
initEnterprise: () => true,
getActiveLicense: () => ({
plan: "enterprise",
features: ["distributed_tracing"],
}),
}));
const { InMemorySpanExporter } = await import("@opentelemetry/sdk-trace-base");
const exporter = new InMemorySpanExporter();
const { initTracing, isTracingActive } = await import("../../../apps/api/src/tracing.js");
await initTracing({ exporter });
expect(isTracingActive()).toBe(true);
});
});