refactor(protocol-designer): merge getMatchingTipLiquidSpecs() and getMatchingTipLiquidSpecsFromSpec() (#20048)

# Overview

The last one!

Back in PR #19041, @ncdiehl introduced `getMatchingTipLiquidSpecsFromSpec()`,
which was almost an exact a copy of `getMatchingTipLiquidSpecs()`
except that it looked up the tiprack definition differently, because
Nick's `getMatchingTipLiquidSpecsFromSpec()` did not have access to the
`PipetteEntity.tiprackLabwareDef`.

After the recent refactorings, the caller passes in the tiprack
definition into both `getMatchingTipLiquidSpecs()` and
`getMatchingTipLiquidSpecsFromSpec()`, so now there is no difference
between the 2 functions anymore.

So this PR merges the 2 functions together and eliminates
`getMatchingTipLiquidSpecsFromSpec()`.

## Test Plan and Hands on Testing

Run CI tests.

## Risk assessment

Low.

Author: ddcc4

protocol-designer/src/load-file/migration/8_5_0.ts

@@ -26,7 +26,7 @@ import { getMaxUiFlowRate } from '../../pages/Designer/ProtocolSteps/StepForm/Pi
 import {
   getDefaultBlowoutFlowRate,
   getDefaultPushOutVolume,
-  getMatchingTipLiquidSpecsFromSpec,
+  getMatchingTipLiquidSpecs,
 } from '../../utils'
 import { getMigratedPositionFromTop } from './utils/getMigrationPositionFromTop'
 
@@ -132,7 +132,7 @@ const getClippedFlowRateForMoveLiquid = (args: {
       ) ?? 0
   }
 
-  const matchingTipLiquidSpecs = getMatchingTipLiquidSpecsFromSpec(
+  const matchingTipLiquidSpecs = getMatchingTipLiquidSpecs(
     pipetteSpecs,
     volume,
     tiprackDef

protocol-designer/src/pages/Designer/ProtocolSteps/StepForm/PipetteFields/FlowRateField.tsx

@@ -67,7 +67,7 @@ export function FlowRateField(props: FlowRateFieldProps): JSX.Element {
 
   const matchingTipLiquidSpecs =
     pipette != null && tiprack != null
-      ? getMatchingTipLiquidSpecs(pipette, volume as number, tiprackDef)
+      ? getMatchingTipLiquidSpecs(pipette.spec, volume as number, tiprackDef)
       : null
 
   let airGapByVolume: Array<[number, number]> = []

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

@@ -570,7 +570,7 @@ const getNoLiquidClassValuesMoveLiquid = (args: {
     const allOT2Defaults = getDefaultsForStepType('moveLiquid')
     const matchingTipLiquidSpecs =
       pipetteEntity != null
-        ? getMatchingTipLiquidSpecs(pipetteEntity, volume, tiprackDef)
+        ? getMatchingTipLiquidSpecs(pipetteEntity.spec, volume, tiprackDef)
         : null
     const aspirateOT2Defaults = {
       aspirate_wellOrder_first: allOT2Defaults.aspirate_wellOrder_first,
@@ -675,7 +675,7 @@ const getNoLiquidClassValuesMoveLiquid = (args: {
 
   const matchingTipLiquidSpecs =
     pipetteEntity != null
-      ? getMatchingTipLiquidSpecs(pipetteEntity, volume, tiprackDef)
+      ? getMatchingTipLiquidSpecs(pipetteEntity.spec, volume, tiprackDef)
       : null
 
   const aspirateCorrectionVolume =
@@ -870,7 +870,7 @@ const getNoLiquidClassValuesMix = (args: {
 
   const matchingTipLiquidSpecs =
     pipetteEntity != null
-      ? getMatchingTipLiquidSpecs(pipetteEntity, volume, tiprackDef)
+      ? getMatchingTipLiquidSpecs(pipetteEntity.spec, volume, tiprackDef)
       : null
   const aspirateCorrectionVolume =
     linearInterpolate(
@@ -1074,7 +1074,7 @@ const getLiquidClassValuesMoveLiquid = (args: {
   const aspirateOffsetFields = getOffsetFields(aspirateOffset, 'aspirate')
   const matchingTipLiquidSpecs =
     pipetteEntity != null
-      ? getMatchingTipLiquidSpecs(pipetteEntity, volume, tiprackDef)
+      ? getMatchingTipLiquidSpecs(pipetteEntity.spec, volume, tiprackDef)
       : null
 
   const aspirateCorrectionVolume =
@@ -1302,7 +1302,7 @@ const getLiquidClassValuesMix = (args: {
 
   const matchingTipLiquidSpecs =
     pipetteEntity != null
-      ? getMatchingTipLiquidSpecs(pipetteEntity, volume, tiprackDef)
+      ? getMatchingTipLiquidSpecs(pipetteEntity.spec, volume, tiprackDef)
       : null
 
   const aspirateCorrectionVolume =

protocol-designer/src/steplist/formLevel/stepFormToArgs/mixFormToArgs.ts

@@ -37,7 +37,7 @@ export const mixFormToArgs = (
     pushOut_volume,
   } = hydratedFormData
   const matchingTipLiquidSpecs = getMatchingTipLiquidSpecs(
-    pipette,
+    pipette?.spec,
     hydratedFormData.volume,
     hydratedFormData.tipRack
   )

protocol-designer/src/steplist/formLevel/stepFormToArgs/moveLiquidFormToArgs.ts

@@ -294,7 +294,7 @@ export const moveLiquidFormToArgs = (
     'dispense_airGap_volume'
   )
   const matchingTipLiquidSpecs = getMatchingTipLiquidSpecs(
-    hydratedFormData.pipette,
+    hydratedFormData.pipette?.spec,
     hydratedFormData.volume,
     tipRack
   )

protocol-designer/src/utils/index.ts

@@ -7,7 +7,6 @@ import {
   getTiprackVolume,
   INTERACTIVE_WELL_DATA_ATTRIBUTE,
   isAddressableAreaStandardSlot,
-  LOW_VOLUME_PIPETTES,
   makeWellSetHelpers,
   STAGING_AREA_RIGHT_SLOT_FIXTURE,
 } from '@opentrons/shared-data'
@@ -32,7 +31,6 @@ import type {
   AdditionalEquipmentEntity,
   LabwareEntities,
   PipetteEntities,
-  PipetteEntity,
 } from '@opentrons/step-generation'
 import type { BoundingRect, GenericRect } from '../collision-types'
 import type {
@@ -185,7 +183,7 @@ export const getStagingAreaAddressableAreas = (
   return addressableAreasRaw
 }
 
-export function getMatchingTipLiquidSpecsFromSpec(
+export function getMatchingTipLiquidSpecs(
   pipetteSpecs: PipetteV2Specs,
   volume: number,
   tiprackDef: LabwareDefinition2
@@ -203,7 +201,6 @@ export function getMatchingTipLiquidSpecsFromSpec(
   const isLowVolumePipette = Object.keys(pipetteSpecs.liquids).some(
     key => key === 'lowVolumeDefault'
   )
-
   const isUsingLowVolume = volume < 5
   const liquidType =
     isLowVolumePipette && isUsingLowVolume ? 'lowVolumeDefault' : 'default'
@@ -228,46 +225,6 @@ export function getMatchingTipLiquidSpecsFromSpec(
   return matchingTipLiquidSpecs
 }
 
-export function getMatchingTipLiquidSpecs(
-  pipetteEntity: PipetteEntity,
-  volume: number,
-  tiprackDef: LabwareDefinition2
-): SupportedTip {
-  const tipLength = tiprackDef?.parameters.tipLength ?? 0
-
-  if (tipLength === 0) {
-    console.error(
-      `expected to find a tiplength with tiprack ${
-        tiprackDef?.metadata.displayName ?? 'unknown displayName'
-      } but could not`
-    )
-  }
-
-  const isLowVolumePipette = LOW_VOLUME_PIPETTES.includes(pipetteEntity.name)
-  const isUsingLowVolume = volume < 5
-  const liquidType =
-    isLowVolumePipette && isUsingLowVolume ? 'lowVolumeDefault' : 'default'
-  const liquidSupportedTips = Object.values(
-    pipetteEntity.spec.liquids[liquidType].supportedTips
-  )
-
-  //  find the supported tip liquid specs that either exactly match
-  //  tipLength or are closest, this accounts for custom tipracks
-  const matchingTipLiquidSpecs = liquidSupportedTips.sort((tipA, tipB) => {
-    const differenceA = Math.abs(tipA.defaultTipLength - tipLength)
-    const differenceB = Math.abs(tipB.defaultTipLength - tipLength)
-    return differenceA - differenceB
-  })[0]
-  console.assert(
-    matchingTipLiquidSpecs,
-    `expected to find the tip liquid specs but could not with pipette tiprack displayname ${
-      tiprackDef?.metadata.displayName ?? 'unknown displayname'
-    }`
-  )
-
-  return matchingTipLiquidSpecs
-}
-
 /**
  * Removes specific phrases from the input string.
  *