feat(protocol-designer, components, step-generation): update modules section to accommodate gripper #12955

jerader · 2023-06-22T13:38:40Z

closes RLIQ-416, RAUT-504, RAUT-506, RAUT-510

Overview

For the Flex protocols, the modules section is updated to allow for adding/removing gripper and the deckmap and edit modules is updated.

Test Plan

Test creating a Flex protocol, modify the modules and gripper and ensure that it works properly. When exporting with a magnetic block, you shouldn't get an "unused module" modal. When exporting with an unused gripper, you sohuld get an "unused gripper" modal.

Test creating an Ot-2 protocol, should work as normal.

Changelog

add additionalEquipmentInvariantProperties key to root state in redux
create a IS_GRIPPER_REQUIRED type redux action (toggleIsGripperRequired), reducer and selector (getAdditionalEquipment)
add the action to CreateFileWizard and EditModulesCard for adding/removing a gripper
create a gripperRow to the Modules section and rename the section to AdditionalItems to encompass modules and gripper
update the slotmap view for Flex and make sure it highlights the correct slots where the modules sit
update the FileSideBar container to take in robot type and additional equipment for wiring up logic for unused gripper and unused module modal
update tests

Review requests

see test plan

Risk assessment

low

closes RLIQ-416, RAUT-504, RAUT-506

codecov · 2023-06-22T13:43:22Z

Codecov Report

Merging #12955 (27f8973) into edge (9201f57) will decrease coverage by 0.09%.
The diff coverage is 50.00%.

@@            Coverage Diff             @@
##             edge   #12955      +/-   ##
==========================================
- Coverage   72.88%   72.79%   -0.09%     
==========================================
  Files        2342     2350       +8     
  Lines       64208    64782     +574     
  Branches     7127     7327     +200     
==========================================
+ Hits        46799    47161     +362     
- Misses      15741    15902     +161     
- Partials     1668     1719      +51

Flag	Coverage Δ
app	`71.34% <ø> (-0.23%)`	⬇️
components	`65.89% <100.00%> (-0.61%)`	⬇️
labware-library	`49.61% <ø> (ø)`
protocol-designer	`44.40% <48.03%> (-0.06%)`	⬇️
shared-data	`76.63% <ø> (+0.37%)`	⬆️
step-generation	`85.91% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
...otocol-designer/src/components/DeckSetup/index.tsx	`23.76% <0.00%> (ø)`
...tocol-designer/src/components/FileSidebar/index.ts	`0.00% <0.00%> (ø)`
...nents/StepEditForm/forms/MoveLabwareForm/index.tsx	`0.00% <0.00%> (ø)`
...omponents/modals/CreateFileWizard/MetadataTile.tsx	`0.00% <ø> (ø)`
...r/src/components/modals/CreateFileWizard/index.tsx	`0.00% <0.00%> (ø)`
protocol-designer/src/load-file/reducers.ts	`76.92% <ø> (ø)`
...igner/src/top-selectors/labware-locations/index.ts	`6.38% <ø> (+0.13%)`	⬆️
step-generation/src/types.ts	`100.00% <ø> (ø)`
protocol-designer/src/step-forms/reducers/index.ts	`57.35% <10.00%> (-2.96%)`	⬇️
protocol-designer/src/modules/moduleData.ts	`44.44% <42.30%> (-17.10%)`	⬇️
... and 11 more

... and 36 files with indirect coverage changes

b-cooper · 2023-06-22T17:23:39Z

components/src/slotmap/SlotMap.tsx

@@ -13,28 +13,38 @@ export interface SlotMapProps {
  collisionSlots?: string[]
  /** Optional error styling */
  isError?: boolean
+  isOt3?: boolean


I'd prefer this branch on RobotType, but at the very least can we not refer to this as OT3 (use Flex instead)

b-cooper · 2023-06-22T17:24:33Z

protocol-designer/src/components/DeckSetup/index.tsx

@@ -432,7 +432,7 @@ export const DeckSetup = (): JSX.Element => {
  })

  return (
-    <React.Fragment>
+    <>


looks like this fragment can be deleted completely?

b-cooper · 2023-06-22T17:26:13Z

protocol-designer/src/components/FileSidebar/FileSidebar.tsx

@@ -174,27 +206,40 @@ export function FileSidebar(props: Props): JSX.Element {
      command => !LOAD_COMMANDS.includes(command.commandType)
    ) ?? []

+  const hasMoveLabware =


We also need to check that the move labware is using the gripper here. As written this will trigger for manual moves as well

b-cooper · 2023-06-22T17:26:44Z

protocol-designer/src/components/FileSidebar/FileSidebar.tsx

  )

+  //  TODO(jr, 6/22/23): need to refactor when the gripper toggle is wired up


isn't the gripper toggle wired up?

oops ya idk why i thought it wasn't wired up 🤦

b-cooper · 2023-06-22T17:30:44Z

protocol-designer/src/components/modals/EditModulesModal/ConnectedSlotMap.tsx

@@ -5,18 +5,20 @@ import styles from './EditModules.css'

 interface ConnectedSlotMapProps {
  fieldName: string
+  isOt3: boolean


same here, can we rename this prop, or make it RobotType?

b-cooper · 2023-06-22T17:32:27Z

protocol-designer/src/components/modals/EditModulesModal/index.tsx

-                <ConnectedSlotMap fieldName={'selectedSlot'} />
+                <ConnectedSlotMap
+                  fieldName="selectedSlot"
+                  isOt3={robotType === 'OT-3 Standard'}


import the FLEX_ROBOT_TYPE constant to compare against here

b-cooper · 2023-06-22T17:34:06Z

protocol-designer/src/components/modules/EditModulesCard.tsx

@@ -67,18 +75,22 @@ export function EditModulesCard(props: Props): JSX.Element {
    ].some(pipetteSpecs => pipetteSpecs?.channels !== 1)

  const warningsEnabled = !moduleRestrictionsDisabled
+  const isOt3 = robotType === 'OT-3 Standard'


use FLEX_ROBOT_TYPE constant

b-cooper · 2023-06-22T17:37:45Z

protocol-designer/src/file-data/selectors/fileCreator.ts

@@ -299,7 +299,9 @@ export const createFile: Selector<ProtocolFile> = createSelector(
    } => {
      const loadedPipettes = Object.values(pipettes)
      const pipetteGEN = loadedPipettes.some(
-        pipette => getPipetteNameSpecs(pipette.name)?.displayCategory === GEN3
+        pipette =>


This entire method should be replaced with the contents of robotType key on the protocol file instead of inferring it from pipette types. If you don't want to cram that into this PR, add a TODO

b-cooper · 2023-06-22T17:40:30Z

protocol-designer/src/step-forms/actions/additionalItems.ts

@@ -0,0 +1,7 @@
+export interface SetGripperAction {
+  type: 'IS_GRIPPER_REQUIRED'


The naming conventions here are a little wonky. I know it seems redundant, but the action type/function/interface should all reflect the action verb itself. E.g. here I would name them accordingly

interface ToggleIsGripperRequiredAction { type: 'TOGGLE_IS_GRIPPER_REQUIRED' } export const toggleIsGripperRequired ...

b-cooper · 2023-06-22T17:41:00Z

protocol-designer/src/step-forms/reducers/index.ts

@@ -47,7 +47,10 @@ import { getLabwareOnModule } from '../../ui/modules/utils'
 import { nestedCombineReducers } from './nestedCombineReducers'
 import { PROFILE_CYCLE, PROFILE_STEP } from '../../form-types'
 import { Reducer } from 'redux'
-import { NormalizedPipetteById } from '@opentrons/step-generation'
+import {
+  NoramlizedAdditionalEquipmentById,


NoramlizedAdditionalEquipmentById should be NormalizedAdditionalEquipmentById

b-cooper · 2023-06-22T19:58:51Z

protocol-designer/src/step-forms/reducers/index.ts

+      )
+      const hasGripper = gripper.length > 0
+      // @ts-expect-error  (jr, 6/22/23): OT-3 Standard doesn't exist on schemav6
+      const isOt3 = file.robot.model === 'OT-3 Standard'


This const should be renamed, and we should be comparing against FLEX_ROBOT_TYPE instead of the bare string

b-cooper

🏁 🏎️

jerader added 6 commits June 21, 2023 11:06

flex support in modules section

033d987

schema version to 7 on PD side only

64f1bcb

modify getRobotModelFromPipettes to work for 96 channel

69cbeeb

create action, reducer, selector for gripper

a15a0ff

add logic to fileSidebar for unused gripper

771ec02

feat(protocol-designer): update modules section to accommodate gripper

3cd8a43

closes RLIQ-416, RAUT-504, RAUT-506

jerader added 3 commits June 22, 2023 10:22

fix tests

179da92

remove loadFile action in additionalEquipmentInvariantProperties

5014cdf

fix loadFile action logic in additionalEquipmentInvariantProperties

e33af4e

jerader marked this pull request as ready for review June 22, 2023 16:40

jerader requested review from a team as code owners June 22, 2023 16:40

jerader requested review from b-cooper and shlokamin and removed request for a team June 22, 2023 16:40

b-cooper reviewed Jun 22, 2023

View reviewed changes

jerader added 3 commits June 22, 2023 14:14

address comments and wire up unused gripper modal logic

d14d735

fix test

913236c

hide gripper toggle for ot2 and disable when gripper not attached

0515d9e

b-cooper reviewed Jun 22, 2023

View reviewed changes

change all OT-3 Standard strings to FLEX_ROBOT_TYPE const

27f8973

jerader requested a review from b-cooper June 23, 2023 14:40

b-cooper approved these changes Jun 23, 2023

View reviewed changes

jerader merged commit 6369f39 into edge Jun 23, 2023

jerader deleted the pd_7.0-modifications branch June 23, 2023 15:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(protocol-designer, components, step-generation): update modules section to accommodate gripper #12955

feat(protocol-designer, components, step-generation): update modules section to accommodate gripper #12955

jerader commented Jun 22, 2023 •

edited

Loading

codecov bot commented Jun 22, 2023 •

edited

Loading

b-cooper Jun 22, 2023

b-cooper Jun 22, 2023

b-cooper Jun 22, 2023

b-cooper Jun 22, 2023

jerader Jun 22, 2023

b-cooper Jun 22, 2023

b-cooper Jun 22, 2023

b-cooper Jun 22, 2023

b-cooper Jun 22, 2023

b-cooper Jun 22, 2023

b-cooper Jun 22, 2023

b-cooper Jun 22, 2023

b-cooper left a comment

		)

		// TODO(jr, 6/22/23): need to refactor when the gripper toggle is wired up

		@@ -0,0 +1,7 @@
		export interface SetGripperAction {
		type: 'IS_GRIPPER_REQUIRED'

feat(protocol-designer, components, step-generation): update modules section to accommodate gripper #12955

feat(protocol-designer, components, step-generation): update modules section to accommodate gripper #12955

Conversation

jerader commented Jun 22, 2023 • edited Loading

Overview

Test Plan

Changelog

Review requests

Risk assessment

codecov bot commented Jun 22, 2023 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

b-cooper left a comment

Choose a reason for hiding this comment

jerader commented Jun 22, 2023 •

edited

Loading

codecov bot commented Jun 22, 2023 •

edited

Loading