Skip to content

πŸ™Œ OpenHands: AI-Driven Development

fix: emit cloud conversation ready once (#1854)

Graham Neubiga9b28ac0dc23
diff --git a/__tests__/hooks/query/use-task-polling.test.tsx b/__tests__/hooks/query/use-task-polling.test.tsx
index 0b760b460a..1e5634ce3c 100644
--- a/__tests__/hooks/query/use-task-polling.test.tsx
+++ b/__tests__/hooks/query/use-task-polling.test.tsx
@@ -5,7 +5,11 @@ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import AgentServerConversationService from "#/api/conversation-service/agent-server-conversation-service.api";
import type { AppConversationStartTask } from "#/api/conversation-service/agent-server-conversation-service.types";
import { NavigationProvider } from "#/context/navigation-context";
-import { useTaskPolling } from "#/hooks/query/use-task-polling";
+import {
+ useTaskPolling,
+ useTaskPollingController,
+} from "#/hooks/query/use-task-polling";
+import { trackCloudConversationReady } from "#/services/cloud-funnel-analytics";
import { useOptimisticUserMessageStore } from "#/stores/optimistic-user-message-store";
import {
consumePendingTaskDraft,
@@ -23,6 +27,9 @@ vi.mock(
},
}),
);
+vi.mock("#/services/cloud-funnel-analytics", () => ({
+ trackCloudConversationReady: vi.fn(),
+}));
const readyTask: AppConversationStartTask = {
id: "123",
@@ -81,7 +88,7 @@ describe("useTaskPolling", () => {
);
setPendingTaskDraft("123", "Create this automation draft");
- const { result } = renderHook(() => useTaskPolling(), {
+ const { result } = renderHook(() => useTaskPollingController(), {
wrapper: createWrapper(),
});
@@ -119,7 +126,7 @@ describe("useTaskPolling", () => {
},
});
- renderHook(() => useTaskPolling(), { wrapper: createWrapper() });
+ renderHook(() => useTaskPollingController(), { wrapper: createWrapper() });
await waitFor(() => {
expect(navigate).toHaveBeenCalledWith("/conversations/conversation-1", {
@@ -172,7 +179,7 @@ describe("useTaskPolling", () => {
};
};
- renderHook(() => useTaskPolling(), {
+ renderHook(() => useTaskPollingController(), {
wrapper: createWrapperForConversation("task-123"),
});
@@ -182,7 +189,7 @@ describe("useTaskPolling", () => {
});
});
- renderHook(() => useTaskPolling(), {
+ renderHook(() => useTaskPollingController(), {
wrapper: createWrapperForConversation("conversation-1"),
});
@@ -193,4 +200,29 @@ describe("useTaskPolling", () => {
expect(pending[0].text).toBe("hello from home");
});
});
+
+ it("handles a ready task once when multiple components consume polling state", async () => {
+ vi.mocked(AgentServerConversationService.getStartTask).mockResolvedValue(
+ readyTask,
+ );
+
+ const { result } = renderHook(
+ () => {
+ const controller = useTaskPollingController();
+ useTaskPolling();
+ useTaskPolling();
+ return controller;
+ },
+ { wrapper: createWrapper() },
+ );
+
+ await waitFor(() => expect(result.current.taskStatus).toBe("READY"));
+ await waitFor(() => expect(navigate).toHaveBeenCalledTimes(1));
+
+ expect(trackCloudConversationReady).toHaveBeenCalledOnce();
+ expect(trackCloudConversationReady).toHaveBeenCalledWith(
+ "123",
+ "conversation-1",
+ );
+ });
});
diff --git a/__tests__/routes/conversation-backend-switch.test.tsx b/__tests__/routes/conversation-backend-switch.test.tsx
index 331ffba72b..a1a4d97849 100644
--- a/__tests__/routes/conversation-backend-switch.test.tsx
+++ b/__tests__/routes/conversation-backend-switch.test.tsx
@@ -49,7 +49,11 @@ vi.mock("#/contexts/websocket-provider-wrapper", () => ({
),
}));
vi.mock("#/hooks/query/use-task-polling", () => ({
- useTaskPolling: () => ({ isTask: false, taskStatus: null, taskDetail: null }),
+ useTaskPollingController: () => ({
+ isTask: false,
+ taskStatus: null,
+ taskDetail: null,
+ }),
}));
vi.mock("#/hooks/query/use-is-authed", () => ({
useIsAuthed: () => ({ data: true }),
diff --git a/src/hooks/query/use-task-polling.ts b/src/hooks/query/use-task-polling.ts
index 49be95a609..e29af71526 100644
--- a/src/hooks/query/use-task-polling.ts
+++ b/src/hooks/query/use-task-polling.ts
@@ -43,25 +43,24 @@ const storeTaskPlugins = (
};
/**
- * Hook that polls V1 conversation start tasks and navigates when ready.
+ * Read the shared polling state for a V1 conversation start task.
*
* This hook:
* - Detects if the conversationId URL param is a task ID (format: "task-{uuid}")
* - Polls the V1 start task API every 3 seconds until status is READY or ERROR
- * - Automatically navigates to the conversation URL when the task becomes READY
* - Exposes task status and details for UI components to show loading states and errors
*
* URL patterns:
* - /conversations/task-{uuid} β†’ Polls start task, then navigates to /conversations/{conversation-id}
* - /conversations/{uuid or hex} β†’ No polling (handled by useActiveConversation)
*
- * Note: This hook does NOT fetch conversation data. It only handles task polling and navigation.
+ * The conversation route mounts useTaskPollingController once to own READY
+ * side effects; other components can consume this hook without repeating them.
*/
export const useTaskPolling = () => {
// Optional: the chat input shell renders on the home page too; polling
// simply no-ops when there's no conversation id yet.
const { conversationId } = useOptionalConversationId();
- const { navigate } = useNavigation();
// Check if this is a task ID (format: "task-{uuid}")
const isTask = !!conversationId && conversationId.startsWith("task-");
@@ -90,6 +89,30 @@ export const useTaskPolling = () => {
retry: false,
});
+ return {
+ isTask,
+ taskId,
+ conversationId: isTask ? null : (conversationId ?? null),
+ task: taskQuery.data,
+ taskStatus: taskQuery.data?.status,
+ taskDetail: taskQuery.data?.detail,
+ taskError: taskQuery.error,
+ isLoadingTask: taskQuery.isLoading,
+ // Repository information from task request
+ repositoryInfo: {
+ selectedRepository: taskQuery.data?.request?.selected_repository,
+ selectedBranch: taskQuery.data?.request?.selected_branch,
+ gitProvider: taskQuery.data?.request?.git_provider,
+ },
+ };
+};
+
+/** Own the task lifecycle side effects once at the conversation route. */
+export const useTaskPollingController = () => {
+ const polling = useTaskPolling();
+ const { task, taskId } = polling;
+ const { conversationId } = useOptionalConversationId();
+ const { navigate } = useNavigation();
const handledReadyTaskIdRef = useRef<string | null>(null);
// Reassign optimistic pending messages before paint on the real conversation
@@ -117,7 +140,6 @@ export const useTaskPolling = () => {
// Navigate to conversation ID when task is ready
useEffect(() => {
- const task = taskQuery.data;
const appConversationId = task?.app_conversation_id;
if (
!taskId ||
@@ -148,26 +170,7 @@ export const useTaskPolling = () => {
navigate(`/conversations/${appConversationId}`, { replace: true });
})();
- }, [taskQuery.data, navigate, taskId]);
-
- useEffect(() => {
- handledReadyTaskIdRef.current = null;
- }, [taskId]);
+ }, [task, taskId, navigate]);
- return {
- isTask,
- taskId,
- conversationId: isTask ? null : (conversationId ?? null),
- task: taskQuery.data,
- taskStatus: taskQuery.data?.status,
- taskDetail: taskQuery.data?.detail,
- taskError: taskQuery.error,
- isLoadingTask: taskQuery.isLoading,
- // Repository information from task request
- repositoryInfo: {
- selectedRepository: taskQuery.data?.request?.selected_repository,
- selectedBranch: taskQuery.data?.request?.selected_branch,
- gitProvider: taskQuery.data?.request?.git_provider,
- },
- };
+ return polling;
};
diff --git a/src/routes/conversation.tsx b/src/routes/conversation.tsx
index ed0a150999..692e68449d 100644
--- a/src/routes/conversation.tsx
+++ b/src/routes/conversation.tsx
@@ -17,7 +17,7 @@ import { AgentState } from "#/types/agent-state";
import { EventHandler } from "../wrapper/event-handler";
import { useActiveConversation } from "#/hooks/query/use-active-conversation";
-import { useTaskPolling } from "#/hooks/query/use-task-polling";
+import { useTaskPollingController } from "#/hooks/query/use-task-polling";
import { displayErrorToast } from "#/utils/custom-toast-handlers";
import { useIsAuthed } from "#/hooks/query/use-is-authed";
@@ -34,7 +34,7 @@ function AppContent() {
const { conversationId } = useConversationId();
const panelViewMatch = useMatch("/conversations/:conversationId/panel");
- const { isTask, taskStatus, taskDetail } = useTaskPolling();
+ const { isTask, taskStatus, taskDetail } = useTaskPollingController();
// The conversationId in the URL belongs to whichever backend was
// active when the route first mounted. If the user switches backends