feat(app): collect pipette and module load analytics from protocol ru…

…ns' (#5675) Closes #5540
Opentrons · May 14, 2020 · 11feca3 · 11feca3
1 parent a90f675
commit 11feca3
Show file tree

Hide file tree

Showing 3 changed files with 80 additions and 1 deletion.
diff --git a/app/src/analytics/__tests__/selectors.test.js b/app/src/analytics/__tests__/selectors.test.js
@@ -1,13 +1,15 @@
 // @flow
 
 import * as Protocol from '../../protocol'
+import * as RobotSelectors from '../../robot/selectors'
 import * as Hash from '../hash'
 
 import { getProtocolAnalyticsData } from '../selectors'
 
 import type { State } from '../../types'
 
 jest.mock('../../protocol/selectors')
+jest.mock('../../robot/selectors')
 jest.mock('../hash')
 
 describe('analytics selectors', () => {
@@ -59,6 +61,16 @@ describe('analytics selectors', () => {
       $Call<typeof Protocol.getProtocolContents, State>
     > = Protocol.getProtocolContents
 
+    const getModules: JestMockFn<
+      [State],
+      $Call<typeof RobotSelectors.getModules, State>
+    > = RobotSelectors.getModules
+
+    const getPipettes: JestMockFn<
+      [State],
+      $Call<typeof RobotSelectors.getPipettes, State>
+    > = RobotSelectors.getPipettes
+
     beforeEach(() => {
       hash.mockImplementation(source => Promise.resolve(`hash:${source}`))
       getProtocolType.mockReturnValue(null)
@@ -68,6 +80,8 @@ describe('analytics selectors', () => {
       getProtocolSource.mockReturnValue(null)
       getProtocolAuthor.mockReturnValue(null)
       getProtocolContents.mockReturnValue(null)
+      getModules.mockReturnValue([])
+      getPipettes.mockReturnValue([])
     })
 
     it('should have information about the protocol', () => {
@@ -82,6 +96,8 @@ describe('analytics selectors', () => {
         protocolSource: '',
         protocolAuthor: '',
         protocolText: '',
+        pipettes: '',
+        modules: '',
       })
     })
 
@@ -124,5 +140,51 @@ describe('analytics selectors', () => {
         })
       })
     })
+
+    it('should collect pipette requestedAs (or actual) names', () => {
+      getPipettes.mockReturnValue([
+        {
+          _id: 0,
+          mount: 'left',
+          channels: 8,
+          name: 'p300_single_v2.0',
+          tipRacks: [],
+          requestedAs: 'p300_single',
+          probed: true,
+          tipOn: false,
+          modelSpecs: null,
+        },
+        {
+          _id: 1,
+          mount: 'right',
+          channels: 8,
+          name: 'p20_multi_v2.0',
+          tipRacks: [],
+          requestedAs: null,
+          probed: true,
+          tipOn: false,
+          modelSpecs: null,
+        },
+      ])
+
+      const result = getProtocolAnalyticsData(mockState)
+
+      return expect(result).resolves.toMatchObject({
+        pipettes: 'p300_single,p20_multi_v2.0',
+      })
+    })
+
+    it('should collect module models', () => {
+      getModules.mockReturnValue([
+        { _id: 0, slot: '1', model: 'temperatureModuleV1' },
+        { _id: 1, slot: '2', model: 'magneticModuleV2' },
+      ])
+
+      const result = getProtocolAnalyticsData(mockState)
+
+      return expect(result).resolves.toMatchObject({
+        modules: 'temperatureModuleV1,magneticModuleV2',
+      })
+    })
   })
 })
diff --git a/app/src/analytics/selectors.js b/app/src/analytics/selectors.js
@@ -27,6 +27,7 @@ import {
 
 import { getRobotSettings } from '../robot-settings'
 import { getAttachedPipettes } from '../pipettes'
+import { getPipettes, getModules } from '../robot/selectors'
 
 import { hash } from './hash'
 
@@ -51,7 +52,19 @@ const _getUnhashedProtocolAnalyticsData: ProtocolDataSelector = createSelector(
   getProtocolSource,
   getProtocolAuthor,
   getProtocolContents,
-  (type, app, apiVersion, name, source, author, contents) => ({
+  getPipettes,
+  getModules,
+  (
+    type,
+    app,
+    apiVersion,
+    name,
+    source,
+    author,
+    contents,
+    pipettes,
+    modules
+  ) => ({
     protocolType: type || '',
     protocolAppName: app.name || '',
     protocolAppVersion: app.version || '',
@@ -60,6 +73,8 @@ const _getUnhashedProtocolAnalyticsData: ProtocolDataSelector = createSelector(
     protocolSource: source || '',
     protocolAuthor: author || '',
     protocolText: contents || '',
+    pipettes: pipettes.map(p => p.requestedAs ?? p.name).join(','),
+    modules: modules.map(m => m.model).join(','),
   })
 )
 

diff --git a/app/src/analytics/types.js b/app/src/analytics/types.js
@@ -13,6 +13,8 @@ export type ProtocolAnalyticsData = {|
   protocolName: string,
   protocolAuthor: string,
   protocolText: string,
+  pipettes: string,
+  modules: string,
 |}
 
 export type RobotAnalyticsData = {|