refactor(app, api-client): add utilities for parsing deck config via addressable areas #13947

b-cooper · 2023-11-08T19:21:03Z

Overview

Instead of explicit load fixture commands, extrapolate the simplest possible setup for the deck
given the included addressable areas referenced in a set of protocol commands

Closes RAUT-853

Changelog

add addressableAreaName to LabwareLocation type
add parseAllAddressableAreas util for iterating through commands and scraping out addressableArea references
add getSimplestDeckConfigForProtocolCommands util that returns the simplest compatible set of cutout fixtures that would satisfy the specced addressable areas

Risk assessment

low

… protocol commands

…addressable areas Instead of explicit load fixture commands, extrapolate the simplest possible setup for the deck given the included addressable areas referenced in a set of protocol commands Closes RAUT-853

codecov · 2023-11-08T19:21:22Z

Codecov Report

Merging #13947 (659cfb4) into edge (c4b3b56) will decrease coverage by 0.34%.
Report is 32 commits behind head on edge.
The diff coverage is 58.46%.

Additional details and impacted files

@@            Coverage Diff             @@
##             edge   #13947      +/-   ##
==========================================
- Coverage   70.82%   70.49%   -0.34%     
==========================================
  Files        2504     2509       +5     
  Lines       70465    72211    +1746     
  Branches     8616     9226     +610     
==========================================
+ Hits        49908    50906     +998     
- Misses      18457    19057     +600     
- Partials     2100     2248     +148

Flag	Coverage Δ
app	`67.87% <64.15%> (-0.93%)`	⬇️
components	`61.89% <0.00%> (-1.45%)`	⬇️
labware-library	`49.17% <ø> (ø)`
protocol-designer	`45.72% <0.00%> (+0.16%)`	⬆️
react-api-client	`66.39% <ø> (+0.56%)`	⬆️
shared-data	`73.03% <80.00%> (+0.04%)`	⬆️
step-generation	`84.95% <ø> (ø)`

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

Files	Coverage Δ
...rc/organisms/ProtocolSetupModulesAndDeck/index.tsx	`67.94% <ø> (ø)`
protocol-designer/src/load-file/migration/8_0_0.ts	`81.25% <ø> (+1.25%)`	⬆️
app/src/organisms/CommandText/LoadCommandText.tsx	`54.76% <0.00%> (-1.34%)`	⬇️
.../Devices/ProtocolRun/utils/getLabwareRenderInfo.ts	`76.66% <0.00%> (-3.34%)`	⬇️
...InterventionModal/utils/getRunLabwareRenderInfo.ts	`83.33% <0.00%> (-5.56%)`	⬇️
shared-data/js/helpers/index.ts	`74.21% <80.00%> (-0.39%)`	⬇️
.../Devices/ProtocolRun/utils/getLocationInfoNames.ts	`54.05% <0.00%> (-3.09%)`	⬇️
...rc/organisms/LabwarePositionCheck/utils/labware.ts	`14.43% <0.00%> (-0.16%)`	⬇️
...ocol-designer/src/labware-ingred/reducers/index.ts	`22.36% <0.00%> (-0.61%)`	⬇️
...yHistoricOffsets/hooks/getLabwareLocationCombos.ts	`21.66% <0.00%> (-1.15%)`	⬇️
... and 3 more

... and 68 files with indirect coverage changes

jerader · 2023-11-08T20:08:30Z

shared-data/protocol/types/schemaV7/command/setup.ts

@@ -91,11 +91,13 @@ export type LabwareLocation =
 | { slotName: string }
 | { moduleId: string }
 | { labwareId: string }
+ | { addressableAreaName: string }


why do you need to add this here? Aren't all the components (supposed to be) using LabwareLocation from schema v8?

jerader · 2023-11-09T13:08:52Z

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

 OT2RobotMixin,
 OT3RobotMixin,
 ProtocolBase,
 ProtocolFile,
 } from '@opentrons/shared-data/protocol/types/schemaV8'
+import type { LoadLabwareCreateCommand } from '@opentrons/shared-data/protocol/types/schemaV7'


why is this being imported from schemaV7 now?

jerader · 2023-11-09T13:11:20Z

app/src/organisms/Devices/ProtocolRun/utils/getLabwareRenderInfo.ts

@@ -75,7 +75,10 @@ export const getLabwareRenderInfo = (
 )
 }
 // TODO(bh, 2023-10-19): convert this to deck definition v4 addressableAreas


can this TODO be deleted now?

jerader · 2023-11-09T13:24:29Z

api-client/src/protocols/utils.ts

+ // TODO(BC, 11/6/23): once moveToAddressableArea command exists add it back here
+ // else if (command.commandType === 'moveToAddressableArea') {


moveToAddressableArea command exists in types on edge

brenthagen

functions look good to me - this will affect BaseDeck renders of fixture SVGs but i think we should merge this later today and resolve inconsistencies in #13931

brenthagen · 2023-11-08T22:28:24Z

shared-data/js/types.ts

+export interface CutoutFixture {
+ id: CutoutFixtureId
+ mayMountTo: CutoutId[]
+ displayName: string
+ providesAddressableAreas: Record<CutoutId, AddressableAreaName[]>
+}
+
+export interface AddressableArea {
+ id: AddressableAreaName
+ areaType: 'slot' | 'movableTrash' | 'fixedTrash' | 'wasteChute'
+ matingSurfaceUnitVector: UnitVectorTuple
+ offsetFromCutoutFixture: UnitVectorTuple
+ boundingBox: Dimensions
+ displayName: string
+ compatibleModuleTypes: ModuleType[]
+}
+


just a note, some of this is duplicated in https://github.com/Opentrons/opentrons/pull/13931/files#diff-d6a873bb9d1ca073c74cc090513ae5c1f010fb305b1440f8607b7e4e34fcb002, some types more complete there, some more complete here. probably this will merge first so can be accounted for in that PR

brenthagen · 2023-11-08T23:23:56Z

shared-data/deck/types/schemaV4.ts

+ | 'singleLeftSlot'
+ | 'singleCenterSlot'
+ | 'singleRightSlot'
+ | 'stagingAreaRightSlot'
+ | 'trashBinAdapter'
+ | 'wasteChuteRightAdapterCovered'
+ | 'wasteChuteRightAdapterNoCover'
+ | 'stagingAreaSlotWithWasteChuteRightAdapterCovered'
+ | 'stagingAreaSlotWithWasteChuteRightAdapterNoCover'


another note, BaseDeck will need these as string literal constants and sets of "singleSlotFixtures" at some point. and probably other components as well. might be better to adjust in #13931 with the understanding that the deck map won't render correctly until that PR is merged.

brenthagen · 2023-11-09T15:43:24Z

app/src/resources/deck_configuration/utils.ts

+ addressableArea: AddressableAreaName,
+ cutoutFixtures: CutoutFixture[]
+): CutoutId | null {
+ return cutoutFixtures.reduce<CutoutId | null>((acc, cutoutFixture) => {


this might read simpler as a forEach

…addressable areas (#13947) Instead of explicit load fixture commands, extrapolate the simplest possible setup for the deck given the included addressable areas referenced in a set of protocol commands Closes RAUT-853

b-cooper added 5 commits November 6, 2023 17:48

build up some useful types and starter logic for get deck config from…

4e39636

… protocol commands

simplest deck config

7d42943

first test

334e0e7

still need to work out next required addressable area

45ddff7

refactor(app, api-client): add utilities for parsing deck config via …

51b0133

…addressable areas Instead of explicit load fixture commands, extrapolate the simplest possible setup for the deck given the included addressable areas referenced in a set of protocol commands Closes RAUT-853

b-cooper requested a review from brenthagen November 8, 2023 19:21

b-cooper requested review from a team as code owners November 8, 2023 19:21

b-cooper requested a review from a team November 8, 2023 19:21

b-cooper requested a review from a team as a code owner November 8, 2023 19:21

jerader reviewed Nov 8, 2023

View reviewed changes

jerader mentioned this pull request Nov 8, 2023

feat(step-generation): wire up moveLabware into waste chute #13950

Merged

fix up tests and remove improper v7 type

659cfb4

jerader reviewed Nov 9, 2023

View reviewed changes

brenthagen approved these changes Nov 9, 2023

View reviewed changes

b-cooper merged commit 7258da8 into edge Nov 9, 2023
62 of 66 checks passed

b-cooper deleted the app_addressable-area-utils branch November 9, 2023 16:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(app, api-client): add utilities for parsing deck config via addressable areas #13947

refactor(app, api-client): add utilities for parsing deck config via addressable areas #13947

b-cooper commented Nov 8, 2023 •

edited by jira bot

Loading

codecov bot commented Nov 8, 2023 •

edited

Loading

jerader Nov 8, 2023

jerader Nov 9, 2023

jerader Nov 9, 2023

jerader Nov 9, 2023

brenthagen left a comment

brenthagen Nov 8, 2023

brenthagen Nov 8, 2023

brenthagen Nov 9, 2023

		// TODO(BC, 11/6/23): once moveToAddressableArea command exists add it back here
		// else if (command.commandType === 'moveToAddressableArea') {

refactor(app, api-client): add utilities for parsing deck config via addressable areas #13947

refactor(app, api-client): add utilities for parsing deck config via addressable areas #13947

Conversation

b-cooper commented Nov 8, 2023 • edited by jira bot Loading

Overview

Changelog

Risk assessment

codecov bot commented Nov 8, 2023 • edited Loading

Codecov Report

jerader Nov 8, 2023

Choose a reason for hiding this comment

jerader Nov 9, 2023

Choose a reason for hiding this comment

jerader Nov 9, 2023

Choose a reason for hiding this comment

jerader Nov 9, 2023

Choose a reason for hiding this comment

brenthagen left a comment

Choose a reason for hiding this comment

brenthagen Nov 8, 2023

Choose a reason for hiding this comment

brenthagen Nov 8, 2023

Choose a reason for hiding this comment

brenthagen Nov 9, 2023

Choose a reason for hiding this comment

b-cooper commented Nov 8, 2023 •

edited by jira bot

Loading

codecov bot commented Nov 8, 2023 •

edited

Loading