refactor(step-generation): load_liquid more eloquantly (#18731)

closes AUTH-1454

Author: jerader

step-generation/src/__tests__/pythonFileUtils.test.ts

@@ -433,7 +433,7 @@ liquid_2 = protocol.define_liquid(
 })
 
 describe('getLoadLiquids', () => {
-  it('should generate 2 liquids in 2 labware in 4 wells', () => {
+  it('should generate 2 liquids in 2 labware in multiple wells', () => {
     const mockLiquidsBylabwareId: LabwareLiquidState = {
       [labwareId3]: {
         A1: { [liquid1]: { volume: 10 } },
@@ -442,6 +442,14 @@ describe('getLoadLiquids', () => {
       },
       [labwareId4]: {
         D1: { [liquid2]: { volume: 180 } },
+        D2: { [liquid2]: { volume: 180 } },
+        D3: { [liquid2]: { volume: 180 } },
+        D4: { [liquid2]: { volume: 180 } },
+        D5: { [liquid2]: { volume: 180 } },
+        D6: { [liquid2]: { volume: 180 } },
+        D7: { [liquid2]: { volume: 180 } },
+        D8: { [liquid2]: { volume: 180 } },
+        E3: { [liquid2]: { volume: 180 } },
       },
     }
     expect(
@@ -453,10 +461,24 @@ describe('getLoadLiquids', () => {
     ).toBe(
       `
 # Load Liquids:
-well_plate_1["A1"].load_liquid(liquid_1, 10)
-well_plate_1["A2"].load_liquid(liquid_1, 10)
-well_plate_1["A3"].load_liquid(liquid_2, 50)
-well_plate_2["D1"].load_liquid(liquid_2, 180)`.trimStart()
+well_plate_1.load_liquid(
+    wells=["A1", "A2"],
+    liquid=liquid_1,
+    volume=10,
+)
+well_plate_1.load_liquid(
+    wells=["A3"],
+    liquid=liquid_2,
+    volume=50,
+)
+well_plate_2.load_liquid(
+    wells=[
+        "D1", "D2", "D3", "D4", "D5", "D6", "D7", "D8",
+        "E3"
+        ],
+    liquid=liquid_2,
+    volume=180,
+)`.trimStart()
     )
   })
 })

step-generation/src/utils/pythonFileUtils.ts

@@ -14,6 +14,8 @@ import {
   CUSTOM_LABWARE_DICT_NAME,
   formatPyDict,
   formatPyStr,
+  getChunkForIndentingLists,
+  INDENT,
   indentPyLines,
   OFF_DECK,
   PROTOCOL_CONTEXT_NAME,
@@ -293,19 +295,67 @@ export function getLoadLiquids(
   liquidEntities: LiquidEntities,
   labwareEntities: LabwareEntities
 ): string {
-  const pythonLoadLiquids = Object.entries(liquidsByLabwareId)
-    .flatMap(([labwareId, liquidState]) => {
+  const groupedLiquids = Object.entries(liquidsByLabwareId).reduce(
+    (
+      acc: Record<
+        string,
+        {
+          labwarePythonName: string
+          liquidPythonName: string
+          volume: number
+          wells: string[]
+        }
+      >,
+      [labwareId, liquidState]
+    ) => {
       const labwarePythonName = labwareEntities[labwareId].pythonName
 
-      return Object.entries(liquidState).flatMap(([well, locationState]) =>
-        Object.entries(locationState)
-          .map(([liquidGroupId, volume]) => {
-            const liquidPythonName = liquidEntities[liquidGroupId].pythonName
-            return `${labwarePythonName}[${formatPyStr(
-              well
-            )}].load_liquid(${liquidPythonName}, ${volume.volume})`
-          })
-          .join('\n')
+      Object.entries(liquidState).forEach(([well, locationState]) => {
+        Object.entries(locationState).forEach(([liquidGroupId, volumeInfo]) => {
+          const liquidPythonName = liquidEntities[liquidGroupId].pythonName
+
+          const key = `${labwarePythonName}__${liquidPythonName}__${volumeInfo.volume}`
+          if (!acc[key]) {
+            acc[key] = {
+              labwarePythonName,
+              liquidPythonName,
+              volume: volumeInfo.volume,
+              wells: [],
+            }
+          }
+          acc[key].wells.push(well)
+        })
+      })
+
+      return acc
+    },
+    {}
+  )
+
+  const pythonLoadLiquids = Object.values(groupedLiquids)
+    .map(({ labwarePythonName, liquidPythonName, volume, wells }) => {
+      const formattedWells = wells.map(w => formatPyStr(w))
+      const wellChunks = getChunkForIndentingLists(formattedWells, 8)
+
+      const indentedWells = wellChunks
+        .map(chunk => INDENT + chunk.join(', '))
+        .join(',\n')
+
+      const pythonWells =
+        formattedWells.length < 8
+          ? formattedWells.join(', ')
+          : `\n${indentedWells}\n${INDENT}`
+
+      const loadLiquidArgs = [
+        `wells=[${pythonWells}],\n` +
+          `liquid=${liquidPythonName},\n` +
+          `volume=${volume},\n`,
+      ].join()
+
+      return (
+        `${labwarePythonName}.load_liquid(\n` +
+        `${indentPyLines(loadLiquidArgs)}` +
+        `)`
       )
     })
     .join('\n')

step-generation/src/utils/pythonFormat.ts

@@ -14,7 +14,7 @@ export const OFF_DECK = 'protocol_api.OFF_DECK'
 /** The variable name for the Python dict containing the custom labware defintions. */
 export const CUSTOM_LABWARE_DICT_NAME = 'CUSTOM_LABWARE'
 
-const INDENT = '    '
+export const INDENT = '    '
 
 /** Indent each of the lines in `text`. */
 export function indentPyLines(text: string): string {
@@ -151,3 +151,14 @@ export function formatPyWellLocation(wellLocation?: WellLocation): string {
   }
   return python
 }
+
+export function getChunkForIndentingLists(
+  lists: string[],
+  size: number
+): string[][] {
+  const chunks: string[][] = []
+  for (let index = 0; index < lists.length; index += size) {
+    chunks.push(lists.slice(index, index + size))
+  }
+  return chunks
+}