Refactor for message action bar and add metrics for alerting summary (o…

…pensearch-project#304) * Add message action module Signed-off-by: Sihan He <[email protected]> * Finish basic function of feedback buttons Signed-off-by: Sihan He <[email protected]> * Add test cases and fix bugs Signed-off-by: Sihan He <[email protected]> * Refactor the code to deal with core loss and fix the regenerate bug Signed-off-by: Sihan He <[email protected]> * Update CHANGELOG.md Signed-off-by: Sihan He <[email protected]> * Update for smaller buttons Signed-off-by: Sihan He <[email protected]> * Update for ui-metric Signed-off-by: Sihan He <[email protected]> * Support insight with RAG Signed-off-by: Heng Qian <[email protected]> * Add change in CHANGELOG.md Signed-off-by: Heng Qian <[email protected]> * Put footer in the same panel with content to match UX design Signed-off-by: Heng Qian <[email protected]> * Refine alert prompt Signed-off-by: Heng Qian <[email protected]> * set CSS scrollbar-width to thin Signed-off-by: Heng Qian <[email protected]> * Hide insight agent id from front-end Signed-off-by: Heng Qian <[email protected]> * Change summary agent config id Signed-off-by: Heng Qian <[email protected]> * Address comments Signed-off-by: Heng Qian <[email protected]> * Incorporate message action buttons into alerting summary Signed-off-by: Sihan He <[email protected]> * Add hover tips and rearrange buttons Signed-off-by: Sihan He <[email protected]> * Fix UT Signed-off-by: Heng Qian <[email protected]> * Add ui-metric for alerting summary Signed-off-by: Sihan He <[email protected]> * fix testing bugs Signed-off-by: Sihan He <[email protected]> * Change agent execute API Signed-off-by: Heng Qian <[email protected]> * Remove prompt from node JS server Signed-off-by: Heng Qian <[email protected]> * Replace CSS with component property Signed-off-by: Heng Qian <[email protected]> * Save the status when switch between summary and insight Signed-off-by: Sihan He <[email protected]> * Add tests for metrics Signed-off-by: Sihan He <[email protected]> * Use usageCollectionPluginMock in tests Signed-off-by: Sihan He <[email protected]> * Refactor reportMetric as util funciton Signed-off-by: Sihan He <[email protected]> * Remove telementry plugin Signed-off-by: Sihan He <[email protected]> * Fix metric type Signed-off-by: Sihan He <[email protected]> --------- Signed-off-by: Sihan He <[email protected]> Signed-off-by: 000FLMS <[email protected]> Signed-off-by: Heng Qian <[email protected]> Co-authored-by: Heng Qian <[email protected]>
qianheng-aws · Sep 20, 2024 · db5155b · db5155b
1 parent 4a3fc51
commit db5155b
Show file tree

Hide file tree

Showing 15 changed files with 515 additions and 226 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -36,4 +36,5 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Use smaller and compressed variants of buttons and form components ([#250](https://github.com/opensearch-project/dashboards-assistant/pull/250))
 - Support insight with RAG in alert analysis assistant and refine the UX ([#266](https://github.com/opensearch-project/dashboards-assistant/pull/266))
 - Add assistant enabled capabilities to control rendering component([#267](https://github.com/opensearch-project/dashboards-assistant/pull/267))
-- Add data to summary API([#295](https://github.com/opensearch-project/dashboards-assistant/pull/295))
+- Add data to summary API([#295](https://github.com/opensearch-project/dashboards-assistant/pull/295))
+- Refactor popover to add message action bar and add metrics to thumb-up and thumb-down([#304](https://github.com/opensearch-project/dashboards-assistant/pull/304))
diff --git a/opensearch_dashboards.json b/opensearch_dashboards.json
@@ -17,7 +17,8 @@
   ],
   "optionalPlugins": [
     "dataSource",
-    "dataSourceManagement"
+    "dataSourceManagement",
+    "usageCollection"
   ],
   "requiredBundles": [],
   "configPath": [

diff --git a/public/components/incontext_insight/generate_popover_body.test.tsx b/public/components/incontext_insight/generate_popover_body.test.tsx
@@ -4,11 +4,12 @@
  */
 
 import React from 'react';
-import { render, cleanup, fireEvent, waitFor } from '@testing-library/react';
+import { render, cleanup, fireEvent, waitFor, screen } from '@testing-library/react';
 import { getConfigSchema, getNotifications } from '../../services';
 import { GeneratePopoverBody } from './generate_popover_body';
 import { HttpSetup } from '../../../../../src/core/public';
 import { SUMMARY_ASSISTANT_API } from '../../../common/constants/llm';
+import { usageCollectionPluginMock } from '../../../../../src/plugins/usage_collection/public/mocks';
 
 jest.mock('../../services');
 
@@ -26,7 +27,7 @@ beforeEach(() => {
 });
 
 afterEach(cleanup);
-
+const mockUsageCollection = usageCollectionPluginMock.createSetupContract();
 const mockPost = jest.fn();
 const mockHttpSetup: HttpSetup = ({
   post: mockPost,
@@ -68,6 +69,7 @@ describe('GeneratePopoverBody', () => {
         incontextInsight={incontextInsightMock}
         httpSetup={mockHttpSetup}
         closePopover={closePopoverMock}
+        usageCollection={mockUsageCollection}
       />
     );
 
@@ -86,9 +88,15 @@ describe('GeneratePopoverBody', () => {
     expect(queryByLabelText('loading_content')).toBeNull();
     expect(mockPost).toHaveBeenCalledWith(SUMMARY_ASSISTANT_API.SUMMARIZE, expect.any(Object));
     expect(mockToasts.addDanger).not.toHaveBeenCalled();
+    // generated metric is sent
+    expect(mockUsageCollection.reportUiStats).toHaveBeenCalledWith(
+      'alertSummary',
+      'count',
+      expect.stringMatching(/^generated/)
+    );
 
     // insight tip icon is visible
-    const insightTipIcon = getByLabelText('Insight');
+    const insightTipIcon = screen.getAllByLabelText('How was this generated?')[0];
     expect(insightTipIcon).toBeInTheDocument();
 
     // 2. Click insight tip icon to view insight
@@ -142,6 +150,7 @@ describe('GeneratePopoverBody', () => {
         incontextInsight={incontextInsightMock}
         httpSetup={mockHttpSetup}
         closePopover={closePopoverMock}
+        usageCollection={mockUsageCollection}
       />
     );
 
@@ -159,9 +168,15 @@ describe('GeneratePopoverBody', () => {
     expect(queryByLabelText('loading_content')).toBeNull();
     expect(mockPost).toHaveBeenCalledWith(SUMMARY_ASSISTANT_API.SUMMARIZE, expect.any(Object));
     expect(mockToasts.addDanger).not.toHaveBeenCalled();
+    // generated metric is sent
+    expect(mockUsageCollection.reportUiStats).toHaveBeenCalledWith(
+      'alertSummary',
+      'count',
+      expect.stringMatching(/^generated/)
+    );
 
     // insight tip icon is not visible
-    expect(queryByLabelText('Insight')).toBeNull();
+    expect(screen.queryAllByLabelText('How was this generated?')).toHaveLength(0);
     // Only call http post 1 time.
     expect(mockPost).toHaveBeenCalledTimes(1);
   });
@@ -223,6 +238,6 @@ describe('GeneratePopoverBody', () => {
     // Show summary content although insight generation failed
     expect(getByText('Generated summary content')).toBeInTheDocument();
     // insight tip icon is not visible for this alert
-    expect(queryByLabelText('Insight')).toBeNull();
+    expect(screen.queryAllByLabelText('How was this generated?')).toHaveLength(0);
   });
 });
diff --git a/public/components/incontext_insight/generate_popover_body.tsx b/public/components/incontext_insight/generate_popover_body.tsx
@@ -9,7 +9,6 @@ import {
   EuiFlexGroup,
   EuiFlexItem,
   EuiIcon,
-  EuiIconTip,
   EuiLoadingContent,
   EuiMarkdownFormat,
   EuiPanel,
@@ -20,21 +19,28 @@ import {
   EuiTitle,
 } from '@elastic/eui';
 import { useEffectOnce } from 'react-use';
+import { METRIC_TYPE } from '@osd/analytics';
+import { MessageActions } from '../../tabs/chat/messages/message_action';
 import { IncontextInsight as IncontextInsightInput } from '../../types';
 import { getNotifications } from '../../services';
 import { HttpSetup } from '../../../../../src/core/public';
 import { SUMMARY_ASSISTANT_API } from '../../../common/constants/llm';
 import shiny_sparkle from '../../assets/shiny_sparkle.svg';
+import { UsageCollectionSetup } from '../../../../../src/plugins/usage_collection/public';
+import { reportMetric } from '../../utils/report_metric';
 
 export const GeneratePopoverBody: React.FC<{
   incontextInsight: IncontextInsightInput;
   httpSetup?: HttpSetup;
+  usageCollection?: UsageCollectionSetup;
   closePopover: () => void;
-}> = ({ incontextInsight, httpSetup, closePopover }) => {
+}> = ({ incontextInsight, httpSetup, usageCollection, closePopover }) => {
   const [summary, setSummary] = useState('');
   const [insight, setInsight] = useState('');
   const [insightAvailable, setInsightAvailable] = useState(false);
   const [showInsight, setShowInsight] = useState(false);
+  const metricAppName = 'alertSummary';
+
   const toasts = getNotifications().toasts;
 
   useEffectOnce(() => {
@@ -98,6 +104,7 @@ export const GeneratePopoverBody: React.FC<{
               `Please provide your insight on this ${summaryType}.`
             );
           }
+          reportMetric(usageCollection, metricAppName, 'generated', METRIC_TYPE.COUNT);
         })
         .catch((error) => {
           toasts.addDanger(
@@ -202,23 +209,34 @@ export const GeneratePopoverBody: React.FC<{
   const renderInnerFooter = () => {
     return (
       <EuiPopoverFooter className="incontextInsightGeneratePopoverFooter" paddingSize="none">
-        <EuiFlexGroup gutterSize="none" direction={'rowReverse'}>
-          {insightAvailable && (
-            <EuiFlexItem
-              grow={false}
-              onClick={() => {
+        {
+          <div style={{ display: showInsight ? 'none' : 'block' }}>
+            <MessageActions
+              contentToCopy={summary}
+              showFeedback
+              showTraceIcon={insightAvailable}
+              onViewTrace={() => {
                 setShowInsight(true);
               }}
-            >
-              <EuiIconTip
-                aria-label="Insight"
-                type="iInCircle"
-                content="Insight with RAG"
-                color={showInsight ? 'blue' : 'black'}
-              />
-            </EuiFlexItem>
-          )}
-        </EuiFlexGroup>
+              usageCollection={usageCollection}
+              isOnTrace={showInsight}
+              metricAppName={metricAppName}
+            />
+          </div>
+        }
+        {
+          <div style={{ display: showInsight && insightAvailable ? 'block' : 'none' }}>
+            <MessageActions
+              contentToCopy={insight}
+              showFeedback
+              showTraceIcon={insightAvailable}
+              onViewTrace={() => {}}
+              usageCollection={usageCollection}
+              isOnTrace={showInsight}
+              metricAppName={metricAppName}
+            />
+          </div>
+        }
       </EuiPopoverFooter>
     );
   };

diff --git a/public/components/incontext_insight/index.tsx b/public/components/incontext_insight/index.tsx
@@ -33,14 +33,20 @@ import chatIcon from '../../assets/chat.svg';
 import sparkle from '../../assets/sparkle.svg';
 import { HttpSetup } from '../../../../../src/core/public';
 import { GeneratePopoverBody } from './generate_popover_body';
+import { UsageCollectionSetup } from '../../../../../src/plugins/usage_collection/public/plugin';
 
 export interface IncontextInsightProps {
   children?: React.ReactNode;
   httpSetup?: HttpSetup;
+  usageCollection?: UsageCollectionSetup;
 }
 
 // TODO: add saved objects / config to store seed suggestions
-export const IncontextInsight = ({ children, httpSetup }: IncontextInsightProps) => {
+export const IncontextInsight = ({
+  children,
+  httpSetup,
+  usageCollection,
+}: IncontextInsightProps) => {
   const anchor = useRef<HTMLDivElement>(null);
   const [isVisible, setIsVisible] = useState(false);
 
@@ -279,6 +285,7 @@ export const IncontextInsight = ({ children, httpSetup }: IncontextInsightProps)
             <GeneratePopoverBody
               incontextInsight={input}
               httpSetup={httpSetup}
+              usageCollection={usageCollection}
               closePopover={closePopover}
             />
           );