Skip to content

fix(site): only attempt to watch when dev containers enabled #18892

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 5 commits into from
Jul 16, 2025
Merged

fix(site): only attempt to watch when dev containers enabled #18892

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7f937cf
fix(site): only attempt to watch when dev containers enabled
DanielleMaywood Jul 15, 2025
c2f43ef
refactor: slightly
DanielleMaywood Jul 15, 2025
5b3836d
chore: simplify based on kayla's feedback
DanielleMaywood Jul 16, 2025
3b37f17
chore: appease kayla's formatting
DanielleMaywood Jul 16, 2025
a1675d2
chore: appease linter
DanielleMaywood Jul 16, 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
74 changes: 58 additions & 16 deletions site/src/modules/resources/useAgentContainers.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,19 @@ import type { WorkspaceAgentListContainersResponse } from "api/typesGenerated";
import * as GlobalSnackbar from "components/GlobalSnackbar/utils";
import { http, HttpResponse } from "msw";
import type { FC, PropsWithChildren } from "react";
import { QueryClient, QueryClientProvider } from "react-query";
import { act } from "react";
import { QueryClientProvider } from "react-query";
import {
MockWorkspaceAgent,
MockWorkspaceAgentDevcontainer,
} from "testHelpers/entities";
import { createTestQueryClient } from "testHelpers/renderHelpers";
import { server } from "testHelpers/server";
import type { OneWayWebSocket } from "utils/OneWayWebSocket";
import { useAgentContainers } from "./useAgentContainers";

const createWrapper = (): FC<PropsWithChildren> => {
const queryClient = new QueryClient({
defaultOptions: {
queries: {
retry: false,
},
},
});
const queryClient = createTestQueryClient();
return ({ children }) => (
<QueryClientProvider client={queryClient}>{children}</QueryClientProvider>
);
Expand Down Expand Up @@ -111,22 +107,29 @@ describe("useAgentContainers", () => {
),
);

const { unmount } = renderHook(
const { result, unmount } = renderHook(
() => useAgentContainers(MockWorkspaceAgent),
{
wrapper: createWrapper(),
},
);

// Simulate message event with parsing error
// Wait for initial query to complete
await waitFor(() => {
expect(result.current).toEqual([MockWorkspaceAgentDevcontainer]);
});

// Now simulate message event with parsing error
const messageHandler = mockSocket.addEventListener.mock.calls.find(
(call) => call[0] === "message",
)?.[1];

if (messageHandler) {
messageHandler({
parseError: new Error("Parse error"),
parsedMessage: null,
act(() => {
messageHandler({
parseError: new Error("Parse error"),
parsedMessage: null,
});
});
}

Expand Down Expand Up @@ -166,20 +169,27 @@ describe("useAgentContainers", () => {
),
);

const { unmount } = renderHook(
const { result, unmount } = renderHook(
() => useAgentContainers(MockWorkspaceAgent),
{
wrapper: createWrapper(),
},
);

// Simulate error event
// Wait for initial query to complete
await waitFor(() => {
expect(result.current).toEqual([MockWorkspaceAgentDevcontainer]);
});

// Now simulate error event
const errorHandler = mockSocket.addEventListener.mock.calls.find(
(call) => call[0] === "error",
)?.[1];

if (errorHandler) {
errorHandler(new Error("WebSocket error"));
act(() => {
errorHandler(new Error("WebSocket error"));
});
}

await waitFor(() => {
Expand Down Expand Up @@ -211,4 +221,36 @@ describe("useAgentContainers", () => {

watchAgentContainersSpy.mockRestore();
});

it("does not establish WebSocket connection when dev container feature is not enabled", async () => {
const watchAgentContainersSpy = jest.spyOn(API, "watchAgentContainers");

server.use(
http.get(
`/api/v2/workspaceagents/${MockWorkspaceAgent.id}/containers`,
() => {
return HttpResponse.json(
{ message: "Dev Container feature not enabled." },
{ status: 403 },
);
},
),
);

const { result } = renderHook(
() => useAgentContainers(MockWorkspaceAgent),
{
wrapper: createWrapper(),
},
);

// Wait for the query to complete and error to be processed
await waitFor(() => {
expect(result.current).toBeUndefined();
});

expect(watchAgentContainersSpy).not.toHaveBeenCalled();

watchAgentContainersSpy.mockRestore();
});
});
16 changes: 13 additions & 3 deletions site/src/modules/resources/useAgentContainers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,11 @@ export function useAgentContainers(
): readonly WorkspaceAgentDevcontainer[] | undefined {
const queryClient = useQueryClient();

const { data: devcontainers } = useQuery({
const {
data: devcontainers,
error: queryError,
isLoading: queryIsLoading,
} = useQuery({
queryKey: ["agents", agent.id, "containers"],
queryFn: () => API.getAgentContainers(agent.id),
enabled: agent.status === "connected",
Expand All @@ -31,7 +35,7 @@ export function useAgentContainers(
);

useEffect(() => {
if (agent.status !== "connected") {
if (agent.status !== "connected" || queryIsLoading || queryError) {
return;
}

Expand All @@ -57,7 +61,13 @@ export function useAgentContainers(
});

return () => socket.close();
}, [agent.id, agent.status, updateDevcontainersCache]);
}, [
agent.id,
agent.status,
queryIsLoading,
queryError,
updateDevcontainersCache,
]);

return devcontainers;
}
Loading