Skip to content

Job application tracker and AI-powered job search assistant. Helps job seekers manage their search journey with AI resume review, job matching, task logging, and application analytics, all while keeping your data private.

test(telemetry): spike span parenting through the agent chat stream boundary

Khuram Niaz6d25f7152283
diff --git a/__tests__/telemetry/streamParenting.spec.ts b/__tests__/telemetry/streamParenting.spec.ts
new file mode 100644
index 0000000..9b0ed6e
--- /dev/null
+++ b/__tests__/telemetry/streamParenting.spec.ts
@@ -0,0 +1,83 @@
+import { AsyncLocalStorage } from "node:async_hooks";
+import { createUIMessageStream, stepCountIs, streamText, tool } from "ai";
+import { MockLanguageModelV3, simulateReadableStream } from "ai/test";
+import { z } from "zod";
+
+// The feature's main deliverable rests on this: a tool's execute, driven by
+// the consumer long after execute() returned, must still see the turn's
+// ambient span. Proven with a bare ALS so it tests the AI SDK, not our code.
+const als = new AsyncLocalStorage<{ spanId: string }>();
+
+const usage = {
+ inputTokens: { total: 10, noCache: 10 },
+ outputTokens: { total: 5, text: 5 },
+ totalTokens: 15,
+} as any;
+
+function toolCallingModel() {
+ return new MockLanguageModelV3({
+ doStream: async () => ({
+ stream: simulateReadableStream({
+ chunks: [
+ { type: "stream-start", warnings: [] },
+ { type: "tool-input-start", id: "call-1", toolName: "nested_tool" },
+ { type: "tool-input-delta", id: "call-1", delta: "{}" },
+ { type: "tool-input-end", id: "call-1" },
+ {
+ type: "tool-call",
+ toolCallId: "call-1",
+ toolName: "nested_tool",
+ input: "{}",
+ },
+ { type: "finish", finishReason: "tool-calls", usage },
+ ] as any,
+ chunkDelayInMs: 1,
+ }),
+ }),
+ });
+}
+
+async function drain(stream: ReadableStream<any>): Promise<void> {
+ const reader = stream.getReader();
+ while (true) {
+ const { done } = await reader.read();
+ if (done) break;
+ }
+}
+
+describe("telemetry context propagation through createUIMessageStream", () => {
+ it("a tool execute sees the ambient span established around execute()", async () => {
+ let seenInTool: string | undefined = "NOT_SET";
+ let seenInOnFinish: string | undefined = "NOT_SET";
+
+ const stream = createUIMessageStream({
+ execute: ({ writer }) =>
+ als.run({ spanId: "turn-span" }, () => {
+ const result = streamText({
+ model: toolCallingModel(),
+ prompt: "go",
+ stopWhen: [stepCountIs(1)],
+ tools: {
+ nested_tool: tool({
+ description: "records the ambient span",
+ inputSchema: z.object({}),
+ execute: async () => {
+ seenInTool = als.getStore()?.spanId;
+ return { status: "ok" };
+ },
+ }),
+ },
+ onFinish: () => {
+ seenInOnFinish = als.getStore()?.spanId;
+ },
+ });
+ writer.merge(result.toUIMessageStream());
+ }),
+ });
+
+ await drain(stream);
+
+ expect(seenInTool).toBe("turn-span");
+ expect(seenInOnFinish).toBe("turn-span");
+ });
+});