feat(api): add liquid classes to the StateSummary. #16899
Merged
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
y3rsh
added
the
gen-analyses-snapshot-pr
|
A PR has been opened to address analyses snapshot changes. Please review the changes here: #16914 |
…#16914) This PR was requested on the PR #16899 Co-authored-by: y3rsh <[email protected]>
…t. Merge remote-tracking branch 'origin' into lcsumm
jbleon95
approved these changes
Nov 20, 2024
sanni-t
approved these changes
Nov 20, 2024
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.
Overview
AUTH-851
Export the liquid classes we loaded into the Protocol Engine to the
StateSummary, which will let clients see what liquid classes we loaded.The liquid classes are stored internally as a map of
{liquid_class_id -> LiquidClassRecords}, but following the convention for the other fields in theStateSummary, we want to export the liquid classes as a list, so this PR defines a newLiquidClassRecordWithIdclass for the summary.The fields in the
StateSummaryin turn are propagated to the CLIAnalyzeResults, and are mirrored to the robot-serverCompletedAnalysis,Run, andMaintenanceRunmodels. So every call-site that uses those classes had to be updated, as well as every test that checks those classes, as well as 200 snapshot tests -- which was kind of painful.Test Plan and Hands on Testing
I'm relying on the CI tests to make sure I found all the call-sites that are affected.
(We don't yet have any protocols that load liquid classes, but when we do, we can probably add integration tests to show that the liquid classes end up in the summaries.)
Review requests
I recommend collapsing the
analyses-snapshot-testing/when looking at this PR in Github. There are so many snapshot changes that Github sometimes errors out when trying to render the diff.The primary files with code changes are:
api/src/opentrons/protocol_engine/types.pyapi/src/opentrons/protocol_engine/state/state.pyapi/src/opentrons/protocol_engine/state/state_summary.pyapi/src/opentrons/cli/analyze.pyrobot-server/robot_server/runs/run_models.pyrobot-server/robot_server/protocols/analysis_models.pyrobot-server/robot_server/maintenance_runs/maintenance_run_models.pyThe other files are pretty mechanical changes.
Risk assessment
Low risk, should affect dev only.