🪢 Open source agent evals & observability: Trace, evaluate, and improve LLM applications with one open platform.
TypeScript analyticsautogenevaluationlangchainlarge-language-modelsllama-indexllmllm-evaluationllm-observabilityllmopsmonitoringobservabilityopen-sourceopenaiplaygroundprompt-engineeringprompt-managementself-hostedycombinator
/** @vitest-environment node */
import type { NextApiRequest, NextApiResponse } from "next";
import { createMocks } from "node-mocks-http";
import { LangfuseNotFoundError, UnauthorizedError } from "@langfuse/shared";
import { beforeEach, describe, expect, it, vi } from "vitest";
import handler from "../../pages/api/traces/[traceId]/download";
import { TraceDownloadTooLargeError } from "../../features/traces/server/buildTraceExport";
const { mockGetServerAuthSession, mockBuildTraceExport } = vi.hoisted(() => ({
mockGetServerAuthSession: vi.fn(),
mockBuildTraceExport: vi.fn(),
}));
vi.mock("../../server/auth", () => ({
getServerAuthSession: (...args: unknown[]) =>
mockGetServerAuthSession(...args),
}));
vi.mock("../../features/traces/server/buildTraceExport", async () => ({
...(await vi.importActual("../../features/traces/server/buildTraceExport")),
buildTraceExport: (...args: unknown[]) => mockBuildTraceExport(...args),
}));
const projectId = "project-1";
const createGetMocks = (query: Record<string, string | string[] | undefined>) =>
createMocks<NextApiRequest, NextApiResponse>({
method: "GET",
query,
});
describe("GET /api/traces/[traceId]/download", () => {
beforeEach(() => {
vi.clearAllMocks();
mockGetServerAuthSession.mockResolvedValue({
user: {
email: "[email protected]",
admin: false,
organizations: [{ projects: [{ id: projectId }] }],
},
});
mockBuildTraceExport.mockResolvedValue({
scores: [{ id: "score-1", traceId: "trace-1", observationId: null }],
observations: [{ id: "obs-1", traceId: "trace-1" }],
});
});
it("delegates unauthenticated requests to buildTraceExport", async () => {
mockGetServerAuthSession.mockResolvedValue(null);
const { req, res } = createGetMocks({
traceId: "trace-1",
projectId,
});
await handler(req, res);
expect(mockBuildTraceExport).toHaveBeenCalledWith({
traceId: "trace-1",
projectId,
session: null,
});
expect(res._getStatusCode()).toBe(200);
});
it("returns 401 for malformed authenticated sessions", async () => {
mockGetServerAuthSession.mockResolvedValue({
user: {
email: "[email protected]",
},
});
const { req, res } = createGetMocks({
traceId: "trace-1",
projectId,
});
await handler(req, res);
expect(res._getStatusCode()).toBe(401);
});
it("returns 400 for invalid params", async () => {
const { req, res } = createGetMocks({
traceId: "",
projectId,
});
await handler(req, res);
expect(res._getStatusCode()).toBe(400);
});
it("returns attachment headers and the log-view export payload", async () => {
const { req, res } = createGetMocks({
traceId: "trace-1",
projectId,
});
await handler(req, res);
expect(mockBuildTraceExport).toHaveBeenCalledWith({
traceId: "trace-1",
projectId,
session: expect.any(Object),
});
expect(res._getStatusCode()).toBe(200);
expect(res.getHeader("Content-Disposition")).toBe(
"attachment; filename=\"trace-export.json\"; filename*=UTF-8''trace-trace-1.json",
);
expect(JSON.parse(res._getData())).toMatchObject({
scores: [{ id: "score-1", traceId: "trace-1", observationId: null }],
observations: [{ id: "obs-1", traceId: "trace-1" }],
});
});
it("encodes quoted trace ids in the attachment filename", async () => {
mockBuildTraceExport.mockResolvedValue({
scores: [{ id: "score-1", traceId: 'foo"bar', observationId: null }],
observations: [{ id: "obs-1", traceId: 'foo"bar' }],
});
const { req, res } = createGetMocks({
traceId: 'foo"bar',
projectId,
});
await handler(req, res);
expect(res.getHeader("Content-Disposition")).toBe(
"attachment; filename=\"trace-export.json\"; filename*=UTF-8''trace-foo%22bar.json",
);
});
it("returns 404 when the trace does not exist", async () => {
mockBuildTraceExport.mockRejectedValue(
new LangfuseNotFoundError("Trace not found"),
);
const { req, res } = createGetMocks({
traceId: "trace-1",
projectId,
});
await handler(req, res);
expect(res._getStatusCode()).toBe(404);
});
it("returns 401 when the trace is unauthorized", async () => {
mockBuildTraceExport.mockRejectedValue(
new UnauthorizedError("Unauthorized"),
);
const { req, res } = createGetMocks({
traceId: "trace-1",
projectId,
});
await handler(req, res);
expect(res._getStatusCode()).toBe(401);
});
it("returns a client-safe size-limit error for full exports", async () => {
mockBuildTraceExport.mockRejectedValue(
new TraceDownloadTooLargeError("Observations in trace are too large"),
);
const { req, res } = createGetMocks({
traceId: "trace-1",
projectId,
});
await handler(req, res);
expect(res._getStatusCode()).toBe(422);
expect(JSON.parse(res._getData()).message).toContain(
"Observations in trace are too large",
);
});
});