feat(app): mark protocol anlayses as stale if they lack RTP (#14763)

closes [AUTH-247](https://opentrons.atlassian.net/browse/AUTH-247)
Opentrons · May 20, 2024 · 37beafc · 37beafc
1 parent 1a45766
commit 37beafc
Show file tree

Hide file tree

Showing 9 changed files with 51 additions and 3 deletions.
diff --git a/api-client/src/protocols/__fixtures__/simpleAnalysisFile.json b/api-client/src/protocols/__fixtures__/simpleAnalysisFile.json
@@ -3936,5 +3936,6 @@
       "description": "",
       "displayColor": "#b925ff"
     }
-  ]
+  ],
+  "runTimeParameters": []
 }
diff --git a/app-shell/src/protocol-analysis/__tests__/writeFailedAnalysis.test.ts b/app-shell/src/protocol-analysis/__tests__/writeFailedAnalysis.test.ts
@@ -41,6 +41,7 @@ describe('write failed analysis', () => {
           modules: [],
           pipettes: [],
           liquids: [],
+          runTimeParameters: [],
         })
       })
   })

diff --git a/app-shell/src/protocol-analysis/writeFailedAnalysis.ts b/app-shell/src/protocol-analysis/writeFailedAnalysis.ts
@@ -27,6 +27,7 @@ export function createFailedAnalysis(
     pipettes: [],
     modules: [],
     liquids: [],
+    runTimeParameters: [],
     // TODO(mc, 2022-05-04): this field does not make sense for an
     // analysis that was unable to complete, but is required by
     // ProtocolAnalysisOutput

diff --git a/app-shell/src/protocol-storage/__tests__/protocol-storage.test.ts b/app-shell/src/protocol-storage/__tests__/protocol-storage.test.ts
@@ -119,6 +119,7 @@ describe('protocol storage directory utilities', () => {
         pipettes: [],
         modules: [],
         labware: [],
+        runTimeParameters: [],
       })
     })
   })

diff --git a/app/src/organisms/Devices/hooks/__tests__/useStoredProtocolAnalysis.test.tsx b/app/src/organisms/Devices/hooks/__tests__/useStoredProtocolAnalysis.test.tsx
@@ -42,6 +42,8 @@ const modifiedStoredProtocolData = {
     commands: storedProtocolData?.mostRecentAnalysis?.commands,
     liquids: storedProtocolData?.mostRecentAnalysis?.liquids,
     errors: storedProtocolData?.mostRecentAnalysis?.errors,
+    runTimeParameters:
+      storedProtocolData?.mostRecentAnalysis?.runTimeParameters,
   },
 }
 

diff --git a/app/src/organisms/ProtocolsLanding/__tests__/hooks.test.tsx b/app/src/organisms/ProtocolsLanding/__tests__/hooks.test.tsx
@@ -97,6 +97,7 @@ const mockStoredProtocolData = [
           displayColor: '#ff4f4f',
         },
       ],
+      runTimeParameters: [],
       errors: [],
     } as ProtocolAnalysisOutput,
   },
@@ -183,6 +184,7 @@ const mockStoredProtocolData = [
           displayColor: '#ff4f4f',
         },
       ],
+      runTimeParameters: [],
       errors: [],
     } as ProtocolAnalysisOutput,
   },
@@ -273,6 +275,7 @@ const mockStoredProtocolData = [
           displayColor: '#ff4f4f',
         },
       ],
+      runTimeParameters: [],
       errors: [],
     } as ProtocolAnalysisOutput,
   },

diff --git a/app/src/organisms/ProtocolsLanding/__tests__/utils.test.ts b/app/src/organisms/ProtocolsLanding/__tests__/utils.test.ts
@@ -1,5 +1,9 @@
 import { describe, it, expect } from 'vitest'
-import { getisFlexProtocol, getRobotTypeDisplayName } from '../utils'
+import {
+  getAnalysisStatus,
+  getisFlexProtocol,
+  getRobotTypeDisplayName,
+} from '../utils'
 import type { ProtocolAnalysisOutput } from '@opentrons/shared-data'
 
 const mockOT3ProtocolAnalysisOutput = {
@@ -10,6 +14,36 @@ const mockOT2ProtocolAnalysisOutput = {
   robotType: 'OT-2 Standard',
 } as ProtocolAnalysisOutput
 
+describe('getAnalysisStatus', () => {
+  it('should return stale if no liquids in analysis', () => {
+    const result = getAnalysisStatus(false, {
+      ...mockOT3ProtocolAnalysisOutput,
+      liquids: [],
+      errors: [],
+    })
+    expect(result).toBe('stale')
+  })
+
+  it('should return stale if no runTimeParameters in analysis', () => {
+    const result = getAnalysisStatus(false, {
+      ...mockOT3ProtocolAnalysisOutput,
+      runTimeParameters: [],
+      errors: [],
+    })
+    expect(result).toBe('stale')
+  })
+
+  it('should return complete if liquids and runTimeParameters in analysis', () => {
+    const result = getAnalysisStatus(false, {
+      ...mockOT3ProtocolAnalysisOutput,
+      liquids: [],
+      runTimeParameters: [],
+      errors: [],
+    })
+    expect(result).toBe('complete')
+  })
+})
+
 describe('getisFlexProtocol', () => {
   it('should return true for protocols intended for a Flex', () => {
     const result = getisFlexProtocol(mockOT3ProtocolAnalysisOutput)

diff --git a/app/src/organisms/ProtocolsLanding/utils.ts b/app/src/organisms/ProtocolsLanding/utils.ts
@@ -10,7 +10,10 @@ export function getAnalysisStatus(
 ): AnalysisStatus {
   if (isAnalyzing) {
     return 'loading'
-  } else if (analysis != null && analysis?.liquids == null) {
+  } else if (
+    analysis != null &&
+    (analysis.liquids == null || analysis.runTimeParameters == null)
+  ) {
     return 'stale'
   } else if (analysis != null) {
     return analysis.errors.length > 0 ? 'error' : 'complete'

diff --git a/shared-data/protocol/types/schemaV8/index.ts b/shared-data/protocol/types/schemaV8/index.ts
@@ -4,6 +4,7 @@ import type {
   LoadedLabware,
   LoadedModule,
   Liquid,
+  RunTimeParameter,
 } from '../../../js'
 import type { CommandAnnotation } from '../../../commandAnnotation/types'
 import type { LabwareDefinition2, RobotType } from '../../../js/types'
@@ -136,6 +137,7 @@ export interface ProtocolAnalysisOutput {
   modules: LoadedModule[]
   liquids: Liquid[]
   errors: AnalysisError[]
+  runTimeParameters: RunTimeParameter[]
   robotType?: RobotType
 }