fix(protocol-designer): default the nozzle field value correctly (#18520)

closes RQA-4228

Author: jerader

protocol-designer/src/step-forms/utils/createPresavedStepForm.ts

@@ -74,6 +74,8 @@ const _patchDefaultPipette = (args: {
     orderedStepIds,
     initialDeckSetup.pipettes
   )
+  const hasPartialTipSupportedChannel =
+    pipetteEntities[defaultPipetteId]?.spec.channels !== 1
   // If there is a `pipette` field in the form,
   // then set `pipette` field of new steps to the next default pipette id.
   //
@@ -85,32 +87,7 @@ const _patchDefaultPipette = (args: {
     const updatedFields = handleFormChange(
       {
         pipette: defaultPipetteId,
-      },
-      formData,
-      pipetteEntities,
-      labwareEntities
-    )
-    return updatedFields
-  }
-
-  return null
-}
-
-const _patchDefaultNozzle = (args: {
-  labwareEntities: LabwareEntities
-  pipetteEntities: PipetteEntities
-}): FormUpdater => formData => {
-  const { labwareEntities, pipetteEntities } = args
-  const hasPartialTipSupportedChannel = Object.values(pipetteEntities).find(
-    pip => pip.spec.channels === 96 || pip.spec.channels === 8
-  )
-
-  const formHasNozzlesField = formData && 'nozzles' in formData
-
-  if (formHasNozzlesField && hasPartialTipSupportedChannel) {
-    const updatedFields = handleFormChange(
-      {
-        nozzles: ALL,
+        nozzles: hasPartialTipSupportedChannel ? ALL : null,
       },
       formData,
       pipetteEntities,
@@ -439,11 +416,6 @@ export const createPresavedStepForm = ({
     stepType,
   })
 
-  const updateDefaultNozzles = _patchDefaultNozzle({
-    labwareEntities,
-    pipetteEntities,
-  })
-
   const updateDefaultDropTip = _patchDefaultDropTipLocation({
     labwareEntities,
     pipetteEntities,
@@ -516,7 +488,6 @@ export const createPresavedStepForm = ({
     updateAbsorbanceReaderModuleId,
     updateDefaultLabwareLocations,
     updateMoveLabwareFields,
-    updateDefaultNozzles,
   ].reduce<FormData>(
     (acc, updater: FormUpdater) => {
       const updates = updater(acc)

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

@@ -1,5 +1,7 @@
 import pick from 'lodash/pick'
 
+import { ALL, SINGLE } from '@opentrons/shared-data'
+
 import { getDefaultsForStepType } from '../getDefaultsForStepType'
 import {
   chainPatchUpdaters,
@@ -9,6 +11,7 @@ import {
   getDefaultWells,
 } from './utils'
 
+import type { NozzleConfigurationStyle } from '@opentrons/shared-data'
 import type {
   LabwareEntities,
   PipetteEntities,
@@ -56,39 +59,21 @@ const updatePatchOnPipetteChannelChange = (
 ): FormPatch => {
   if (patch.pipette === undefined) return patch
   let update = {}
-  const prevChannels = getChannels(rawForm.pipette as string, pipetteEntities)
-  const nChannels =
+  const previousChannels = getChannels(
+    rawForm.pipette as string,
+    pipetteEntities
+  )
+  const nextChannels =
     typeof patch.pipette === 'string'
-      ? getChannels(patch.pipette, pipetteEntities)
+      ? getChannels(patch.pipette as string, pipetteEntities)
       : null
+
   const appliedPatch = { ...rawForm, ...patch }
-  let previousChannels = prevChannels
-  if (
-    rawForm.stepType === 'moveLiquid' ||
-    (rawForm.stepType === 'mix' && prevChannels === 96)
-  ) {
-    if (rawForm.nozzles === 'full') {
-      previousChannels = 96
-    } else {
-      previousChannels = 8
-    }
-  }
-  let nextChannels = nChannels
-  if (
-    rawForm.stepType === 'moveLiquid' ||
-    (rawForm.stepType === 'mix' && nChannels === 96)
-  ) {
-    if (rawForm.nozzles === 'full') {
-      nextChannels = 96
-    } else {
-      nextChannels = 8
-    }
-  }
 
   const singleToMulti =
-    previousChannels === 1 && (nextChannels === 8 || nextChannels === 96)
+    previousChannels === 1 && nextChannels === 8 && patch.nozzles !== SINGLE
   const multiToSingle =
-    (previousChannels === 8 || previousChannels === 96) && nextChannels === 1
+    previousChannels === 8 && rawForm.nozzles !== SINGLE && nextChannels === 1
 
   if (patch.pipette === null || singleToMulti) {
     // reset all well selection
@@ -102,17 +87,6 @@ const updatePatchOnPipetteChannelChange = (
       }),
     }
   } else if (multiToSingle) {
-    let channels: 8 | 96 = 8
-    if (
-      rawForm.stepType === 'moveLiquid' ||
-      (rawForm.stepType === 'mix' && prevChannels === 96)
-    ) {
-      if (rawForm.nozzles === 'full') {
-        channels = 96
-      } else {
-        channels = 8
-      }
-    }
     // multi-channel to single-channel: convert primary wells to all wells
     const labwareId = appliedPatch.labware
 
@@ -122,7 +96,7 @@ const updatePatchOnPipetteChannelChange = (
         wells: getAllWellsFromPrimaryWells(
           appliedPatch.wells as string[],
           labwareDef,
-          channels
+          previousChannels
         ),
       }
     }
@@ -133,19 +107,25 @@ const updatePatchOnPipetteChannelChange = (
 
 const updatePatchOnPipetteChange = (
   patch: FormPatch,
-  rawForm: FormData
+  rawForm: FormData,
+  pipetteEntities: PipetteEntities
 ): FormPatch => {
   // when pipette ID is changed (to another ID, or to null),
   // set any flow rates to null
   if (fieldHasChanged(rawForm, patch, 'pipette')) {
+    let nozzles: NozzleConfigurationStyle | null = null
+    const newPipette = patch.pipette
+
+    if (typeof newPipette === 'string' && newPipette in pipetteEntities) {
+      const hasPartialTipSupportedChannel =
+        pipetteEntities[newPipette].spec.channels !== 1
+      nozzles = hasPartialTipSupportedChannel ? ALL : null
+    }
+
     return {
       ...patch,
-      ...getDefaultFields(
-        'aspirate_flowRate',
-        'dispense_flowRate',
-        'tipRack',
-        'nozzles'
-      ),
+      ...getDefaultFields('aspirate_flowRate', 'dispense_flowRate', 'tipRack'),
+      nozzles,
     }
   }
 
@@ -166,23 +146,6 @@ const updatePatchOnTiprackChange = (
   return patch
 }
 
-const updatePatchOnNozzleChange = (
-  patch: FormPatch,
-  rawForm: FormData,
-  pipetteEntities: PipetteEntities
-): FormPatch => {
-  if (
-    Object.values(pipetteEntities).find(pip => pip.spec.channels === 96) &&
-    fieldHasChanged(rawForm, patch, 'nozzles')
-  ) {
-    return {
-      ...patch,
-      ...getDefaultFields('wells'),
-    }
-  }
-  return patch
-}
-
 export function dependentFieldsUpdateMix(
   originalPatch: FormPatch,
   rawForm: FormData, // raw = NOT hydrated
@@ -205,9 +168,8 @@ export function dependentFieldsUpdateMix(
         labwareEntities,
         pipetteEntities
       ),
-    chainPatch => updatePatchOnPipetteChange(chainPatch, rawForm),
-    chainPatch => updatePatchOnTiprackChange(chainPatch, rawForm),
     chainPatch =>
-      updatePatchOnNozzleChange(chainPatch, rawForm, pipetteEntities),
+      updatePatchOnPipetteChange(chainPatch, rawForm, pipetteEntities),
+    chainPatch => updatePatchOnTiprackChange(chainPatch, rawForm),
   ])
 }

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

@@ -2,7 +2,7 @@ import clamp from 'lodash/clamp'
 import pick from 'lodash/pick'
 import round from 'lodash/round'
 
-import { getPipetteSpecsV2 } from '@opentrons/shared-data'
+import { ALL, getPipetteSpecsV2, SINGLE } from '@opentrons/shared-data'
 import {
   DEST_WELL_BLOWOUT_DESTINATION,
   SOURCE_WELL_BLOWOUT_DESTINATION,
@@ -26,6 +26,7 @@ import {
   volumeInCapacityForMulti,
 } from './utils'
 
+import type { NozzleConfigurationStyle } from '@opentrons/shared-data'
 import type {
   LabwareEntities,
   PipetteEntities,
@@ -236,10 +237,14 @@ const updatePatchOnPipetteChange = (
   if (fieldHasChanged(rawForm, patch, 'pipette')) {
     const newPipette = patch.pipette
     let airGapVolume: string | null = null
+    let nozzles: NozzleConfigurationStyle | null = null
 
     if (typeof newPipette === 'string' && newPipette in pipetteEntities) {
       const minVolume = getMinPipetteVolume(pipetteEntities[newPipette])
       airGapVolume = minVolume.toString()
+      const hasPartialTipSupportedChannel =
+        pipetteEntities[newPipette].spec.channels !== 1
+      nozzles = hasPartialTipSupportedChannel ? ALL : null
     }
 
     return {
@@ -252,9 +257,9 @@ const updatePatchOnPipetteChange = (
         'disposalVolume_volume',
         'aspirate_mmFromBottom',
         'dispense_mmFromBottom',
-        'nozzles',
         'tipRack'
       ),
+      nozzles,
       aspirate_airGap_volume: airGapVolume,
       dispense_airGap_volume: airGapVolume,
     }
@@ -501,22 +506,27 @@ const updatePatchOnPipetteChannelChange = (
 ): FormPatch => {
   if (patch.pipette === undefined) return patch
   let update: FormPatch = {}
-  const prevChannels = getChannels(rawForm.pipette as string, pipetteEntities)
+  const previousChannels = getChannels(
+    rawForm.pipette as string,
+    pipetteEntities
+  )
   const nextChannels =
     typeof patch.pipette === 'string'
       ? getChannels(patch.pipette, pipetteEntities)
       : null
+
   const { id, stepType, ...stepData } = rawForm
   const appliedPatch: FormPatch = {
     ...(stepData as FormPatch),
     ...patch,
     id,
     stepType,
   }
+
   const singleToMulti =
-    prevChannels === 1 && (nextChannels === 8 || nextChannels === 96)
+    previousChannels === 1 && nextChannels === 8 && patch.nozzles !== SINGLE
   const multiToSingle =
-    (prevChannels === 8 || prevChannels === 96) && nextChannels === 1
+    previousChannels === 8 && rawForm.nozzles !== SINGLE && nextChannels === 1
 
   const pipetteId: string = appliedPatch.pipette as string
 
@@ -539,10 +549,6 @@ const updatePatchOnPipetteChannelChange = (
       }),
     }
   } else if (multiToSingle) {
-    let channels = 8
-    if (prevChannels === 96) {
-      channels = 96
-    }
     // multi-channel to single-channel: convert primary wells to all wells
     const sourceLabwareId: string = appliedPatch.aspirate_labware as string
     const destLabwareId: string = appliedPatch.dispense_labware as string
@@ -554,7 +560,7 @@ const updatePatchOnPipetteChannelChange = (
         aspirate_wells: getAllWellsFromPrimaryWells(
           appliedPatch.aspirate_wells as string[],
           sourceLabware.def,
-          channels as 8 | 96
+          previousChannels
         ),
         dispense_wells:
           destLabwareId.includes('trashBin') ||
@@ -568,7 +574,7 @@ const updatePatchOnPipetteChannelChange = (
             : getAllWellsFromPrimaryWells(
                 appliedPatch.dispense_wells as string[],
                 destLabware.def,
-                channels as 8 | 96
+                previousChannels
               ),
       }
     }

protocol-designer/src/steplist/formLevel/handleFormChange/test/mix.test.ts

@@ -1,5 +1,6 @@
 import { beforeEach, describe, expect, it } from 'vitest'
 
+import { ALL } from '@opentrons/shared-data'
 import {
   fixture_96_plate,
   fixture_tiprack_10_ul,
@@ -110,7 +111,7 @@ describe('well selection should update', () => {
       wells: [],
       aspirate_flowRate: null,
       dispense_flowRate: null,
-      nozzles: null,
+      nozzles: ALL,
       tipRack: null,
     })
   })