From 003a1cdaa03a9eecc30613d88895e6fd6ec096dd Mon Sep 17 00:00:00 2001
From: Virginia Cepeda <virginia.cepeda@grafana.com>
Date: Fri, 23 Sep 2022 08:51:16 -0300
Subject: [PATCH] Alerting: log some basic user interactions (#55401)

* Log leaving rule group edit without saving

* Log filtering alert instances by label

Also debouncing the search to prevent sending too many log requests

* Log loading the Alert Rules list

* Move log messages to centralized location

* Add tests on log trackings

* Fix linting
---
 .../features/alerting/unified/Analytics.ts    |  5 +++
 .../alert-groups/MatcherFilter.test.tsx       | 25 +++++++++++
 .../components/alert-groups/MatcherFilter.tsx | 10 ++++-
 .../components/rules/EditRuleGroupModal.tsx   | 12 +++--
 .../rules/RuleListGroupView.test.tsx          | 22 ++++++++-
 .../components/rules/RuleListGroupView.tsx    |  8 +++-
 .../components/rules/RulesGroup.test.tsx      | 45 ++++++++++++++++++-
 .../unified/components/rules/RulesGroup.tsx   | 13 ++++--
 8 files changed, 128 insertions(+), 12 deletions(-)
 create mode 100644 public/app/features/alerting/unified/Analytics.ts
 create mode 100644 public/app/features/alerting/unified/components/alert-groups/MatcherFilter.test.tsx

diff --git a/public/app/features/alerting/unified/Analytics.ts b/public/app/features/alerting/unified/Analytics.ts
new file mode 100644
index 00000000000..586617926a8
--- /dev/null
+++ b/public/app/features/alerting/unified/Analytics.ts
@@ -0,0 +1,5 @@
+export const LogMessages = {
+  filterByLabel: 'filtering alert instances by label',
+  loadedList: 'loaded Alert Rules list',
+  leavingRuleGroupEdit: 'leaving rule group edit without saving',
+};
diff --git a/public/app/features/alerting/unified/components/alert-groups/MatcherFilter.test.tsx b/public/app/features/alerting/unified/components/alert-groups/MatcherFilter.test.tsx
new file mode 100644
index 00000000000..ca59051e704
--- /dev/null
+++ b/public/app/features/alerting/unified/components/alert-groups/MatcherFilter.test.tsx
@@ -0,0 +1,25 @@
+import { render, screen } from '@testing-library/react';
+import userEvent from '@testing-library/user-event';
+import lodash from 'lodash'; // eslint-disable-line lodash/import-scope
+import React from 'react';
+
+import { logInfo } from '@grafana/runtime';
+
+import { LogMessages } from '../../Analytics';
+
+import { MatcherFilter } from './MatcherFilter';
+
+jest.mock('@grafana/runtime');
+
+describe('Analytics', () => {
+  it('Sends log info when filtering alert instances by label', async () => {
+    lodash.debounce = jest.fn().mockImplementation((fn) => fn);
+
+    render(<MatcherFilter onFilterChange={jest.fn()} />);
+
+    const searchInput = screen.getByTestId('search-query-input');
+    await userEvent.type(searchInput, 'job=');
+
+    expect(logInfo).toHaveBeenCalledWith(LogMessages.filterByLabel);
+  });
+});
diff --git a/public/app/features/alerting/unified/components/alert-groups/MatcherFilter.tsx b/public/app/features/alerting/unified/components/alert-groups/MatcherFilter.tsx
index f885fdbea8b..6eebd413c22 100644
--- a/public/app/features/alerting/unified/components/alert-groups/MatcherFilter.tsx
+++ b/public/app/features/alerting/unified/components/alert-groups/MatcherFilter.tsx
@@ -1,9 +1,13 @@
 import { css } from '@emotion/css';
+import { debounce } from 'lodash';
 import React, { FormEvent } from 'react';
 
 import { GrafanaTheme2 } from '@grafana/data';
+import { logInfo } from '@grafana/runtime';
 import { Label, Tooltip, Input, Icon, useStyles2, Stack } from '@grafana/ui';
 
+import { LogMessages } from '../../Analytics';
+
 interface Props {
   className?: string;
   queryString?: string;
@@ -13,10 +17,12 @@ interface Props {
 
 export const MatcherFilter = ({ className, onFilterChange, defaultQueryString, queryString }: Props) => {
   const styles = useStyles2(getStyles);
-  const handleSearchChange = (e: FormEvent<HTMLInputElement>) => {
+  const handleSearchChange = debounce((e: FormEvent<HTMLInputElement>) => {
+    logInfo(LogMessages.filterByLabel);
+
     const target = e.target as HTMLInputElement;
     onFilterChange(target.value);
-  };
+  }, 600);
   const searchIcon = <Icon name={'search'} />;
   return (
     <div className={className}>
diff --git a/public/app/features/alerting/unified/components/rules/EditRuleGroupModal.tsx b/public/app/features/alerting/unified/components/rules/EditRuleGroupModal.tsx
index f2650b72f94..ef6f901cf31 100644
--- a/public/app/features/alerting/unified/components/rules/EditRuleGroupModal.tsx
+++ b/public/app/features/alerting/unified/components/rules/EditRuleGroupModal.tsx
@@ -18,7 +18,7 @@ import { EvaluationIntervalLimitExceeded } from '../InvalidIntervalWarning';
 interface ModalProps {
   namespace: CombinedRuleNamespace;
   group: CombinedRuleGroup;
-  onClose: () => void;
+  onClose: (saved?: boolean) => void;
 }
 
 interface FormValues {
@@ -46,7 +46,7 @@ export function EditCloudGroupModal(props: ModalProps): React.ReactElement {
   // close modal if successfully saved
   useEffect(() => {
     if (dispatched && !loading && !error) {
-      onClose();
+      onClose(true);
     }
   }, [dispatched, loading, onClose, error]);
 
@@ -123,7 +123,13 @@ export function EditCloudGroupModal(props: ModalProps): React.ReactElement {
             )}
 
             <Modal.ButtonRow>
-              <Button variant="secondary" type="button" disabled={loading} onClick={onClose} fill="outline">
+              <Button
+                variant="secondary"
+                type="button"
+                disabled={loading}
+                onClick={() => onClose(false)}
+                fill="outline"
+              >
                 Close
               </Button>
               <Button type="submit" disabled={!isDirty || loading}>
diff --git a/public/app/features/alerting/unified/components/rules/RuleListGroupView.test.tsx b/public/app/features/alerting/unified/components/rules/RuleListGroupView.test.tsx
index c0c0b5a28e6..82ffb120c84 100644
--- a/public/app/features/alerting/unified/components/rules/RuleListGroupView.test.tsx
+++ b/public/app/features/alerting/unified/components/rules/RuleListGroupView.test.tsx
@@ -4,17 +4,26 @@ import { Provider } from 'react-redux';
 import { Router } from 'react-router-dom';
 import { byRole } from 'testing-library-selector';
 
-import { locationService } from '@grafana/runtime';
+import { locationService, logInfo } from '@grafana/runtime';
 import { contextSrv } from 'app/core/services/context_srv';
 import { configureStore } from 'app/store/configureStore';
 import { AccessControlAction } from 'app/types';
 import { CombinedRuleNamespace } from 'app/types/unified-alerting';
 
+import { LogMessages } from '../../Analytics';
 import { mockCombinedRule, mockDataSource } from '../../mocks';
 import { GRAFANA_RULES_SOURCE_NAME } from '../../utils/datasource';
 
 import { RuleListGroupView } from './RuleListGroupView';
 
+jest.mock('@grafana/runtime', () => {
+  const original = jest.requireActual('@grafana/runtime');
+  return {
+    ...original,
+    logInfo: jest.fn(),
+  };
+});
+
 const ui = {
   grafanaRulesHeading: byRole('heading', { name: 'Grafana' }),
   cloudRulesHeading: byRole('heading', { name: 'Mimir / Cortex / Loki' }),
@@ -74,6 +83,17 @@ describe('RuleListGroupView', () => {
       expect(ui.cloudRulesHeading.query()).not.toBeInTheDocument();
     });
   });
+
+  describe('Analytics', () => {
+    it('Sends log info when the list is loaded', () => {
+      const grafanaNamespace = getGrafanaNamespace();
+      const namespaces: CombinedRuleNamespace[] = [grafanaNamespace];
+
+      renderRuleList(namespaces);
+
+      expect(logInfo).toHaveBeenCalledWith(LogMessages.loadedList);
+    });
+  });
 });
 
 function renderRuleList(namespaces: CombinedRuleNamespace[]) {
diff --git a/public/app/features/alerting/unified/components/rules/RuleListGroupView.tsx b/public/app/features/alerting/unified/components/rules/RuleListGroupView.tsx
index ffd5ebc904d..95b183973fc 100644
--- a/public/app/features/alerting/unified/components/rules/RuleListGroupView.tsx
+++ b/public/app/features/alerting/unified/components/rules/RuleListGroupView.tsx
@@ -1,8 +1,10 @@
-import React, { FC, useMemo } from 'react';
+import React, { FC, useEffect, useMemo } from 'react';
 
+import { logInfo } from '@grafana/runtime';
 import { AccessControlAction } from 'app/types';
 import { CombinedRuleNamespace } from 'app/types/unified-alerting';
 
+import { LogMessages } from '../../Analytics';
 import { isCloudRulesSource, isGrafanaRulesSource } from '../../utils/datasource';
 import { Authorize } from '../Authorize';
 
@@ -28,6 +30,10 @@ export const RuleListGroupView: FC<Props> = ({ namespaces, expandAll }) => {
     ];
   }, [namespaces]);
 
+  useEffect(() => {
+    logInfo(LogMessages.loadedList);
+  }, []);
+
   return (
     <>
       <Authorize actions={[AccessControlAction.AlertingRuleRead]}>
diff --git a/public/app/features/alerting/unified/components/rules/RulesGroup.test.tsx b/public/app/features/alerting/unified/components/rules/RulesGroup.test.tsx
index 5b24fcdbac3..0d4f7277d13 100644
--- a/public/app/features/alerting/unified/components/rules/RulesGroup.test.tsx
+++ b/public/app/features/alerting/unified/components/rules/RulesGroup.test.tsx
@@ -1,20 +1,28 @@
-import { render } from '@testing-library/react';
+import { render, screen } from '@testing-library/react';
 import userEvent from '@testing-library/user-event';
 import React from 'react';
 import { Provider } from 'react-redux';
 import { byTestId, byText } from 'testing-library-selector';
 
+import { logInfo } from '@grafana/runtime';
 import { contextSrv } from 'app/core/services/context_srv';
 import { configureStore } from 'app/store/configureStore';
 import { CombinedRuleGroup, CombinedRuleNamespace } from 'app/types/unified-alerting';
 
+import { LogMessages } from '../../Analytics';
 import { useHasRuler } from '../../hooks/useHasRuler';
 import { disableRBAC, mockCombinedRule, mockDataSource } from '../../mocks';
 
 import { RulesGroup } from './RulesGroup';
 
 jest.mock('../../hooks/useHasRuler');
-
+jest.mock('@grafana/runtime', () => {
+  const original = jest.requireActual('@grafana/runtime');
+  return {
+    ...original,
+    logInfo: jest.fn(),
+  };
+});
 const mocks = {
   useHasRuler: jest.mocked(useHasRuler),
 };
@@ -130,4 +138,37 @@ describe('Rules group tests', () => {
       expect(ui.confirmDeleteModal.confirmButton.get()).toBeInTheDocument();
     });
   });
+
+  describe('Analytics', () => {
+    beforeEach(() => {
+      contextSrv.isEditor = true;
+    });
+
+    const group: CombinedRuleGroup = {
+      name: 'TestGroup',
+      rules: [mockCombinedRule()],
+    };
+
+    const namespace: CombinedRuleNamespace = {
+      name: 'TestNamespace',
+      rulesSource: mockDataSource(),
+      groups: [group],
+    };
+
+    disableRBAC();
+
+    it('Should log info when closing the edit group rule modal without saving', async () => {
+      mockUseHasRuler(true, true);
+      renderRulesGroup(namespace, group);
+
+      await userEvent.click(ui.editGroupButton.get());
+
+      expect(screen.getByText('Close')).toBeInTheDocument();
+
+      await userEvent.click(screen.getByText('Close'));
+
+      expect(screen.queryByText('Close')).not.toBeInTheDocument();
+      expect(logInfo).toHaveBeenCalledWith(LogMessages.leavingRuleGroupEdit);
+    });
+  });
 });
diff --git a/public/app/features/alerting/unified/components/rules/RulesGroup.tsx b/public/app/features/alerting/unified/components/rules/RulesGroup.tsx
index 4fd7b7a91e5..c963e732964 100644
--- a/public/app/features/alerting/unified/components/rules/RulesGroup.tsx
+++ b/public/app/features/alerting/unified/components/rules/RulesGroup.tsx
@@ -3,10 +3,12 @@ import pluralize from 'pluralize';
 import React, { FC, useEffect, useState } from 'react';
 
 import { GrafanaTheme2 } from '@grafana/data';
+import { logInfo } from '@grafana/runtime';
 import { Badge, ConfirmModal, HorizontalGroup, Icon, Spinner, Tooltip, useStyles2 } from '@grafana/ui';
 import { useDispatch } from 'app/types';
 import { CombinedRuleGroup, CombinedRuleNamespace } from 'app/types/unified-alerting';
 
+import { LogMessages } from '../../Analytics';
 import { useFolder } from '../../hooks/useFolder';
 import { useHasRuler } from '../../hooks/useHasRuler';
 import { deleteRulesGroupAction } from '../../state/actions';
@@ -179,6 +181,13 @@ export const RulesGroup: FC<Props> = React.memo(({ group, namespace, expandAll,
     <RuleLocation namespace={namespace.name} group={group.name} />
   );
 
+  const closeEditModal = (saved = false) => {
+    if (!saved) {
+      logInfo(LogMessages.leavingRuleGroupEdit);
+    }
+    setIsEditingGroup(false);
+  };
+
   return (
     <div className={styles.wrapper} data-testid="rule-group">
       <div className={styles.header} data-testid="rule-group-header">
@@ -215,9 +224,7 @@ export const RulesGroup: FC<Props> = React.memo(({ group, namespace, expandAll,
       {!isCollapsed && (
         <RulesTable showSummaryColumn={true} className={styles.rulesTable} showGuidelines={true} rules={group.rules} />
       )}
-      {isEditingGroup && (
-        <EditCloudGroupModal group={group} namespace={namespace} onClose={() => setIsEditingGroup(false)} />
-      )}
+      {isEditingGroup && <EditCloudGroupModal group={group} namespace={namespace} onClose={() => closeEditModal()} />}
       {isReorderingGroup && (
         <ReorderCloudGroupModal group={group} namespace={namespace} onClose={() => setIsReorderingGroup(false)} />
       )}