feat(protocol-designer,-shared-data): add liquid class scaffolding to PD #17126

ncdiehl11 · 2024-12-17T19:38:09Z

Overview

This PR introduces initial work for liquid class support in protocol designer. I create a full liquid class interface based on the API's Pydantic model. I also add utilities for getting all liquid class definitions and a feature flag to hide liquid classes from the UI. Lastly, I add some of the basic functionality for assigning a liquid class to a defined liquid, and displaying that liquid class in LiquidCard. A liquid class assigned to a defined liquid will be accessible through extended existing selectors (allIngredientNamesIds) for step forms.

closes AUTH-965
closes AUTH-968

Test Plan and Hands on Testing

navigate to settings and flip on liquid classes feature flag
navigate to protocol overview and add or modify a liquid
select a liquid class (should only see water as this is the only built out definition as of now)
save and verify that liquid definitions reflect liquid class
add this liquid to a labware or inspect a labware that has already loaded this liquid
verify that liquid card in toolbox reflects liquid class

Screen.Recording.2024-12-17.at.2.44.38.PM.mov

Changelog

add liquid class interface
add liquid class feature flag
add liquid class definitions getter
update selectors to accommodate liquid classes
dad liquid class feature to DefineLiquidsModal, LiquidsToolbox, LiquidCard, LiquidDefinitions (behind feature flag)
update tests

Review requests

see test plan

Risk assessment

medium

This PR introduces initial work for liquid class support in protocol designer. I create a full liquid class interface based on the API's Pydantic model. I also add utilities for getting all liquid class definitions and a feature flag to hide liquid classes from the UI. Lastly, I add some of the basic functionality for assigning a liquid class to a defined liquid, and displaying that liquid class in LiquidCard. A liquid class assigned to a defined liquid will be accessible through extended existing selectors (allIngredientNamesIds) for step forms.

jerader · 2024-12-17T20:32:57Z

protocol-designer/src/labware-ingred/types.ts

 // ==== INGREDIENTS ====
 export type OrderedLiquids = Array<{
  ingredientId: string
  name: string | null | undefined
  displayColor: string | null | undefined
+  liquidClass: string | null | undefined


nit, the other fields can be refactored as well.

Suggested change

liquidClass: string | null | undefined

liquidClass?: string | null

is this undefined here to avoid needing to add this to a migration?

I think these are unnecessarily allowed to be undefined or null in some cases. The modal disallows saving without a liquid name, and displayColor is always a valid hex string. I think description can be set to null for easier use downstream as well. Thoughts on this interface for the selector allIngredientGroupFields:

export interface LiquidGroup { name: string description: string | null displayColor: string liquidClass: string | null serialize: boolean }

and since we're dealing with nullish initial values in DefineLiquidsModal, we can update that interface to

interface LiquidEditFormValues { name: string displayColor: string description: string liquidClass: string serialize: boolean [key: string]: unknown }

i see, that makes sense to me.

i think we would need liquidClass to be undefined in OrderedLiquids at least because its included in the JSON protocols and if it is always null or a string, we'd need to make a migration for it. i'm all for adding this to the migration but not right now since there's no way to put it behind a FF. Do you mind adding a TODO or something above the type to remind us to migrate it later?

For sure! I will keep it as an optional property for now and we can remove the optionality and add a migration later

protocol-designer/src/labware-ingred/types.ts

protocol-designer/src/liquid-defs/utils.ts

jerader · 2024-12-17T20:38:58Z

shared-data/js/types.ts

+  | 'well-top'
+  | 'well-center'
+  | 'liquid-meniscus'
+type BlowoutLocation = 'source' | 'destination' | 'trash'


do we not have this type already?

I don't see it anywhere in ts types

jerader

looks great! left some comments. curious if adding liquidClass to the ingredients would be nice to have in the migration -- like populating it to null. though it'd be tricky to make a migration right now since we may need one in 8.3.0 or for plate reader, so i'd recommend adding a TODO for that for now if we decide to go down that route.

koji · 2024-12-17T20:53:14Z

protocol-designer/src/pages/ProtocolOverview/LiquidDefinitions.tsx

+  IngredInputs,
+} from '../../labware-ingred/types'
+
+const getLiquidDescription = (


for consistency

Suggested change

const getLiquidDescription = (

function getLiquidDescription(

I thought we usually defined utility functions with const notation?

wait i thought so too?

sorry the comment isn't clear enough.

This returns JSX.Elment so the following method would be consistent.

function LiquidDescription()

shared-data/js/types.ts

koji · 2024-12-17T21:03:43Z

shared-data/js/types.ts

+  touchTip: TouchTipProperties
+  delay: DelayProperties
+}
+type RetractAspirate = BaseRetract


need this?

extends BaseLiquidHandlingProperties<BaseRetract>

I don't think so, since the interface is exactly the same. I wanted to add a Base interface so that Aspirate and Dispense could share it

koji · 2024-12-17T21:07:00Z

probably add ff mock code to protocol-designer/src/pages/ProtocolOverview/__tests__/LiquidDefinitions.test.tsx

jerader

awesome! 🎉

ncdiehl11 self-assigned this Dec 17, 2024

ncdiehl11 requested review from koji, shlokamin and jerader December 17, 2024 19:38

ncdiehl11 added the authorship label Dec 17, 2024

ncdiehl11 marked this pull request as ready for review December 17, 2024 19:51

ncdiehl11 requested review from a team as code owners December 17, 2024 19:51

ncdiehl11 removed request for a team December 17, 2024 19:51

hide liquiddefinitions liquidclasses behind ff

e6b2407

jerader reviewed Dec 17, 2024

View reviewed changes

protocol-designer/src/labware-ingred/types.ts Show resolved Hide resolved

jerader reviewed Dec 17, 2024

View reviewed changes

protocol-designer/src/liquid-defs/utils.ts Outdated Show resolved Hide resolved

jerader reviewed Dec 17, 2024

View reviewed changes

refactor LiquidDefinitions content

a4e11a8

jerader reviewed Dec 17, 2024

View reviewed changes

koji reviewed Dec 17, 2024

View reviewed changes

shared-data/js/types.ts Show resolved Hide resolved

koji reviewed Dec 17, 2024

View reviewed changes

fix tests

997baec

ncdiehl11 added 2 commits December 17, 2024 16:26

clean up types and test

b583dd9

fix colorpicker zindex

121c7dd

ncdiehl11 requested review from jerader and koji December 17, 2024 21:41

jerader approved these changes Dec 17, 2024

View reviewed changes

add todo for migration

9dca002

ncdiehl11 merged commit f8def77 into edge Dec 18, 2024
36 checks passed

ncdiehl11 deleted the pd_feat-liquid-class-scaffolding branch December 18, 2024 14:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(protocol-designer,-shared-data): add liquid class scaffolding to PD #17126

feat(protocol-designer,-shared-data): add liquid class scaffolding to PD #17126

ncdiehl11 commented Dec 17, 2024 •

edited

Loading

jerader Dec 17, 2024

jerader Dec 17, 2024

ncdiehl11 Dec 17, 2024 •

edited

Loading

ncdiehl11 Dec 17, 2024 •

edited

Loading

jerader Dec 17, 2024

ncdiehl11 Dec 17, 2024

jerader Dec 17, 2024

ncdiehl11 Dec 17, 2024

jerader left a comment

koji Dec 17, 2024 •

edited

Loading

ncdiehl11 Dec 17, 2024

jerader Dec 17, 2024

koji Dec 18, 2024

koji Dec 17, 2024

ncdiehl11 Dec 17, 2024

koji commented Dec 17, 2024

jerader left a comment

	liquidClass: string \| null \| undefined
	liquidClass?: string \| null

	const getLiquidDescription = (
	function getLiquidDescription(

feat(protocol-designer,-shared-data): add liquid class scaffolding to PD #17126

feat(protocol-designer,-shared-data): add liquid class scaffolding to PD #17126

Conversation

ncdiehl11 commented Dec 17, 2024 • edited Loading

Overview

Test Plan and Hands on Testing

Changelog

Review requests

Risk assessment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ncdiehl11 Dec 17, 2024 • edited Loading

Choose a reason for hiding this comment

ncdiehl11 Dec 17, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jerader left a comment

Choose a reason for hiding this comment

koji Dec 17, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

koji commented Dec 17, 2024

jerader left a comment

Choose a reason for hiding this comment

ncdiehl11 commented Dec 17, 2024 •

edited

Loading

ncdiehl11 Dec 17, 2024 •

edited

Loading

ncdiehl11 Dec 17, 2024 •

edited

Loading

koji Dec 17, 2024 •

edited

Loading