Merge back 'chore_release-pd-8.6.3' into 'chore_release-8.8.0' (#20028)

Resolved conflicts:
- protocol-designer/release-notes.md

Author: ddcc4

app/src/organisms/ErrorRecoveryFlows/hooks/useDeckMapUtils.ts

@@ -23,7 +23,7 @@ import type {
   CutoutConfigProtocolSpec,
   DeckDefinition,
   LabwareDefinition,
-  LabwareDefinitionsByUri,
+  LabwareDefinitionsByURI,
   LabwareLocation,
   LoadedLabware,
   LoadedModule,
@@ -415,7 +415,7 @@ export function getRunCurrentLabwareInfo({
 
 const getLabwareDefinition = (
   labware: LoadedLabware,
-  protocolLabwareDefinitionsByUri: LabwareDefinitionsByUri
+  protocolLabwareDefinitionsByUri: LabwareDefinitionsByURI
 ): LabwareDefinition => {
   if (labware.id === 'fixedTrash') {
     return getFixedTrashLabwareDefinition()

app/src/organisms/InterventionModal/__fixtures__/index.ts

@@ -7,7 +7,7 @@ import {
 import type { RunData } from '@opentrons/api-client'
 import type {
   LabwareDefinition,
-  LabwareDefinitionsByUri,
+  LabwareDefinitionsByURI,
   Liquid,
   LoadedLabware,
   LoadedModule,
@@ -171,7 +171,7 @@ export const mockLabwareDefinition = {
 
 export const mockLabwareDefinitionsByUri = {
   'opentrons/nest_96_wellplate_100ul_pcr_full_skirt/1': mockLabwareDefinition,
-} as LabwareDefinitionsByUri
+} as LabwareDefinitionsByURI
 
 export const mockModule: LoadedModule = {
   id: 'mockModuleID',

app/src/organisms/InterventionModal/utils/getRunModuleRenderInfo.ts

@@ -10,7 +10,7 @@ import type { Module } from '@opentrons/components'
 import type {
   DeckDefinition,
   LabwareDefinition,
-  LabwareDefinitionsByUri,
+  LabwareDefinitionsByURI,
   ModuleDefinition,
 } from '@opentrons/shared-data'
 
@@ -33,7 +33,7 @@ export interface RunModuleInfo {
 export function getRunModuleRenderInfo(
   runData: RunData,
   deckDef: DeckDefinition,
-  labwareDefs: LabwareDefinitionsByUri
+  labwareDefs: LabwareDefinitionsByURI
 ): RunModuleInfo[] {
   if (runData.modules.length > 0) {
     return runData.modules.reduce<RunModuleInfo[]>((acc, module) => {

protocol-designer/release-notes.md

@@ -8,11 +8,11 @@ By using Opentrons Protocol Designer, you agree to the Opentrons End-User Licens
 
 ---
 
-## Opentrons Protocol Designer Changes in 8.6.2
+## Opentrons Protocol Designer Changes in 8.6.3
 
-**Welcome to Protocol Designer 8.6.2!**
+**Welcome to Protocol Designer 8.6.3!**
 
-This hotfix release improves bug tracking for future software updates.
+This hotfix release addresses issues when uploading protocols containing custom labware.
 
 ## Opentrons Protocol Designer Changes in 8.6.1
 

protocol-designer/src/labware-defs/types.ts

@@ -1,6 +1,9 @@
-import type { LabwareDefinition2 } from '@opentrons/shared-data'
+import type {
+  LabwareDef2ByDefURI,
+  LabwareDefinition2,
+} from '@opentrons/shared-data'
 
-export type LabwareDefByDefURI = Record<string, LabwareDefinition2>
+export type LabwareDefByDefURI = LabwareDef2ByDefURI
 export type LabwareUploadMessageType =
   | 'INVALID_JSON_FILE'
   | 'NOT_JSON'

protocol-designer/src/labware-ingred/utils.ts

@@ -145,9 +145,18 @@ export const getMigratedLabwareId = (
   const latestURI = Object.entries(latestDefs).find(
     ([_, def]) => def.parameters.loadName === loadName
   )?.[0]
+
+  if (defURI == null) {
+    console.error(
+      `expected to find a matching defURI with labwareId ${oldLabwareId} but could not`
+    )
+  }
+
   const labwareIdString = oldLabwareId.split(':')[0]
   const latestLabwareId =
-    latestURI != null ? `${labwareIdString}:${latestURI}` : oldLabwareId // fallback to original labwareId for custom labware
+    latestURI != null
+      ? `${labwareIdString}:${latestURI}`
+      : `${labwareIdString}:${defURI}` // fallback to original labwareId & defURI for custom labware
 
   return latestLabwareId
 }

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

@@ -87,7 +87,12 @@ const getClippedFlowRateForMoveLiquid = (args: {
   const tipLiquidSpecs = liquidClass?.byPipette
     .find(byPipette => byPipette.pipetteModel === pipetteName)
     ?.byTipType.find(byTipType => byTipType.tiprack === tiprack)
+  // TODO: this won't find the definition for a custom tiprack
   const tiprackDef = getAllDefinitions()[tiprack]
+  console.assert(
+    tiprackDef != null,
+    `could not find labware definition for ${tiprack}`
+  )
   let correctionVolume: number = 0
   if (tipLiquidSpecs != null && flowRateType !== 'blowout') {
     const liquidClassLookup =
@@ -130,7 +135,7 @@ const getClippedFlowRateForMoveLiquid = (args: {
   const matchingTipLiquidSpecs = getMatchingTipLiquidSpecsFromSpec(
     pipetteSpecs,
     volume,
-    formData.tipRack as string
+    tiprackDef
   )
 
   const shaftULperMM = pipetteSpecs?.shaftULperMM

protocol-designer/src/utils/index.ts

@@ -189,21 +189,14 @@ export const getStagingAreaAddressableAreas = (
 export function getMatchingTipLiquidSpecsFromSpec(
   pipetteSpecs: PipetteV2Specs,
   volume: number,
-  tiprackUri: string
+  tiprackDef: LabwareDefinition2
 ): SupportedTip {
-  const matchingLabwareDef = getAllDefinitions()[tiprackUri]
-
-  console.assert(
-    matchingLabwareDef,
-    `expected to find a matching labware def with tiprack ${tiprackUri} but could not`
-  )
-
-  const tipLength = matchingLabwareDef?.parameters.tipLength ?? 0
+  const tipLength = tiprackDef?.parameters.tipLength ?? 0
 
   if (tipLength === 0) {
     console.error(
       `expected to find a tiplength with tiprack ${
-        matchingLabwareDef?.metadata.displayName ?? 'unknown displayName'
+        tiprackDef?.metadata.displayName ?? 'unknown displayName'
       } but could not`
     )
   }
@@ -229,7 +222,7 @@ export function getMatchingTipLiquidSpecsFromSpec(
   console.assert(
     matchingTipLiquidSpecs,
     `expected to find the tip liquid specs but could not with pipette tiprack displayname ${
-      matchingLabwareDef?.metadata.displayName ?? 'unknown displayname'
+      tiprackDef?.metadata.displayName ?? 'unknown displayname'
     }`
   )
 

shared-data/js/helpers/getLabwareDefinitionsByURIForProtocol.ts

@@ -7,11 +7,7 @@ import type {
   LoadLidStackRunTimeCommand,
   RunTimeCommand,
 } from '../../protocol'
-import type { LabwareDefinition } from '../types'
-
-export interface LabwareDefinitionsByURI {
-  [labwareDefURI: string]: LabwareDefinition
-}
+import type { LabwareDefinition, LabwareDefinitionsByURI } from '../types'
 
 const defPair = (
   maybeDef?: LabwareDefinition

shared-data/js/helpers/getLoadedLabwareDefinitionsByUri.ts

@@ -1,14 +1,14 @@
 import { getLabwareDefURI } from '.'
 
-import type { LabwareDefinition, RunTimeCommand } from '..'
-
-export interface LabwareDefinitionsByUri {
-  [defURI: string]: LabwareDefinition
-}
+import type {
+  LabwareDefinition,
+  LabwareDefinitionsByURI,
+  RunTimeCommand,
+} from '..'
 
 export function getLoadedLabwareDefinitionsByUri(
   commands: RunTimeCommand[]
-): LabwareDefinitionsByUri {
+): LabwareDefinitionsByURI {
   return commands.reduce((acc, command) => {
     if (
       command.commandType === 'loadLabware' ||