feat(protocol-designer): analytics: pass only liquid class properties for liquids when saving protocol (#18509)

ncdiehl11 · web-flow · commit e445014d639c · 2025-06-05T11:19:11.000-04:00
Previously, we flattened all properties of all loaded liquids to mixpanel in our save protocol analytics event. This information was not particularly legible or useful, so product has asked that we only pass a list of liquid classes in this event. Closes AUTH-1923
diff --git a/protocol-designer/fixtures/protocol/8/doItAllV3MigratedToV8.json b/protocol-designer/fixtures/protocol/8/doItAllV3MigratedToV8.json
@@ -31,7 +31,8 @@
           "displayName": "Water",
           "description": null,
           "displayColor": "#b925ff",
-          "liquidGroupId": "0"
+          "liquidGroupId": "0",
+          "liquidClass": null
         }
       },
       "ingredLocations": {
@@ -2664,12 +2665,13 @@
       }
     }
   },
-  "liquidSchemaId": "opentronsLiquidSchemaV1",
+  "liquidSchemaId": "opentronsLiquidSchemaV2",
   "liquids": {
     "0": {
       "displayName": "Water",
       "description": "",
-      "displayColor": "#b925ff"
+      "displayColor": "#b925ff",
+      "liquidClass": null
     }
   },
   "commandSchemaId": "opentronsCommandSchemaV10",
diff --git a/protocol-designer/fixtures/protocol/8/doItAllV4MigratedToV8.json b/protocol-designer/fixtures/protocol/8/doItAllV4MigratedToV8.json
@@ -31,7 +31,8 @@
           "displayName": "Water",
           "description": null,
           "displayColor": "#b925ff",
-          "liquidGroupId": "0"
+          "liquidGroupId": "0",
+          "liquidClass": null
         }
       },
       "ingredLocations": {
@@ -2688,12 +2689,13 @@
       }
     }
   },
-  "liquidSchemaId": "opentronsLiquidSchemaV1",
+  "liquidSchemaId": "opentronsLiquidSchemaV2",
   "liquids": {
     "0": {
       "displayName": "Water",
       "description": "",
-      "displayColor": "#b925ff"
+      "displayColor": "#b925ff",
+      "liquidClass": null
     }
   },
   "commandSchemaId": "opentronsCommandSchemaV10",
diff --git a/protocol-designer/fixtures/protocol/8/doItAllV7MigratedToV8.json b/protocol-designer/fixtures/protocol/8/doItAllV7MigratedToV8.json
@@ -37,13 +37,15 @@
           "displayName": "Water",
           "description": null,
           "displayColor": "#b925ff",
-          "liquidGroupId": "0"
+          "liquidGroupId": "0",
+          "liquidClass": null
         },
         "1": {
           "displayName": "Samples",
           "description": null,
           "displayColor": "#ffd600",
-          "liquidGroupId": "1"
+          "liquidGroupId": "1",
+          "liquidClass": null
         }
       },
       "ingredLocations": {
@@ -4057,17 +4059,19 @@
       }
     }
   },
-  "liquidSchemaId": "opentronsLiquidSchemaV1",
+  "liquidSchemaId": "opentronsLiquidSchemaV2",
   "liquids": {
     "0": {
       "displayName": "Water",
       "description": "",
-      "displayColor": "#b925ff"
+      "displayColor": "#b925ff",
+      "liquidClass": null
     },
     "1": {
       "displayName": "Samples",
       "description": "",
-      "displayColor": "#ffd600"
+      "displayColor": "#ffd600",
+      "liquidClass": null
     }
   },
   "commandSchemaId": "opentronsCommandSchemaV10",
diff --git a/protocol-designer/fixtures/protocol/8/doItAllV8.json b/protocol-designer/fixtures/protocol/8/doItAllV8.json
@@ -31,13 +31,15 @@
           "displayName": "h20",
           "description": null,
           "displayColor": "#b925ff",
-          "liquidGroupId": "0"
+          "liquidGroupId": "0",
+          "liquidClass": null
         },
         "1": {
           "displayName": "sample",
           "description": null,
           "displayColor": "#ffd600",
-          "liquidGroupId": "1"
+          "liquidGroupId": "1",
+          "liquidClass": null
         }
       },
       "ingredLocations": {
@@ -3583,17 +3585,19 @@
       }
     }
   },
-  "liquidSchemaId": "opentronsLiquidSchemaV1",
+  "liquidSchemaId": "opentronsLiquidSchemaV2",
   "liquids": {
     "0": {
       "displayName": "h20",
       "description": "",
-      "displayColor": "#b925ff"
+      "displayColor": "#b925ff",
+      "liquidClass": null
     },
     "1": {
       "displayName": "sample",
       "description": "",
-      "displayColor": "#ffd600"
+      "displayColor": "#ffd600",
+      "liquidClass": null
     }
   },
   "commandSchemaId": "opentronsCommandSchemaV10",
diff --git a/protocol-designer/fixtures/protocol/8/example_1_1_0MigratedToV8.json b/protocol-designer/fixtures/protocol/8/example_1_1_0MigratedToV8.json
@@ -34,13 +34,15 @@
           "displayName": "samples",
           "description": null,
           "displayColor": "#b925ff",
-          "liquidGroupId": "0"
+          "liquidGroupId": "0",
+          "liquidClass": null
         },
         "1": {
           "displayName": "dna",
           "description": null,
           "displayColor": "#ffd600",
-          "liquidGroupId": "1"
+          "liquidGroupId": "1",
+          "liquidClass": null
         }
       },
       "ingredLocations": {
@@ -3570,17 +3572,19 @@
       }
     }
   },
-  "liquidSchemaId": "opentronsLiquidSchemaV1",
+  "liquidSchemaId": "opentronsLiquidSchemaV2",
   "liquids": {
     "0": {
       "displayName": "samples",
       "description": "",
-      "displayColor": "#b925ff"
+      "displayColor": "#b925ff",
+      "liquidClass": null
     },
     "1": {
       "displayName": "dna",
       "description": "",
-      "displayColor": "#ffd600"
+      "displayColor": "#ffd600",
+      "liquidClass": null
     }
   },
   "commandSchemaId": "opentronsCommandSchemaV10",
diff --git a/protocol-designer/fixtures/protocol/8/newAdvancedSettingsAndMultiTemp.json b/protocol-designer/fixtures/protocol/8/newAdvancedSettingsAndMultiTemp.json
@@ -3650,7 +3650,7 @@
       }
     }
   },
-  "liquidSchemaId": "opentronsLiquidSchemaV1",
+  "liquidSchemaId": "opentronsLiquidSchemaV2",
   "liquids": {},
   "commandSchemaId": "opentronsCommandSchemaV10",
   "commands": [
diff --git a/protocol-designer/fixtures/protocol/8/ninetySixChannelFullAndColumn.json b/protocol-designer/fixtures/protocol/8/ninetySixChannelFullAndColumn.json
@@ -2390,7 +2390,7 @@
       }
     }
   },
-  "liquidSchemaId": "opentronsLiquidSchemaV1",
+  "liquidSchemaId": "opentronsLiquidSchemaV2",
   "liquids": {},
   "commandSchemaId": "opentronsCommandSchemaV10",
   "commands": [
diff --git a/protocol-designer/fixtures/protocol/8/thermocyclerOnOt2V7MigratedToV8.json b/protocol-designer/fixtures/protocol/8/thermocyclerOnOt2V7MigratedToV8.json
@@ -31,7 +31,8 @@
           "displayName": "123",
           "description": null,
           "displayColor": "#b925ff",
-          "liquidGroupId": "0"
+          "liquidGroupId": "0",
+          "liquidClass": null
         }
       },
       "ingredLocations": {
@@ -2265,12 +2266,13 @@
       }
     }
   },
-  "liquidSchemaId": "opentronsLiquidSchemaV1",
+  "liquidSchemaId": "opentronsLiquidSchemaV2",
   "liquids": {
     "0": {
       "displayName": "123",
       "description": "",
-      "displayColor": "#b925ff"
+      "displayColor": "#b925ff",
+      "liquidClass": null
     }
   },
   "commandSchemaId": "opentronsCommandSchemaV10",
diff --git a/protocol-designer/src/analytics/middleware.ts b/protocol-designer/src/analytics/middleware.ts
@@ -419,7 +419,11 @@ export const reduxActionToAnalyticsEvent = (
           ? null
           : location
     )
-    const flattenedLiquids = flattenNestedProperties(liquids)
+    const liquidClasses = {
+      liquidClasses: Object.values(liquids).map(liquid =>
+        'liquidClass' in liquid ? liquid.liquidClass : null
+      ),
+    }
 
     const fixtureInfo = {
       trashBin: trashCommands,
@@ -439,7 +443,7 @@ export const reduxActionToAnalyticsEvent = (
         ...metadata,
         ...loadCommandInfo,
         ...robotType,
-        ...flattenedLiquids,
+        ...liquidClasses,
         ...numberOfSteps,
         ...fixtureInfo,
         ...labwareInfo,
diff --git a/protocol-designer/src/components/organisms/DefineLiquidsModal/LiquidClassDropdown.tsx b/protocol-designer/src/components/organisms/DefineLiquidsModal/LiquidClassDropdown.tsx
@@ -15,7 +15,7 @@ interface LiquidClassDropdownProps {
   control: Control<Ingredient, any>
   setValue: UseFormSetValue<Ingredient>
   liquidClassOptions: Array<{ name: string; value: string }>
-  liquidClass?: string
+  liquidClass?: string | null
 }
 
 export function LiquidClassDropdown({
diff --git a/protocol-designer/src/file-data/selectors/fileCreator.ts b/protocol-designer/src/file-data/selectors/fileCreator.ts
@@ -40,7 +40,7 @@ import type {
   CommandV10Mixin,
   CreateCommand,
   LabwareV2Mixin,
-  LiquidV1Mixin,
+  LiquidV2Mixin,
   OT2RobotMixin,
   OT3RobotMixin,
   ProtocolBase,
@@ -196,7 +196,7 @@ export const createFile: Selector<ProtocolFile> = createSelector(
       },
     }
 
-    const liquids: ProtocolFile['liquids'] = reduce(
+    const liquids: LiquidV2Mixin['liquids'] = reduce(
       liquidEntities,
       (acc, liquidData, liquidId) => {
         return {
@@ -205,6 +205,7 @@ export const createFile: Selector<ProtocolFile> = createSelector(
             displayName: liquidData.displayName,
             description: liquidData.description ?? '',
             displayColor: liquidData.displayColor ?? swatchColors(liquidId),
+            liquidClass: liquidData.liquidClass ?? null,
           },
         }
       },
@@ -244,8 +245,8 @@ export const createFile: Selector<ProtocolFile> = createSelector(
       labwareDefinitions,
     }
 
-    const liquidV1Mixin: LiquidV1Mixin = {
-      liquidSchemaId: 'opentronsLiquidSchemaV1',
+    const liquidV2Mixin: LiquidV2Mixin = {
+      liquidSchemaId: 'opentronsLiquidSchemaV2',
       liquids,
     }
 
@@ -305,7 +306,7 @@ export const createFile: Selector<ProtocolFile> = createSelector(
       ...protocolBase,
       ...deckStructure,
       ...labwareV2Mixin,
-      ...liquidV1Mixin,
+      ...liquidV2Mixin,
       ...commandv10Mixin,
       ...commandAnnotionaV1Mixin,
     }
diff --git a/protocol-designer/src/load-file/migration/8_4_4.ts b/protocol-designer/src/load-file/migration/8_4_4.ts
@@ -29,7 +29,6 @@ export const migrateFile = (
   ).reduce<Ingredients>((acc, [id, ingredient]) => {
     acc[id] = {
       displayName: ingredient.name ?? '',
-      liquidClass: ingredient.liquidClass,
       description: ingredient.description ?? null,
       liquidGroupId: id,
       displayColor: liquids[id].displayColor ?? swatchColors(id),
diff --git a/protocol-designer/src/load-file/migration/8_5_0.ts b/protocol-designer/src/load-file/migration/8_5_0.ts
@@ -20,10 +20,12 @@ import { getMigratedPositionFromTop } from './utils/getMigrationPositionFromTop'
 
 import type {
   LabwareDefinition2,
+  LiquidV2Mixin,
   LoadLabwareCreateCommand,
   PipetteV2Specs,
   ProtocolFile,
 } from '@opentrons/shared-data'
+import type { Ingredients } from '@opentrons/step-generation'
 import type { PDMetadata } from '../../file-types'
 import type { FormData } from '../../form-types'
 
@@ -42,11 +44,17 @@ const getMigratedBlowoutFlowRate = (
 export const migrateFile = (
   appData: ProtocolFile<PDMetadata>
 ): ProtocolFile<PDMetadata> => {
-  const { designerApplication, commands, labwareDefinitions, robot } = appData
+  const {
+    designerApplication,
+    commands,
+    labwareDefinitions,
+    robot,
+    liquids,
+  } = appData
   if (designerApplication == null || designerApplication?.data == null) {
     throw Error('The designerApplication key in your file is corrupt.')
   }
-  const { savedStepForms } = designerApplication.data
+  const { savedStepForms, ingredients } = designerApplication.data
   const { model: robotType } = robot
   const loadLabwareCommands = commands.filter(
     (command): command is LoadLabwareCreateCommand =>
@@ -57,6 +65,16 @@ export const migrateFile = (
     labwareDefinitions
   )
 
+  const migratedIngredients: Ingredients = Object.entries(
+    ingredients
+  ).reduce<Ingredients>((acc, [id, ingredient]) => {
+    acc[id] = {
+      ...ingredient,
+      liquidClass: null,
+    }
+    return acc
+  }, {})
+
   const savedStepsWithUpdatedMoveLiquidFields = Object.values(
     savedStepForms
   ).reduce((acc, form) => {
@@ -284,6 +302,19 @@ export const migrateFile = (
     {}
   )
 
+  const migratedLiquidsWithLiquidClass = Object.entries(liquids).reduce<
+    LiquidV2Mixin['liquids']
+  >((acc, [liquidId, liquid]) => {
+    acc[liquidId] = {
+      ...liquid,
+      liquidClass: null,
+    }
+    return acc
+  }, {})
+  const liquidV2Mixin: LiquidV2Mixin = {
+    liquidSchemaId: 'opentronsLiquidSchemaV2',
+    liquids: migratedLiquidsWithLiquidClass,
+  }
   return {
     ...appData,
     metadata: {
@@ -294,12 +325,14 @@ export const migrateFile = (
       ...designerApplication,
       data: {
         ...designerApplication.data,
+        ingredients: migratedIngredients,
         savedStepForms: {
           ...designerApplication.data.savedStepForms,
           ...savedStepsWithUpdatedMoveLiquidFields,
           ...savedStepsWithUpdatedMixFields,
         },
       },
     },
+    ...liquidV2Mixin,
   }
 }
diff --git a/protocol-designer/src/pages/Designer/ProtocolSteps/StepForm/StepTools/MoveLiquidTools/hooks.ts b/protocol-designer/src/pages/Designer/ProtocolSteps/StepForm/StepTools/MoveLiquidTools/hooks.ts
@@ -38,7 +38,7 @@ export function useAssignLiquidClass(
   const liquidClasses = getAllLiquidClassDefs()
   const liquidClassToLiquidsMap: Record<string, string[]> = {}
   Object.values(liquids).forEach(({ displayName, liquidClass }) => {
-    if (liquidClass !== undefined) {
+    if (liquidClass != null) {
       if (!liquidClassToLiquidsMap[liquidClass]) {
         liquidClassToLiquidsMap[liquidClass] = []
       }
diff --git a/shared-data/protocol/types/schemaV8/index.ts b/shared-data/protocol/types/schemaV8/index.ts
diff --git a/step-generation/src/types.ts b/step-generation/src/types.ts

Original file line number	Diff line number	Diff line change
`@@ -3650,7 +3650,7 @@`
`3650`	`3650`	`}`
`3651`	`3651`	`}`
`3652`	`3652`	`},`
`3653`		`- "liquidSchemaId": "opentronsLiquidSchemaV1",`
	`3653`	`+ "liquidSchemaId": "opentronsLiquidSchemaV2",`
`3654`	`3654`	`"liquids": {},`
`3655`	`3655`	`"commandSchemaId": "opentronsCommandSchemaV10",`
`3656`	`3656`	`"commands": [`
Original file line number	Diff line number	Diff line change
`@@ -2390,7 +2390,7 @@`
`2390`	`2390`	`}`
`2391`	`2391`	`}`
`2392`	`2392`	`},`
`2393`		`- "liquidSchemaId": "opentronsLiquidSchemaV1",`
	`2393`	`+ "liquidSchemaId": "opentronsLiquidSchemaV2",`
`2394`	`2394`	`"liquids": {},`
`2395`	`2395`	`"commandSchemaId": "opentronsCommandSchemaV10",`
`2396`	`2396`	`"commands": [`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ interface LiquidClassDropdownProps {`
`15`	`15`	`control: Control<Ingredient, any>`
`16`	`16`	`setValue: UseFormSetValue<Ingredient>`
`17`	`17`	`liquidClassOptions: Array<{ name: string; value: string }>`
`18`		`- liquidClass?: string`
	`18`	`+ liquidClass?: string \| null`
`19`	`19`	`}`
`20`	`20`
`21`	`21`	`export function LiquidClassDropdown({`