Skip to content

feat(protocol-designer): add warning about dangerous submerge/retract position #18825

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 3, 2025

Conversation

ncdiehl11
Copy link
Collaborator

@ncdiehl11 ncdiehl11 commented Jul 3, 2025

Overview

In analysis, we determine whether the submerge/retract location for a given liquid transfer is deemed to be within the specified well's liquid. We are afforded this since the API calculates the liquid meniscus height in a all wells throughout the protocol. However, we do not have access to this logic in Protocol Designer. Due to this reality, we cannot know for sure whether a submerge/retract position set inside a well is safely above the meniscus level. The resolution is to warn the user that their submerge/retract position may result in analysis failure if the tip is in fact below the calculated liquid meniscus at the time of the pipette movement.

Screenshot 2025-07-03 at 2 05 51 PM

Closes RQA-4334

Test Plan and Hands on Testing

  • create or import a protocol with a transfer step
  • navigate to advanced settings
  • open aspirate submerge tip position and set the z value such that the tip is inside the well
  • verify banner warning the user about possible analysis errors
  • repeat with aspirate retract, dispense submerge, and dispense retract
  • open aspirate/dispense tip position and set the z value such that the tip is inside the well. verify that the banner does not show

Changelog

  • introduce logic for determining unsafe submerge/retract positions
  • wire up banner if tip position is unsfae
  • refactor constants
  • update tests
  • remove unneeded subdirectory

Review requests

see test plan

Risk assessment

low

… position

In analysis, we determine whether the submerge/retract location for a given liquid transfer is deemed to be within the specified well's liquid. We are afforded this since the API calculates the liquid meniscus height in a all wells throughout the protocol. However, we do not have access to this logic in Protocol Designer. Due to this reality, we cannot know for sure whether a submerge/retract position set inside a well is safely above the meniscus level. The resolution is to warn the user that their submerge/retract position may result in analysis failure if the tip is in fact below the calculated liquid meniscus at the time of the pipette movement.

Closes RQA-4334
@ncdiehl11 ncdiehl11 self-assigned this Jul 3, 2025
@ncdiehl11 ncdiehl11 requested review from koji and jerader July 3, 2025 18:18
@ncdiehl11 ncdiehl11 marked this pull request as ready for review July 3, 2025 18:18
@ncdiehl11 ncdiehl11 requested a review from a team as a code owner July 3, 2025 18:18
@ncdiehl11 ncdiehl11 removed the request for review from a team July 3, 2025 18:18
Copy link

codecov bot commented Jul 3, 2025

Codecov Report

Attention: Patch coverage is 89.09091% with 6 lines in your changes missing coverage. Please review.

Project coverage is 27.70%. Comparing base (3ad5220) to head (f8ab586).
Report is 1 commits behind head on chore_release-pd-8.5.0.

Files with missing lines Patch % Lines
...ocolSteps/StepForm/PipetteFields/PositionField.tsx 0.00% 3 Missing ⚠️
...rc/components/organisms/TipPositionModal/utils.tsx 81.81% 2 Missing ⚠️
...rc/components/organisms/TipPositionModal/index.tsx 96.87% 1 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@                   Coverage Diff                   @@
##           chore_release-pd-8.5.0   #18825   +/-   ##
=======================================================
  Coverage                   27.70%   27.70%           
=======================================================
  Files                        3204     3204           
  Lines                      250439   250480   +41     
  Branches                    26320    26321    +1     
=======================================================
+ Hits                        69380    69405   +25     
- Misses                     181042   181058   +16     
  Partials                       17       17           
Flag Coverage Δ
protocol-designer 19.11% <89.09%> (+<0.01%) ⬆️

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

Files with missing lines Coverage Δ
...components/organisms/TipPositionModal/constants.ts 100.00% <100.00%> (ø)
...ms/TipPositionModal/hooks/usePositionReference.tsx 44.04% <ø> (ø)
...rc/components/organisms/TipPositionModal/index.tsx 78.76% <96.87%> (-0.16%) ⬇️
...rc/components/organisms/TipPositionModal/utils.tsx 85.83% <81.81%> (-0.41%) ⬇️
...ocolSteps/StepForm/PipetteFields/PositionField.tsx 0.91% <0.00%> (ø)
🚀 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.

Copy link
Collaborator

@jerader jerader left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

left a couple of nits but smoke tested and works well!

@ncdiehl11 ncdiehl11 merged commit d6aaced into chore_release-pd-8.5.0 Jul 3, 2025
14 checks passed
@ncdiehl11 ncdiehl11 deleted the pd_feat-submergeretract-warning branch July 3, 2025 18:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants