feat(step-generation): error for full hopper

Author: rclarke0

step-generation/src/__tests__/flexStackerStore.test.ts

@@ -218,4 +218,56 @@ describe('flexStackerStore', () => {
       type: 'MISMATCHED_STACKER_LABWARE_TYPE',
     })
   })
+  it ('raises an error if the hopper is full', () => {
+    vi.mocked(flexStackerStateGetter).mockReturnValue({
+      labwareOnShuttle: {
+        primaryLabwareId: 'mockLabwareId',
+        adapterLabwareId: null,
+        lidLabwareId: null,
+      },
+      labwareInHopper: [
+        {
+          primaryLabwareId: 'mockLabwareId',
+          adapterLabwareId: null,
+          lidLabwareId: null,
+        },
+      ],
+      maxPoolCount: 10,
+      storedLabwareDetails: {
+        moduleId,
+        initialCount: 10,
+        primaryLabware: {
+          loadName: 'fixture_96_plate',
+          namespace: 'opentrons',
+          version: 1,
+        },
+        lidLabware: null,
+        adapterLabware: null,
+      },
+      type: FLEX_STACKER_MODULE_TYPE,
+    } as FlexStackerModuleState)
+    const fullRobotState = {
+      ...robotState,
+      modules: {
+        [moduleId]: {
+          slot: 'D3',
+          moduleState: {} as FlexStackerModuleState,
+        },
+      },
+      labware: {
+        mockLabwareId: {
+          stack: ['mockLabwareId', 'D3'],
+        },
+      },
+    }
+    const result = flexStackerStore(
+      { moduleId, strategy: 'automatic' },
+      invariantContext,
+      fullRobotState
+    )
+    expect(getErrorResult(result).errors[0]).toMatchObject({
+      type: 'HOPPER_FULL',
+    })
+  })
+
 })

step-generation/src/types.ts

@@ -752,6 +752,7 @@ export type ErrorType =
   | 'HEATER_SHAKER_NORTH_SOUTH__OF_NON_TIPRACK_WITH_MULTI_CHANNEL'
   | 'HEATER_SHAKER_NORTH_SOUTH_EAST_WEST_SHAKING'
   | 'HOPPER_EMPTY'
+  | 'HOPPER_FULL'
   | 'INSUFFICIENT_TIPS'
   | 'INVALID_SLOT'
   | 'LABWARE_DISCARDED_IN_TRASH'

step-generation/src/utils/misc.ts

@@ -1382,3 +1382,12 @@ export const labwareMatchesLabwareInHopper = (
   const labwareToBeStored = def.parameters.loadName
   return loadedLabware === labwareToBeStored
 }
+
+export const spaceInHopper = (
+  stackerState: FlexStackerModuleState | null
+) : boolean => {
+  const maximumAllowedLabware = stackerState?.maxPoolCount ?? 0
+  const labwareStored = stackerState?.labwareInHopper
+  const numberOfLabwareStored = labwareStored?.length ?? 0
+  return (numberOfLabwareStored + 1) < maximumAllowedLabware
+}