feat(odd): list actions to document in reason for interaction flow + pass interaction reason with mutations#21681
Open
janiejaffe wants to merge 18 commits into
Open
feat(odd): list actions to document in reason for interaction flow + pass interaction reason with mutations#21681janiejaffe wants to merge 18 commits into
janiejaffe wants to merge 18 commits into
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Overview
Screen.Recording.2026-06-05.at.2.19.50.PM.mov
Adds new popup to DocumentationRequired modal that lists all actions that should currently be documented. For most actions this will be a single line - 'Playing protocol', etc. For maintenance runs, the app will track each command sent to the server during the run and display them on this popup.
Additionally, this PR hooks up the documentation modal to requests sent to the server, passing provided notes along in the header as 'userNotes'.
Test Plan and Hands on Testing
Adds unit tests for displaying the correct strings for maintenance run commands.
To test, go through maintenance runs like attaching, detaching, and calibrating pipettes, labware, and modules. All mutations sent to the server should be listed in a distinct line item, and all line items should have proper text and formatting.
Review requests
I did my best to track down maintenance run commands that weren't represented in CommandText, but if you notice any I'm missing let me know. Also let me know if my approach for passing along userNotes to the server makes sense.
Risk assessment
Medium. Should not change anything functionally for maintenance runs or other usages of CommandText, but I will need to keep an eye out for maintenance run commands that do not display correctly.