fix(app): fix air gap volume range calc (#19111)

* fix(app): fix air gap volume range calc

Author: koji

app/src/organisms/ODD/QuickTransferFlow/QuickTransferAdvancedSettings/AirGap.tsx

@@ -22,6 +22,10 @@ import { useTrackEventWithRobotSerial } from '/app/redux-resources/analytics'
 import { ANALYTICS_QUICK_TRANSFER_SETTING_SAVED } from '/app/redux/analytics'
 
 import { ACTIONS } from '../constants'
+import {
+  getAspirateAirGapVolumeRange,
+  getDispenseAirGapVolumeRange,
+} from '../utils'
 
 import type { Dispatch } from 'react'
 import type {
@@ -110,40 +114,18 @@ export function AirGap(props: AirGapProps): JSX.Element {
   const setSaveOrContinueButtonText =
     airGapEnabled && currentStep < 2 ? t('shared:continue') : t('shared:save')
 
-  const maxPipetteVolume = Object.values(state.pipette.liquids)[0].maxVolume
-  const tipVolume = Object.values(state.tipRack.wells)[0].totalLiquidVolume
-
-  // dispense air gap is performed whenever a tip is on its way to the trash, so
-  // we can have the max be at the max tip capacity
-  let maxAvailableCapacity = Math.min(maxPipetteVolume, tipVolume)
-  console.log('maxAvailableCapacity', maxAvailableCapacity)
-  console.log('path', state.path)
-  console.log('volume', state.volume)
-
-  // for aspirate, air gap behaves differently depending on the path
-  if (kind === 'aspirate') {
-    if (state.path === 'single') {
-      // for a single path, air gap capacity is just the difference between the
-      // pipette/tip capacity and the volume per well
-      maxAvailableCapacity =
-        Math.min(maxPipetteVolume, tipVolume) - state.volume
-    } else if (state.path === 'multiAspirate') {
-      // an aspirate air gap for multi aspirate will aspirate an air gap
-      // after each aspirate action, so we need to halve the available capacity for single path
-      // to get the amount available, assuming a min of 2 aspirates per dispense
-      maxAvailableCapacity =
-        (Math.min(maxPipetteVolume, tipVolume) - 2 * state.volume) / 2
-    } else {
-      // aspirate air gap for multi dispense occurs once per asprirate and
-      // available volume is max capacity - volume*3 assuming a min of 2 dispenses
-      // per aspirate plus 1x the volume for disposal
-      maxAvailableCapacity =
-        Math.min(maxPipetteVolume, tipVolume) - state.volume * 3
-    }
-  }
-
-  const volumeRange = { min: 1, max: Math.floor(maxAvailableCapacity) }
-  console.log(volumeRange)
+  const { min, max } =
+    kind === 'aspirate'
+      ? getAspirateAirGapVolumeRange(state.pipette, state.tipRack)
+      : getDispenseAirGapVolumeRange(
+          state.volume,
+          state?.disposalVolume ?? 0,
+          state.path,
+          state.pipette,
+          state.tipRack
+        )
+
+  const volumeRange = { min, max }
   let volumeError = null
   if (volumeRange.min > volumeRange.max) {
     volumeError = t('air_gap_capacity_error')

app/src/organisms/ODD/QuickTransferFlow/QuickTransferAdvancedSettings/__tests__/AirGap.test.tsx

@@ -76,7 +76,7 @@ describe('AirGap', () => {
     fireEvent.click(screen.getByRole('button', { name: '1' }))
     fireEvent.click(screen.getByRole('button', { name: '1' }))
     fireEvent.click(screen.getByText('Save'))
-    screen.getByText('Value must be between 1 to 5')
+    screen.getByText('Value must be between 0 to 9')
   })
 
   it('should call dispatch when clicking save button aspirate', () => {

app/src/organisms/ODD/QuickTransferFlow/__tests__/QuickTransferAdvancedSettings/AirGap.test.tsx

@@ -49,6 +49,9 @@ describe('AirGap', () => {
           ] as any,
         } as any,
         tipRack: {
+          parameters: {
+            isTiprack: true,
+          },
           wells: {
             A1: {
               totalLiquidVolume: 200,
@@ -119,15 +122,16 @@ describe('AirGap', () => {
     fireEvent.click(enabledBtn)
     const continueBtn = screen.getByText('Continue')
     fireEvent.click(continueBtn)
-    const numButton = screen.getByText('0')
-    fireEvent.click(numButton)
+    fireEvent.click(screen.getByText('2'))
+    fireEvent.click(screen.getByText('0'))
+    fireEvent.click(screen.getByText('0'))
     expect(vi.mocked(InputField)).toHaveBeenCalledWith(
       {
         title: 'Air gap volume (µL)',
-        error: 'Value must be between 1 to 180',
+        error: 'Value must be between 0 to 195',
         readOnly: true,
         type: 'number',
-        value: 0,
+        value: 200,
       },
       {}
     )
@@ -153,7 +157,7 @@ describe('AirGap', () => {
     expect(vi.mocked(InputField)).toHaveBeenCalledWith(
       {
         title: 'Air gap volume (µL)',
-        error: 'Value must be between 1 to 80',
+        error: null,
         readOnly: true,
         type: 'number',
         value: 0,
@@ -180,7 +184,7 @@ describe('AirGap', () => {
     expect(vi.mocked(InputField)).toHaveBeenCalledWith(
       {
         title: 'Air gap volume (µL)',
-        error: 'Value must be between 1 to 140',
+        error: null,
         readOnly: true,
         type: 'number',
         value: 0,
@@ -205,7 +209,7 @@ describe('AirGap', () => {
     expect(vi.mocked(InputField)).toHaveBeenCalledWith(
       {
         title: 'Air gap volume (µL)',
-        error: 'Value must be between 1 to 200',
+        error: null,
         readOnly: true,
         type: 'number',
         value: 0,

app/src/organisms/ODD/QuickTransferFlow/utils/getAspirateAirGapVolumeRange.ts

@@ -0,0 +1,26 @@
+import { getTiprackVolume } from '@opentrons/shared-data'
+
+import type { LabwareDefinition2, PipetteV2Specs } from '@opentrons/shared-data'
+
+interface VolumeRange {
+  min: number
+  max: number
+}
+
+export const getAspirateAirGapVolumeRange = (
+  pipette: PipetteV2Specs,
+  tipRack: LabwareDefinition2
+): VolumeRange => {
+  const minPipetteVolume = Object.values(pipette.liquids)[0].minVolume
+  const maxPipetteVolume = Object.values(pipette.liquids)[0].maxVolume
+  const minAirGapVolume = 0
+  const tipRackTipVol = getTiprackVolume(tipRack)
+
+  const maxAirGapVolume =
+    Math.min(maxPipetteVolume, tipRackTipVol) - minPipetteVolume
+
+  return {
+    min: minAirGapVolume,
+    max: maxAirGapVolume,
+  }
+}

app/src/organisms/ODD/QuickTransferFlow/utils/getDispenseAirGapVolumeRange.ts

@@ -0,0 +1,28 @@
+import { getTiprackVolume } from '@opentrons/shared-data'
+
+import type { LabwareDefinition2, PipetteV2Specs } from '@opentrons/shared-data'
+import type { PathOption } from '../types'
+
+interface VolumeRange {
+  min: number
+  max: number
+}
+
+export const getDispenseAirGapVolumeRange = (
+  volume: number,
+  disposalVolume: number,
+  path: PathOption,
+  pipette: PipetteV2Specs,
+  tipRack: LabwareDefinition2
+): VolumeRange => {
+  const maxPipetteVolume = Object.values(pipette.liquids)[0].maxVolume
+  const minAirGapVolume = 0
+  const tipRackTipVol = getTiprackVolume(tipRack)
+  const capacity = Math.min(maxPipetteVolume, tipRackTipVol)
+  const maxAirGapVolume =
+    path === 'multiDispense' ? capacity - disposalVolume - volume : capacity
+  return {
+    min: minAirGapVolume,
+    max: maxAirGapVolume,
+  }
+}

app/src/organisms/ODD/QuickTransferFlow/utils/index.ts

@@ -2,7 +2,9 @@ export { checkLiquidClassCompatibility } from './checkLiquidClassCompatibility'
 export { createQuickTransferFile } from './createQuickTransferFile'
 export { generateCompatibleLabwareForPipette } from './generateCompatibleLabwareForPipette'
 export { generateQuickTransferArgs } from './generateQuickTransferArgs'
+export { getAspirateAirGapVolumeRange } from './getAspirateAirGapVolumeRange'
 export { getCompatibleLabwareByCategory } from './getCompatibleLabwareByCategory'
+export { getDispenseAirGapVolumeRange } from './getDispenseAirGapVolumeRange'
 export { getInitialSummaryState } from './getInitialSummaryState'
 export { getMaxConditioningVolume } from './getMaxConditioningVolume'
 export { getMaxUiFlowRate } from './getMaxUiFlowRate'