fix(app): fix LPC error when loading a module into C2 (#18480)

Closes RESC-461

Loading a module, aka the mag block, into slot C2 causes LPC to error out when setting a default offset. Product + Design are working on a longer term solution, but in the interim, we want to include something for 8.5.

Select a default offset location for LPC based on slots that we know do not contain a module. We preferentially select C2 if available.

Author: mjhuff

app/src/organisms/LabwarePositionCheck/LPCFlows/hooks/useLPCLabwareInfo/getLPCLabwareInfoFrom/__tests__/getDefaultOffsetForLabware.test.ts

@@ -1,6 +1,7 @@
 import { vi, it, describe, expect } from 'vitest'
+
 import { ANY_LOCATION } from '@opentrons/api-client'
-import { getLabwareDefURI } from '@opentrons/shared-data'
+import { C2_ADDRESSABLE_AREA, getLabwareDefURI } from '@opentrons/shared-data'
 
 import { getDefaultOffsetDetailsForLabware } from '../getDefaultOffsetForLabware'
 import { OFFSET_KIND_DEFAULT } from '/app/redux/protocol-runs'
@@ -70,6 +71,24 @@ describe('getDefaultOffsetDetailsForLabware', () => {
         definitionUri: ADAPTER_URI,
       },
     ],
+    modules: [],
+  }
+
+  const MOCK_PROTOCOL_DATA_WITH_MODULES = {
+    labware: [
+      {
+        id: ADAPTER_ID,
+        definitionUri: ADAPTER_URI,
+      },
+    ],
+    modules: [
+      {
+        location: { slotName: 'C2' },
+      },
+      {
+        location: { slotName: 'A1' },
+      },
+    ],
   }
 
   it('should return default offset details with minimal params', () => {
@@ -89,7 +108,7 @@ describe('getDefaultOffsetDetailsForLabware', () => {
         labwareId: LABWARE_ID,
         definitionUri: LABWARE_URI,
         kind: OFFSET_KIND_DEFAULT,
-        addressableAreaName: 'C2',
+        addressableAreaName: C2_ADDRESSABLE_AREA,
         lwOffsetLocSeq: ANY_LOCATION,
         closestBeneathAdapterId: undefined,
         lwModOnlyStackupDetails: [
@@ -202,4 +221,75 @@ describe('getDefaultOffsetDetailsForLabware', () => {
 
     expect(result.locationDetails.closestBeneathAdapterId).toBeUndefined()
   })
+
+  it('should use C2 when available and no modules are present', () => {
+    const result = getDefaultOffsetDetailsForLabware({
+      uri: LABWARE_URI,
+      lwLocInfo: MOCK_LW_LOC_COMBOS,
+      currentOffsets: [],
+      labwareDefs: [MOCK_LABWARE_DEF],
+      locationSpecificOffsetDetails: [],
+      protocolData: MOCK_PROTOCOL_DATA,
+    } as any)
+
+    expect(result.locationDetails.addressableAreaName).toBe(C2_ADDRESSABLE_AREA)
+  })
+
+  it('should use alternative slot when C2 is occupied by a module', () => {
+    const result = getDefaultOffsetDetailsForLabware({
+      uri: LABWARE_URI,
+      lwLocInfo: MOCK_LW_LOC_COMBOS,
+      currentOffsets: [],
+      labwareDefs: [MOCK_LABWARE_DEF],
+      locationSpecificOffsetDetails: [],
+      protocolData: MOCK_PROTOCOL_DATA_WITH_MODULES,
+    } as any)
+
+    expect(result.locationDetails.addressableAreaName).not.toBe(
+      C2_ADDRESSABLE_AREA
+    )
+    expect([
+      'A2',
+      'A3',
+      'B1',
+      'B2',
+      'B3',
+      'C1',
+      'C3',
+      'D1',
+      'D2',
+      'D3',
+    ]).toContain(result.locationDetails.addressableAreaName)
+  })
+
+  it('should fallback to C2 when all slots are occupied', () => {
+    const protocolDataWithAllModules = {
+      labware: [],
+      modules: [
+        { location: { slotName: 'A1' } },
+        { location: { slotName: 'A2' } },
+        { location: { slotName: 'A3' } },
+        { location: { slotName: 'B1' } },
+        { location: { slotName: 'B2' } },
+        { location: { slotName: 'B3' } },
+        { location: { slotName: 'C1' } },
+        { location: { slotName: 'C2' } },
+        { location: { slotName: 'C3' } },
+        { location: { slotName: 'D1' } },
+        { location: { slotName: 'D2' } },
+        { location: { slotName: 'D3' } },
+      ],
+    }
+
+    const result = getDefaultOffsetDetailsForLabware({
+      uri: LABWARE_URI,
+      lwLocInfo: MOCK_LW_LOC_COMBOS,
+      currentOffsets: [],
+      labwareDefs: [MOCK_LABWARE_DEF],
+      locationSpecificOffsetDetails: [],
+      protocolData: protocolDataWithAllModules,
+    } as any)
+
+    expect(result.locationDetails.addressableAreaName).toBe(C2_ADDRESSABLE_AREA)
+  })
 })

app/src/organisms/LabwarePositionCheck/LPCFlows/hooks/useLPCLabwareInfo/getLPCLabwareInfoFrom/getDefaultOffsetForLabware.ts

@@ -1,13 +1,26 @@
+import head from 'lodash/head'
+
 import { ANY_LOCATION } from '@opentrons/api-client'
-import { getLabwareDefURI } from '@opentrons/shared-data'
+import {
+  A1_ADDRESSABLE_AREA,
+  B1_ADDRESSABLE_AREA,
+  C2_ADDRESSABLE_AREA,
+  getLabwareDefURI,
+  STANDARD_FLEX_SLOTS,
+  THERMOCYCLER_MODULE_V1,
+  THERMOCYCLER_MODULE_V2,
+} from '@opentrons/shared-data'
 
 import { OFFSET_KIND_DEFAULT } from '/app/redux/protocol-runs'
 
-import type { LabwareDefinition2 } from '@opentrons/shared-data'
+import type {
+  FlexAddressableAreaName,
+  LabwareDefinition2,
+} from '@opentrons/shared-data'
 import type {
   DefaultOffsetDetails,
-  LocationSpecificOffsetDetails,
   LabwareModuleStackupDetails,
+  LocationSpecificOffsetDetails,
 } from '/app/redux/protocol-runs'
 import type { GetLPCLabwareInfoForURI } from '.'
 
@@ -42,7 +55,7 @@ export function getDefaultOffsetDetailsForLabware(
       definitionUri: uri,
       kind: OFFSET_KIND_DEFAULT,
       // We always do default offset LPCing in this slot.
-      addressableAreaName: 'C2',
+      addressableAreaName: getValidDefaultOffsetLocation(params.protocolData),
       lwOffsetLocSeq: ANY_LOCATION,
       closestBeneathAdapterId,
       // The only labware present on deck when configuring the default offset is the top-most labware itself.
@@ -128,3 +141,39 @@ function getFirstAdapterIdFrom(
     lsOffset => lsOffset.locationDetails.closestBeneathAdapterId != null
   )?.locationDetails.closestBeneathAdapterId
 }
+
+// Find a valid location for setting a default offset slot.
+// A slot is valid if it does not contain a module.
+// This util works under the assumption that modules cannot be added or removed
+// from the deck mid-protocol run and that currently there is at least one
+// slot on the deck without a module (true as of 8.4.0, since launching LPC requires
+// the presence of a tiprack, which must occupy a non-module deck slot).
+// NOTE: This util is meant to be temporary until product/design devise
+// an alternative method for default offset location selection.
+function getValidDefaultOffsetLocation(
+  protocolData: GetStackingInfoParams['protocolData']
+): FlexAddressableAreaName {
+  const validLocations = new Set<FlexAddressableAreaName>(
+    STANDARD_FLEX_SLOTS as FlexAddressableAreaName[]
+  )
+
+  protocolData?.modules.forEach(mod => {
+    if (
+      mod.model === THERMOCYCLER_MODULE_V2 ||
+      mod.model === THERMOCYCLER_MODULE_V1
+    ) {
+      validLocations.delete(A1_ADDRESSABLE_AREA)
+      validLocations.delete(B1_ADDRESSABLE_AREA)
+    } else {
+      const slotName = mod.location.slotName as FlexAddressableAreaName
+      validLocations.delete(slotName)
+    }
+  })
+
+  if (validLocations.has(C2_ADDRESSABLE_AREA)) {
+    return C2_ADDRESSABLE_AREA
+  } else {
+    // The fallback should never occur in practice.
+    return head(Array.from(validLocations)) ?? C2_ADDRESSABLE_AREA
+  }
+}

app/src/redux/protocol-runs/types/lpc/offsets.ts

@@ -73,7 +73,7 @@ export type OffsetLocationDetails =
 
 export interface DefaultOffsetLocationDetails
   extends BaseOffsetLocationDetails {
-  addressableAreaName: 'C2'
+  addressableAreaName: FlexAddressableAreaName
   kind: 'default'
   lwOffsetLocSeq: typeof ANY_LOCATION
   hardCodedOffsetId?: undefined