fix(step-generation): add wait for temperature timeline warning (#16581)

closes RESC-329 AUTH-891

Author: jerader

protocol-designer/src/assets/localization/en/alert.json

@@ -219,6 +219,10 @@
       "TIPRACK_IN_WASTE_CHUTE_HAS_TIPS": {
         "title": "Disposing unused tips",
         "body": "This step moves a tip rack that contains unused tips to the waste chute. There is no way to retrieve the tips after disposal."
+      },
+      "TEMPERATURE_IS_POTENTIALLY_UNREACHABLE": {
+        "title": "The pause temperature is potentially unreachable",
+        "body": "This step tries to set the module temperature but it can possibly not be reached, resulting in your protocol running forever."
       }
     }
   },

step-generation/src/__tests__/moveLabware.test.ts

@@ -372,7 +372,7 @@ describe('moveLabware', () => {
     )
     expect(result.warnings).toEqual([
       {
-        message: 'Disposing of a tiprack with tips',
+        message: 'Disposing unused tips',
         type: 'TIPRACK_IN_WASTE_CHUTE_HAS_TIPS',
       },
     ])

step-generation/src/__tests__/waitForTemperature.test.ts

@@ -46,7 +46,7 @@ describe('waitForTemperature', () => {
     invariantContext = stateAndContext.invariantContext
     robotState = stateAndContext.robotState
   })
-  it('temperature module id exists and temp status is approaching temp', () => {
+  it('temperature module id exists and temp status is approaching temp with a warning that the temp might not be hit', () => {
     const temperature = 20
     const args: WaitForTemperatureArgs = {
       module: temperatureModuleId,
@@ -70,6 +70,12 @@ describe('waitForTemperature', () => {
           },
         },
       ],
+      warnings: [
+        {
+          type: 'TEMPERATURE_IS_POTENTIALLY_UNREACHABLE',
+          message: expect.any(String),
+        },
+      ],
     }
     const result = waitForTemperature(
       args,

step-generation/src/commandCreators/atomic/waitForTemperature.ts

@@ -3,10 +3,19 @@ import {
   TEMPERATURE_MODULE_TYPE,
 } from '@opentrons/shared-data'
 import { uuid } from '../../utils'
-import { TEMPERATURE_AT_TARGET, TEMPERATURE_DEACTIVATED } from '../../constants'
-import * as errorCreators from '../../errorCreators'
-import type { CommandCreator, WaitForTemperatureArgs } from '../../types'
+import {
+  TEMPERATURE_APPROACHING_TARGET,
+  TEMPERATURE_AT_TARGET,
+  TEMPERATURE_DEACTIVATED,
+} from '../../constants'
 import { getModuleState } from '../../robotStateSelectors'
+import * as errorCreators from '../../errorCreators'
+import * as warningCreators from '../../warningCreators'
+import type {
+  CommandCreator,
+  CommandCreatorWarning,
+  WaitForTemperatureArgs,
+} from '../../types'
 
 /** Set temperature target for specified module. */
 export const waitForTemperature: CommandCreator<WaitForTemperatureArgs> = (
@@ -16,6 +25,7 @@ export const waitForTemperature: CommandCreator<WaitForTemperatureArgs> = (
 ) => {
   const { module, temperature } = args
   const moduleState = module ? getModuleState(prevRobotState, module) : null
+  const warnings: CommandCreatorWarning[] = []
 
   if (module === null || !moduleState) {
     return {
@@ -42,6 +52,10 @@ export const waitForTemperature: CommandCreator<WaitForTemperatureArgs> = (
     'status' in moduleState &&
     moduleState.status === TEMPERATURE_AT_TARGET &&
     moduleState.targetTemperature !== temperature
+  const potentiallyUnreachableTemp =
+    'status' in moduleState &&
+    moduleState.status === TEMPERATURE_APPROACHING_TARGET &&
+    moduleState.targetTemperature !== temperature
 
   if (
     unreachableTemp ||
@@ -52,6 +66,10 @@ export const waitForTemperature: CommandCreator<WaitForTemperatureArgs> = (
     }
   }
 
+  if (potentiallyUnreachableTemp) {
+    warnings.push(warningCreators.potentiallyUnreachableTemp())
+  }
+
   const moduleType = invariantContext.moduleEntities[module]?.type
 
   switch (moduleType) {
@@ -67,6 +85,7 @@ export const waitForTemperature: CommandCreator<WaitForTemperatureArgs> = (
             },
           },
         ],
+        warnings: warnings.length > 0 ? warnings : undefined,
       }
 
     case HEATERSHAKER_MODULE_TYPE:
@@ -81,6 +100,7 @@ export const waitForTemperature: CommandCreator<WaitForTemperatureArgs> = (
             },
           },
         ],
+        warnings: warnings.length > 0 ? warnings : undefined,
       }
 
     default:

step-generation/src/types.ts

@@ -575,6 +575,7 @@ export type WarningType =
   | 'ASPIRATE_FROM_PRISTINE_WELL'
   | 'LABWARE_IN_WASTE_CHUTE_HAS_LIQUID'
   | 'TIPRACK_IN_WASTE_CHUTE_HAS_TIPS'
+  | 'TEMPERATURE_IS_POTENTIALLY_UNREACHABLE'
 
 export interface CommandCreatorWarning {
   message: string

step-generation/src/warningCreators.ts

@@ -2,14 +2,13 @@ import type { CommandCreatorWarning } from './types'
 export function aspirateMoreThanWellContents(): CommandCreatorWarning {
   return {
     type: 'ASPIRATE_MORE_THAN_WELL_CONTENTS',
-    message: 'Not enough liquid in well(s)',
+    message: 'Not enough liquid',
   }
 }
 export function aspirateFromPristineWell(): CommandCreatorWarning {
   return {
     type: 'ASPIRATE_FROM_PRISTINE_WELL',
-    message:
-      'Aspirating from a pristine well. No liquids were ever added to this well',
+    message: 'This step tries to aspirate from an empty well.',
   }
 }
 export function labwareInWasteChuteHasLiquid(): CommandCreatorWarning {
@@ -21,6 +20,13 @@ export function labwareInWasteChuteHasLiquid(): CommandCreatorWarning {
 export function tiprackInWasteChuteHasTips(): CommandCreatorWarning {
   return {
     type: 'TIPRACK_IN_WASTE_CHUTE_HAS_TIPS',
-    message: 'Disposing of a tiprack with tips',
+    message: 'Disposing unused tips',
+  }
+}
+
+export function potentiallyUnreachableTemp(): CommandCreatorWarning {
+  return {
+    type: 'TEMPERATURE_IS_POTENTIALLY_UNREACHABLE',
+    message: 'The module set temperature is potentially unreachable.',
   }
 }