Skip to content

chore: refactor mock websocket to make open explicit #26323

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

Open
code-asher wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: refactor mock websocket to make open explicit #26323

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
152 changes: 114 additions & 38 deletions site/src/pages/CreateWorkspacePage/CreateWorkspacePage.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,19 @@ describe("CreateWorkspacePage", () => {
});
};

const renderCreateWorkspacePageWithSocket = (route?: string) => {
mockDynamicParameterWebSocket((mockPublisher) => {
mockPublisher.publishOpen(new Event("open"));
mockPublisher.publishMessage(
new MessageEvent("message", {
data: JSON.stringify(MockDynamicParametersResponse),
}),
);
});

return renderCreateWorkspacePage(route);
};

const mockGpuPreset: Preset = {
ID: "preset-gpu",
Name: "gpu-large",
Expand All @@ -63,7 +76,6 @@ describe("CreateWorkspacePage", () => {
vi.spyOn(API, "getTemplateVersionPresets").mockResolvedValue([]);
vi.spyOn(API, "createWorkspace").mockResolvedValue(MockWorkspace);
vi.spyOn(API, "checkAuthorization").mockResolvedValue(MockPermissions);
mockDynamicParameterWebSocket(MockDynamicParametersResponse);
});

afterEach(() => {
Expand All @@ -73,8 +85,7 @@ describe("CreateWorkspacePage", () => {

describe("WebSocket Integration", () => {
it("establishes WebSocket connection and receives initial parameters", async () => {
renderCreateWorkspacePage();

renderCreateWorkspacePageWithSocket();
await waitForLoaderToBeRemoved();

expect(API.templateVersionDynamicParameters).toHaveBeenCalledWith(
Expand All @@ -96,9 +107,14 @@ describe("CreateWorkspacePage", () => {
});

it("sends parameter updates via WebSocket when form values change", async () => {
const [mockWebSocket] = mockDynamicParameterWebSocket(
MockDynamicParametersResponse,
);
const [mockWebSocket] = mockDynamicParameterWebSocket((mockPublisher) => {
mockPublisher.publishOpen(new Event("open"));
mockPublisher.publishMessage(
new MessageEvent("message", {
data: JSON.stringify(MockDynamicParametersResponse),
}),
);
});

renderCreateWorkspacePage();
await waitForLoaderToBeRemoved();
Expand Down Expand Up @@ -134,7 +150,7 @@ describe("CreateWorkspacePage", () => {
});

it("handles WebSocket error gracefully", async () => {
const [, mockPublisher] = mockDynamicParameterWebSocket([]);
const [_, mockPublisher] = mockDynamicParameterWebSocket();

renderCreateWorkspacePage();

Expand All @@ -157,7 +173,20 @@ describe("CreateWorkspacePage", () => {
});

it("handles WebSocket close event", async () => {
const [, mockPublisher] = mockDynamicParameterWebSocket([]);
const [_, mockPublisher] = mockDynamicParameterWebSocket(
(mockPublisher) => {
mockPublisher.publishOpen(new Event("open"));
mockPublisher.publishMessage(
new MessageEvent("message", {
data: JSON.stringify({
id: -1,
parameters: [],
diagnostics: [],
}),
}),
);
},
);

renderCreateWorkspacePage();

Expand All @@ -180,9 +209,18 @@ describe("CreateWorkspacePage", () => {
});

it("only parameters from latest response are displayed", async () => {
const [, mockPublisher] = mockDynamicParameterWebSocket([
MockDropdownParameter,
]);
const [, mockPublisher] = mockDynamicParameterWebSocket(() => {
mockPublisher.publishOpen(new Event("open"));
mockPublisher.publishMessage(
new MessageEvent("message", {
data: JSON.stringify({
id: -1,
parameters: [MockDropdownParameter],
diagnostics: [],
}),
}),
);
});

renderCreateWorkspacePage();
await waitForLoaderToBeRemoved();
Expand Down Expand Up @@ -215,9 +253,20 @@ describe("CreateWorkspacePage", () => {
});

it("does not clobber user values", async () => {
const [, mockPublisher] = mockDynamicParameterWebSocket([
MockPreviewParameter,
]);
const [, mockPublisher] = mockDynamicParameterWebSocket(
(mockPublisher) => {
mockPublisher.publishOpen(new Event("open"));
mockPublisher.publishMessage(
new MessageEvent("message", {
data: JSON.stringify({
id: -1,
parameters: [MockPreviewParameter],
diagnostics: [],
}),
}),
);
},
);

renderCreateWorkspacePage();
await waitForLoaderToBeRemoved();
Expand All @@ -240,8 +289,9 @@ describe("CreateWorkspacePage", () => {
mockPublisher.publishMessage(
new MessageEvent("message", {
data: JSON.stringify({
id: 1,
id: 2,
parameters: [MockPreviewParameter, MockValidationParameter],
diagnostics: [],
}),
}),
);
Expand All @@ -257,10 +307,20 @@ describe("CreateWorkspacePage", () => {
});

it("does not clobber auto-filled values", async () => {
const [, mockPublisher] = mockDynamicParameterWebSocket([
MockPreviewParameter,
MockSliderParameter,
]);
const [, mockPublisher] = mockDynamicParameterWebSocket(
(mockPublisher) => {
mockPublisher.publishOpen(new Event("open"));
mockPublisher.publishMessage(
new MessageEvent("message", {
data: JSON.stringify({
id: -1,
parameters: [MockPreviewParameter, MockSliderParameter],
diagnostics: [],
}),
}),
);
},
);

renderCreateWorkspacePage(
`/templates/${MockTemplate.name}/workspace?param.cpu_count=44&param.parameter1=auto`,
Expand All @@ -278,6 +338,7 @@ describe("CreateWorkspacePage", () => {
MockSliderParameter,
MockValidationParameter,
],
diagnostics: [],
}),
}),
);
Expand All @@ -295,7 +356,14 @@ describe("CreateWorkspacePage", () => {

describe("Dynamic Parameter Types", () => {
it("displays parameter validation errors", async () => {
mockDynamicParameterWebSocket(MockDynamicParametersResponseWithError);
mockDynamicParameterWebSocket((mockPublisher) => {
mockPublisher.publishOpen(new Event("open"));
mockPublisher.publishMessage(
new MessageEvent("message", {
data: JSON.stringify(MockDynamicParametersResponseWithError),
}),
);
});

renderCreateWorkspacePage();
await waitForLoaderToBeRemoved();
Expand Down Expand Up @@ -339,14 +407,22 @@ describe("CreateWorkspacePage", () => {
diagnostics: [],
};

const [mockWebSocket, publisher] =
mockDynamicParameterWebSocket(mockResponseInitial);
const [mockWebSocket, mockPublisher] = mockDynamicParameterWebSocket(
(mockPublisher) => {
mockPublisher.publishOpen(new Event("open"));
mockPublisher.publishMessage(
new MessageEvent("message", {
data: JSON.stringify(mockResponseInitial),
}),
);
},
);
const originalSend = mockWebSocket.send;
mockWebSocket.send = vi.fn((data) => {
originalSend.call(mockWebSocket, data);

if (typeof data === "string" && data.includes('"200"')) {
publisher.publishMessage(
mockPublisher.publishMessage(
new MessageEvent("message", {
data: JSON.stringify(mockResponseWithError),
}),
Expand Down Expand Up @@ -400,7 +476,7 @@ describe("CreateWorkspacePage", () => {
MockTemplateVersionExternalAuthGithub,
]);

renderCreateWorkspacePage();
renderCreateWorkspacePageWithSocket();
await waitForLoaderToBeRemoved();

await waitFor(() => {
Expand All @@ -416,7 +492,7 @@ describe("CreateWorkspacePage", () => {
MockTemplateVersionExternalAuthGithubAuthenticated,
]);

renderCreateWorkspacePage();
renderCreateWorkspacePageWithSocket();
await waitForLoaderToBeRemoved();

await waitFor(() => {
Expand All @@ -430,7 +506,7 @@ describe("CreateWorkspacePage", () => {
MockTemplateVersionExternalAuthGithub,
]);

renderCreateWorkspacePage(
renderCreateWorkspacePageWithSocket(
`/templates/${MockTemplate.name}/workspace?mode=auto&version=${MockTemplate.id}`,
);
await waitForLoaderToBeRemoved();
Expand All @@ -457,7 +533,7 @@ describe("CreateWorkspacePage", () => {
new Error("Auto-creation failed"),
);

renderCreateWorkspacePage(
renderCreateWorkspacePageWithSocket(
`/templates/${MockTemplate.name}/workspace?mode=auto`,
);

Expand All @@ -482,7 +558,7 @@ describe("CreateWorkspacePage", () => {

describe("Form Submission", () => {
it("creates workspace with correct parameters", async () => {
renderCreateWorkspacePage();
renderCreateWorkspacePageWithSocket();
await waitForLoaderToBeRemoved();

expect(screen.getByText(/instance type/i)).toBeInTheDocument();
Expand Down Expand Up @@ -523,7 +599,7 @@ describe("CreateWorkspacePage", () => {

describe("URL Parameters", () => {
it("pre-fills parameters from URL", async () => {
renderCreateWorkspacePage(
renderCreateWorkspacePageWithSocket(
`/templates/${MockTemplate.name}/workspace?param.instance_type=t3.large&param.cpu_count=4`,
);
await waitForLoaderToBeRemoved();
Expand All @@ -535,7 +611,7 @@ describe("CreateWorkspacePage", () => {
it("uses custom template version when specified", async () => {
const customVersionId = "custom-version-123";

renderCreateWorkspacePage(
renderCreateWorkspacePageWithSocket(
`/templates/${MockTemplate.name}/workspace?version=${customVersionId}`,
);

Expand All @@ -551,7 +627,7 @@ describe("CreateWorkspacePage", () => {
it("pre-fills workspace name from URL", async () => {
const workspaceName = "my-custom-workspace";

renderCreateWorkspacePage(
renderCreateWorkspacePageWithSocket(
`/templates/${MockTemplate.name}/workspace?name=${workspaceName}`,
);
await waitForLoaderToBeRemoved();
Expand All @@ -571,7 +647,7 @@ describe("CreateWorkspacePage", () => {
mockGpuPreset,
]);

renderCreateWorkspacePage(
renderCreateWorkspacePageWithSocket(
`/templates/${MockTemplate.name}/workspace?preset=gpu-large`,
);
await waitForLoaderToBeRemoved();
Expand All @@ -586,7 +662,7 @@ describe("CreateWorkspacePage", () => {
.spyOn(API, "getTemplateVersionPresets")
.mockResolvedValue([mockGpuPreset]);

renderCreateWorkspacePage(
renderCreateWorkspacePageWithSocket(
`/templates/${MockTemplate.name}/workspace?version=custom-version&preset=gpu-large`,
);

Expand All @@ -605,7 +681,7 @@ describe("CreateWorkspacePage", () => {
mockGpuPreset,
]);

renderCreateWorkspacePage(
renderCreateWorkspacePageWithSocket(
`/templates/${MockTemplate.name}/workspace?mode=auto&preset=missing`,
);
await waitForLoaderToBeRemoved();
Expand All @@ -632,7 +708,7 @@ describe("CreateWorkspacePage", () => {
new Error("presets unavailable"),
);

renderCreateWorkspacePage(
renderCreateWorkspacePageWithSocket(
`/templates/${MockTemplate.name}/workspace?mode=auto&preset=gpu-large`,
);
await waitForLoaderToBeRemoved();
Expand All @@ -654,7 +730,7 @@ describe("CreateWorkspacePage", () => {
mockGpuPreset,
]);

renderCreateWorkspacePage(
renderCreateWorkspacePageWithSocket(
`/templates/${MockTemplate.name}/workspace?preset=gpu-large&param.instance_type=t3.small&param.cpu_count=99`,
);
await waitForLoaderToBeRemoved();
Expand Down Expand Up @@ -695,7 +771,7 @@ describe("CreateWorkspacePage", () => {
mockGpuPreset,
]);

renderCreateWorkspacePage(
renderCreateWorkspacePageWithSocket(
`/templates/${MockTemplate.name}/workspace?mode=auto&preset=gpu-large&name=preset-workspace`,
);

Expand All @@ -719,7 +795,7 @@ describe("CreateWorkspacePage", () => {

describe("Navigation", () => {
it("navigates to workspace after successful creation", async () => {
const { router } = renderCreateWorkspacePage();
const { router } = renderCreateWorkspacePageWithSocket();
await waitForLoaderToBeRemoved();

const nameInput = screen.getByRole("textbox", {
Expand Down
Loading
Loading