fix(app): disable module commands when protocol paused #5209
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The module command cards displayed in the protocol run page have historically allowed users to send module commands (like setting temperature) when the protocol was active but paused. That used to work essentially as a side effect: modules didn't respect pausing, so you could tell them to do things while the protocol was paused. Now that modules respect pausing, sending module commands when the protocol is paused results in the modules not doing anything. The science and UX intent of controlling modules from the protocol run page is to implement pre-protocol preparation (like preheat) or post-protocol behavior (like keeping some incubation going), not to control the modules when paused - and in fact, when more advanced module control behaviors land in protocol designer or in the python api, controlling modules when the protocol is paused could break protocol execution. This PR changes the module command cards to only work when the protocol is not paused or running.
sfoster1
added
app
Codecov Report
@@ Coverage Diff @@
## edge #5209 +/- ##
==========================================
+ Coverage 60.85% 61.23% +0.37%
==========================================
Files 1027 1033 +6
Lines 29316 29817 +501
==========================================
+ Hits 17841 18259 +418
- Misses 11475 11558 +83
Continue to review full report at Codecov.
|
mcous
reviewed
Mar 12, 2020
|
Issues with text spacing on the run screen for module card when the protocol is paused Note: The issue is only on run tab
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The module command cards displayed in the protocol run page have
historically allowed users to send module commands (like setting
temperature) when the protocol was active but paused. That used to work
essentially as a side effect: modules didn't respect pausing, so you
could tell them to do things while the protocol was paused.
Now that modules respect pausing, sending module commands when the
protocol is paused results in the modules not doing anything.
The science and UX intent of controlling modules from the protocol run
page is to implement pre-protocol preparation (like preheat) or
post-protocol behavior (like keeping some incubation going), not to
control the modules when paused - and in fact, when more advanced module
control behaviors land in protocol designer or in the python api,
controlling modules when the protocol is paused could break protocol
execution.
This PR changes the module command cards to only work when the protocol
is not paused or running.
Testing
Note: Testing this pr requires #5194 to be installed on a robot (or a robot on 3.16.1 or previous)
Risk Assessment
Limited to out-of-protocol module interaction (and only in the app, at that). However, we should make sure to test both the protocol run page module cards and the pipette info page run cards.