fix(protocol-designer): remove updatePatchPathField

[ncdiehl11]

Overview

Here, we remove the updatePatchPathField from dependentFieldsUpdateMoveLiquid.

Context

In the times of single-page step form PD, we wired up a patch during form updates that would reset the path from multiAspirate or multiDispense to single if advanced settings were configured such that multiAspirate or multiDispense are not possible. Here's an example:

• P300 pipette with 300µl tips
• 2x destination wells
• multiDispense path
• per-sample volume of 140µl
• aspirate air gap of 30µl **

In this scenario, without air gap (or disposal volume), we can comfortably aspirate 280µl, and dispense 140µl into each of our 2 destinations. However, with air gap, we can no longer accommodate both samples-worth of volume with air gap— this total volume would be 140 + 140 + 30 = 310µl > 300µl tip volume. So, previously, when this air gap was configured such that the tip volume was exceeded and multiDispense was not possible, the path would flip back to single.

The trouble is that in our new step form design, air gap configuration comes on page 3 of the step form, while the path is configured on page 1! A user would select multiDispense on page 1, add an air gap on page 3, save, and not realize the path has flipped back to single.

After speaking with the API team, we resolved to remove the patch such that the form always carries the user's selected path regardless of the tip's capacity, and determine the if the form's path is valid for its corresponding step generation command creator (single -> transfer, multiAspirate -> consolidate, or multiDispense -> distribute) in moveLiquidFormToArgs (see: checkedPath). This is to ensure we don't encounter errors in step generation in distribute or consolidate if multi-dispense or -aspiration, respectively, or is not possible. The downside is that we generate the Python API method transfer_with_liquid_class rather than distribute_with_liquid_class or consolidate_with_liquid_class in this scenario, but we determined it is the least of all evils at this stage of 8.5.0 development.

In a post-release followup, I will refactor distribute and consolidate command creator logic to allow non multi-aspiration/dispense behavior so that the most accurate Python is emitted.

Closes AUTH-1987

Changelog

• remove path patch described above
• remove air gap check in getDisabledPathMap implementation in PathField

Risk assessment

lowish

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 25.48%. Comparing base (cfa7df7) to head (62d9fdc).
Report is 1 commits behind head on chore_release-pd-8.5.0.

Additional details and impacted files

@@                    Coverage Diff                     @@
##           chore_release-pd-8.5.0   #18622      +/-   ##
==========================================================
- Coverage                   25.89%   25.48%   -0.42%     
==========================================================
  Files                        3256     3238      -18     
  Lines                      281350   280952     -398     
  Branches                    28562    28669     +107     
==========================================================
- Hits                        72869    71611    -1258     
- Misses                     208454   209312     +858     
- Partials                       27       29       +2     

Flag	Coverage Δ
protocol-designer	19.10% <100.00%> (-0.02%)	⬇️

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

Files with missing lines	Coverage Δ
...ProtocolSteps/StepForm/PipetteFields/PathField.tsx	27.21% <ø> (+0.72%)	⬆️
...andleFormChange/dependentFieldsUpdateMoveLiquid.ts	72.41% <ø> (-0.01%)	⬇️
...formLevel/handleFormChange/test/moveLiquid.test.ts	88.00% <100.00%> (-0.09%)	⬇️

... and 196 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.

[jerader]

thanks for the description! do you mind making a ticket for this? probably a ticket in this epic would be best for now.

In a post-release followup, I will refactor distribute and consolidate command creator logic to allow non multi-aspiration/dispense behavior so that the most accurate Python is emitted.

[jerader]

🦖

[ncdiehl11]

thanks for the description! do you mind making a ticket for this? probably a ticket in this epic would be best for now.

In a post-release followup, I will refactor distribute and consolidate command creator logic to allow non multi-aspiration/dispense behavior so that the most accurate Python is emitted.

Will do! I also noticed there's some logic in PathField that disables paths after checking air gap. I will make a commit to remove that logic.