A `message.part.updated` snapshot did not invalidate the pending delta coalescing key for its message/part. A delta arriving after an intervening snapshot merged into a delta queued before it, and the snapshot then overwrote that slot, dropping the later delta's text (e.g. `abc` rendered as `ab`). Enqueueing a part snapshot now drops that part's pending delta coalescing keys, while leaving already-queued delta events in place, so post-snapshot deltas start a fresh entry. Closes #1647. Co-authored-by: Ibrahim Khan <ibrakhxn@amazon.com>
184 lines
5.3 KiB
TypeScript
184 lines
5.3 KiB
TypeScript
import { describe, expect, test } from "bun:test"
|
|
import type { Event, OpencodeClient } from "@opencode-ai/sdk/v2/client"
|
|
import { createEventPipeline } from "./event-pipeline"
|
|
|
|
const failAfter = (ms: number) => new Promise<never>((_, reject) => {
|
|
setTimeout(() => reject(new Error("Timed out waiting for event pipeline flush")), ms)
|
|
})
|
|
|
|
function partUpdatedEvent(text: string): Event {
|
|
return {
|
|
type: "message.part.updated",
|
|
properties: {
|
|
part: {
|
|
id: "prt_1",
|
|
messageID: "msg_1",
|
|
sessionID: "ses_1",
|
|
type: "text",
|
|
text,
|
|
},
|
|
},
|
|
} as Event
|
|
}
|
|
|
|
function deltaEvent(delta: string): Event {
|
|
return {
|
|
type: "message.part.delta",
|
|
properties: {
|
|
messageID: "msg_1",
|
|
partID: "prt_1",
|
|
field: "text",
|
|
delta,
|
|
},
|
|
} as Event
|
|
}
|
|
|
|
function createSdk(events: Event[], streamFinished: () => void): OpencodeClient {
|
|
return {
|
|
global: {
|
|
event: async ({ signal }: { signal: AbortSignal }) => ({
|
|
stream: (async function* () {
|
|
for (const payload of events) {
|
|
yield { directory: "/repo", payload }
|
|
}
|
|
streamFinished()
|
|
await new Promise<void>((resolve) => {
|
|
if (signal.aborted) {
|
|
resolve()
|
|
return
|
|
}
|
|
signal.addEventListener("abort", () => resolve(), { once: true })
|
|
})
|
|
})(),
|
|
}),
|
|
},
|
|
} as unknown as OpencodeClient
|
|
}
|
|
|
|
describe("createEventPipeline", () => {
|
|
test("preserves part update order around text deltas", async () => {
|
|
let resolveStreamFinished!: () => void
|
|
const streamFinished = new Promise<void>((resolve) => {
|
|
resolveStreamFinished = resolve
|
|
})
|
|
let resolveDelivered!: () => void
|
|
const deliveredAll = new Promise<void>((resolve) => {
|
|
resolveDelivered = resolve
|
|
})
|
|
const delivered: Event[] = []
|
|
const pipeline = createEventPipeline({
|
|
sdk: createSdk([
|
|
partUpdatedEvent("a"),
|
|
deltaEvent("b"),
|
|
partUpdatedEvent("ab"),
|
|
], resolveStreamFinished),
|
|
onEvent: (_directory, payload) => {
|
|
delivered.push(payload)
|
|
if (delivered.length === 3) {
|
|
resolveDelivered()
|
|
}
|
|
},
|
|
transport: "sse",
|
|
heartbeatTimeoutMs: 1_000,
|
|
})
|
|
|
|
try {
|
|
await streamFinished
|
|
await Promise.race([deliveredAll, failAfter(500)])
|
|
} finally {
|
|
pipeline.cleanup()
|
|
}
|
|
|
|
expect(delivered.map((event) => {
|
|
if (event.type === "message.part.delta") {
|
|
return `delta:${(event.properties as { delta: string }).delta}`
|
|
}
|
|
return `updated:${((event.properties as { part: { text: string } }).part).text}`
|
|
})).toEqual(["updated:a", "delta:b", "updated:ab"])
|
|
})
|
|
|
|
test("does not merge deltas across an intervening part snapshot", async () => {
|
|
let resolveStreamFinished!: () => void
|
|
const streamFinished = new Promise<void>((resolve) => {
|
|
resolveStreamFinished = resolve
|
|
})
|
|
let resolveDelivered!: () => void
|
|
const deliveredAll = new Promise<void>((resolve) => {
|
|
resolveDelivered = resolve
|
|
})
|
|
const delivered: Event[] = []
|
|
const pipeline = createEventPipeline({
|
|
sdk: createSdk([
|
|
partUpdatedEvent("a"),
|
|
deltaEvent("b"),
|
|
partUpdatedEvent("ab"),
|
|
deltaEvent("c"),
|
|
], resolveStreamFinished),
|
|
onEvent: (_directory, payload) => {
|
|
delivered.push(payload)
|
|
if (delivered.length === 4) {
|
|
resolveDelivered()
|
|
}
|
|
},
|
|
transport: "sse",
|
|
heartbeatTimeoutMs: 1_000,
|
|
})
|
|
|
|
try {
|
|
await streamFinished
|
|
await Promise.race([deliveredAll, new Promise<void>((resolve) => setTimeout(resolve, 300))])
|
|
} finally {
|
|
pipeline.cleanup()
|
|
}
|
|
|
|
// The "ab" snapshot is a coalescing barrier: the trailing "c" delta must
|
|
// stay a separate event after it, not merge into the "b" delta queued
|
|
// before the snapshot (which the snapshot would then overwrite).
|
|
expect(delivered.map((event) => {
|
|
if (event.type === "message.part.delta") {
|
|
return `delta:${(event.properties as { delta: string }).delta}`
|
|
}
|
|
return `updated:${((event.properties as { part: { text: string } }).part).text}`
|
|
})).toEqual(["updated:a", "delta:b", "updated:ab", "delta:c"])
|
|
})
|
|
|
|
test("normalizes openchamber session status events", async () => {
|
|
let resolveStreamFinished!: () => void
|
|
const streamFinished = new Promise<void>((resolve) => {
|
|
resolveStreamFinished = resolve
|
|
})
|
|
let resolveDelivered!: (event: Event) => void
|
|
const deliveredEvent = new Promise<Event>((resolve) => {
|
|
resolveDelivered = resolve
|
|
})
|
|
const pipeline = createEventPipeline({
|
|
sdk: createSdk([
|
|
{
|
|
type: "openchamber:session-status",
|
|
properties: {
|
|
sessionID: "ses_1",
|
|
status: "idle",
|
|
},
|
|
} as unknown as Event,
|
|
], resolveStreamFinished),
|
|
onEvent: (_directory, payload) => {
|
|
resolveDelivered(payload)
|
|
},
|
|
transport: "sse",
|
|
heartbeatTimeoutMs: 1_000,
|
|
})
|
|
|
|
try {
|
|
await streamFinished
|
|
const delivered = await Promise.race([deliveredEvent, failAfter(500)])
|
|
expect(delivered.type).toBe("session.status")
|
|
expect(delivered.properties).toEqual({
|
|
sessionID: "ses_1",
|
|
status: { type: "idle" },
|
|
})
|
|
} finally {
|
|
pipeline.cleanup()
|
|
}
|
|
})
|
|
})
|