refactor(app): add RTP properties to protocol run event analytics (#1…

…4836) * refactor(app): add RTP properties to protocol run event analytics
Opentrons · Apr 24, 2024 · 77bc720 · 77bc720
1 parent 5f85719
commit 77bc720
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/app/src/organisms/Devices/hooks/__tests__/useProtocolRunAnalyticsData.test.tsx b/app/src/organisms/Devices/hooks/__tests__/useProtocolRunAnalyticsData.test.tsx
@@ -37,6 +37,16 @@ const MODULES = {
  module1: { model: 'module1' },
  module2: { model: 'module2' },
 }
+const RUNTIME_PARAMETERS = [
+ {
+ displayName: 'test param',
+ variableName: 'test_param',
+ description: 'Mock boolean parameter',
+ type: 'bool',
+ default: true,
+ value: true,
+ },
+]
 const FORMATTED_MODULES = 'module1,module2'
 const STORED_PROTOCOL_ANALYSIS = {
  config: { protocolType: 'json', schemaVersion: 1.11 },
@@ -49,11 +59,13 @@ const STORED_PROTOCOL_ANALYSIS = {
  robotType: 'OT-2 Standard',
  pipettes: PIPETTES,
  modules: MODULES,
+ runTimeParameters: RUNTIME_PARAMETERS,
 }
 const ROBOT_PROTOCOL_ANALYSIS = {
  robotType: 'OT-2 Standard',
  pipettes: PIPETTES,
  modules: MODULES,
+ runTimeParameters: RUNTIME_PARAMETERS,
 }
 
 describe('useProtocolAnalysisErrors hook', () => {
@@ -126,6 +138,8 @@ describe('useProtocolAnalysisErrors hook', () => {
  protocolAppName: 'Python API',
  protocolAppVersion: 2.3,
  protocolAuthor: 'hashedString',
+ protocolHasRunTimeParameterCustomValues: false,
+ protocolHasRunTimeParameters: true,
  protocolName: 'robot protocol',
  protocolSource: 'robot protocol source',
  protocolText: 'hashedString',
@@ -156,6 +170,8 @@ describe('useProtocolAnalysisErrors hook', () => {
  protocolAppVersion: '1.1',
  protocolAuthor: 'hashedString',
  protocolName: 'stored protocol',
+ protocolHasRunTimeParameterCustomValues: false,
+ protocolHasRunTimeParameters: true,
  protocolSource: 'stored protocol source',
  protocolText: 'hashedString',
  protocolType: 'json',

diff --git a/app/src/organisms/Devices/hooks/useProtocolRunAnalyticsData.ts b/app/src/organisms/Devices/hooks/useProtocolRunAnalyticsData.ts
@@ -51,6 +51,14 @@ export const parseProtocolRunAnalyticsData = (
  .join(','),
  protocolAuthor: protocolAuthor !== '' ? protocolAuthor : '',
  protocolText: protocolText !== '' ? protocolText : '',
+ protocolHasRunTimeParameters:
+ protocolAnalysis?.runTimeParameters != null
+ ? protocolAnalysis?.runTimeParameters?.length > 0
+ : false,
+ protocolHasRunTimeParameterCustomValues:
+ protocolAnalysis?.runTimeParameters?.some(
+ param => param.value !== param.default
+ ) ?? false,
  robotType:
  protocolAnalysis?.robotType != null
  ? protocolAnalysis?.robotType