fix(app): refactor logic for getSimplestDeckConfigForProtocol to be able to use combo fixtures (#19186)

Author: TamarZanzouri

app/src/organisms/Desktop/Devices/ProtocolRun/SetupLabware/SetupLabwareMap.tsx

@@ -50,6 +50,11 @@ export function SetupLabwareMap({
     stack: StackItem[]
   } | null>(null)
   const [hoverLabwareId, setHoverLabwareId] = useState<string | null>(null)
+
+  const deckConfig = useMemo(() => {
+    return getSimplestDeckConfigForProtocol(protocolAnalysis)
+  }, [protocolAnalysis])
+
   const startingDeck = useMemo(
     () =>
       getStackedItemsOnStartingDeck(
@@ -147,9 +152,6 @@ export function SetupLabwareMap({
       }
     }
   )
-
-  const deckConfig = getSimplestDeckConfigForProtocol(protocolAnalysis)
-
   const labwareOnDeck: Array<LabwareOnDeck | null> = Object.entries(
     getLabwareOnDeck(startingDeck)
   ).map(([slotName, stackedItems]) => {

shared-data/js/fixtures.ts

@@ -1165,6 +1165,31 @@ export const getMainUsbModuleFixtureIdForComboFixture = (
   )
 }
 
+export const getMainFixtureIdForAA = (
+  compatibleCutoutFixtureIds: CutoutFixtureId[],
+  addressableAreaIds: AddressableAreaName[],
+  cutoutId: CutoutId
+): CutoutFixtureId | null => {
+  if (addressableAreaIds.length === 1) {
+    return getMainNonComboFixtureId(
+      compatibleCutoutFixtureIds,
+      addressableAreaIds,
+      cutoutId
+    )
+  }
+
+  const deckDef = getDeckDefFromRobotType('OT-3 Standard')
+  const cutoutFixtures = deckDef.cutoutFixtures.filter(cf =>
+    compatibleCutoutFixtureIds.includes(cf.id)
+  )
+  const cutoutFixturesWithAddressableAreas = cutoutFixtures.find(cf =>
+    Object.values(cf.providesAddressableAreas).some(providedAAs =>
+      addressableAreaIds.every(aa => providedAAs.includes(aa))
+    )
+  )
+  return cutoutFixturesWithAddressableAreas?.id ?? null
+}
+
 export const getMainNonComboFixtureId = (
   compatibleCutoutFixtureIds: CutoutFixtureId[],
   addressableAreaIds: AddressableAreaName[],

shared-data/js/helpers/getSimplestFlexDeckConfig.ts

@@ -2,7 +2,7 @@ import { getAddressableAreasInProtocol, getDeckDefFromRobotType } from '.'
 import { FLEX_ROBOT_TYPE } from '../constants'
 import {
   getAddressableAreaFromSlotId,
-  getMainNonComboFixtureId,
+  getMainFixtureIdForAA,
 } from '../fixtures'
 
 import type { AddressableAreaName, CutoutFixtureId, CutoutId } from '../../deck'
@@ -44,29 +44,34 @@ export function getSimplestDeckConfigForProtocol(
 ): CutoutConfigProtocolSpec[] {
   // TODO(BC, 2023-11-06): abstract out the robot type
   const deckDef = getDeckDefFromRobotType(FLEX_ROBOT_TYPE)
-
   const addressableAreas =
     protocolAnalysis != null
       ? getAddressableAreasInProtocol(protocolAnalysis, deckDef)
       : []
+  // iterates through the list of required addressable areas for the protocol
   const simplestDeckConfig = addressableAreas.reduce<
     CutoutConfigProtocolSpec[]
   >((acc, addressableArea) => {
+    // finds all cutout fixtures that provide this addressable area
     const cutoutFixturesForAddressableArea = getCutoutFixturesForAddressableAreas(
       [addressableArea],
       deckDef.cutoutFixtures
     )
+    // grabs the cutout id for the addressable area
     const cutoutIdForAddressableArea = getCutoutIdForAddressableArea(
       addressableArea,
       cutoutFixturesForAddressableArea
     )
+    // grabs all possible cutout fixtures for that cutout id
     const cutoutFixturesForCutoutId =
       cutoutIdForAddressableArea != null
         ? getCutoutFixturesForCutoutId(
             cutoutIdForAddressableArea,
             deckDef.cutoutFixtures
           )
         : null
+    // this grabs the previously found CutoutConfig if we've already added one to our acc
+    // for a different addressable area required by the same CutoutId
     const existingCutoutConfig = acc.find(
       cutoutConfig => cutoutConfig.cutoutId === cutoutIdForAddressableArea
     )
@@ -76,32 +81,29 @@ export function getSimplestDeckConfigForProtocol(
       cutoutFixturesForCutoutId != null &&
       cutoutIdForAddressableArea != null
     ) {
-      const indexOfExistingFixture = cutoutFixturesForCutoutId.findIndex(
-        ({ id }) => id === existingCutoutConfig.cutoutFixtureId
-      )
+      // finds what index in our acc that the `existingCutoutConfig` is at so that
+      // we know which item to swap out with a new CutoutConfig that provides the previously
+      // and newly found addressable areas
       const accIndex = acc.findIndex(
         ({ cutoutId }) => cutoutId === cutoutIdForAddressableArea
       )
+      // what addressable areas we've already looped through and added to this cutout
       const previousRequiredAAs = acc[accIndex]?.requiredAddressableAreas
       const allNextRequiredAddressableAreas =
         previousRequiredAAs != null &&
         previousRequiredAAs.includes(addressableArea)
           ? previousRequiredAAs
           : [...previousRequiredAAs, addressableArea]
-
+      // check for the next compatible fixture for the new, longer list of addressable areas
       const nextCompatibleCutoutFixture = getSimplestFixtureForAddressableAreas(
         cutoutIdForAddressableArea,
         allNextRequiredAddressableAreas,
         cutoutFixturesForCutoutId
       )
-      const indexOfCurrentFixture = cutoutFixturesForCutoutId.findIndex(
-        ({ id }) => id === nextCompatibleCutoutFixture?.id
-      )
 
-      if (
-        nextCompatibleCutoutFixture != null &&
-        indexOfCurrentFixture > indexOfExistingFixture
-      ) {
+      // this logic swaps out the newly found cutoutfixture id with the existing one
+      // that was added for the last addressable area we referenced
+      if (nextCompatibleCutoutFixture != null) {
         return [
           ...acc.slice(0, accIndex),
           {
@@ -192,7 +194,7 @@ export function getSimplestFixtureForAddressableAreas(
     cutoutFixturesForCutoutId
   )
   if (nextCompatibleCutoutFixtures.length > 1) {
-    const mainFixture = getMainNonComboFixtureId(
+    const mainFixture = getMainFixtureIdForAA(
       nextCompatibleCutoutFixtures.map(cf => cf.id),
       requiredAddressableAreas,
       cutoutId