import { describe, expect, it } from "vitest"; import { catchUp, parseEvent, subscribeUrl } from "../src/jetstream"; import type { JetstreamEvent, JetstreamState } from "../src/jetstream"; import { commitMessage, jetstreamSocket, jetstreamUrl, repoDid as did, routeFetch, } from "./helpers"; const filter = { collections: ["org.tangled.review.patch"], dids: [did] }; const now = 1_800_000_000_000; const hourMs = 60 * 60_000; describe("subscribeUrl", () => { it("asks for commits of the collections and DIDs from the cursor", () => { expect( subscribeUrl({ collections: ["a.b", "c.d"], dids: ["did:x:1", "did:x:2"] }, 42).href, ).toBe( `${jetstreamUrl}?collections=a.b&collections=c.d&kinds=commit&dids=did%3Ax%3A1&dids=did%3Ax%3A2&cursor=42`, ); }); }); describe("parseEvent", () => { it("reads a commit", () => { expect(parseEvent(JSON.stringify(commitMessage(7, did, "bafyp")))).toEqual({ seq: 7, did, collection: "org.tangled.review.patch", rkey: "bafyp", operation: "create", }); }); it.each([ ["not JSON", "{"], ["no payload", JSON.stringify({ seq: 1 })], ["a fractional seq", JSON.stringify(commitMessage(1.5, did, "r"))], ["an unsafe seq", JSON.stringify(commitMessage(2 ** 53, did, "r"))], [ "a string seq", JSON.stringify(commitMessage(1, did, "r")).replace('"seq":1', '"seq":"1"'), ], ["no rkey", JSON.stringify(commitMessage(1, did, "r")).replace('"rkey":"r",', "")], ])("ignores %s", (_, data) => { expect(parseEvent(data)).toBeUndefined(); }); }); interface Tick { state: JetstreamState; handled: number[]; url: URL | undefined; } async function tick( state: JetstreamState | undefined, answer: () => Response, fail: (seq: number) => boolean = () => false, ): Promise { const handled: number[] = []; let url: URL | undefined; routeFetch({ [`GET ${jetstreamUrl}`]: (u, request) => { url = u; expect(request.headers.get("upgrade")).toBe("websocket"); expect(request.headers.get("sec-websocket-protocol")).toBe("xrpc.v1.json"); return answer(); }, }); const next = await catchUp( state, filter, async (event: JetstreamEvent) => { if (fail(event.seq)) { throw new Error(`seq ${event.seq} failed`); } handled.push(event.seq); await Promise.resolve(); }, now, ); return { state: next, handled, url }; } function messages(...seqs: number[]): object[] { return seqs.map((seq) => commitMessage(seq, did, `r${seq}`)); } const tail = (now - 30_000) * 1000; describe("catchUp", () => { it("starts 30 s before now without a cursor", async () => { const { state, url } = await tick(undefined, () => jetstreamSocket([])); expect(url?.searchParams.get("cursor")).toBe(String(tail)); expect(state).toEqual({ cursor: tail, savedAt: now }); }); it("handles each event in order and resumes after the last one", async () => { const { state, handled, url } = await tick({ cursor: 5, savedAt: now - 10_000 }, () => jetstreamSocket([...messages(5, 6), "{", ...messages(9)]), ); expect(url?.searchParams.get("cursor")).toBe("5"); expect(handled).toEqual([5, 6, 9]); expect(state).toEqual({ cursor: 10, savedAt: now }); }); it("moves to the live tail when the stream goes idle", async () => { const { state, handled } = await tick({ cursor: tail, savedAt: now - 10_000 }, () => jetstreamSocket(messages(5), false), ); expect(handled).toEqual([5]); expect(state).toEqual({ cursor: tail, savedAt: now }); }); it("stops after 200 events", async () => { const seqs = Array.from({ length: 201 }, (_, i) => i + 1); const { state, handled } = await tick({ cursor: 1, savedAt: now }, () => jetstreamSocket(messages(...seqs), false), ); expect(handled).toHaveLength(200); expect(state.cursor).toBe(201); }); it("restarts from the live tail after 12 h without a tick", async () => { const { url } = await tick({ cursor: 5, savedAt: now - 12 * hourMs - 1 }, () => jetstreamSocket([]), ); expect(url?.searchParams.get("cursor")).toBe(String(tail)); }); it.each([ ["does not connect", () => new Response("down", { status: 503 })], ["closes without events", () => jetstreamSocket(["{"])], ])("keeps the cursor when Jetstream %s", async (_, answer) => { const state = { cursor: 5, savedAt: now - 10_000 }; expect((await tick(state, answer)).state).toBe(state); }); it("retries a failed event from its seq", async () => { const { state, handled } = await tick( { cursor: 5, savedAt: now - 10_000 }, () => jetstreamSocket(messages(5, 6, 7)), (seq) => seq === 6, ); expect(handled).toEqual([5]); expect(state).toEqual({ cursor: 6, savedAt: now, failSeq: 6, failSince: now }); }); it("keeps the time of the first failure", async () => { const { state } = await tick( { cursor: 6, savedAt: now - 10_000, failSeq: 6, failSince: now - hourMs }, () => jetstreamSocket(messages(6, 7)), (seq) => seq === 6, ); expect(state).toEqual({ cursor: 6, savedAt: now, failSeq: 6, failSince: now - hourMs }); }); it("skips an event that has failed for more than an hour", async () => { const { state, handled } = await tick( { cursor: 6, savedAt: now - 10_000, failSeq: 6, failSince: now - hourMs - 1 }, () => jetstreamSocket(messages(6, 7)), (seq) => seq === 6, ); expect(handled).toEqual([7]); expect(state).toEqual({ cursor: 8, savedAt: now }); }); });