feature(app, shared-data): module setup deck config assignment #18864

TamarZanzouri · 2025-07-09T18:25:31Z

Overview

closes https://opentrons.atlassian.net/browse/EXEC-1418.
implement module setup deck configuration.

Test Plan and Hands on Testing

(test both combo fixtures and simple modules)

trigger module setup flows
place module on a slot
make sure the only slots that you are able to press on are allowed for the module
make sure when clicking the slot the module is added to the deck config.

Changelog

SelectLocation will now check for aa matches with combo fixtures.
calculate logic for placing and removing module from deck.
added tests.

Review requests

changes make sense?

Risk assessment

Medium. changes the logic for placing a module on the deck in module setup. need to smoke test.

codecov · 2025-07-09T18:29:44Z

Codecov Report

Attention: Patch coverage is 18.47826% with 150 lines in your changes missing coverage. Please review.

Project coverage is 27.68%. Comparing base (f823458) to head (754e149).
Report is 51 commits behind head on edge.

Files with missing lines	Patch %	Lines
shared-data/js/fixtures.ts	3.89%	74 Missing ⚠️
...src/organisms/ModuleWizardFlows/SelectLocation.tsx	0.00%	56 Missing ⚠️
.../hardware-sim/DeckConfigurator/EmptyConfigItem.tsx	13.33%	13 Missing ⚠️
...onents/src/hardware-sim/DeckConfigurator/index.tsx	0.00%	6 Missing ⚠️
...anisms/ModuleWizardFlows/getFixtureIdByCutoutId.ts	0.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##             edge   #18864       +/-   ##
===========================================
- Coverage   62.81%   27.68%   -35.13%     
===========================================
  Files        3250     3277       +27     
  Lines      257655   261768     +4113     
  Branches    32754    32750        -4     
===========================================
- Hits       161835    72464    -89371     
- Misses      95622   189286    +93664     
+ Partials      198       18      -180

Flag	Coverage Δ
app	`2.89% <17.39%> (-45.00%)`	⬇️
opentrons-ai-client	`3.20% <18.47%> (+0.07%)`	⬆️
protocol-designer	`19.01% <18.47%> (-0.15%)`	⬇️
shared-data	`72.78% <ø> (+0.01%)`	⬆️
step-generation	`5.33% <17.39%> (-0.02%)`	⬇️

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

Files with missing lines	Coverage Δ
app/src/organisms/ModuleCard/index.tsx	`0.00% <ø> (-69.29%)`	⬇️
shared-data/js/constants.ts	`100.00% <100.00%> (ø)`
...anisms/ModuleWizardFlows/getFixtureIdByCutoutId.ts	`0.00% <0.00%> (-10.53%)`	⬇️
...onents/src/hardware-sim/DeckConfigurator/index.tsx	`1.03% <0.00%> (-0.03%)`	⬇️
.../hardware-sim/DeckConfigurator/EmptyConfigItem.tsx	`29.48% <13.33%> (-3.33%)`	⬇️
...src/organisms/ModuleWizardFlows/SelectLocation.tsx	`0.00% <0.00%> (-3.11%)`	⬇️
shared-data/js/fixtures.ts	`43.27% <3.89%> (-28.18%)`	⬇️

... and 1691 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

mjhuff

Lookin good overall. Approving to unblock work. A few cleanup comments, the main ones some utility recommendations and some docstrings.

I haven't smoke tested this personally, but I think it would be a really good idea to spend the time doing so via VPN/on a robot if not done already!

mjhuff · 2025-07-15T12:51:35Z

components/src/hardware-sim/DeckConfigurator/index.tsx

+  console.log('deckConfig: ', deckConfig)
+  console.log('editableCutoutIds: ', editableCutoutIds)


Suggested change

console.log('deckConfig: ', deckConfig)

console.log('editableCutoutIds: ', editableCutoutIds)

mjhuff · 2025-07-15T12:51:58Z

components/src/hardware-sim/DeckConfigurator/EmptyConfigItem.tsx

      >
-        <Icon name="add-circle" color={COLORS.blue50} size="2rem" />
+        {!disableButton && (
+          <Icon name="add-circle" color={COLORS.blue50} size="2rem" />


Suggested change

<Icon name="add-circle" color={COLORS.blue50} size="2rem" />

<Icon name="add-circle" color={COLORS.blue50} size={SPACING.whatever} />

mjhuff · 2025-07-15T12:52:10Z

components/src/hardware-sim/DeckConfigurator/index.tsx

@@ -89,6 +95,8 @@ export function DeckConfigurator(props: DeckConfiguratorProps): JSX.Element {
    'fakeStagingSlot'
  )

+  console.log('fakeStagingItems: ', fakeStagingItems)


Suggested change

console.log('fakeStagingItems: ', fakeStagingItems)

mjhuff · 2025-07-15T12:53:09Z

shared-data/js/constants.ts

@@ -641,6 +659,17 @@ export const MODULE_FIXTURES_BY_MODEL: {
  [FLEX_STACKER_MODULE_V1]: [FLEX_STACKER_V1_FIXTURE],
 }

+export const MODULE_AA_TYPE_BY_MODEL: {


Maybe FLEX_MODULE_... if this is just pertaining to flex modules?

mjhuff · 2025-07-15T12:54:08Z

shared-data/js/fixtures.ts

+  fixtureId: CutoutFixtureIdsWithFakes,
+  moduleModel: ModuleModel
+): AddressableAreaNamesWithFakes => {
+  const deckDef = getDeckDefFromRobotType('OT-3 Standard')


Suggested change

const deckDef = getDeckDefFromRobotType('OT-3 Standard')

const deckDef = getDeckDefFromRobotType(FLEX_ROBOT_TYPE)

mjhuff · 2025-07-15T13:02:13Z

shared-data/js/fixtures.ts

+  fixtureId: CutoutFixtureId,
+  moduleModel: ModuleModel,
+  deckConfig: CutoutConfig[],
+  serialNumber?: string


This serialNumber is effectively a pass through prop that's adding no value except being redefined. Is there any way we can just not include this and have the callee create a new cutout config with opentronsModuleSerialNumber?

mjhuff · 2025-07-15T13:02:29Z

shared-data/js/fixtures.ts

@@ -1209,3 +1266,34 @@ export const isFixtureInUsbModules = (fixtureId: CutoutFixtureId): boolean => {
    )
  )
 }
+
+export const getCutoutConfigReplacmentForModule = (


I don't think this fn is called in any non-test code?

mjhuff · 2025-07-15T13:04:59Z

app/src/organisms/ModuleWizardFlows/SelectLocation.tsx

+          mayMountToCutoutIds.includes(cutoutId) &&
+          (isCurrentConfiguration ||
+            SINGLE_SLOT_FIXTURES.includes(cutoutFixtureId) ||
+            FAKE_FIXTURE_IDS.includes(cutoutFixtureId))) ||


Sorry, I dont' have the context here. Why do we allow "fake" slot fixtures to be included in editable cutout ids? If this is definitely what we want, a comment on why we do this would be helpful. A comment on FAKE_FIXTURE_IDS would be helpful, too.

mjhuff · 2025-07-15T13:05:31Z

app/src/organisms/ModuleWizardFlows/SelectLocation.tsx

-            return cc
+      const updatedDeckConfig = deckConfig.map(cc => {
+        if (cc.cutoutId in configuredFixtureIdByCutoutId) {
+          let replacementFixtureId: CutoutFixtureId = SINGLE_LEFT_SLOT_FIXTURE


Suggested change

let replacementFixtureId: CutoutFixtureId = SINGLE_LEFT_SLOT_FIXTURE

const replacementFixtureId: CutoutFixtureId = SINGLE_LEFT_SLOT_FIXTURE

No let bindings please. Let's spread in the whole object in each case.

mjhuff · 2025-07-15T13:08:03Z

components/src/hardware-sim/DeckConfigurator/EmptyConfigItem.tsx

  } = props

+  console.log('addressableAreaId: ', addressableAreaId)


Suggested change

console.log('addressableAreaId: ', addressableAreaId)

TamarZanzouri added 8 commits July 7, 2025 13:50

disable empty config if not editable

adfb7d3

disable empty config if not editable

969c812

moved logic to fixtures

d5a51e3

added tests and fixed bugs with staging area

9e22dbe

linting and bug fixes

f36cf8d

infrastructure for aa in handleAddFixture WIP

6723a41

get aa for fixture module

c0fb1c5

adding tests and fixing logic WIP

24ed786

TamarZanzouri added 11 commits July 9, 2025 16:40

test progress

0411ff6

trying to make progress with the tests

ae3449f

finally made test work for get fixture replacment

059d69d

combo fixture working

748742b

test fix

86664d3

found solution to make all tests work

fcaab7f

refactor and finally made test work

c2658be

bug fix for removing in module setup

6abe920

WIP remove fixture - need to fix change position with combo

50dbbe3

a few test fixes and linting

384a77b

test fixes

02b7a86

TamarZanzouri marked this pull request as ready for review July 14, 2025 17:55

TamarZanzouri requested review from a team as code owners July 14, 2025 17:55

TamarZanzouri requested review from ncdiehl11, sfoster1 and smb2268 and removed request for a team and ncdiehl11 July 14, 2025 17:55

TamarZanzouri changed the title ~~Exec 1418 verify select location screen functionality~~ feature(app, shared-data): module setup deck config assignment Jul 14, 2025

removed console.log

754e149

TamarZanzouri requested a review from mjhuff July 14, 2025 18:01

mjhuff approved these changes Jul 15, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feature(app, shared-data): module setup deck config assignment #18864

feature(app, shared-data): module setup deck config assignment #18864

TamarZanzouri commented Jul 9, 2025 •

edited

Loading

Uh oh!

codecov bot commented Jul 9, 2025 •

edited

Loading

Uh oh!

mjhuff left a comment

Uh oh!

mjhuff Jul 15, 2025

Uh oh!

mjhuff Jul 15, 2025

Uh oh!

mjhuff Jul 15, 2025

Uh oh!

mjhuff Jul 15, 2025

Uh oh!

mjhuff Jul 15, 2025

Uh oh!

mjhuff Jul 15, 2025

Uh oh!

mjhuff Jul 15, 2025

Uh oh!

mjhuff Jul 15, 2025

Uh oh!

mjhuff Jul 15, 2025

Uh oh!

mjhuff Jul 15, 2025

Uh oh!

Uh oh!

		console.log('deckConfig: ', deckConfig)
		console.log('editableCutoutIds: ', editableCutoutIds)

	<Icon name="add-circle" color={COLORS.blue50} size="2rem" />
	<Icon name="add-circle" color={COLORS.blue50} size={SPACING.whatever} />

	const deckDef = getDeckDefFromRobotType('OT-3 Standard')
	const deckDef = getDeckDefFromRobotType(FLEX_ROBOT_TYPE)

	let replacementFixtureId: CutoutFixtureId = SINGLE_LEFT_SLOT_FIXTURE
	const replacementFixtureId: CutoutFixtureId = SINGLE_LEFT_SLOT_FIXTURE

		} = props

		console.log('addressableAreaId: ', addressableAreaId)

feature(app, shared-data): module setup deck config assignment #18864

Are you sure you want to change the base?

feature(app, shared-data): module setup deck config assignment #18864

Conversation

TamarZanzouri commented Jul 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Overview

Test Plan and Hands on Testing

Changelog

Review requests

Risk assessment

Uh oh!

codecov bot commented Jul 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

mjhuff left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

TamarZanzouri commented Jul 9, 2025 •

edited

Loading

codecov bot commented Jul 9, 2025 •

edited

Loading