Skip to content

🪢 Open source agent evals & observability: Trace, evaluate, and improve LLM applications with one open platform.

fix(sessions): stop NUL-byte session ids from failing Postgres lookups (#18284)

Niklas Semmler123b94cad08b
diff --git a/packages/shared/src/server/repositories/trace-sessions.ts b/packages/shared/src/server/repositories/trace-sessions.ts
index 74494c8cf7..3a05cc26c1 100644
--- a/packages/shared/src/server/repositories/trace-sessions.ts
+++ b/packages/shared/src/server/repositories/trace-sessions.ts
@@ -2,6 +2,17 @@ import z from "zod";
import { prisma } from "../../db";
import { singleFilter } from "../../interfaces/filters";
+/**
+ * Session ids come from ClickHouse, whose strings may contain NUL bytes.
+ * Postgres text cannot, and rejects any query that binds one, so such a
+ * session can never have a trace_sessions row. Check before querying.
+ */
+export const isStorableTraceSessionId = (sessionId: string) =>
+ !sessionId.includes("\u0000");
+
+export const storableTraceSessionIds = (sessionIds: string[]) =>
+ sessionIds.filter(isStorableTraceSessionId);
+
export const getPublicSessionsFilter = async (
projectId: string,
filter: z.infer<typeof singleFilter>[],
diff --git a/web/src/__tests__/server/sessions-trpc-events-only.servertest.ts b/web/src/__tests__/server/sessions-trpc-events-only.servertest.ts
index 6bbc6b87b3..d0d006c22f 100644
--- a/web/src/__tests__/server/sessions-trpc-events-only.servertest.ts
+++ b/web/src/__tests__/server/sessions-trpc-events-only.servertest.ts
@@ -213,6 +213,51 @@ maybe("sessions trpc (events_only write mode)", () => {
expect(read.bookmarked).toBe(false);
});
+ // Postgres text cannot contain NUL bytes; ClickHouse strings can.
+ describe("session id containing a NUL byte", () => {
+ const nulSessionId = () => `nul-${randomUUID()}\u0000suffix`;
+
+ it("lists the session instead of failing the page", async () => {
+ const sessionId = nulSessionId();
+ await seedSessionEvent(sessionId);
+
+ const result = await caller.sessions.allFromEvents({
+ projectId,
+ filter: [],
+ orderBy: { column: "createdAt", order: "DESC" },
+ page: 0,
+ limit: 50,
+ });
+
+ const listed = result.sessions.find((s) => s.id === sessionId);
+ expect(listed?.bookmarked).toBe(false);
+ expect(listed?.public).toBe(false);
+ });
+
+ it("opens the session detail", async () => {
+ const sessionId = nulSessionId();
+ await seedSessionEvent(sessionId);
+
+ const result = await caller.sessions.byIdWithScoresFromEvents({
+ projectId,
+ sessionId,
+ });
+ expect(result.id).toBe(sessionId);
+ expect(result.bookmarked).toBe(false);
+ });
+
+ it("rejects bookmarking and publishing with BAD_REQUEST", async () => {
+ const sessionId = nulSessionId();
+
+ await expect(
+ caller.sessions.bookmark({ projectId, sessionId, bookmarked: true }),
+ ).rejects.toMatchObject({ code: "BAD_REQUEST" });
+ await expect(
+ caller.sessions.publish({ projectId, sessionId, public: true }),
+ ).rejects.toMatchObject({ code: "BAD_REQUEST" });
+ });
+ });
+
it("rejects publishing an empty session id", async () => {
await expect(
caller.sessions.publish({
diff --git a/web/src/features/traces/server/buildTraceExport.ts b/web/src/features/traces/server/buildTraceExport.ts
index 4889b03fbc..c6b416d0f7 100644
--- a/web/src/features/traces/server/buildTraceExport.ts
+++ b/web/src/features/traces/server/buildTraceExport.ts
@@ -9,6 +9,7 @@ import {
getObservationsCountFromEventsTable,
getObservationsForTraceFromEventsTable,
getTraceByIdFromEventsTable,
+ isStorableTraceSessionId,
} from "@langfuse/shared/src/server";
import { env } from "@langfuse/shared/src/env";
import { prisma } from "@langfuse/shared/src/db";
@@ -121,17 +122,19 @@ export async function getAuthorizedTrace(params: {
throw new LangfuseNotFoundError("Trace not found");
}
- const traceSession = clickhouseTrace.sessionId
- ? await prisma.traceSession.findFirst({
- where: {
- id: clickhouseTrace.sessionId,
- projectId,
- },
- select: {
- public: true,
- },
- })
- : null;
+ const traceSession =
+ clickhouseTrace.sessionId &&
+ isStorableTraceSessionId(clickhouseTrace.sessionId)
+ ? await prisma.traceSession.findFirst({
+ where: {
+ id: clickhouseTrace.sessionId,
+ projectId,
+ },
+ select: {
+ public: true,
+ },
+ })
+ : null;
const isSessionPublic = traceSession?.public === true;
const isAdmin = session?.user.admin === true;
diff --git a/web/src/features/web-callouts/server/targetValidation.ts b/web/src/features/web-callouts/server/targetValidation.ts
index bc0752ceaa..0207812692 100644
--- a/web/src/features/web-callouts/server/targetValidation.ts
+++ b/web/src/features/web-callouts/server/targetValidation.ts
@@ -12,6 +12,7 @@ import {
getTracesIdentifierForSession,
getTracesIdentifierForSessionFromEvents,
logger,
+ isStorableTraceSessionId,
} from "@langfuse/shared/src/server";
export const assertTargetBelongsToProject = async ({
@@ -389,15 +390,17 @@ const sessionBelongsToProject = async ({
sessionId: string;
useEventsTable: boolean;
}) => {
- const postgresSession = await prisma.traceSession.findFirst({
- where: {
- id: sessionId,
- projectId,
- },
- select: {
- id: true,
- },
- });
+ const postgresSession = isStorableTraceSessionId(sessionId)
+ ? await prisma.traceSession.findFirst({
+ where: {
+ id: sessionId,
+ projectId,
+ },
+ select: {
+ id: true,
+ },
+ })
+ : null;
if (postgresSession) {
return true;
diff --git a/web/src/pages/api/public/sessions/[sessionId].ts b/web/src/pages/api/public/sessions/[sessionId].ts
index b7530f45b3..5f00b8f342 100644
--- a/web/src/pages/api/public/sessions/[sessionId].ts
+++ b/web/src/pages/api/public/sessions/[sessionId].ts
@@ -6,7 +6,10 @@ import {
import { withMiddlewares } from "@/src/features/public-api/server/withMiddlewares";
import { createAuthedProjectAPIRoute } from "@/src/features/public-api/server/createAuthedProjectAPIRoute";
import { LangfuseNotFoundError } from "@langfuse/shared";
-import { getTracesBySessionId } from "@langfuse/shared/src/server";
+import {
+ getTracesBySessionId,
+ isStorableTraceSessionId,
+} from "@langfuse/shared/src/server";
import { legacyPublicApiRateLimitUpgradePaths } from "@/src/features/public-api/server/rateLimitUpgradePaths";
import { SESSIONS_DEPRECATION } from "@/src/features/public-api/server/deprecations";
@@ -24,20 +27,22 @@ export default withMiddlewares({
rejectInEventsOnlyMode: true,
fn: async ({ query, auth }) => {
const { sessionId } = query;
- const session = await prisma.traceSession.findUnique({
- where: {
- id_projectId: {
- id: sessionId,
- projectId: auth.scope.projectId,
- },
- },
- select: {
- id: true,
- createdAt: true,
- projectId: true,
- environment: true,
- },
- });
+ const session = !isStorableTraceSessionId(sessionId)
+ ? null
+ : await prisma.traceSession.findUnique({
+ where: {
+ id_projectId: {
+ id: sessionId,
+ projectId: auth.scope.projectId,
+ },
+ },
+ select: {
+ id: true,
+ createdAt: true,
+ projectId: true,
+ environment: true,
+ },
+ });
if (!session) {
throw new LangfuseNotFoundError(
diff --git a/web/src/server/api/routers/sessions.ts b/web/src/server/api/routers/sessions.ts
index 9d631c1bdf..c099707c04 100644
--- a/web/src/server/api/routers/sessions.ts
+++ b/web/src/server/api/routers/sessions.ts
@@ -29,6 +29,8 @@ import {
getEventsGroupedByTraceTags,
hasAnySessionFromEventsTable,
parseClickhouseUTCDateTimeFormat,
+ isStorableTraceSessionId,
+ storableTraceSessionIds,
} from "@langfuse/shared/src/server";
import {
createTRPCRouter,
@@ -58,6 +60,11 @@ import {
toDomainWithStringifiedMetadata,
} from "@/src/utils/clientSideDomainTypes";
+const storableSessionIdInput = z.string().refine(isStorableTraceSessionId, {
+ message:
+ "This session id contains a null character, which cannot be bookmarked or published.",
+});
+
const SessionCountOptions = z.object({
projectId: z.string(), // Required for protectedProjectProcedure
filter: singleFilterList.nullable(),
@@ -101,12 +108,14 @@ const handleGetSessionById = async (input: {
prisma: PrismaClient;
};
}) => {
- const postgresSession = await input.ctx.prisma.traceSession.findFirst({
- where: {
- id: input.sessionId,
- projectId: input.projectId,
- },
- });
+ const postgresSession = isStorableTraceSessionId(input.sessionId)
+ ? await input.ctx.prisma.traceSession.findFirst({
+ where: {
+ id: input.sessionId,
+ projectId: input.projectId,
+ },
+ })
+ : null;
if (!postgresSession) {
throw new TRPCError({
@@ -227,7 +236,7 @@ export const sessionRouter = createTRPCRouter({
const prismaSessionInfo = await ctx.prisma.traceSession.findMany({
where: {
id: {
- in: sessions.map((s) => s.session_id),
+ in: storableTraceSessionIds(sessions.map((s) => s.session_id)),
},
projectId: input.projectId,
},
@@ -290,7 +299,7 @@ export const sessionRouter = createTRPCRouter({
const prismaSessionInfo = await ctx.prisma.traceSession.findMany({
where: {
id: {
- in: sessions.map((s) => s.session_id),
+ in: storableTraceSessionIds(sessions.map((s) => s.session_id)),
},
projectId: input.projectId,
},
@@ -412,7 +421,7 @@ export const sessionRouter = createTRPCRouter({
const prismaSessionInfo = await ctx.prisma.traceSession.findMany({
where: {
id: {
- in: sessions.map((s) => s.session_id),
+ in: storableTraceSessionIds(sessions.map((s) => s.session_id)),
},
projectId: input.projectId,
},
@@ -479,7 +488,7 @@ export const sessionRouter = createTRPCRouter({
const prismaSessionInfo = await ctx.prisma.traceSession.findMany({
where: {
id: {
- in: sessions.map((s) => s.session_id),
+ in: storableTraceSessionIds(sessions.map((s) => s.session_id)),
},
projectId: input.projectId,
},
@@ -720,16 +729,18 @@ export const sessionRouter = createTRPCRouter({
projectId: input.projectId,
sessionIds: [input.sessionId],
}).then((rows) => rows[0]),
- ctx.prisma.traceSession.findFirst({
- where: {
- id: input.sessionId,
- projectId: input.projectId,
- },
- select: {
- bookmarked: true,
- public: true,
- },
- }),
+ isStorableTraceSessionId(input.sessionId)
+ ? ctx.prisma.traceSession.findFirst({
+ where: {
+ id: input.sessionId,
+ projectId: input.projectId,
+ },
+ select: {
+ bookmarked: true,
+ public: true,
+ },
+ })
+ : null,
]);
if (!sessionMetrics) {
@@ -1008,7 +1019,7 @@ export const sessionRouter = createTRPCRouter({
bookmark: protectedProjectProcedure
.input(
z.object({
- sessionId: z.string(),
+ sessionId: storableSessionIdInput,
projectId: z.string(),
bookmarked: z.boolean(),
}),
@@ -1049,7 +1060,7 @@ export const sessionRouter = createTRPCRouter({
.input(
z.object({
projectId: z.string(),
- sessionId: z.string().min(1),
+ sessionId: storableSessionIdInput.min(1),
public: z.boolean(),
}),
)
diff --git a/web/src/server/api/trpc.ts b/web/src/server/api/trpc.ts
index 44de7cf1a4..ee0fe57334 100644
--- a/web/src/server/api/trpc.ts
+++ b/web/src/server/api/trpc.ts
@@ -100,6 +100,7 @@ import {
contextWithLangfuseProps,
ClickHouseResourceError,
getActiveTraceId,
+ isStorableTraceSessionId,
} from "@langfuse/shared/src/server";
import { AdminApiAuthService } from "@/src/ee/features/admin-api/server";
@@ -615,17 +616,18 @@ const enforceTraceAccess = (readSource: "v3" | "v4") =>
.flatMap((org) => org.projects)
.find(({ id }) => id === projectId);
- const traceSession = !!trace?.sessionId
- ? await ctx.prisma.traceSession.findFirst({
- where: {
- id: trace.sessionId,
- projectId,
- },
- select: {
- public: true,
- },
- })
- : null;
+ const traceSession =
+ !!trace?.sessionId && isStorableTraceSessionId(trace.sessionId)
+ ? await ctx.prisma.traceSession.findFirst({
+ where: {
+ id: trace.sessionId,
+ projectId,
+ },
+ select: {
+ public: true,
+ },
+ })
+ : null;
const isSessionPublic = traceSession?.public === true;
@@ -701,15 +703,17 @@ const enforceSessionAccess = t.middleware(async (opts) => {
// trace_sessions should be a sparse metadata side-table: a row only exists once a
// session has been bookmarked or published.
// If it's not marked as public, we fallback to the usual user-based project access check.
- const session = await ctx.prisma.traceSession.findFirst({
- where: {
- id: sessionId,
- projectId,
- },
- select: {
- public: true,
- },
- });
+ const session = isStorableTraceSessionId(sessionId)
+ ? await ctx.prisma.traceSession.findFirst({
+ where: {
+ id: sessionId,
+ projectId,
+ },
+ select: {
+ public: true,
+ },
+ })
+ : null;
const isPublicSession = session?.public ?? false;
diff --git a/worker/src/features/database-read-stream/getDatabaseReadStream.ts b/worker/src/features/database-read-stream/getDatabaseReadStream.ts
index 5502b287d7..e0fe7712dd 100644
--- a/worker/src/features/database-read-stream/getDatabaseReadStream.ts
+++ b/worker/src/features/database-read-stream/getDatabaseReadStream.ts
@@ -28,6 +28,7 @@ import {
getTracesByIds,
getScoresForTraces,
getDatasetItems,
+ storableTraceSessionIds,
type PreferredClickhouseService,
} from "@langfuse/shared/src/server";
import Decimal from "decimal.js";
@@ -380,7 +381,7 @@ export const getDatabaseReadStreamPaginated = async ({
const prismaSessionInfo = await prisma.traceSession.findMany({
where: {
id: {
- in: sessions.map((s) => s.session_id),
+ in: storableTraceSessionIds(sessions.map((s) => s.session_id)),
},
projectId: projectId,
},
@@ -417,7 +418,7 @@ export const getDatabaseReadStreamPaginated = async ({
const sessionComments = await fetchCommentsForExport(
projectId,
"SESSION",
- sessions.map((s) => s.session_id),
+ storableTraceSessionIds(sessions.map((s) => s.session_id)),
);
// Add comments to each session