feature(app): get command text for flex stacker commands #18045

TamarZanzouri · 2025-04-11T16:03:21Z

Overview

closes https://opentrons.atlassian.net/browse/EXEC-1135.
add flex stacker commands to command text

Test Plan and Hands on Testing

upload the following protocol and make sure all commands appear with the correct text:

requirements = {"robotType": "Flex", "apiLevel": "2.23"}


def run(protocol):
    stacker_c = protocol.load_module("flexStackerModuleV1", "C4")
    stacker_d = protocol.load_module("flexStackerModuleV1", "D4")
    stacker_c.set_stored_labware(load_name="opentrons_flex_96_tiprack_1000ul", count=5)

    tiprack = stacker_c.retrieve()
    stacker_c.store()
    stacker_c.empty(message="hell")
    stacker_c.fill(message="whatttt")

Changelog

added command text logic for flex stacker commands and added tests.

Review requests

changes make sesense? am I missing something?

Risk assessment

Medium. affects command text rendering, need to smoke test

codecov · 2025-04-11T16:07:15Z

Codecov Report

Attention: Patch coverage is 54.59770% with 79 lines in your changes missing coverage. Please review.

Project coverage is 26.47%. Comparing base (b6a86c7) to head (9c7c4f3).

Files with missing lines	Patch %	Lines
...ing/utils/commandText/getFlexStackerCommandText.ts	64.28%	45 Missing ⚠️
...rganisms/CommandText/useCommandTextString/index.ts	0.00%	13 Missing ⚠️
.../useCommandTextString/utils/getLabwareLocation.tsx	0.00%	11 Missing ⚠️
...mandTextString/utils/getLabwareDisplayLocation.tsx	56.52%	10 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             edge   #18045      +/-   ##
==========================================
+ Coverage   25.47%   26.47%   +0.99%     
==========================================
  Files        3008     2966      -42     
  Lines      233870   231261    -2609     
  Branches    20072    19883     -189     
==========================================
+ Hits        59584    61221    +1637     
+ Misses     174271   170018    -4253     
- Partials       15       22       +7

Flag	Coverage Δ
step-generation	`4.38% <0.00%> (-0.01%)`	⬇️

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

Files with missing lines	Coverage Δ
...xt/useCommandTextString/utils/commandText/index.ts	`100.00% <100.00%> (ø)`
...mandTextString/utils/getLabwareDisplayLocation.tsx	`65.78% <56.52%> (-3.52%)`	⬇️
.../useCommandTextString/utils/getLabwareLocation.tsx	`29.85% <0.00%> (+0.31%)`	⬆️
...rganisms/CommandText/useCommandTextString/index.ts	`77.20% <0.00%> (-4.32%)`	⬇️
...ing/utils/commandText/getFlexStackerCommandText.ts	`66.16% <64.28%> (+53.66%)`	⬆️

... and 210 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. A couple clean up comments.

...mandText/useCommandTextString/utils/commandText/__tests__/getFlexStackerCommandText.test.tsx

...rc/organisms/CommandText/useCommandTextString/utils/commandText/getFlexStackerCommandText.ts

mjhuff

lgtm with passing CI!

ecormany

Just nitpicking some prepositions. Can you tell I used to teach freshman composition? 😇

app/src/assets/localization/en/protocol_command_text.json

Co-authored-by: Ed Cormany <edward.cormany@opentrons.com>

…n-log

vegano1 · 2025-04-14T13:38:53Z

@TamarZanzouri
looks great, thank you
Can we also say the number of labware we are filling the stacker with for the' fill' command?

smb2268 · 2025-04-14T15:01:20Z

...rc/organisms/CommandText/useCommandTextString/utils/commandText/getFlexStackerCommandText.ts

+  command: FlexStackerCommand
+): string | null => {
+  if (command.result !== undefined && 'primaryLabwareURI' in command?.result) {
+    const currentLabwareDef = getAllLabwareDefs()[


This should be refactored to grab the definitions from getLabwareDefinitionsByURIForProtocol which I added because we aren't able to get definitions for custom labware in this way. You'll might need to grab this definition map at the top level of command text and drill it down here!

smb2268 · 2025-04-14T15:06:41Z

app/src/assets/localization/en/protocol_command_text.json

+  "flex_stacker_fill": "Fill Flex Stacker",
+  "flex_stacker_fill_with_quantity_and_labware": "Fill Flex Stacker with {{quantity}} {{primaryDefinitionDisplayName}}",
+  "flex_stacker_retrieve": "Retrieve from Flex Stacker",
+  "flex_stacker_set_stored_labware": "Set stored labware in Flex Stacker",


These strings don't match the ones Nick and I came up with that are listed in the ticket. Can you update them to ensure they're all written properly? I also don't think we should need a version with + without all of these variables. Only setStoredLabware and fill should have optional fields.

these are the strings from the ticket, I just made sure + default in case there is no command found

There's a few small differences! Added a few more comments. Is it possible for there to be no command found here?

@smb2268 probably not.. I just followed the other module commands. if there are small diffs that might be bc Ed gave me feedback?

smb2268 · 2025-04-14T15:18:56Z

...rc/organisms/CommandText/useCommandTextString/utils/commandText/getFlexStackerCommandText.ts

-  return ''
+  const primaryDefinitionDisplayName = getPrimaryLabwareUriIfExsists(command)
+  if (command.commandType === 'flexStacker/retrieve') {
+    const slotName = getLabwareDisplayLocation({


We'll need to adjust this getLabwareDisplayLocation function for stacker. If we're trying to get the location of the stacker itself, we want to represent that as "Column A". For labware in the hopper it would be "Flex Stacker in Column A" and for the location shuttle location, we'll say "A4".

smb2268

This looks good so far, but there's a little more work to do to get these strings and display locations in line with the product requirements - see above comments!

...rc/organisms/CommandText/useCommandTextString/utils/commandText/getFlexStackerCommandText.ts

app/src/assets/localization/en/protocol_command_text.json

smb2268 · 2025-04-15T01:44:25Z

app/src/assets/localization/en/protocol_command_text.json

@@ -74,6 +82,7 @@
  "prepare_to_aspirate": "Preparing {{pipette}} to aspirate",
  "pressurizing_to_dispense": "Pressurize pipette to dispense {{volume}} µL from resin tip at {{flow_rate}} µL/sec",
  "reloading_labware": "Reloading {{labware}}",
+  "retrieve_labware_from_stacker_to": "Retrieve {{primaryDefinitionDisplayName}} from {{slotName}}",


This should have two locations -- from Flex Stacker in {{stackerColumn}} to {{slotName}}

There is no "to" when retrieving. it stays on the shuttle

app/src/assets/localization/en/protocol_command_text.json

…n-log

mjhuff · 2025-04-16T15:10:18Z

app/src/assets/localization/en/anonymous.json

+  "flex_stacker_empty": "Manually empty all labware from Robot Stacker",
+  "flex_stacker_empty_from_location": "Manually empty all labware from Robot {{stackerColumn}}",
+  "flex_stacker_fill": "Fill Robot Stacker",
+  "flex_stacker_fill_with_quantity_and_labware": "Fill Robot {{stackerColumn}} with {{quantity}} {{labwareAndLidDisplayNames}}",
+  "flex_stacker_retrieve": "Retrieve from Robot Stacker",
+  "flex_stacker_set_stored_labware": "Set stored labware in Robot Stacker",
+  "flex_stacker_set_stored_labware_with_quantity_and_location": "Configure Robot {{stackerColumn}} with {{quantity}} {{labwareAndLidDisplayNames}}",
+  "flex_stacker_store": "Store into Robot Stacker",
+  "store_labware_from_slot_to_stacker": "Store {{primaryDefinitionDisplayName}} from {{slotName}} to Robot Stacker",
+  "retrieve_labware_from_stacker_to": "Retrieve {{primaryDefinitionDisplayName}} from Robot Stacker to {{slotName}}"


Is it intentional to treat "Robot Stacker" as a proper noun?

Nick asked to switch Flex Stacker with Robot Stacker :-) let me know what you think it should be instead

TamarZanzouri added 9 commits April 8, 2025 20:51

WIP implement getFlexStackerCommandText

823fbbc

exploring

eacd66c

get retieve command text

e3e2c23

command text for store WIP

dd88d91

add defualts to text. fixed logic to get labware location. lint fixes

cc67cdf

setStoredLabware

7c25d82

empty+fill

b06b674

bug fixes and started to add tests

b30714f

added tests

22fa669

TamarZanzouri requested a review from a team as a code owner April 11, 2025 16:03

TamarZanzouri requested review from ncdiehl11, mjhuff and smb2268 and removed request for a team and ncdiehl11 April 11, 2025 16:03

mjhuff reviewed Apr 11, 2025

View reviewed changes

...mandText/useCommandTextString/utils/commandText/__tests__/getFlexStackerCommandText.test.tsx Outdated Show resolved Hide resolved

...rc/organisms/CommandText/useCommandTextString/utils/commandText/getFlexStackerCommandText.ts Outdated Show resolved Hide resolved

TamarZanzouri added 2 commits April 11, 2025 13:35

export and import KEYS_BY_COMMAND_TYPE

735849e

describe each and move logic to function without let

00d5e27

TamarZanzouri requested a review from mjhuff April 11, 2025 18:03

mjhuff approved these changes Apr 11, 2025

View reviewed changes

ecormany reviewed Apr 11, 2025

View reviewed changes

app/src/assets/localization/en/protocol_command_text.json Outdated Show resolved Hide resolved

app/src/assets/localization/en/protocol_command_text.json Outdated Show resolved Hide resolved

linting

46b35ff

TamarZanzouri requested a review from a team as a code owner April 11, 2025 20:13

TamarZanzouri and others added 3 commits April 11, 2025 16:15

Update app/src/assets/localization/en/protocol_command_text.json

906b7f3

Co-authored-by: Ed Cormany <edward.cormany@opentrons.com>

Update app/src/assets/localization/en/protocol_command_text.json

1a6125f

Co-authored-by: Ed Cormany <edward.cormany@opentrons.com>

Merge branch 'edge' into EXEC-1135-support-for-stacker-commands-in-ru…

ce40b3e

…n-log

smb2268 reviewed Apr 14, 2025

View reviewed changes

smb2268 requested changes Apr 14, 2025

View reviewed changes

smb2268 reviewed Apr 15, 2025

View reviewed changes

TamarZanzouri and others added 5 commits April 15, 2025 11:58

Merge branch 'edge' into EXEC-1135-support-for-stacker-commands-in-ru…

0d3e231

…n-log

pr feedback + getLabwareDisplayLocation WIP

c4547f7

WIP get labware location

67a0a90

slot only and full for stacker and text fixes

12536f3

branded translations

2d939f8

TamarZanzouri requested a review from smb2268 April 16, 2025 14:52

Merge branch 'edge' into EXEC-1135-support-for-stacker-commands-in-ru…

4b9493d

…n-log

mjhuff reviewed Apr 16, 2025

View reviewed changes

get def by uri and column for full command text

9c7c4f3

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feature(app): get command text for flex stacker commands #18045

feature(app): get command text for flex stacker commands #18045

TamarZanzouri commented Apr 11, 2025 •

edited

Loading

codecov bot commented Apr 11, 2025 •

edited

Loading

mjhuff left a comment •

edited

Loading

mjhuff left a comment

ecormany left a comment

vegano1 commented Apr 14, 2025

smb2268 Apr 14, 2025 •

edited

Loading

smb2268 Apr 14, 2025

TamarZanzouri Apr 15, 2025

smb2268 Apr 15, 2025

TamarZanzouri Apr 15, 2025

smb2268 Apr 14, 2025

smb2268 left a comment

smb2268 Apr 15, 2025

TamarZanzouri Apr 15, 2025

mjhuff Apr 16, 2025

TamarZanzouri Apr 16, 2025

feature(app): get command text for flex stacker commands #18045

Are you sure you want to change the base?

feature(app): get command text for flex stacker commands #18045

Conversation

TamarZanzouri commented Apr 11, 2025 • edited Loading

Overview

Test Plan and Hands on Testing

Changelog

Review requests

Risk assessment

codecov bot commented Apr 11, 2025 • edited Loading

Codecov Report

mjhuff left a comment • edited Loading

Choose a reason for hiding this comment

mjhuff left a comment

Choose a reason for hiding this comment

ecormany left a comment

Choose a reason for hiding this comment

vegano1 commented Apr 14, 2025

smb2268 Apr 14, 2025 • edited Loading

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

smb2268 left a 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

TamarZanzouri commented Apr 11, 2025 •

edited

Loading

codecov bot commented Apr 11, 2025 •

edited

Loading

mjhuff left a comment •

edited

Loading

smb2268 Apr 14, 2025 •

edited

Loading