fix(protocol-designer): populate blowout flow rate, remove disposal volume warning (#19044)

This PR ensures blowout flow rate is populated for "don't use a liquid
class" transfers. It also removes a legacy warning for disposal volume
below recommended value (liquid classes specify values below the 5ul
minimum frequently).

Closes RQA-4425

Author: ncdiehl11

protocol-designer/src/steplist/formLevel/handleFormChange/utils.ts

@@ -627,6 +627,8 @@ const getNoLiquidClassValuesMoveLiquid = (args: {
       dispense_retract_delay_seconds:
         allOT2Defaults.dispense_retract_delay_seconds,
       ...dipsosalFields,
+      blowout_flowRate:
+        matchingTipLiquidSpecs?.defaultBlowOutFlowRate.default ?? null,
     }
     return {
       ...(liquidHandlingAction === 'all' || liquidHandlingAction === 'aspirate'
@@ -728,6 +730,11 @@ const getNoLiquidClassValuesMoveLiquid = (args: {
     'dispense',
     dispenseMaxUiFlowRate
   )
+
+  const blowoutFlowRateFields = {
+    blowout_flowRate: dispense.retract.blowout.params?.flowRate ?? null,
+  }
+
   const pushOutVolume =
     linearInterpolate(
       volume,
@@ -776,6 +783,7 @@ const getNoLiquidClassValuesMoveLiquid = (args: {
     ...dispenseFlowRateFields,
     ...dispenseOffsetFields,
     ...dispensePositionReferenceFields,
+    ...blowoutFlowRateFields,
     dispense_mmFromBottom: DEFAULT_MM_OFFSET_FROM_BOTTOM,
     dispense_submerge_mmFromBottom: SAFE_MOVE_TO_WELL_OFFSET_FROM_TOP_MM,
     dispense_submerge_position_reference: POSITION_REFERENCE_TOP,

protocol-designer/src/steplist/formLevel/index.ts

@@ -84,7 +84,6 @@ import {
   composeWarnings,
   incompatibleLiquidClass,
   maxDispenseWellVolume,
-  minDisposalVolume,
   mixTipPositionInTube,
   tipPositionInTube,
 } from './warnings'
@@ -245,7 +244,6 @@ const stepFormHelperMap: {
     getWarnings: composeWarnings(
       belowPipetteMinimumVolume,
       maxDispenseWellVolume,
-      minDisposalVolume,
       tipPositionInTube,
       incompatibleLiquidClass
     ),

protocol-designer/src/steplist/formLevel/test/warnings.test.ts

@@ -10,7 +10,6 @@ import {
   belowPipetteMinimumVolume,
   incompatibleLiquidClass,
   maxDispenseWellVolume,
-  minDisposalVolume,
   mixTipPositionInTube,
   tipPositionInTube,
 } from '../warnings'
@@ -68,90 +67,6 @@ describe('Below pipette minimum volume', () => {
     )
   })
 })
-describe('Below min disposal volume', () => {
-  let fieldsWithPipette: {
-    pipette: { spec: { liquids: { default: { minVolume: number } } } }
-    disposalVolume_checkbox: boolean
-    disposalVolume_volume: number
-    path: string
-  }
-  beforeEach(() => {
-    fieldsWithPipette = {
-      pipette: {
-        spec: {
-          liquids: {
-            default: {
-              minVolume: 100,
-            },
-          },
-        },
-      },
-      disposalVolume_checkbox: true,
-      disposalVolume_volume: 100,
-      path: 'multiDispense',
-    }
-  })
-  it('should NOT return a warning when there is no pipette', () => {
-    const fields = {
-      ...fieldsWithPipette,
-      pipette: undefined,
-    } as any
-    expect(minDisposalVolume(fields)).toBe(null)
-  })
-  it('should NOT return a warning when there is no pipette spec', () => {
-    const fields = {
-      ...fieldsWithPipette,
-      pipette: { spec: undefined },
-    } as any
-    expect(minDisposalVolume(fields)).toBe(null)
-  })
-  it('should NOT return a warning when the path is NOT multi dispense', () => {
-    const fields = {
-      ...fieldsWithPipette,
-      path: 'another_path',
-    } as any
-    expect(minDisposalVolume(fields)).toBe(null)
-  })
-  it('should NOT return a warning when the volume is equal to the min pipette volume', () => {
-    const fields = {
-      ...fieldsWithPipette,
-      disposalVolume_volume: 100,
-    } as any
-    expect(minDisposalVolume(fields)).toBe(null)
-  })
-  it('should NOT return a warning when the volume is greater than the min pipette volume', () => {
-    const fields = {
-      ...fieldsWithPipette,
-      disposalVolume_volume: 100,
-    } as any
-    expect(minDisposalVolume(fields)).toBe(null)
-  })
-
-  it('should return a warning when the volume is less than the min pipette volume', () => {
-    const fields = {
-      ...fieldsWithPipette,
-      disposalVolume_volume: 99,
-    }
-    // @ts-expect-error(sa, 2021-6-15): minDisposalVolume might return null, need to null check before property access
-    expect(minDisposalVolume(fields).type).toBe('BELOW_MIN_DISPOSAL_VOLUME')
-  })
-  it('should return a warning when the path is multi dispense and the checkbox is unchecked', () => {
-    const fields = {
-      ...fieldsWithPipette,
-      disposalVolume_checkbox: false,
-    }
-    // @ts-expect-error(sa, 2021-6-15): minDisposalVolume might return null, need to null check before property access
-    expect(minDisposalVolume(fields).type).toBe('BELOW_MIN_DISPOSAL_VOLUME')
-  })
-  it('should return a warning when the path is multi dispense and there is no disposal volume', () => {
-    const fields = {
-      ...fieldsWithPipette,
-      disposalVolume_volume: undefined,
-    }
-    // @ts-expect-error(sa, 2021-6-15): minDisposalVolume might return null, need to null check before property access
-    expect(minDisposalVolume(fields).type).toBe('BELOW_MIN_DISPOSAL_VOLUME')
-  })
-})
 describe('Max dispense well volume', () => {
   let fieldsWithDispenseLabware: any
   beforeEach(() => {

protocol-designer/src/steplist/formLevel/warnings.tsx

@@ -21,7 +21,6 @@ import type { FormError } from './errors'
  ********************/
 
 export type FormWarningType =
-  | 'BELOW_MIN_DISPOSAL_VOLUME'
   | 'BELOW_PIPETTE_MINIMUM_VOLUME'
   | 'INCOMPATIBLE_ALL_PIPETTE'
   | 'INCOMPATIBLE_PIPETTE_PATH'
@@ -52,15 +51,6 @@ const overMaxWellVolumeWarning = (): FormWarning => ({
   location: 'form',
 })
 
-const belowMinDisposalVolumeWarning = (min: number): FormWarning => ({
-  type: 'BELOW_MIN_DISPOSAL_VOLUME',
-  title: `Disposal volume is below recommended minimum (${min} uL)`,
-  body:
-    'For accuracy in multi-dispense Transfers we recommend you use a disposal volume of at least the pipette`s minimum.',
-  dependentFields: ['disposalVolume_volume', 'pipette'],
-  location: 'form',
-})
-
 const tipPositionedLowInTube = (): FormWarning => ({
   type: 'TIP_POSITIONED_LOW_IN_TUBE',
   title:
@@ -161,29 +151,6 @@ export const maxDispenseWellVolume = (
   return hasExceeded ? overMaxWellVolumeWarning() : null
 }
 
-export const minDisposalVolume = (
-  fields: HydratedMoveLiquidFormData
-): FormWarning | null => {
-  const {
-    disposalVolume_checkbox,
-    disposalVolume_volume,
-    pipette,
-    path,
-  } = fields
-  if (!(pipette && pipette.spec) || path !== 'multiDispense') return null
-  const isUnselected = !disposalVolume_checkbox || !disposalVolume_volume
-  const liquidSpecs = pipette.spec.liquids
-  const minVolume =
-    'lowVolumeDefault' in liquidSpecs
-      ? liquidSpecs.lowVolumeDefault.minVolume
-      : liquidSpecs.default.minVolume
-  if (isUnselected) {
-    return belowMinDisposalVolumeWarning(minVolume as number)
-  }
-  const isBelowMin = disposalVolume_volume < minVolume
-  return isBelowMin ? belowMinDisposalVolumeWarning(minVolume as number) : null
-}
-
 export const _lowVolumeTransferWarning = (): FormWarning => ({
   type: 'LOW_VOLUME_TRANSFER',
   title: `Transfer volumes of ${MINIMUM_LIQUID_CLASS_VOLUME} µL or less are incompatible with liquid classes.`,