EPMRPP-87425 || Add events for Component health check widgets (#3757)

reportportal · Mar 1, 2024 · 1b9c55b · 1b9c55b
1 parent 2ab0efa
commit 1b9c55b
Show file tree

Hide file tree

Showing 5 changed files with 54 additions and 5 deletions.
diff --git a/app/src/components/main/analytics/events/ga4Events/dashboardsPageEvents.js b/app/src/components/main/analytics/events/ga4Events/dashboardsPageEvents.js
@@ -17,12 +17,13 @@
 import { normalizeEventString } from '../../utils';
 import { getBasicClickEventParameters } from '../common/ga4Utils';
 
-const RATIO_BASED_ON = 'ratio_based_on';
 const DASHBOARDS = 'dashboards';
+const RATIO_BASED_ON = 'ratio_based_on';
+const EXCLUDE_SKIPPED_TESTS_FROM_STATISTICS = 'exclude_skipped_tests_from_statistics';
 
 const modalNames = {
-  editWidgetModal: 'edit_modal',
-  widgetWizardModal: 'add_modal',
+  editWidgetModal: 'edit_widget',
+  widgetWizardModal: 'add_widget',
 };
 
 const getBasicEventTypeConfig = (type) => ({
@@ -37,6 +38,14 @@ export const WIDGETS_EVENTS = {
     modal: modalNames[modalId],
     element_name: RATIO_BASED_ON,
   }),
+
+  createClickExcludeSkippedTestsOnHealthCheck: (modalId) => (type, status) => ({
+    ...getBasicEventTypeConfig(type),
+    type,
+    status,
+    modal: modalNames[modalId],
+    element_name: EXCLUDE_SKIPPED_TESTS_FROM_STATISTICS,
+  }),
 };
 
 export const DASHBOARD_EVENTS = {

diff --git a/app/src/pages/inside/dashboardItemPage/dashboardItemPage.jsx b/app/src/pages/inside/dashboardItemPage/dashboardItemPage.jsx
@@ -302,6 +302,7 @@ export class DashboardItemPage extends Component {
           ratioBasedOnChange: WIDGETS_EVENTS.createClickOnRatioBasedOptionInPassingRateCharts(
             modalId,
           ),
+          excludeSkippedTests: WIDGETS_EVENTS.createClickExcludeSkippedTestsOnHealthCheck(modalId),
         },
       },
     });

diff --git a/...es/inside/dashboardItemPage/modals/common/widgetControls/componentHealthCheckControls.jsx b/...es/inside/dashboardItemPage/modals/common/widgetControls/componentHealthCheckControls.jsx
@@ -16,6 +16,7 @@
 
 import React, { Component, Fragment } from 'react';
 import PropTypes from 'prop-types';
+import track from 'react-tracking';
 import classNames from 'classnames/bind';
 import { injectIntl, defineMessages } from 'react-intl';
 import { connect } from 'react-redux';
@@ -90,6 +91,7 @@ const attributeKeyValidator = (formatMessage) => (attributes) =>
 @connect((state) => ({
   activeProject: activeProjectSelector(state),
 }))
+@track()
 @injectIntl
 export class ComponentHealthCheckControls extends Component {
   static propTypes = {
@@ -100,6 +102,9 @@ export class ComponentHealthCheckControls extends Component {
     onFormAppearanceChange: PropTypes.func.isRequired,
     activeProject: PropTypes.string.isRequired,
     eventsInfo: PropTypes.object,
+    tracking: PropTypes.shape({
+      trackEvent: PropTypes.func,
+    }).isRequired,
   };
 
   static defaultProps = {
@@ -154,6 +159,16 @@ export class ComponentHealthCheckControls extends Component {
     );
   };
 
+  handleExcludeSkipped = ({ target: { checked } }) => {
+    const {
+      eventsInfo: { excludeSkippedTests },
+      tracking: { trackEvent },
+    } = this.props;
+    const type = 'component_health_check';
+
+    trackEvent(excludeSkippedTests(type, checked));
+  };
+
   render() {
     const {
       intl: { formatMessage },
@@ -184,7 +199,11 @@ export class ComponentHealthCheckControls extends Component {
                 )}
               />
             </FieldProvider>
-            <FieldProvider name="contentParameters.widgetOptions.excludeSkipped" format={Boolean}>
+            <FieldProvider
+              onChange={this.handleExcludeSkipped}
+              name="contentParameters.widgetOptions.excludeSkipped"
+              format={Boolean}
+            >
               <CheckboxControl fieldLabel=" " text={formatMessage(messages.excludeSkipped)} />
             </FieldProvider>
             <FieldProvider

diff --git a/.../dashboardItemPage/modals/common/widgetControls/componentHealthCheckTableViewControls.jsx b/.../dashboardItemPage/modals/common/widgetControls/componentHealthCheckTableViewControls.jsx
@@ -16,6 +16,7 @@
 
 import React, { Component, Fragment } from 'react';
 import PropTypes from 'prop-types';
+import track from 'react-tracking';
 import classNames from 'classnames/bind';
 import { injectIntl, defineMessages } from 'react-intl';
 import { connect } from 'react-redux';
@@ -105,6 +106,7 @@ const attributeKeyValidator = (formatMessage) => (attributes) =>
 @connect((state) => ({
   activeProject: activeProjectSelector(state),
 }))
+@track()
 @injectIntl
 export class ComponentHealthCheckTableViewControls extends Component {
   static propTypes = {
@@ -115,6 +117,9 @@ export class ComponentHealthCheckTableViewControls extends Component {
     onFormAppearanceChange: PropTypes.func.isRequired,
     activeProject: PropTypes.string.isRequired,
     eventsInfo: PropTypes.object,
+    tracking: PropTypes.shape({
+      trackEvent: PropTypes.func,
+    }).isRequired,
   };
 
   static defaultProps = {
@@ -197,6 +202,16 @@ export class ComponentHealthCheckTableViewControls extends Component {
     );
   };
 
+  handleExcludeSkipped = ({ target: { checked } }) => {
+    const {
+      eventsInfo: { excludeSkippedTests },
+      tracking: { trackEvent },
+    } = this.props;
+    const type = 'component_health_check_table_view';
+
+    trackEvent(excludeSkippedTests(type, checked));
+  };
+
   render() {
     const {
       intl: { formatMessage },
@@ -230,7 +245,11 @@ export class ComponentHealthCheckTableViewControls extends Component {
                   )}
                 />
               </FieldProvider>
-              <FieldProvider name="contentParameters.widgetOptions.excludeSkipped" format={Boolean}>
+              <FieldProvider
+                onChange={this.handleExcludeSkipped}
+                name="contentParameters.widgetOptions.excludeSkipped"
+                format={Boolean}
+              >
                 <CheckboxControl fieldLabel=" " text={formatMessage(messages.excludeSkipped)} />
               </FieldProvider>
               <FieldProvider

diff --git a/app/src/pages/inside/dashboardItemPage/widgetsGrid/widget/widget.jsx b/app/src/pages/inside/dashboardItemPage/widgetsGrid/widget/widget.jsx
@@ -329,6 +329,7 @@ export class SimpleWidget extends Component {
           ratioBasedOnChange: WIDGETS_EVENTS.createClickOnRatioBasedOptionInPassingRateCharts(
             modalId,
           ),
+          excludeSkippedTests: WIDGETS_EVENTS.createClickExcludeSkippedTestsOnHealthCheck(modalId),
         },
       },
     });
-Original file line number
+Diff line change
@@ Expand Up / @@ -302,6 +302,7 @@ export class DashboardItemPage extends Component { @@
               ratioBasedOnChange: WIDGETS_EVENTS.createClickOnRatioBasedOptionInPassingRateCharts(
                 modalId,
               ),
+              excludeSkippedTests: WIDGETS_EVENTS.createClickExcludeSkippedTestsOnHealthCheck(modalId),
             },
           },
         });
@@ Expand Down @@