fix(app): add robot serial number to BuildrootAnalyticsData (#15000)

* fix(app): add robot serial number to BuildrootAnalyticsData
Opentrons · Apr 25, 2024 · ee6e9fe · ee6e9fe
1 parent f6099c4
commit ee6e9fe
Show file tree

Hide file tree

Showing 16 changed files with 77 additions and 76 deletions.
diff --git a/.eslintcache b/.eslintcache
diff --git a/app/src/organisms/Devices/HistoricalProtocolRunOverflowMenu.tsx b/app/src/organisms/Devices/HistoricalProtocolRunOverflowMenu.tsx
@@ -29,7 +29,7 @@ import { useRunControls } from '../../organisms/RunTimeControl/hooks'
 import {
   useTrackEvent,
   ANALYTICS_PROTOCOL_PROCEED_TO_RUN,
-  ANALYTICS_PROTOCOL_RUN_AGAIN,
+  ANALYTICS_PROTOCOL_RUN_ACTION,
 } from '../../redux/analytics'
 import { getRobotUpdateDisplayInfo } from '../../redux/robot-update'
 import { useDownloadRunLog, useTrackProtocolRunEvent, useRobot } from './hooks'
@@ -150,7 +150,7 @@ function MenuDropdown(props: MenuDropdownProps): JSX.Element {
         robotSerialNumber,
       },
     })
-    trackProtocolRunEvent({ name: ANALYTICS_PROTOCOL_RUN_AGAIN })
+    trackProtocolRunEvent({ name: ANALYTICS_PROTOCOL_RUN_ACTION.AGAIN })
   }
 
   const handleDeleteClick: React.MouseEventHandler<HTMLButtonElement> = e => {

diff --git a/app/src/organisms/Devices/ProtocolRun/ProtocolRunHeader.tsx b/app/src/organisms/Devices/ProtocolRun/ProtocolRunHeader.tsx
@@ -62,11 +62,7 @@ import { Banner } from '../../../atoms/Banner'
 import {
   useTrackEvent,
   ANALYTICS_PROTOCOL_PROCEED_TO_RUN,
-  ANALYTICS_PROTOCOL_RUN_AGAIN,
-  ANALYTICS_PROTOCOL_RUN_FINISH,
-  ANALYTICS_PROTOCOL_RUN_PAUSE,
-  ANALYTICS_PROTOCOL_RUN_START,
-  ANALYTICS_PROTOCOL_RUN_RESUME,
+  ANALYTICS_PROTOCOL_RUN_ACTION,
 } from '../../../redux/analytics'
 import { getIsHeaterShakerAttached } from '../../../redux/config'
 import { Tooltip } from '../../../atoms/Tooltip'
@@ -252,7 +248,7 @@ export function ProtocolRunHeader({
     // After a user-initiated stopped run, close the run current run automatically.
     if (runStatus === RUN_STATUS_STOPPED && isRunCurrent && runId != null) {
       trackProtocolRunEvent({
-        name: ANALYTICS_PROTOCOL_RUN_FINISH,
+        name: ANALYTICS_PROTOCOL_RUN_ACTION.FINISH,
         properties: {
           ...robotAnalyticsData,
         },
@@ -301,7 +297,7 @@ export function ProtocolRunHeader({
 
   const handleClearClick = (): void => {
     trackProtocolRunEvent({
-      name: ANALYTICS_PROTOCOL_RUN_FINISH,
+      name: ANALYTICS_PROTOCOL_RUN_ACTION.FINISH,
       properties: robotAnalyticsData ?? undefined,
     })
     closeCurrentRun()
@@ -701,7 +697,7 @@ function ActionButton(props: ActionButtonProps): JSX.Element {
     buttonText = t('pause_run')
     handleButtonClick = (): void => {
       pause()
-      trackProtocolRunEvent({ name: ANALYTICS_PROTOCOL_RUN_PAUSE })
+      trackProtocolRunEvent({ name: ANALYTICS_PROTOCOL_RUN_ACTION.PAUSE })
     }
   } else if (runStatus === RUN_STATUS_STOP_REQUESTED) {
     buttonIconName = 'ot-spinner'
@@ -725,8 +721,8 @@ function ActionButton(props: ActionButtonProps): JSX.Element {
         trackProtocolRunEvent({
           name:
             runStatus === RUN_STATUS_IDLE
-              ? ANALYTICS_PROTOCOL_RUN_START
-              : ANALYTICS_PROTOCOL_RUN_RESUME,
+              ? ANALYTICS_PROTOCOL_RUN_ACTION.START
+              : ANALYTICS_PROTOCOL_RUN_ACTION.RESUME,
           properties:
             runStatus === RUN_STATUS_IDLE && robotAnalyticsData != null
               ? robotAnalyticsData
@@ -744,7 +740,7 @@ function ActionButton(props: ActionButtonProps): JSX.Element {
         properties: { sourceLocation: 'RunRecordDetail', robotSerialNumber },
       })
       trackProtocolRunEvent({
-        name: ANALYTICS_PROTOCOL_RUN_AGAIN,
+        name: ANALYTICS_PROTOCOL_RUN_ACTION.AGAIN,
       })
     }
   }

diff --git a/app/src/organisms/Devices/ProtocolRun/__tests__/ProtocolRunHeader.test.tsx b/app/src/organisms/Devices/ProtocolRun/__tests__/ProtocolRunHeader.test.tsx
@@ -59,11 +59,7 @@ import { mockHeaterShaker } from '../../../../redux/modules/__fixtures__'
 import {
   useTrackEvent,
   ANALYTICS_PROTOCOL_PROCEED_TO_RUN,
-  ANALYTICS_PROTOCOL_RUN_AGAIN,
-  ANALYTICS_PROTOCOL_RUN_FINISH,
-  ANALYTICS_PROTOCOL_RUN_PAUSE,
-  ANALYTICS_PROTOCOL_RUN_START,
-  ANALYTICS_PROTOCOL_RUN_RESUME,
+  ANALYTICS_PROTOCOL_RUN_ACTION,
 } from '../../../../redux/analytics'
 import { mockConnectableRobot } from '../../../../redux/discovery/__fixtures__'
 import { getRobotUpdateDisplayInfo } from '../../../../redux/robot-update'
@@ -427,7 +423,7 @@ describe('ProtocolRunHeader', () => {
     fireEvent.click(button)
     expect(mockTrackProtocolRunEvent).toBeCalledTimes(1)
     expect(mockTrackProtocolRunEvent).toBeCalledWith({
-      name: ANALYTICS_PROTOCOL_RUN_START,
+      name: ANALYTICS_PROTOCOL_RUN_ACTION.START,
       properties: {},
     })
   })
@@ -445,7 +441,7 @@ describe('ProtocolRunHeader', () => {
     expect(mockCloseCurrentRun).toBeCalled()
     expect(mockTrackProtocolRunEvent).toBeCalled()
     expect(mockTrackProtocolRunEvent).toBeCalledWith({
-      name: ANALYTICS_PROTOCOL_RUN_FINISH,
+      name: ANALYTICS_PROTOCOL_RUN_ACTION.FINISH,
       properties: {},
     })
   })
@@ -526,7 +522,7 @@ describe('ProtocolRunHeader', () => {
     screen.getByText('Protocol end')
     fireEvent.click(button)
     expect(mockTrackProtocolRunEvent).toBeCalledWith({
-      name: ANALYTICS_PROTOCOL_RUN_PAUSE,
+      name: ANALYTICS_PROTOCOL_RUN_ACTION.PAUSE,
     })
   })
 
@@ -564,7 +560,7 @@ describe('ProtocolRunHeader', () => {
     screen.getByText('Paused')
     fireEvent.click(button)
     expect(mockTrackProtocolRunEvent).toBeCalledWith({
-      name: ANALYTICS_PROTOCOL_RUN_RESUME,
+      name: ANALYTICS_PROTOCOL_RUN_ACTION.RESUME,
       properties: {},
     })
   })
@@ -649,7 +645,7 @@ describe('ProtocolRunHeader', () => {
     screen.getByText(formatTimestamp(COMPLETED_AT))
     fireEvent.click(button)
     expect(mockTrackProtocolRunEvent).toBeCalledWith({
-      name: ANALYTICS_PROTOCOL_RUN_AGAIN,
+      name: ANALYTICS_PROTOCOL_RUN_ACTION.AGAIN,
     })
   })
 
@@ -676,7 +672,7 @@ describe('ProtocolRunHeader', () => {
     screen.getByText(formatTimestamp(COMPLETED_AT))
     fireEvent.click(button)
     expect(mockTrackProtocolRunEvent).toBeCalledWith({
-      name: ANALYTICS_PROTOCOL_RUN_AGAIN,
+      name: ANALYTICS_PROTOCOL_RUN_ACTION.AGAIN,
     })
   })
 
@@ -710,7 +706,7 @@ describe('ProtocolRunHeader', () => {
       },
     })
     expect(mockTrackProtocolRunEvent).toBeCalledWith({
-      name: ANALYTICS_PROTOCOL_RUN_AGAIN,
+      name: ANALYTICS_PROTOCOL_RUN_ACTION.AGAIN,
     })
   })
 

diff --git a/app/src/organisms/Devices/hooks/__tests__/useTrackProtocolRunEvent.test.tsx b/app/src/organisms/Devices/hooks/__tests__/useTrackProtocolRunEvent.test.tsx
@@ -10,7 +10,7 @@ import { useTrackProtocolRunEvent } from '../useTrackProtocolRunEvent'
 import { useProtocolRunAnalyticsData } from '../useProtocolRunAnalyticsData'
 import {
   useTrackEvent,
-  ANALYTICS_PROTOCOL_RUN_START,
+  ANALYTICS_PROTOCOL_RUN_ACTION,
 } from '../../../../redux/analytics'
 import { mockConnectableRobot } from '../../../../redux/discovery/__fixtures__'
 import { useRobot } from '../useRobot'
@@ -85,12 +85,12 @@ describe('useTrackProtocolRunEvent hook', () => {
     )
     await waitFor(() =>
       result.current.trackProtocolRunEvent({
-        name: ANALYTICS_PROTOCOL_RUN_START,
+        name: ANALYTICS_PROTOCOL_RUN_ACTION.START,
         properties: {},
       })
     )
     expect(mockTrackEvent).toHaveBeenCalledWith({
-      name: ANALYTICS_PROTOCOL_RUN_START,
+      name: ANALYTICS_PROTOCOL_RUN_ACTION.START,
       properties: PROTOCOL_PROPERTIES,
     })
   })
@@ -112,12 +112,12 @@ describe('useTrackProtocolRunEvent hook', () => {
     )
     await waitFor(() =>
       result.current.trackProtocolRunEvent({
-        name: ANALYTICS_PROTOCOL_RUN_START,
+        name: ANALYTICS_PROTOCOL_RUN_ACTION.START,
         properties: {},
       })
     )
     expect(mockTrackEvent).toHaveBeenCalledWith({
-      name: ANALYTICS_PROTOCOL_RUN_START,
+      name: ANALYTICS_PROTOCOL_RUN_ACTION.START,
       properties: {},
     })
   })

diff --git a/app/src/organisms/OnDeviceDisplay/RunningProtocol/ConfirmCancelRunModal.tsx b/app/src/organisms/OnDeviceDisplay/RunningProtocol/ConfirmCancelRunModal.tsx
@@ -21,7 +21,7 @@ import { SmallButton } from '../../../atoms/buttons'
 import { Modal } from '../../../molecules/Modal'
 import { useTrackProtocolRunEvent } from '../../../organisms/Devices/hooks'
 import { useRunStatus } from '../../../organisms/RunTimeControl/hooks'
-import { ANALYTICS_PROTOCOL_RUN_CANCEL } from '../../../redux/analytics'
+import { ANALYTICS_PROTOCOL_RUN_ACTION } from '../../../redux/analytics'
 import { getLocalRobot } from '../../../redux/discovery'
 import { CancelingRunModal } from './CancelingRunModal'
 
@@ -71,7 +71,7 @@ export function ConfirmCancelRunModal({
 
   React.useEffect(() => {
     if (runStatus === RUN_STATUS_STOPPED) {
-      trackProtocolRunEvent({ name: ANALYTICS_PROTOCOL_RUN_CANCEL })
+      trackProtocolRunEvent({ name: ANALYTICS_PROTOCOL_RUN_ACTION.CANCEL })
       dismissCurrentRun(runId)
       if (!isActiveRun) {
         if (protocolId != null) {

diff --git a/app/src/organisms/OnDeviceDisplay/RunningProtocol/CurrentRunningProtocolCommand.tsx b/app/src/organisms/OnDeviceDisplay/RunningProtocol/CurrentRunningProtocolCommand.tsx
@@ -23,11 +23,7 @@ import { CommandText } from '../../CommandText'
 import { RunTimer } from '../../Devices/ProtocolRun/RunTimer'
 import { PlayPauseButton } from './PlayPauseButton'
 import { StopButton } from './StopButton'
-import {
-  ANALYTICS_PROTOCOL_RUN_START,
-  ANALYTICS_PROTOCOL_RUN_RESUME,
-  ANALYTICS_PROTOCOL_RUN_PAUSE,
-} from '../../../redux/analytics'
+import { ANALYTICS_PROTOCOL_RUN_ACTION } from '../../../redux/analytics'
 
 import type {
   CompletedProtocolAnalysis,
@@ -168,14 +164,14 @@ export function CurrentRunningProtocolCommand({
   const onTogglePlayPause = (): void => {
     if (runStatus === RUN_STATUS_RUNNING) {
       pauseRun()
-      trackProtocolRunEvent({ name: ANALYTICS_PROTOCOL_RUN_PAUSE })
+      trackProtocolRunEvent({ name: ANALYTICS_PROTOCOL_RUN_ACTION.PAUSE })
     } else {
       playRun()
       trackProtocolRunEvent({
         name:
           runStatus === RUN_STATUS_IDLE
-            ? ANALYTICS_PROTOCOL_RUN_START
-            : ANALYTICS_PROTOCOL_RUN_RESUME,
+            ? ANALYTICS_PROTOCOL_RUN_ACTION.START
+            : ANALYTICS_PROTOCOL_RUN_ACTION.RESUME,
         properties:
           runStatus === RUN_STATUS_IDLE && robotAnalyticsData != null
             ? robotAnalyticsData

diff --git a/app/src/organisms/OnDeviceDisplay/RunningProtocol/RunningProtocolCommandList.tsx b/app/src/organisms/OnDeviceDisplay/RunningProtocol/RunningProtocolCommandList.tsx
@@ -25,11 +25,7 @@ import { CommandText } from '../../CommandText'
 import { CommandIcon } from '../../RunPreview/CommandIcon'
 import { PlayPauseButton } from './PlayPauseButton'
 import { StopButton } from './StopButton'
-import {
-  ANALYTICS_PROTOCOL_RUN_START,
-  ANALYTICS_PROTOCOL_RUN_RESUME,
-  ANALYTICS_PROTOCOL_RUN_PAUSE,
-} from '../../../redux/analytics'
+import { ANALYTICS_PROTOCOL_RUN_ACTION } from '../../../redux/analytics'
 
 import type {
   CompletedProtocolAnalysis,
@@ -119,14 +115,14 @@ export function RunningProtocolCommandList({
   const onTogglePlayPause = (): void => {
     if (runStatus === RUN_STATUS_RUNNING) {
       pauseRun()
-      trackProtocolRunEvent({ name: ANALYTICS_PROTOCOL_RUN_PAUSE })
+      trackProtocolRunEvent({ name: ANALYTICS_PROTOCOL_RUN_ACTION.PAUSE })
     } else {
       playRun()
       trackProtocolRunEvent({
         name:
           runStatus === RUN_STATUS_IDLE
-            ? ANALYTICS_PROTOCOL_RUN_START
-            : ANALYTICS_PROTOCOL_RUN_RESUME,
+            ? ANALYTICS_PROTOCOL_RUN_ACTION.START
+            : ANALYTICS_PROTOCOL_RUN_ACTION.RESUME,
         properties:
           runStatus === RUN_STATUS_IDLE && robotAnalyticsData != null
             ? robotAnalyticsData

diff --git a/app/src/organisms/RunDetails/ConfirmCancelModal.tsx b/app/src/organisms/RunDetails/ConfirmCancelModal.tsx
@@ -24,7 +24,7 @@ import { getModalPortalEl } from '../../App/portal'
 import { LegacyModal } from '../../molecules/LegacyModal'
 import { useTrackProtocolRunEvent, useIsFlex } from '../Devices/hooks'
 import { useRunStatus } from '../RunTimeControl/hooks'
-import { ANALYTICS_PROTOCOL_RUN_CANCEL } from '../../redux/analytics'
+import { ANALYTICS_PROTOCOL_RUN_ACTION } from '../../redux/analytics'
 
 export interface ConfirmCancelModalProps {
   onClose: () => unknown
@@ -53,7 +53,7 @@ export function ConfirmCancelModal(
     setIsCanceling(true)
     stopRun(runId, {
       onSuccess: () => {
-        trackProtocolRunEvent({ name: ANALYTICS_PROTOCOL_RUN_CANCEL })
+        trackProtocolRunEvent({ name: ANALYTICS_PROTOCOL_RUN_ACTION.CANCEL })
       },
       onError: () => {
         setIsCanceling(false)

diff --git a/app/src/pages/ProtocolSetup/__tests__/ProtocolSetup.test.tsx b/app/src/pages/ProtocolSetup/__tests__/ProtocolSetup.test.tsx
@@ -35,7 +35,7 @@ import {
   useTrackProtocolRunEvent,
 } from '../../../organisms/Devices/hooks'
 import { getLocalRobot } from '../../../redux/discovery'
-import { ANALYTICS_PROTOCOL_RUN_START } from '../../../redux/analytics'
+import { ANALYTICS_PROTOCOL_RUN_ACTION } from '../../../redux/analytics'
 import { ProtocolSetupLiquids } from '../../../organisms/ProtocolSetupLiquids'
 import { getProtocolModulesInfo } from '../../../organisms/Devices/ProtocolRun/utils/getProtocolModulesInfo'
 import { ProtocolSetupModulesAndDeck } from '../../../organisms/ProtocolSetupModulesAndDeck'
@@ -419,7 +419,7 @@ describe('ProtocolSetup', () => {
     fireEvent.click(screen.getByRole('button', { name: 'play' }))
     expect(mockTrackProtocolRunEvent).toBeCalledTimes(1)
     expect(mockTrackProtocolRunEvent).toHaveBeenCalledWith({
-      name: ANALYTICS_PROTOCOL_RUN_START,
+      name: ANALYTICS_PROTOCOL_RUN_ACTION.START,
       properties: {},
     })
   })

diff --git a/app/src/pages/ProtocolSetup/index.tsx b/app/src/pages/ProtocolSetup/index.tsx
@@ -78,7 +78,7 @@ import { getLabwareSetupItemGroups } from '../Protocols/utils'
 import { getLocalRobot, getRobotSerialNumber } from '../../redux/discovery'
 import {
   ANALYTICS_PROTOCOL_PROCEED_TO_RUN,
-  ANALYTICS_PROTOCOL_RUN_START,
+  ANALYTICS_PROTOCOL_RUN_ACTION,
   useTrackEvent,
 } from '../../redux/analytics'
 import { getIsHeaterShakerAttached } from '../../redux/config'
@@ -492,7 +492,7 @@ function PrepareToRun({
         if (isReadyToRun) {
           play()
           trackProtocolRunEvent({
-            name: ANALYTICS_PROTOCOL_RUN_START,
+            name: ANALYTICS_PROTOCOL_RUN_ACTION.START,
             properties: robotAnalyticsData != null ? robotAnalyticsData : {},
           })
         } else {

diff --git a/app/src/pages/RunSummary/index.tsx b/app/src/pages/RunSummary/index.tsx
@@ -54,9 +54,7 @@ import { EMPTY_TIMESTAMP } from '../../organisms/Devices/constants'
 import { RunTimer } from '../../organisms/Devices/ProtocolRun/RunTimer'
 import {
   useTrackEvent,
-  // ANALYTICS_PROTOCOL_RUN_CANCEL,
-  ANALYTICS_PROTOCOL_RUN_AGAIN,
-  ANALYTICS_PROTOCOL_RUN_FINISH,
+  ANALYTICS_PROTOCOL_RUN_ACTION,
   ANALYTICS_PROTOCOL_PROCEED_TO_RUN,
 } from '../../redux/analytics'
 import { getLocalRobot } from '../../redux/discovery'
@@ -175,7 +173,7 @@ export function RunSummary(): JSX.Element {
           name: ANALYTICS_PROTOCOL_PROCEED_TO_RUN,
           properties: { sourceLocation: 'RunSummary', robotSerialNumber },
         })
-        trackProtocolRunEvent({ name: ANALYTICS_PROTOCOL_RUN_AGAIN })
+        trackProtocolRunEvent({ name: ANALYTICS_PROTOCOL_RUN_ACTION.AGAIN })
       }
     }
   }
@@ -186,7 +184,7 @@ export function RunSummary(): JSX.Element {
 
   const handleClickSplash = (): void => {
     trackProtocolRunEvent({
-      name: ANALYTICS_PROTOCOL_RUN_FINISH,
+      name: ANALYTICS_PROTOCOL_RUN_ACTION.FINISH,
       properties: robotAnalyticsData ?? undefined,
     })
     setShowSplash(false)