Initial implementation of context aware alert analysis (#215)

* support context aware alert analysis Signed-off-by: Hailong Cui <[email protected]> * Render GeneratePopover IncontextInsight component as a button to generate summary Signed-off-by: Songkan Tang <[email protected]> * Remove hardcoded assistant role from the parameter payload Signed-off-by: Songkan Tang <[email protected]> * Make GeneratePopoverBody as independent component Signed-off-by: Songkan Tang <[email protected]> * Update change log Signed-off-by: Songkan Tang <[email protected]> * Add independent GeneratePopoverBody ut and reorgnize constants Signed-off-by: Songkan Tang <[email protected]> * Simplify states of loading to get summary process Signed-off-by: Songkan Tang <[email protected]> * Make IncontextInsight not shareable and each component has its own IncontextInsight Signed-off-by: Songkan Tang <[email protected]> * Enable context aware alert only if feature flag is enabled Signed-off-by: Songkan Tang <[email protected]> --------- Signed-off-by: Hailong Cui <[email protected]> Signed-off-by: Songkan Tang <[email protected]> Co-authored-by: Hailong Cui <[email protected]>
opensearch-project · Jul 31, 2024 · 32888dd · 32888dd
1 parent d94b896
commit 32888dd
Show file tree

Hide file tree

Showing 15 changed files with 529 additions and 43 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -21,3 +21,4 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Reset chat and reload history after data source change ([#194](https://github.com/opensearch-project/dashboards-assistant/pull/194))
 - Add experimental feature to support text to visualization ([#218](https://github.com/opensearch-project/dashboards-assistant/pull/218))
 - Be compatible with ML configuration index mapping change ([#239](https://github.com/opensearch-project/dashboards-assistant/pull/239))
+- Support context aware alert analysis by reusing incontext insight component([#215](https://github.com/opensearch-project/dashboards-assistant/pull/215))
diff --git a/common/types/chat_saved_object_attributes.ts b/common/types/chat_saved_object_attributes.ts
@@ -43,8 +43,11 @@ export interface IInput {
   content: string;
   context?: {
     appId?: string;
+    content?: string;
+    datasourceId?: string;
   };
   messageId?: string;
+  promptPrefix?: string;
 }
 export interface IOutput {
   type: 'output';

diff --git a/public/chat_header_button.tsx b/public/chat_header_button.tsx
@@ -170,19 +170,23 @@ export const HeaderChatButton = (props: HeaderChatButtonProps) => {
   }, []);
 
   useEffect(() => {
-    const handleSuggestion = (event: { suggestion: string }) => {
+    const handleSuggestion = (event: {
+      suggestion: string;
+      contextContent: string;
+      datasourceId?: string;
+    }) => {
       if (!flyoutVisible) {
         // open chat window
         setFlyoutVisible(true);
-        // start a new chat
-        props.assistantActions.loadChat();
       }
+      // start a new chat
+      props.assistantActions.loadChat();
       // send message
       props.assistantActions.send({
         type: 'input',
         contentType: 'text',
         content: event.suggestion,
-        context: { appId },
+        context: { appId, content: event.contextContent, datasourceId: event.datasourceId },
       });
     };
     registry.on('onSuggestion', handleSuggestion);
@@ -191,6 +195,25 @@ export const HeaderChatButton = (props: HeaderChatButtonProps) => {
     };
   }, [appId, flyoutVisible, props.assistantActions, registry]);
 
+  useEffect(() => {
+    const handleChatContinuation = (event: {
+      conversationId?: string;
+      contextContent: string;
+      datasourceId?: string;
+    }) => {
+      if (!flyoutVisible) {
+        // open chat window
+        setFlyoutVisible(true);
+      }
+      // continue chat with current conversationId
+      props.assistantActions.loadChat(event.conversationId);
+    };
+    registry.on('onChatContinuation', handleChatContinuation);
+    return () => {
+      registry.off('onChatContinuation', handleChatContinuation);
+    };
+  }, [appId, flyoutVisible, props.assistantActions, registry]);
+
   return (
     <>
       <div className={classNames('llm-chat-header-icon-wrapper')}>

diff --git a/public/components/incontext_insight/generate_popover_body.test.tsx b/public/components/incontext_insight/generate_popover_body.test.tsx
@@ -0,0 +1,199 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import React from 'react';
+import { render, cleanup, fireEvent, waitFor } from '@testing-library/react';
+import { getConfigSchema, getNotifications } from '../../services';
+import { GeneratePopoverBody } from './generate_popover_body';
+import { HttpSetup } from '../../../../../src/core/public';
+import { ASSISTANT_API } from '../../../common/constants/llm';
+
+jest.mock('../../services');
+
+const mockToasts = {
+  addDanger: jest.fn(),
+};
+
+beforeEach(() => {
+  (getNotifications as jest.Mock).mockImplementation(() => ({
+    toasts: mockToasts,
+  }));
+  (getConfigSchema as jest.Mock).mockReturnValue({
+    chat: { enabled: true },
+  });
+});
+
+afterEach(cleanup);
+
+const mockPost = jest.fn();
+const mockHttpSetup: HttpSetup = ({
+  post: mockPost,
+} as unknown) as HttpSetup; // Mocking HttpSetup
+
+describe('GeneratePopoverBody', () => {
+  const incontextInsightMock = {
+    contextProvider: jest.fn(),
+    suggestions: ['Test summarization question'],
+    datasourceId: 'test-datasource',
+    key: 'test-key',
+  };
+
+  const closePopoverMock = jest.fn();
+
+  it('renders the generate summary button', () => {
+    const { getByText } = render(
+      <GeneratePopoverBody
+        incontextInsight={incontextInsightMock}
+        httpSetup={mockHttpSetup}
+        closePopover={closePopoverMock}
+      />
+    );
+
+    expect(getByText('Generate summary')).toBeInTheDocument();
+  });
+
+  it('calls onGenerateSummary when button is clicked', async () => {
+    mockPost.mockResolvedValue({
+      interactions: [{ conversation_id: 'test-conversation' }],
+      messages: [{ type: 'output', content: 'Generated summary content' }],
+    });
+
+    const { getByText } = render(
+      <GeneratePopoverBody
+        incontextInsight={incontextInsightMock}
+        httpSetup={mockHttpSetup}
+        closePopover={closePopoverMock}
+      />
+    );
+
+    const button = getByText('Generate summary');
+    fireEvent.click(button);
+
+    // Wait for loading to complete and summary to render
+    await waitFor(() => {
+      expect(getByText('Generated summary content')).toBeInTheDocument();
+    });
+
+    expect(mockPost).toHaveBeenCalledWith(ASSISTANT_API.SEND_MESSAGE, expect.any(Object));
+    expect(mockToasts.addDanger).not.toHaveBeenCalled();
+  });
+
+  it('shows loading state while generating summary', async () => {
+    const { getByText } = render(
+      <GeneratePopoverBody
+        incontextInsight={incontextInsightMock}
+        httpSetup={mockHttpSetup}
+        closePopover={closePopoverMock}
+      />
+    );
+
+    const button = getByText('Generate summary');
+    fireEvent.click(button);
+
+    // Wait for loading state to appear
+    expect(getByText('Generating summary...')).toBeInTheDocument();
+  });
+
+  it('handles error during summary generation', async () => {
+    mockPost.mockRejectedValue(new Error('Network Error'));
+
+    const { getByText } = render(
+      <GeneratePopoverBody
+        incontextInsight={incontextInsightMock}
+        httpSetup={mockHttpSetup}
+        closePopover={closePopoverMock}
+      />
+    );
+
+    const button = getByText('Generate summary');
+    fireEvent.click(button);
+
+    await waitFor(() => {
+      expect(mockToasts.addDanger).toHaveBeenCalledWith('Generate summary error');
+    });
+  });
+
+  it('renders the continue in chat button after summary is generated', async () => {
+    mockPost.mockResolvedValue({
+      interactions: [{ conversation_id: 'test-conversation' }],
+      messages: [{ type: 'output', content: 'Generated summary content' }],
+    });
+
+    const { getByText } = render(
+      <GeneratePopoverBody
+        incontextInsight={incontextInsightMock}
+        httpSetup={mockHttpSetup}
+        closePopover={closePopoverMock}
+      />
+    );
+
+    const button = getByText('Generate summary');
+    fireEvent.click(button);
+
+    // Wait for the summary to be displayed
+    await waitFor(() => {
+      expect(getByText('Generated summary content')).toBeInTheDocument();
+    });
+
+    // Check for continue in chat button
+    expect(getByText('Continue in chat')).toBeInTheDocument();
+  });
+
+  it('calls onChatContinuation when continue in chat button is clicked', async () => {
+    mockPost.mockResolvedValue({
+      interactions: [{ conversation_id: 'test-conversation' }],
+      messages: [{ type: 'output', content: 'Generated summary content' }],
+    });
+
+    const { getByText } = render(
+      <GeneratePopoverBody
+        incontextInsight={incontextInsightMock}
+        httpSetup={mockHttpSetup}
+        closePopover={closePopoverMock}
+      />
+    );
+
+    const button = getByText('Generate summary');
+    fireEvent.click(button);
+
+    await waitFor(() => {
+      expect(getByText('Generated summary content')).toBeInTheDocument();
+    });
+
+    const continueButton = getByText('Continue in chat');
+    fireEvent.click(continueButton);
+
+    expect(mockPost).toHaveBeenCalledTimes(1);
+    expect(closePopoverMock).toHaveBeenCalled();
+  });
+
+  it("continue in chat button doesn't appear when chat is disabled", async () => {
+    mockPost.mockResolvedValue({
+      interactions: [{ conversation_id: 'test-conversation' }],
+      messages: [{ type: 'output', content: 'Generated summary content' }],
+    });
+    (getConfigSchema as jest.Mock).mockReturnValue({
+      chat: { enabled: false },
+    });
+
+    const { getByText, queryByText } = render(
+      <GeneratePopoverBody
+        incontextInsight={incontextInsightMock}
+        httpSetup={mockHttpSetup}
+        closePopover={closePopoverMock}
+      />
+    );
+
+    const button = getByText('Generate summary');
+    fireEvent.click(button);
+
+    await waitFor(() => {
+      expect(getByText('Generated summary content')).toBeInTheDocument();
+    });
+
+    expect(queryByText('Continue in chat')).toBeNull();
+    expect(mockPost).toHaveBeenCalledTimes(1);
+  });
+});