π OpenHands: AI-Driven Development
fix(frontend): prevent budget/credit error banner from disappearing immediately (#13786)
Hiep Le69d281c6be58
diff --git a/frontend/__tests__/conversation-websocket-handler.test.tsx b/frontend/__tests__/conversation-websocket-handler.test.tsxindex 8a86f5a820..1c336bf5f8 100644--- a/frontend/__tests__/conversation-websocket-handler.test.tsx+++ b/frontend/__tests__/conversation-websocket-handler.test.tsx@@ -335,36 +335,6 @@ describe("Conversation WebSocket Handler", () => {});});- it("should show friendly i18n message for budget/credit errors", async () => {- // Create a mock AgentErrorEvent with budget-related error message- const mockBudgetErrorEvent = createMockAgentErrorEvent({- error:- "litellm.BadRequestError: Litellm_proxyException - ExceededBudget: User=xxx over budget.",- });-- // Set up MSW to send the budget error event when connection is established- mswServer.use(- wsLink.addEventListener("connection", ({ client, server }) => {- server.connect();- client.send(JSON.stringify(mockBudgetErrorEvent));- }),- );-- // Render components that use both WebSocket and error message store- renderWithWebSocketContext(<ErrorMessageStoreComponent />);-- // Initially should show "none"- expect(screen.getByTestId("error-message")).toHaveTextContent("none");-- // Wait for connection and error event processing- // Should show the i18n key instead of raw error message- await waitFor(() => {- expect(screen.getByTestId("error-message")).toHaveTextContent(- "STATUS$ERROR_LLM_OUT_OF_CREDITS",- );- });- });-it("should update error message store on ServerErrorEvent", async () => {// ServerErrorEvent represents server-side errors (e.g., MCP configuration errors)// that should be shown as a banner to the user.@@ -502,6 +472,97 @@ describe("Conversation WebSocket Handler", () => {});});+ it("should not clear budget error when non-agent events are received", async () => {+ // Regression test: budget/credit error banner used to disappear ~500ms after+ // appearing because every subsequent non-error event called removeErrorMessage().+ const conversationId = "test-conversation-budget-persist";++ const mockBudgetError = createMockConversationErrorEvent({+ id: "budget-error-1",+ detail:+ "Budget has been exceeded! Current cost: 18.51, Max budget: 18.24",+ });++ // A user MessageEvent (source: "user") should NOT clear the budget error+ const mockUserEvent = createMockUserMessageEvent({+ id: "user-msg-after-error",+ });++ mswServer.use(+ http.get(+ `http://localhost:3000/api/conversations/${conversationId}/events/count`,+ () => HttpResponse.json(2),+ ),+ wsLink.addEventListener("connection", ({ client, server }) => {+ server.connect();+ // Send budget error, then a non-agent event right after+ client.send(JSON.stringify(mockBudgetError));+ client.send(JSON.stringify(mockUserEvent));+ }),+ );++ renderWithWebSocketContext(+ <ErrorMessageStoreComponent />,+ conversationId,+ `http://localhost:3000/api/conversations/${conversationId}`,+ );++ // Wait for both events to be processed+ await waitFor(() => {+ expect(useEventStore.getState().events.length).toBe(2);+ });++ // Budget error should still be visible β not cleared by the user event+ expect(useErrorMessageStore.getState().errorMessage).toBe(+ "STATUS$ERROR_LLM_OUT_OF_CREDITS",+ );+ });++ it("should clear budget error when an agent event is received", async () => {+ // When the agent sends a new event, it means the LLM is working+ // (credits are available), so the budget error should be cleared.+ const conversationId = "test-conversation-budget-clear";++ const mockBudgetError = createMockConversationErrorEvent({+ id: "budget-error-2",+ detail:+ "Budget has been exceeded! Current cost: 18.51, Max budget: 18.24",+ });++ // An agent MessageEvent (source: "agent") SHOULD clear the budget error+ const mockAgentEvent = createMockMessageEvent({+ id: "agent-msg-after-credits",+ });++ mswServer.use(+ http.get(+ `http://localhost:3000/api/conversations/${conversationId}/events/count`,+ () => HttpResponse.json(2),+ ),+ wsLink.addEventListener("connection", ({ client, server }) => {+ server.connect();+ client.send(JSON.stringify(mockBudgetError));+ client.send(JSON.stringify(mockAgentEvent));+ }),+ );++ renderWithWebSocketContext(+ <ErrorMessageStoreComponent />,+ conversationId,+ `http://localhost:3000/api/conversations/${conversationId}`,+ );++ // Wait for both events to be processed+ await waitFor(() => {+ expect(useEventStore.getState().events.length).toBe(2);+ });++ // After both events processed, the budget error should have been cleared+ // by the agent event (source: "agent"). Check it's not the budget error.+ const currentError = useErrorMessageStore.getState().errorMessage;+ expect(currentError).not.toBe("STATUS$ERROR_LLM_OUT_OF_CREDITS");+ });+it("should set error message store on WebSocket connection errors", async () => {// Simulate a connect-then-fail sequence (the MSW server auto-connects by default).// This should surface an error message because the app has previously connected.diff --git a/frontend/__tests__/posthog-tracking.test.tsx b/frontend/__tests__/posthog-tracking.test.tsxindex a2b42657d8..d6fff267aa 100644--- a/frontend/__tests__/posthog-tracking.test.tsx+++ b/frontend/__tests__/posthog-tracking.test.tsx@@ -99,71 +99,6 @@ function renderWithProviders(describe("PostHog Analytics Tracking", () => {describe("Credit Limit Tracking", () => {- it("should track credit_limit_reached when AgentErrorEvent contains budget error", async () => {- // Create a mock AgentErrorEvent with budget-related error message- const mockBudgetErrorEvent = createMockAgentErrorEvent({- error: "ExceededBudget: Task exceeded maximum budget of $10.00",- });-- // Set up MSW to send the budget error event when connection is established- mswServer.use(- wsLink.addEventListener("connection", ({ client, server }) => {- server.connect();- // Send the mock budget error event after connection- client.send(JSON.stringify(mockBudgetErrorEvent));- }),- );-- // Render with all providers- renderWithProviders(<ConnectionStatusComponent />);-- // Wait for connection to be established- await waitFor(() => {- expect(screen.getByTestId("connection-state")).toHaveTextContent(- "OPEN",- );- });-- // Wait for the tracking event to be captured- await waitFor(() => {- expect(mockTrackCreditLimitReached).toHaveBeenCalledWith(- expect.objectContaining({- conversationId: "test-conversation-123",- }),- );- });- });-- it("should track credit_limit_reached when AgentErrorEvent contains 'credit' keyword", async () => {- // Create error with "credit" keyword (case-insensitive)- const mockCreditErrorEvent = createMockAgentErrorEvent({- error: "Insufficient CREDIT to complete this operation",- });-- mswServer.use(- wsLink.addEventListener("connection", ({ client, server }) => {- server.connect();- client.send(JSON.stringify(mockCreditErrorEvent));- }),- );-- renderWithProviders(<ConnectionStatusComponent />);-- await waitFor(() => {- expect(screen.getByTestId("connection-state")).toHaveTextContent(- "OPEN",- );- });-- await waitFor(() => {- expect(mockTrackCreditLimitReached).toHaveBeenCalledWith(- expect.objectContaining({- conversationId: "test-conversation-123",- }),- );- });- });-it("should NOT track credit_limit_reached for non-budget errors", async () => {// Create a regular error without budget/credit keywordsconst mockRegularErrorEvent = createMockAgentErrorEvent({@@ -190,49 +125,6 @@ describe("PostHog Analytics Tracking", () => {expect(mockTrackCreditLimitReached).not.toHaveBeenCalled();});- it("should only track credit_limit_reached once per error event", async () => {- const mockBudgetErrorEvent = createMockAgentErrorEvent({- error: "Budget exceeded: $10.00 limit reached",- });-- mswServer.use(- wsLink.addEventListener("connection", ({ client, server }) => {- server.connect();- // Send the same error event twice- client.send(JSON.stringify(mockBudgetErrorEvent));- client.send(- JSON.stringify({ ...mockBudgetErrorEvent, id: "different-id" }),- );- }),- );-- renderWithProviders(<ConnectionStatusComponent />);-- await waitFor(() => {- expect(screen.getByTestId("connection-state")).toHaveTextContent(- "OPEN",- );- });-- await waitFor(() => {- expect(mockTrackCreditLimitReached).toHaveBeenCalledTimes(2);- });-- // Both calls should be for credit_limit_reached (once per event)- expect(mockTrackCreditLimitReached).toHaveBeenNthCalledWith(- 1,- expect.objectContaining({- conversationId: "test-conversation-123",- }),- );- expect(mockTrackCreditLimitReached).toHaveBeenNthCalledWith(- 2,- expect.objectContaining({- conversationId: "test-conversation-123",- }),- );- });-it("should track credit_limit_reached when ConversationErrorEvent contains budget error", async () => {const mockBudgetConversationError = createMockConversationErrorEvent({detail:diff --git a/frontend/src/contexts/conversation-websocket-context.tsx b/frontend/src/contexts/conversation-websocket-context.tsxindex 3a51e5c015..59aa241fc3 100644--- a/frontend/src/contexts/conversation-websocket-context.tsx+++ b/frontend/src/contexts/conversation-websocket-context.tsx@@ -139,6 +139,25 @@ export function ConversationWebSocketProvider({const isPlanFilePath = (path: string | null): boolean =>path?.toUpperCase().endsWith("PLAN.MD") ?? false;+ // Helper to handle error clearing logic for non-error events.+ // Budget/credit errors persist until an agent event proves the LLM is working.+ const handleNonErrorEvent = useCallback(+ (event: { source?: string }) => {+ const currentError = useErrorMessageStore.getState().errorMessage;+ const isBudgetError =+ currentError === I18nKey.STATUS$ERROR_LLM_OUT_OF_CREDITS;+ const isAgentEvent = event.source === "agent";++ // Budget errors persist until agent proves LLM is working+ if (isBudgetError && !isAgentEvent) {+ return; // Keep budget error visible+ }++ removeErrorMessage();+ },+ [removeErrorMessage],+ );+// Helper function to update metrics from stats eventconst updateMetricsFromStats = useCallback((event: ConversationStateUpdateEventStats) => {@@ -380,8 +399,7 @@ export function ConversationWebSocketProvider({setErrorMessage(errorEvent.detail);}} else {- // Clear error message on any non-ConversationErrorEvent- removeErrorMessage();+ handleNonErrorEvent(event);}// Track credit limit reached if AgentErrorEvent has budget-related error@@ -396,15 +414,7 @@ export function ConversationWebSocketProvider({},posthog,});- // Use friendly i18n message for budget/credit errors instead of raw error- if (isBudgetOrCreditError(event.error)) {- setErrorMessage(I18nKey.STATUS$ERROR_LLM_OUT_OF_CREDITS);- trackCreditLimitReached({- conversationId: conversationId || "unknown",- });- } else {- setErrorMessage(event.error);- }+ setErrorMessage(event.error);}// Clear optimistic user message when a user message is confirmed@@ -546,8 +556,7 @@ export function ConversationWebSocketProvider({setErrorMessage(errorEvent.detail);}} else {- // Clear error message on any non-ConversationErrorEvent- removeErrorMessage();+ handleNonErrorEvent(event);}// Handle AgentErrorEvent specifically@@ -562,15 +571,7 @@ export function ConversationWebSocketProvider({},posthog,});- // Use friendly i18n message for budget/credit errors instead of raw error- if (isBudgetOrCreditError(event.error)) {- setErrorMessage(I18nKey.STATUS$ERROR_LLM_OUT_OF_CREDITS);- trackCreditLimitReached({- conversationId: conversationId || "unknown",- });- } else {- setErrorMessage(event.error);- }+ setErrorMessage(event.error);}// Clear optimistic user message when a user message is confirmed