Skip to content

armgit / eve

Public Imported from GitHub
0

The Open Framework for Building Agents

fix(eve): bound durable session replays (#2429)

Casey Gowrieebf94faca87b
diff --git a/.changeset/bound-session-replay-streams.md b/.changeset/bound-session-replay-streams.md
new file mode 100644
index 000000000..abcde71ab
--- /dev/null
+++ b/.changeset/bound-session-replay-streams.md
@@ -0,0 +1,5 @@
+---
+"eve": patch
+---
+
+Session stream requests that ask for a durable tail index now close after replaying that tail, preventing Web Chat restoration through framework proxies from leaving local workflow listeners attached. Generated Web Chat apps also pin Shiki 3.23 to match the current Streamdown code plugin and pass type checking.
diff --git a/apps/docs/registry.json b/apps/docs/registry.json
index c70a4dc44..a74d6a20d 100644
--- a/apps/docs/registry.json
+++ b/apps/docs/registry.json
@@ -1429,9 +1429,9 @@
},
"dependencies": [
"@radix-ui/[email protected]",
- "@shikijs/[email protected]",
- "@shikijs/[email protected]",
- "@shikijs/[email protected]",
+ "@shikijs/[email protected]",
+ "@shikijs/[email protected]",
+ "@shikijs/[email protected]",
"@streamdown/[email protected]",
"@streamdown/[email protected]",
"@streamdown/[email protected]",
@@ -1447,7 +1447,7 @@
diff --git a/packages/eve/src/public/channels/eve.test.ts b/packages/eve/src/public/channels/eve.test.ts
index eb956c9af..1f721abb0 100644
--- a/packages/eve/src/public/channels/eve.test.ts
+++ b/packages/eve/src/public/channels/eve.test.ts
@@ -598,6 +598,49 @@ describe("eveChannel — stream cursor", () => {
expect(response.status).toBe(200);
expect(response.headers.get("x-eve-stream-tail-index")).toBe("41");
});
+
+ it("closes a tail-indexed replay after its durable events", async () => {
+ const handler = createEveStreamHandler({ auth: none() });
+ const cancelled = vi.fn();
+ handler.getStreamTailIndex.mockResolvedValueOnce(1);
+ handler.getEventStream.mockResolvedValueOnce(
+ new ReadableStream({
+ start(controller) {
+ controller.enqueue({ sequence: 0 });
+ controller.enqueue({ sequence: 1 });
+ },
+ cancel: cancelled,
+ }),
+ );
+
+ const response = await handler.fetch(
+ "https://eve.test/eve/v1/session/test-session-id/stream?includeTailIndex=1",
+ );
+
+ await expect(response.text()).resolves.toBe('\n{"sequence":0}\n{"sequence":1}\n');
+ await vi.waitFor(() => expect(cancelled).toHaveBeenCalledOnce());
+ });
+
+ it("closes a tail-relative replay after the requested durable event", async () => {
+ const handler = createEveStreamHandler({ auth: none() });
+ const cancelled = vi.fn();
+ handler.getStreamTailIndex.mockResolvedValueOnce(41);
+ handler.getEventStream.mockResolvedValueOnce(
+ new ReadableStream({
+ start(controller) {
+ controller.enqueue({ sequence: 41 });
+ },
+ cancel: cancelled,
+ }),
+ );
+
+ const response = await handler.fetch(
+ "https://eve.test/eve/v1/session/test-session-id/stream?startIndex=-1&includeTailIndex=1",
+ );
+
+ await expect(response.text()).resolves.toBe('\n{"sequence":41}\n');
+ await vi.waitFor(() => expect(cancelled).toHaveBeenCalledOnce());
+ });
});
describe("eveChannel — onMessage", () => {
diff --git a/packages/eve/src/public/channels/eve.ts b/packages/eve/src/public/channels/eve.ts
index 29bda462d..39d385616 100644
--- a/packages/eve/src/public/channels/eve.ts
+++ b/packages/eve/src/public/channels/eve.ts
@@ -1068,9 +1068,10 @@ async function createSessionStreamResponse(request: Request, session: Session):
if (tailIndex !== undefined) {
headers.set(EVE_STREAM_TAIL_INDEX_HEADER, String(tailIndex));
}
- return new Response(serializeAsNdjson(events, request.signal), {
- headers,
- });
+ return new Response(
+ serializeAsNdjson(events, request.signal, streamEventLimit(startIndex, tailIndex)),
+ { headers },
+ );
} catch {
return Response.json({ error: "Session not found.", ok: false }, { status: 404 });
}
@@ -1352,17 +1353,36 @@ function parseStartIndex(request: Request): number | undefined | Response {
return parsed;
}
+function streamEventLimit(
+ startIndex: number | undefined,
+ tailIndex: number | undefined,
+): number | undefined {
+ if (tailIndex === undefined) return undefined;
+ const resolvedStartIndex =
+ startIndex === undefined
+ ? 0
+ : startIndex < 0
+ ? Math.max(0, tailIndex + 1 + startIndex)
+ : startIndex;
+ return Math.max(0, tailIndex - resolvedStartIndex + 1);
+}
+
function serializeAsNdjson(
events: ReadableStream<unknown>,
signal: AbortSignal,
+ eventLimit?: number,
): ReadableStream<Uint8Array> {
const encoder = new TextEncoder();
+ let eventCount = 0;
const transform = new TransformStream<unknown, Uint8Array>({
start(controller) {
controller.enqueue(encoder.encode("\n"));
+ if (eventLimit === 0) controller.terminate();
},
transform(event, controller) {
controller.enqueue(encoder.encode(`${JSON.stringify(event)}\n`));
+ eventCount += 1;
+ if (eventCount === eventLimit) controller.terminate();
},
});
void events.pipeTo(transform.writable, { signal }).catch(() => {});
diff --git a/packages/eve/src/setup/scaffold/create/web-template.ts b/packages/eve/src/setup/scaffold/create/web-template.ts
index 3110639f8..9120d84ed 100644
--- a/packages/eve/src/setup/scaffold/create/web-template.ts
+++ b/packages/eve/src/setup/scaffold/create/web-template.ts
@@ -116,9 +116,9 @@ export const WEB_APP_TEMPLATE_PACKAGE_JSON = {
},
dependencies: {
"@radix-ui/react-use-controllable-state": "1.2.2",
- "@shikijs/core": "4.1.0",
- "@shikijs/engine-javascript": "4.1.0",
- "@shikijs/engine-oniguruma": "4.1.0",
+ "@shikijs/core": "3.23.0",
+ "@shikijs/engine-javascript": "3.23.0",
+ "@shikijs/engine-oniguruma": "3.23.0",
"@streamdown/cjk": "1.0.3",
"@streamdown/code": "1.1.1",
"@streamdown/math": "1.0.2",
@@ -134,7 +134,7 @@ export const WEB_APP_TEMPLATE_PACKAGE_JSON = {
"radix-ui": "1.4.3",
react: "19.2.6",
"react-dom": "19.2.6",
- shiki: "4.1.0",
+ shiki: "3.23.0",
streamdown: "2.5.0",
"tailwind-merge": "3.6.0",
tailwindcss: "4.3.0",
diff --git a/packages/eve/src/setup/scaffold/index.integration.test.ts b/packages/eve/src/setup/scaffold/index.integration.test.ts
index 7fa1e01fa..2a735608c 100644
--- a/packages/eve/src/setup/scaffold/index.integration.test.ts
+++ b/packages/eve/src/setup/scaffold/index.integration.test.ts
@@ -255,6 +255,10 @@ describe("ensureChannel", () => {
const packageJson = await readFile(join(projectRoot, "package.json"), "utf8");
expect(packageJson).not.toContain('"better-auth"');
expect(packageJson).toContain('"next": "16.2.6"');
+ expect(packageJson).toContain('"shiki": "3.23.0"');
+ expect(packageJson).toContain('"@shikijs/core": "3.23.0"');
+ expect(packageJson).toContain('"@shikijs/engine-javascript": "3.23.0"');
+ expect(packageJson).toContain('"@shikijs/engine-oniguruma": "3.23.0"');
expect(packageJson).toContain('"build:eve": "eve build"');
expect(packageJson).toContain('"dev": "next dev"');
expect(packageJson).toContain('"dev:eve": "eve dev"');