π OpenHands: AI-Driven Development
feat(frontend): handle the build button for the planning agent (planning agent) (#12644)
Hiep Led2eced9cffd1
diff --git a/frontend/__tests__/components/features/chat/plan-preview.test.tsx b/frontend/__tests__/components/features/chat/plan-preview.test.tsxindex 9206e730ba..d7e5134b0b 100644--- a/frontend/__tests__/components/features/chat/plan-preview.test.tsx+++ b/frontend/__tests__/components/features/chat/plan-preview.test.tsx@@ -4,6 +4,8 @@ import userEvent from "@testing-library/user-event";import { renderWithProviders } from "test-utils";import { PlanPreview } from "#/components/features/chat/plan-preview";import { useConversationStore } from "#/stores/conversation-store";+import { useOptimisticUserMessageStore } from "#/stores/optimistic-user-message-store";+import { createChatMessage } from "#/services/chat-service";// Mock the feature flag to always return true (not testing feature flag behavior)vi.mock("#/utils/feature-flags", () => ({@@ -21,6 +23,22 @@ vi.mock("react-i18next", async (importOriginal) => {};});+// Mock services (underlying dependencies of the hook)+const mockSend = vi.fn();++vi.mock("#/hooks/use-send-message", () => ({+ useSendMessage: vi.fn(() => ({+ send: mockSend,+ })),+}));++vi.mock("#/services/chat-service", () => ({+ createChatMessage: vi.fn((content, imageUrls, fileUrls, timestamp) => ({+ action: "message",+ args: { content, image_urls: imageUrls, file_urls: fileUrls, timestamp },+ })),+}));+vi.mock("#/hooks/use-conversation-id", () => ({useConversationId: () => ({ conversationId: "test-conversation-id" }),}));@@ -28,8 +46,13 @@ vi.mock("#/hooks/use-conversation-id", () => ({describe("PlanPreview", () => {beforeEach(() => {vi.clearAllMocks();+ // Reset store stateslocalStorage.clear();+ useOptimisticUserMessageStore.setState({+ optimisticUserMessage: null,+ });useConversationStore.setState({+ conversationMode: "plan",selectedTab: null,isRightPanelShown: false,hasRightPanelToggled: false,@@ -38,6 +61,13 @@ describe("PlanPreview", () => {afterEach(() => {vi.clearAllMocks();+ // Clean up store states+ useConversationStore.setState({+ conversationMode: "code",+ });+ useOptimisticUserMessageStore.setState({+ optimisticUserMessage: null,+ });localStorage.clear();});@@ -95,30 +125,79 @@ describe("PlanPreview", () => {expect(container.textContent).toContain("COMMON$READ_MORE");});- it("should call onBuildClick when Build button is clicked", async () => {+ it("should render Build button", () => {+ renderWithProviders(<PlanPreview planContent="Plan content" />);++ const buildButton = screen.getByTestId("plan-preview-build-button");+ expect(buildButton).toBeInTheDocument();+ });++ it("should switch to code mode when Build button is clicked", async () => {+ // Arrange+ useConversationStore.setState({ conversationMode: "plan" });const user = userEvent.setup();- const onBuildClick = vi.fn();+ renderWithProviders(<PlanPreview planContent="Plan content" />);+ const buildButton = screen.getByTestId("plan-preview-build-button");- renderWithProviders(- <PlanPreview planContent="Plan content" onBuildClick={onBuildClick} />,+ // Act+ await user.click(buildButton);++ // Assert+ expect(useConversationStore.getState().conversationMode).toBe("code");+ });++ it("should send build prompt message when Build button is clicked", async () => {+ // Arrange+ const user = userEvent.setup();+ const expectedPrompt =+ "Execute the plan based on the workspace/project/PLAN.md file.";+ renderWithProviders(<PlanPreview planContent="Plan content" />);+ const buildButton = screen.getByTestId("plan-preview-build-button");++ // Act+ await user.click(buildButton);++ // Assert+ expect(createChatMessage).toHaveBeenCalledTimes(1);+ expect(createChatMessage).toHaveBeenCalledWith(+ expectedPrompt,+ [],+ [],+ expect.any(String),);+ expect(mockSend).toHaveBeenCalledTimes(1);+ expect(mockSend).toHaveBeenCalledWith(+ expect.objectContaining({+ action: "message",+ args: expect.objectContaining({+ content: expectedPrompt,+ }),+ }),+ );+ });+ it("should set optimistic user message when Build button is clicked", async () => {+ // Arrange+ useOptimisticUserMessageStore.setState({ optimisticUserMessage: null });+ const user = userEvent.setup();+ const expectedPrompt =+ "Execute the plan based on the workspace/project/PLAN.md file.";+ renderWithProviders(<PlanPreview planContent="Plan content" />);const buildButton = screen.getByTestId("plan-preview-build-button");- expect(buildButton).toBeInTheDocument();+ // Actawait user.click(buildButton);- expect(onBuildClick).toHaveBeenCalledTimes(1);+ // Assert+ expect(useOptimisticUserMessageStore.getState().optimisticUserMessage).toBe(+ expectedPrompt,+ );});it("should disable Build button when isBuildDisabled is true", () => {// ArrangerenderWithProviders(- <PlanPreview- planContent="Plan content"- onBuildClick={vi.fn()}- isBuildDisabled={true}- />,+ <PlanPreview planContent="Plan content" isBuildDisabled={true} />,);// Act@@ -131,11 +210,7 @@ describe("PlanPreview", () => {it("should not disable Build button when isBuildDisabled is false", () => {// ArrangerenderWithProviders(- <PlanPreview- planContent="Plan content"- onBuildClick={vi.fn()}- isBuildDisabled={false}- />,+ <PlanPreview planContent="Plan content" isBuildDisabled={false} />,);// Act@@ -147,9 +222,7 @@ describe("PlanPreview", () => {it("should not disable Build button when isBuildDisabled is undefined", () => {// Arrange- renderWithProviders(- <PlanPreview planContent="Plan content" onBuildClick={vi.fn()} />,- );+ renderWithProviders(<PlanPreview planContent="Plan content" />);// Actconst buildButton = screen.getByTestId("plan-preview-build-button");@@ -164,11 +237,7 @@ describe("PlanPreview", () => {const onBuildClick = vi.fn();renderWithProviders(- <PlanPreview- planContent="Plan content"- onBuildClick={onBuildClick}- isBuildDisabled={true}- />,+ <PlanPreview planContent="Plan content" isBuildDisabled={true} />,);const buildButton = screen.getByTestId("plan-preview-build-button");diff --git a/frontend/__tests__/hooks/use-handle-build-plan-click.test.ts b/frontend/__tests__/hooks/use-handle-build-plan-click.test.tsnew file mode 100644index 0000000000..9ec40fd83a--- /dev/null+++ b/frontend/__tests__/hooks/use-handle-build-plan-click.test.ts@@ -0,0 +1,181 @@+import { renderHook, act } from "@testing-library/react";+import { describe, expect, it, vi, beforeEach, afterEach } from "vitest";+import { useHandleBuildPlanClick } from "#/hooks/use-handle-build-plan-click";+import { useConversationStore } from "#/stores/conversation-store";+import { useOptimisticUserMessageStore } from "#/stores/optimistic-user-message-store";+import { createChatMessage } from "#/services/chat-service";++// Mock the send message hook - we'll mock the underlying WebSocket services+vi.mock("#/hooks/use-send-message", () => ({+ useSendMessage: vi.fn(),+}));++// Mock the chat service+vi.mock("#/services/chat-service", () => ({+ createChatMessage: vi.fn(),+}));++// Import mocked modules+import { useSendMessage } from "#/hooks/use-send-message";++describe("useHandleBuildPlanClick", () => {+ const mockSend = vi.fn();++ beforeEach(() => {+ vi.clearAllMocks();++ // Reset store states+ useConversationStore.setState({+ conversationMode: "plan",+ });+ useOptimisticUserMessageStore.setState({+ optimisticUserMessage: null,+ });++ // Setup send message hook mock+ (useSendMessage as unknown as ReturnType<typeof vi.fn>).mockReturnValue({+ send: mockSend,+ });++ // Setup chat service mock+ (createChatMessage as unknown as ReturnType<typeof vi.fn>).mockReturnValue({+ action: "message",+ args: {+ content:+ "Execute the plan based on the workspace/project/PLAN.md file.",+ image_urls: [],+ file_urls: [],+ timestamp: expect.any(String),+ },+ });+ });++ afterEach(() => {+ // Clean up store states+ useConversationStore.setState({+ conversationMode: "code",+ });+ useOptimisticUserMessageStore.setState({+ optimisticUserMessage: null,+ });+ });++ it("should switch conversation mode to code when handleBuildPlanClick is called", () => {+ // Arrange+ useConversationStore.setState({ conversationMode: "plan" });+ const { result } = renderHook(() => useHandleBuildPlanClick());++ // Act+ act(() => {+ result.current.handleBuildPlanClick();+ });++ // Assert+ expect(useConversationStore.getState().conversationMode).toBe("code");+ });++ it("should send build prompt message when handleBuildPlanClick is called", () => {+ // Arrange+ const { result } = renderHook(() => useHandleBuildPlanClick());+ const expectedPrompt =+ "Execute the plan based on the workspace/project/PLAN.md file.";++ // Act+ act(() => {+ result.current.handleBuildPlanClick();+ });++ // Assert+ expect(createChatMessage).toHaveBeenCalledTimes(1);+ expect(createChatMessage).toHaveBeenCalledWith(+ expectedPrompt,+ [],+ [],+ expect.any(String),+ );+ expect(mockSend).toHaveBeenCalledTimes(1);+ expect(mockSend).toHaveBeenCalledWith(+ expect.objectContaining({+ action: "message",+ args: expect.objectContaining({+ content: expectedPrompt,+ }),+ }),+ );+ });++ it("should set optimistic user message when handleBuildPlanClick is called", () => {+ // Arrange+ useOptimisticUserMessageStore.setState({ optimisticUserMessage: null });+ const { result } = renderHook(() => useHandleBuildPlanClick());+ const expectedPrompt =+ "Execute the plan based on the workspace/project/PLAN.md file.";++ // Act+ act(() => {+ result.current.handleBuildPlanClick();+ });++ // Assert+ expect(useOptimisticUserMessageStore.getState().optimisticUserMessage).toBe(+ expectedPrompt,+ );+ });++ it("should prevent default and stop propagation when event is provided", () => {+ // Arrange+ const { result } = renderHook(() => useHandleBuildPlanClick());+ const mockEvent = {+ preventDefault: vi.fn(),+ stopPropagation: vi.fn(),+ } as unknown as React.MouseEvent<HTMLButtonElement>;++ // Act+ act(() => {+ result.current.handleBuildPlanClick(mockEvent);+ });++ // Assert+ expect(mockEvent.preventDefault).toHaveBeenCalledTimes(1);+ expect(mockEvent.stopPropagation).toHaveBeenCalledTimes(1);+ });++ it("should handle call without event parameter", () => {+ // Arrange+ useConversationStore.setState({ conversationMode: "plan" });+ useOptimisticUserMessageStore.setState({ optimisticUserMessage: null });+ const { result } = renderHook(() => useHandleBuildPlanClick());++ // Act & Assert - should not throw+ act(() => {+ result.current.handleBuildPlanClick();+ });++ // Assert all expected behaviors still occur+ expect(useConversationStore.getState().conversationMode).toBe("code");+ expect(mockSend).toHaveBeenCalledTimes(1);+ expect(useOptimisticUserMessageStore.getState().optimisticUserMessage).toBe(+ "Execute the plan based on the workspace/project/PLAN.md file.",+ );+ });++ it("should handle keyboard event", () => {+ // Arrange+ useConversationStore.setState({ conversationMode: "plan" });+ const { result } = renderHook(() => useHandleBuildPlanClick());+ const mockKeyboardEvent = {+ preventDefault: vi.fn(),+ stopPropagation: vi.fn(),+ } as unknown as KeyboardEvent;++ // Act+ act(() => {+ result.current.handleBuildPlanClick(mockKeyboardEvent);+ });++ // Assert+ expect(mockKeyboardEvent.preventDefault).toHaveBeenCalledTimes(1);+ expect(mockKeyboardEvent.stopPropagation).toHaveBeenCalledTimes(1);+ expect(useConversationStore.getState().conversationMode).toBe("code");+ });+});diff --git a/frontend/src/components/features/chat/plan-preview.tsx b/frontend/src/components/features/chat/plan-preview.tsxindex 1eae4d7db0..9788985021 100644--- a/frontend/src/components/features/chat/plan-preview.tsx+++ b/frontend/src/components/features/chat/plan-preview.tsx@@ -6,6 +6,7 @@ import { USE_PLANNING_AGENT } from "#/utils/feature-flags";import { Typography } from "#/ui/typography";import { I18nKey } from "#/i18n/declaration";import { MarkdownRenderer } from "#/components/features/markdown/markdown-renderer";+import { useHandleBuildPlanClick } from "#/hooks/use-handle-build-plan-click";import { cn } from "#/utils/utils";import { useSelectConversationTab } from "#/hooks/use-select-conversation-tab";import { planHeadings } from "#/components/features/markdown/plan-headings";@@ -15,7 +16,6 @@ const MAX_CONTENT_LENGTH = 300;interface PlanPreviewProps {/** Raw plan content from PLAN.md file */planContent?: string | null;- onBuildClick?: () => void;/** Whether the Build button should be disabled (e.g., while streaming) */isBuildDisabled?: boolean;}@@ -23,11 +23,11 @@ interface PlanPreviewProps {/* eslint-disable i18next/no-literal-string */export function PlanPreview({planContent,- onBuildClick,isBuildDisabled,}: PlanPreviewProps) {const { t } = useTranslation();const { selectTab } = useSelectConversationTab();+ const { handleBuildPlanClick } = useHandleBuildPlanClick();const shouldUsePlanningAgent = USE_PLANNING_AGENT();@@ -96,7 +96,7 @@ export function PlanPreview({<div className="border-t border-[#525252] flex h-[54px] items-center justify-start px-4"><buttontype="button"- onClick={onBuildClick}+ onClick={handleBuildPlanClick}disabled={isBuildDisabled}className={cn("bg-white flex items-center justify-center h-[26px] px-2 rounded-[4px] w-[93px] transition-opacity",diff --git a/frontend/src/contexts/conversation-websocket-context.tsx b/frontend/src/contexts/conversation-websocket-context.tsxindex 3fd59a6985..f2999c0d03 100644--- a/frontend/src/contexts/conversation-websocket-context.tsx+++ b/frontend/src/contexts/conversation-websocket-context.tsx@@ -110,7 +110,7 @@ export function ConversationWebSocketProvider({number | null>(null);- const { conversationMode, setPlanContent } = useConversationStore();+ const { setPlanContent } = useConversationStore();// Hook for reading conversation fileconst { mutate: readConversationFile } = useReadConversationFile();@@ -741,15 +741,14 @@ export function ConversationWebSocketProvider({planningWebsocketOptions,);- const socket = useMemo(- () => (conversationMode === "plan" ? planningAgentSocket : mainSocket),- [conversationMode, planningAgentSocket, mainSocket],- );-// V1 send message function via WebSocketconst sendMessage = useCallback(async (message: V1SendMessageRequest) => {- if (!socket || socket.readyState !== WebSocket.OPEN) {+ const currentMode = useConversationStore.getState().conversationMode;+ const currentSocket =+ currentMode === "plan" ? planningAgentSocket : mainSocket;++ if (!currentSocket || currentSocket.readyState !== WebSocket.OPEN) {const error = "WebSocket is not connected";setErrorMessage(error);throw new Error(error);@@ -757,7 +756,7 @@ export function ConversationWebSocketProvider({try {// Send message through WebSocket as JSON- socket.send(JSON.stringify(message));+ currentSocket.send(JSON.stringify(message));} catch (error) {const errorMessage =error instanceof Error ? error.message : "Failed to send message";@@ -765,7 +764,7 @@ export function ConversationWebSocketProvider({throw error;}},- [socket, setErrorMessage],+ [mainSocket, planningAgentSocket, setErrorMessage],);// Track main socket state changesdiff --git a/frontend/src/hooks/use-handle-build-plan-click.ts b/frontend/src/hooks/use-handle-build-plan-click.tsnew file mode 100644index 0000000000..b058a11deb--- /dev/null+++ b/frontend/src/hooks/use-handle-build-plan-click.ts@@ -0,0 +1,38 @@+import { useCallback } from "react";+import { useConversationStore } from "#/stores/conversation-store";+import { useSendMessage } from "#/hooks/use-send-message";+import { createChatMessage } from "#/services/chat-service";+import { useOptimisticUserMessageStore } from "#/stores/optimistic-user-message-store";++/**+ * Custom hook that encapsulates the logic for handling the Build button click.+ * Switches to code mode and sends a prompt to execute the plan.+ *+ * @returns An object containing handleBuildClick function+ */+export const useHandleBuildPlanClick = () => {+ const { setConversationMode } = useConversationStore();+ const { send } = useSendMessage();+ const { setOptimisticUserMessage } = useOptimisticUserMessageStore();++ const handleBuildPlanClick = useCallback(+ (event?: React.MouseEvent<HTMLButtonElement> | KeyboardEvent) => {+ event?.preventDefault();+ event?.stopPropagation();++ // Switch to code mode+ setConversationMode("code");++ // Create the build prompt to execute the plan+ const buildPrompt = `Execute the plan based on the workspace/project/PLAN.md file.`;++ // Send the message to the code agent+ const timestamp = new Date().toISOString();+ send(createChatMessage(buildPrompt, [], [], timestamp));+ setOptimisticUserMessage(buildPrompt);+ },+ [setConversationMode, send, setOptimisticUserMessage],+ );++ return { handleBuildPlanClick };+};