fix(protocol-designer): remove command references from 8_5_0 migration (#18862)

Author: jerader

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

@@ -4,6 +4,7 @@ import min from 'lodash/min'
 
 import {
   FLEX_ROBOT_TYPE,
+  getAllLabwareDefs,
   getPipetteSpecsV2,
   POSITION_REFERENCE_BOTTOM,
   POSITION_REFERENCE_TOP,
@@ -16,12 +17,10 @@ import {
   PROTOCOL_DESIGNER_SOURCE,
 } from '../../constants'
 import { getDefaultBlowoutFlowRate, getDefaultPushOutVolume } from '../../utils'
-import { getEquipmentLoadInfoFromCommands } from './utils/getEquipmentLoadInfoFromCommands'
 import { getMigratedPositionFromTop } from './utils/getMigrationPositionFromTop'
 
 import type {
   LabwareDefinition2,
-  LoadLabwareCreateCommand,
   PipetteV2Specs,
   ProtocolFile,
 } from '@opentrons/shared-data'
@@ -56,21 +55,25 @@ const getMigratedBlowoutLocation = (
 export const migrateFile = (
   appData: ProtocolFile<PDMetadata>
 ): ProtocolFile<PDMetadata> => {
-  const { designerApplication, commands, labwareDefinitions, robot } = appData
+  const { designerApplication, robot, labwareDefinitions } = appData
   if (designerApplication == null || designerApplication?.data == null) {
     throw Error('The designerApplication key in your file is corrupt.')
   }
-  const { savedStepForms, ingredients } = designerApplication.data
+  const {
+    savedStepForms,
+    ingredients,
+    labware,
+    pipettes,
+  } = designerApplication.data
   const { model: robotType } = robot
-  const loadLabwareCommands = commands.filter(
-    (command): command is LoadLabwareCreateCommand =>
-      command.commandType === 'loadLabware'
-  )
-  const equipmentLoadInfoFromCommands = getEquipmentLoadInfoFromCommands(
-    commands,
-    labwareDefinitions
-  )
 
+  const allLabwareDefsByURI =
+    //  read the labware definitions key first
+    //  otherwise map to all labware defs as a fallback
+    //  for OpentronsAI
+    Object.values(labwareDefinitions).length > 0
+      ? labwareDefinitions
+      : getAllLabwareDefs()
   const migratedIngredients: Ingredients = Object.entries(
     ingredients
   ).reduce<Ingredients>((acc, [id, ingredient]) => {
@@ -127,19 +130,17 @@ export const migrateFile = (
         blowout_z_offset,
         ...rest
       } = form
-      const aspirateLabwareUri =
-        equipmentLoadInfoFromCommands.labware[aspirate_labware].labwareDefURI
-      const isAspirateLabwareTouchtipDisabled = labwareDefinitions[
+      const aspirateLabwareUri = labware[aspirate_labware].labwareDefURI
+      const isAspirateLabwareTouchtipDisabled = allLabwareDefsByURI[
         aspirateLabwareUri
       ].parameters.quirks?.includes('touchTipDisabled')
-      const dispenseLabwareUri =
-        equipmentLoadInfoFromCommands.labware[dispense_labware]?.labwareDefURI
+      const dispenseLabwareUri = labware[dispense_labware]?.labwareDefURI
 
       const isDispenseLabwareTouchtipDisabled =
         //  dispense is in a waste chute/trash bin
-        labwareDefinitions[dispenseLabwareUri] == null
+        allLabwareDefsByURI[dispenseLabwareUri] == null
           ? true
-          : labwareDefinitions[dispenseLabwareUri].parameters.quirks?.includes(
+          : allLabwareDefsByURI[dispenseLabwareUri].parameters.quirks?.includes(
               'touchTipDisabled'
             )
 
@@ -148,21 +149,19 @@ export const migrateFile = (
         firstTrashBinOrWasteChuteId
       )
       const matchingAspirateLabwareWellDepth = getMigratedPositionFromTop(
-        labwareDefinitions,
-        loadLabwareCommands,
+        allLabwareDefsByURI,
         aspirate_labware as string,
+        labware,
         'aspirate'
       )
       const matchingDispenseLabwareWellDepth = getMigratedPositionFromTop(
-        labwareDefinitions,
-        loadLabwareCommands,
+        allLabwareDefsByURI,
         dispense_labware as string,
+        labware,
         'dispense'
       )
-      const tipRackDef = labwareDefinitions[form.tipRack]
-      const pipetteName =
-        equipmentLoadInfoFromCommands.pipettes?.[form.pipette]?.pipetteName ??
-        null
+      const tipRackDef = allLabwareDefsByURI[form.tipRack]
+      const pipetteName = pipettes?.[form.pipette]?.pipetteName ?? null
       const pipetteSpecs =
         pipetteName != null ? getPipetteSpecsV2(pipetteName) : null
       const defaultPushOutVolume =
@@ -272,20 +271,17 @@ export const migrateFile = (
         const {
           id,
           mix_touchTip_mmFromBottom,
-          labware,
+          labware: formLabware,
           liquidClassesSupported,
           mix_touchTip_checkbox,
           ...rest
         } = form
-        const tipRackDef = labwareDefinitions[form.tipRack]
-        const mixLabwareUri =
-          equipmentLoadInfoFromCommands.labware[labware].labwareDefURI
-        const isLabwareTouchtipDisabled = labwareDefinitions[
+        const tipRackDef = allLabwareDefsByURI[form.tipRack]
+        const mixLabwareUri = labware[formLabware].labwareDefURI
+        const isLabwareTouchtipDisabled = allLabwareDefsByURI[
           mixLabwareUri
         ].parameters.quirks?.includes('touchTipDisabled')
-        const pipetteName =
-          equipmentLoadInfoFromCommands.pipettes?.[form.pipette]?.pipetteName ??
-          null
+        const pipetteName = pipettes?.[form.pipette]?.pipetteName ?? null
         const pipetteSpecs =
           pipetteName != null ? getPipetteSpecsV2(pipetteName) : null
         const defaultPushOutVolume =
@@ -298,9 +294,9 @@ export const migrateFile = (
               )
 
         const matchingLabwareWellDepth = getMigratedPositionFromTop(
-          labwareDefinitions,
-          loadLabwareCommands,
-          labware as string,
+          allLabwareDefsByURI,
+          formLabware as string,
+          labware,
           'mix'
         )
 
@@ -321,7 +317,7 @@ export const migrateFile = (
           [id]: {
             ...rest,
             id,
-            labware,
+            labware: formLabware,
             mix_touchTip_checkbox: isLabwareTouchtipDisabled
               ? false
               : mix_touchTip_checkbox,

protocol-designer/src/load-file/migration/utils/getMigrationPositionFromTop.ts

@@ -1,44 +1,33 @@
-import type {
-  LabwareDefinition2,
-  LoadLabwareCreateCommand,
-} from '@opentrons/shared-data'
+import type { LabwareDefinition2 } from '@opentrons/shared-data'
+import type { Labware } from '../../../file-types'
 import type { MoveLiquidPrefixType } from '../../../resources/types'
 
 export const getMigratedPositionFromTop = (
-  labwareDefinitions: {
-    [definitionId: string]: LabwareDefinition2
-  },
-  loadLabwareCommands: LoadLabwareCreateCommand[],
-  labware: string,
+  labwareDefsByURI: Record<string, LabwareDefinition2>,
+  formLabwareId: string,
+  labware: Labware,
   type: MoveLiquidPrefixType
 ): number => {
-  const matchingLoadLabware = loadLabwareCommands.find(
-    command =>
-      command.commandType === 'loadLabware' &&
-      command.params.labwareId === labware
-  )
-  if (matchingLoadLabware == null) {
+  const labwareDefUri = labware[formLabwareId].labwareDefURI
+
+  if (labwareDefUri == null) {
     console.error(
-      `expected to find matching ${type} labware load command but could not with ${type}_labware from form data as ${labware}`
+      `unable to find matching labware def uri from form labware id ${formLabwareId}`
     )
   }
-  const labwareUri =
-    matchingLoadLabware != null
-      ? `${matchingLoadLabware.params.namespace}/${matchingLoadLabware.params.loadName}/${matchingLoadLabware.params.version}`
-      : ''
 
   //    early exit for dispense_labware equaling trashBin or wasteChute
-  if (labwareDefinitions[labwareUri] == null) {
+  if (labwareDefsByURI[labwareDefUri] == null) {
     return 0
   }
 
-  const matchingLabwareWellDepth = labwareUri
-    ? labwareDefinitions[labwareUri].wells.A1.depth
+  const matchingLabwareWellDepth = labwareDefUri
+    ? labwareDefsByURI[labwareDefUri].wells.A1.depth
     : 0
 
   if (matchingLabwareWellDepth === 0) {
     console.error(
-      `error in finding the ${type} labware well depth with labware uri ${labwareUri}`
+      `error in finding the ${type} labware well depth with labware uri ${labwareDefUri}`
     )
   }
   return matchingLabwareWellDepth