feat(protocol-designer): cap flow rate at hardware maximum

[ncdiehl11]

Overview

This PR ensures that the interpolated liquid class flow rate for aspirate, dispense, and blowout does not exceed the range prescribed by the pipette liquid definition's plunger curves. To achieve this, we reuse the max flow rate logic in getMaxUiFlowRate in the liquid class form change handler utils, to make sure the populated flow rates from the liquid class are physically possible.

The code is a bit redundant in the various form change utils, but I am erring on the side of caution vs. DRY given the upcoming release. I can refactor the utilities in a followup post-release.

Closes RQA-4151

Test Plan and Hands on Testing

• import the protocol attached to this ticket (titled RQA4151_updated.py)
• edit the transfer step to transfer a volume of 1000µl (change destination labware if necessary)
• select viscous liquid class
• update liquid class values when prompted
• confirm that all flow rates (aspirate, dispense, blowout) do not exceed the maximum shown in the flow rate caption

Changelog

• implement hardware (UI) max flow rate logic in getLiquidClassValuesMoveLiquid and getLiquidClassValuesMix
• refine types in getMaxUiFlowRate

Review requests

see test plan

Risk assessment

medium. touches core logic of liquid class value population

[codecov]

Codecov Report

Attention: Patch coverage is 3.26087% with 267 lines in your changes missing coverage. Please review.

Project coverage is 24.60%. Comparing base (e4ab7b3) to head (7731899).
Report is 1 commits behind head on chore_release-pd-8.5.0.

Files with missing lines	Patch %	Lines
...r/src/steplist/formLevel/handleFormChange/utils.ts	1.47%	267 Missing ⚠️

Additional details and impacted files

@@                    Coverage Diff                     @@
##           chore_release-pd-8.5.0   #18859      +/-   ##
==========================================================
- Coverage                   24.62%   24.60%   -0.03%     
==========================================================
  Files                        3263     3263              
  Lines                      282679   282891     +212     
  Branches                    30247    30244       -3     
==========================================================
- Hits                        69602    69596       -6     
- Misses                     213057   213275     +218     
  Partials                       20       20              

Flag	Coverage Δ
protocol-designer	19.09% <3.26%> (-0.03%)	⬇️

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

Files with missing lines	Coverage Δ
...gner/ProtocolSteps/StepForm/PipetteFields/utils.ts	17.35% <100.00%> (-1.87%)	⬇️
...r/src/steplist/formLevel/handleFormChange/utils.ts	14.82% <1.47%> (-2.79%)	⬇️

🚀 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]

Suggested change

	import { min } from 'lodash'
	import min from 'lodash/min'

[jerader]

it works with the example you added. hopefully this is it for tweaking flow rate 🤞 i wonder if some of these utils can be moved to step-generation or shared-data so quick transfer can use them too? not necessary to do it in this PR, you can do it next week.

[ncdiehl11]

it works with the example you added. hopefully this is it for tweaking flow rate 🤞 i wonder if some of these utils can be moved to step-generation or shared-data so quick transfer can use them too? not necessary to do it in this PR, you can do it next week.

Yep, I actually mentioned that to Koji on one of his PRs, and I believe he is ticketing that refactor. Especially getMaxUIFlowRate and all of the liquid class form change utils. It might need a bit of massaging to move out of PD, but not too bad.