Skip to content

fix(site): add tests for createMockWebSocket #19172

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Aug 7, 2025
Merged

fix(site): add tests for createMockWebSocket #19172

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
a87e93e
wip: commit progress on tests
Parkreiner Aug 4, 2025
1c48afc
chore: get another test working
Parkreiner Aug 5, 2025
5eff4df
chore: get all initial tests passing
Parkreiner Aug 5, 2025
c2d07fb
refactor: centralize socket implementation
Parkreiner Aug 5, 2025
21c9eb8
chore: format
Parkreiner Aug 5, 2025
1834c59
refactor: rename variable
Parkreiner Aug 5, 2025
6ee9afc
refactor: rename property
Parkreiner Aug 5, 2025
c95aa4b
Merge branch 'main' into mes/socket-mock
Parkreiner Aug 7, 2025
cb42aa7
fix: use sets
Parkreiner Aug 7, 2025
b63ff10
refactor: clean up types
Parkreiner Aug 7, 2025
dab74d7
docs: beef up comment
Parkreiner Aug 7, 2025
c17ee61
fix: update protocol back
Parkreiner Aug 7, 2025
9b155b1
Merge branch 'main' into mes/socket-mock
Parkreiner Aug 7, 2025
5f9032d
fix: knip
Parkreiner Aug 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
chore: get another test working
  • Loading branch information
@Parkreiner
Parkreiner committed Aug 5, 2025
commit 1c48afcf1f98f8323d1f2a4df22ad387b917fcc5
33 changes: 33 additions & 0 deletions site/src/testHelpers/websockets.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,35 @@ describe(createMockWebSocket.name, () => {
expect(onClose).toHaveBeenCalledTimes(1);
});

it("Lets a socket unsubscribe to event types", () => {
const [socket, publisher] = createMockWebSocket("wss://www.dog.ceo/zoomies");

const onOpen = jest.fn();
const onError = jest.fn();
const onMessage = jest.fn();
const onClose = jest.fn();

socket.addEventListener("open", onOpen);
socket.addEventListener("error", onError);
socket.addEventListener("message", onMessage);
socket.addEventListener("close", onClose);

socket.removeEventListener("open", onOpen);
socket.removeEventListener("error", onError);
socket.removeEventListener("message", onMessage);
socket.removeEventListener("close", onClose);

publisher.publishOpen(new Event("open"));
publisher.publishError(new Event("error"));
publisher.publishMessage(new MessageEvent<string>("message"));
publisher.publishClose(new CloseEvent("close"));

expect(onOpen).not.toHaveBeenCalled();
expect(onError).not.toHaveBeenCalled();
expect(onMessage).not.toHaveBeenCalled();
expect(onClose).not.toHaveBeenCalled();
});

it("Renders socket inert after being closed", () => {
const [socket, publisher] = createMockWebSocket("wss://www.dog.ceo/woof");
expect(publisher.isConnectionOpen).toBe(true);
Expand All @@ -132,4 +161,8 @@ describe(createMockWebSocket.name, () => {
publisher.publishMessage(new MessageEvent<string>("message"));
expect(onMessage).not.toHaveBeenCalled();
});

it("Lets a socket send data to the mock server", () => {
expect.hasAssertions();
});
});
11 changes: 8 additions & 3 deletions site/src/testHelpers/websockets.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
import type { WebSocketEventType } from "utils/OneWayWebSocket";

export type MockWebSocketPublisher = Readonly<{
export type MockWebSocketServer = Readonly<{
publishMessage: (event: MessageEvent<string>) => void;
publishError: (event: Event) => void;
publishClose: (event: CloseEvent) => void;
publishOpen: (event: Event) => void;

readonly isConnectionOpen: boolean;
}>;

export function createMockWebSocket(
url: string,
protocols?: string | string[],
): readonly [WebSocket, MockWebSocketPublisher] {
): readonly [WebSocket, MockWebSocketServer] {
type EventMap = {
message: MessageEvent<string>;
error: Event;
Expand All @@ -22,6 +23,10 @@ export function createMockWebSocket(
[K in keyof EventMap]: ((event: EventMap[K]) => void)[];
};

if (!url.startsWith("ws://") && !url.startsWith("wss://")) {
throw new Error("URL must start with ws:// or wss://");
}

let activeProtocol: string;
if (Array.isArray(protocols)) {
activeProtocol = protocols[0] ?? "";
Expand Down Expand Up @@ -92,7 +97,7 @@ export function createMockWebSocket(
},
};

const publisher: MockWebSocketPublisher = {
const publisher: MockWebSocketServer = {
get isConnectionOpen() {
return isOpen;
},
Expand Down