- Notifications
You must be signed in to change notification settings - Fork35
Add SSE Connection and streamingFetchAdapter tests#625
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
3 commits Select commitHold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
11 changes: 6 additions & 5 deletionssrc/api/coderApi.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletionsrc/api/streamingFetchAdapter.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
9 changes: 4 additions & 5 deletionssrc/websocket/sseConnection.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -109,11 +109,10 @@ export class SseConnection implements UnidirectionalStream<ServerSentEvent> { | ||
| } | ||
| private createErrorEvent(event: Event | ErrorEvent): WsErrorEvent { | ||
| // Check for properties instead of instanceof to avoid browser-only ErrorEvent global | ||
| const eventWithMessage = event as { message?: string; error?: unknown }; | ||
| const errorMessage = eventWithMessage.message || "SSE connection error"; | ||
| const error = eventWithMessage.error; | ||
EhabY marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| return { | ||
| error: error, | ||
4 changes: 2 additions & 2 deletionstest/unit/api/coderApi.test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
220 changes: 220 additions & 0 deletionstest/unit/api/streamingFetchAdapter.test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,220 @@ | ||
| import { type AxiosInstance, type AxiosResponse } from "axios"; | ||
| import { type ReaderLike } from "eventsource"; | ||
| import { EventEmitter } from "node:events"; | ||
| import { type IncomingMessage } from "node:http"; | ||
| import { describe, it, expect, vi } from "vitest"; | ||
| import { createStreamingFetchAdapter } from "@/api/streamingFetchAdapter"; | ||
| const TEST_URL = "https://example.com/api"; | ||
| describe("createStreamingFetchAdapter", () => { | ||
| describe("Request Handling", () => { | ||
| it("passes URL, signal, and responseType to axios", async () => { | ||
| const mockAxios = createAxiosMock(); | ||
| const mockStream = createMockStream(); | ||
| setupAxiosResponse(mockAxios, 200, {}, mockStream); | ||
| const adapter = createStreamingFetchAdapter(mockAxios); | ||
| const signal = new AbortController().signal; | ||
| await adapter(TEST_URL, { signal }); | ||
| expect(mockAxios.request).toHaveBeenCalledWith({ | ||
| url: TEST_URL, | ||
| signal, // correctly passes signal | ||
| headers: {}, | ||
| responseType: "stream", | ||
| validateStatus: expect.any(Function), | ||
| }); | ||
| }); | ||
| it("applies headers in correct precedence order (config overrides init)", async () => { | ||
| const mockAxios = createAxiosMock(); | ||
| const mockStream = createMockStream(); | ||
| setupAxiosResponse(mockAxios, 200, {}, mockStream); | ||
| // Test 1: No config headers, only init headers | ||
| const adapter1 = createStreamingFetchAdapter(mockAxios); | ||
| await adapter1(TEST_URL, { | ||
| headers: { "X-Init": "init-value" }, | ||
| }); | ||
| expect(mockAxios.request).toHaveBeenCalledWith( | ||
| expect.objectContaining({ | ||
| headers: { "X-Init": "init-value" }, | ||
| }), | ||
| ); | ||
| // Test 2: Config headers merge with init headers | ||
| const adapter2 = createStreamingFetchAdapter(mockAxios, { | ||
| "X-Config": "config-value", | ||
| }); | ||
| await adapter2(TEST_URL, { | ||
| headers: { "X-Init": "init-value" }, | ||
| }); | ||
| expect(mockAxios.request).toHaveBeenCalledWith( | ||
| expect.objectContaining({ | ||
| headers: { | ||
| "X-Init": "init-value", | ||
| "X-Config": "config-value", | ||
| }, | ||
| }), | ||
| ); | ||
| // Test 3: Config headers override init headers | ||
| const adapter3 = createStreamingFetchAdapter(mockAxios, { | ||
| "X-Header": "config-value", | ||
| }); | ||
| await adapter3(TEST_URL, { | ||
| headers: { "X-Header": "init-value" }, | ||
| }); | ||
EhabY marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| expect(mockAxios.request).toHaveBeenCalledWith( | ||
| expect.objectContaining({ | ||
| headers: { "X-Header": "config-value" }, | ||
| }), | ||
| ); | ||
| }); | ||
| }); | ||
| describe("Response Properties", () => { | ||
| it("returns response with correct properties", async () => { | ||
| const mockAxios = createAxiosMock(); | ||
| const mockStream = createMockStream(); | ||
| setupAxiosResponse( | ||
| mockAxios, | ||
| 200, | ||
| { "content-type": "text/event-stream" }, | ||
| mockStream, | ||
| ); | ||
| const adapter = createStreamingFetchAdapter(mockAxios); | ||
| const response = await adapter(TEST_URL); | ||
| expect(response.url).toBe(TEST_URL); | ||
| expect(response.status).toBe(200); | ||
| expect(response.headers.get("content-type")).toBe("text/event-stream"); | ||
| // Headers are lowercased when we retrieve them | ||
| expect(response.headers.get("CoNtEnT-TyPe")).toBe("text/event-stream"); | ||
EhabY marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| expect(response.body?.getReader).toBeDefined(); | ||
| }); | ||
| it("detects redirected requests", async () => { | ||
| const mockAxios = createAxiosMock(); | ||
| const mockStream = createMockStream(); | ||
| const mockResponse = { | ||
EhabY marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| status: 200, | ||
| headers: {}, | ||
| data: mockStream, | ||
| request: { | ||
| res: { | ||
| responseUrl: "https://redirect.com/api", | ||
| }, | ||
| }, | ||
| } as AxiosResponse<IncomingMessage>; | ||
| vi.mocked(mockAxios.request).mockResolvedValue(mockResponse); | ||
| const adapter = createStreamingFetchAdapter(mockAxios); | ||
| const response = await adapter(TEST_URL); | ||
| expect(response.redirected).toBe(true); | ||
| }); | ||
| }); | ||
| describe("Stream Handling", () => { | ||
| it("enqueues data chunks from stream", async () => { | ||
| const { mockStream, reader } = await setupReaderTest(); | ||
| const chunk1 = Buffer.from("data1"); | ||
| const chunk2 = Buffer.from("data2"); | ||
| mockStream.emit("data", chunk1); | ||
| mockStream.emit("data", chunk2); | ||
| mockStream.emit("end"); | ||
| const result1 = await reader.read(); | ||
| expect(result1.value).toEqual(chunk1); | ||
| expect(result1.done).toBe(false); | ||
| const result2 = await reader.read(); | ||
| expect(result2.value).toEqual(chunk2); | ||
| expect(result2.done).toBe(false); | ||
| const result3 = await reader.read(); | ||
| // Closed after end | ||
| expect(result3.done).toBe(true); | ||
| }); | ||
| it("propagates stream errors", async () => { | ||
| const { mockStream, reader } = await setupReaderTest(); | ||
| const error = new Error("Stream error"); | ||
| mockStream.emit("error", error); | ||
| await expect(reader.read()).rejects.toThrow("Stream error"); | ||
| }); | ||
| it("handles errors after stream is closed", async () => { | ||
| const { mockStream, reader } = await setupReaderTest(); | ||
| mockStream.emit("end"); | ||
| await reader.read(); | ||
| // Emit events after stream is closed - should not throw | ||
| expect(() => mockStream.emit("data", Buffer.from("late"))).not.toThrow(); | ||
| expect(() => mockStream.emit("end")).not.toThrow(); | ||
| }); | ||
| it("destroys stream on cancel", async () => { | ||
| const { mockStream, reader } = await setupReaderTest(); | ||
| await reader.cancel(); | ||
| expect(mockStream.destroy).toHaveBeenCalled(); | ||
| }); | ||
| }); | ||
| }); | ||
| function createAxiosMock(): AxiosInstance { | ||
| return { | ||
| request: vi.fn(), | ||
| } as unknown as AxiosInstance; | ||
| } | ||
| function createMockStream(): IncomingMessage { | ||
| const stream = new EventEmitter() as IncomingMessage; | ||
| stream.destroy = vi.fn(); | ||
| return stream; | ||
| } | ||
| function setupAxiosResponse( | ||
| axios: AxiosInstance, | ||
| status: number, | ||
| headers: Record<string, string>, | ||
| stream: IncomingMessage, | ||
| ): void { | ||
| vi.mocked(axios.request).mockResolvedValue({ | ||
| status, | ||
| headers, | ||
| data: stream, | ||
| }); | ||
| } | ||
| async function setupReaderTest(): Promise<{ | ||
| mockStream: IncomingMessage; | ||
| reader: ReaderLike | ReadableStreamDefaultReader<Uint8Array<ArrayBuffer>>; | ||
| }> { | ||
| const mockAxios = createAxiosMock(); | ||
| const mockStream = createMockStream(); | ||
| setupAxiosResponse(mockAxios, 200, {}, mockStream); | ||
| const adapter = createStreamingFetchAdapter(mockAxios); | ||
| const response = await adapter(TEST_URL); | ||
| const reader = response.body?.getReader(); | ||
| if (reader === undefined) { | ||
| throw new Error("Reader is undefined"); | ||
| } | ||
| return { mockStream, reader }; | ||
| } | ||
5 changes: 3 additions & 2 deletionstest/unit/core/cliManager.test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
3 changes: 2 additions & 1 deletiontest/unit/logging/utils.test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.