feat(protocol-designer): update mixFormToArgs with new delay fields (#6575)

Closes #6348

* add new delay fields to mixFormToArgs
* add test coverage to mixFormToArgs
* refactor: make Flow types for inexact step-generation's Args types exact, and fix tests for command creators called with superfluous fields

Author: IanLondon

protocol-designer/benchmarks/timelineGeneration.js

@@ -39,6 +39,8 @@ bench(`commandCreatorsTimeline: mix ${times} times`, b => {
       dispenseOffsetFromBottomMm: 2,
       aspirateFlowRateUlSec: 5,
       dispenseFlowRateUlSec: 6,
+      aspirateDelay: null,
+      dispenseDelay: null,
     }),
   ]
 

protocol-designer/src/step-generation/__fixtures__/commandFixtures.js

@@ -52,7 +52,7 @@ export const DISPENSE_OFFSET_FROM_BOTTOM_MM = 3.2
 export const BLOWOUT_OFFSET_FROM_TOP_MM = 3.3
 const TOUCH_TIP_OFFSET_FROM_BOTTOM_MM = 3.4
 
-type FlowRateAndOffsetParams = {|
+type FlowRateAndOffsetParamsTransferlike = {|
   aspirateFlowRateUlSec: number,
   dispenseFlowRateUlSec: number,
   blowoutFlowRateUlSec: number,
@@ -61,9 +61,8 @@ type FlowRateAndOffsetParams = {|
   blowoutOffsetFromTopMm: number,
   touchTipAfterAspirateOffsetMmFromBottom: number,
   touchTipAfterDispenseOffsetMmFromBottom: number,
-  touchTipMmFromBottom: number,
 |}
-export const getFlowRateAndOffsetParams = (): FlowRateAndOffsetParams => ({
+export const getFlowRateAndOffsetParamsTransferLike = (): FlowRateAndOffsetParamsTransferlike => ({
   aspirateFlowRateUlSec: ASPIRATE_FLOW_RATE,
   dispenseFlowRateUlSec: DISPENSE_FLOW_RATE,
   blowoutFlowRateUlSec: BLOWOUT_FLOW_RATE,
@@ -74,6 +73,24 @@ export const getFlowRateAndOffsetParams = (): FlowRateAndOffsetParams => ({
   // for consolidate/distribute/transfer only
   touchTipAfterAspirateOffsetMmFromBottom: TOUCH_TIP_OFFSET_FROM_BOTTOM_MM,
   touchTipAfterDispenseOffsetMmFromBottom: TOUCH_TIP_OFFSET_FROM_BOTTOM_MM,
+})
+
+type FlowRateAndOffsetParamsMix = {|
+  aspirateFlowRateUlSec: number,
+  dispenseFlowRateUlSec: number,
+  blowoutFlowRateUlSec: number,
+  aspirateOffsetFromBottomMm: number,
+  dispenseOffsetFromBottomMm: number,
+  blowoutOffsetFromTopMm: number,
+  touchTipMmFromBottom: number,
+|}
+export const getFlowRateAndOffsetParamsMix = (): FlowRateAndOffsetParamsMix => ({
+  aspirateFlowRateUlSec: ASPIRATE_FLOW_RATE,
+  dispenseFlowRateUlSec: DISPENSE_FLOW_RATE,
+  blowoutFlowRateUlSec: BLOWOUT_FLOW_RATE,
+  aspirateOffsetFromBottomMm: ASPIRATE_OFFSET_FROM_BOTTOM_MM,
+  dispenseOffsetFromBottomMm: DISPENSE_OFFSET_FROM_BOTTOM_MM,
+  blowoutOffsetFromTopMm: BLOWOUT_OFFSET_FROM_TOP_MM,
 
   // for mix only
   touchTipMmFromBottom: TOUCH_TIP_OFFSET_FROM_BOTTOM_MM,

protocol-designer/src/step-generation/__tests__/consolidate.test.js

@@ -11,7 +11,7 @@ import {
   dropTipHelper,
   FIXED_TRASH_ID,
   getErrorResult,
-  getFlowRateAndOffsetParams,
+  getFlowRateAndOffsetParamsTransferLike,
   getInitialRobotStateStandard,
   getRobotStatePickedUpTipStandard,
   getSuccessResult,
@@ -27,7 +27,7 @@ import type {
   AspirateParams,
   DispenseParams,
 } from '@opentrons/shared-data/protocol/flowTypes/schemaV3'
-
+import type { ConsolidateArgs } from '../types'
 const airGapHelper = makeAirGapHelper({ offsetFromBottomMm: 11.54 })
 const aspirateHelper = makeAspirateHelper()
 const dispenseHelper = makeDispenseHelper()
@@ -61,18 +61,17 @@ function tripleMix(
 let invariantContext
 let initialRobotState
 let robotStatePickedUpOneTip
-let mixinArgs
+let mixinArgs: $Shape<ConsolidateArgs>
 
 beforeEach(() => {
   invariantContext = makeContext()
   initialRobotState = getInitialRobotStateStandard(invariantContext)
   robotStatePickedUpOneTip = getRobotStatePickedUpTipStandard(invariantContext)
 
   mixinArgs = {
+    ...getFlowRateAndOffsetParamsTransferLike(),
     // `volume` and `changeTip` should be explicit in tests,
     // those fields intentionally omitted from here
-    ...getFlowRateAndOffsetParams(),
-    stepType: 'consolidate',
     commandCreatorFnName: 'consolidate',
     name: 'Consolidate Test',
     description: 'test blah blah',
@@ -1137,8 +1136,8 @@ describe('consolidate multi-channel', () => {
       pipette: 'p300MultiId',
     })
 
-  const args = {
-    stepType: 'consolidate',
+  const args: $Shape<ConsolidateArgs> = {
+    ...getFlowRateAndOffsetParamsTransferLike(),
     commandCreatorFnName: 'consolidate',
     name: 'Consolidate Test',
     description: 'test blah blah',
@@ -1160,12 +1159,10 @@ describe('consolidate multi-channel', () => {
     touchTipAfterDispense: false,
     mixInDestination: null,
     blowoutLocation: null,
-
-    ...getFlowRateAndOffsetParams(),
   }
 
   it('simple multi-channel: cols A1 A2 A3 A4 to col A12', () => {
-    const data = {
+    const data: ConsolidateArgs = {
       ...args,
       volume: 140,
       changeTip: 'once',

protocol-designer/src/step-generation/__tests__/distribute.test.js

@@ -9,7 +9,7 @@ import {
   dropTipHelper,
   FIXED_TRASH_ID,
   getErrorResult,
-  getFlowRateAndOffsetParams,
+  getFlowRateAndOffsetParamsTransferLike,
   getRobotInitialStateNoTipsRemain,
   getRobotStateWithTipStandard,
   getSuccessResult,
@@ -36,7 +36,7 @@ const touchTipHelper = makeTouchTipHelper()
 // TODO: Ian 2019-06-14 more elegant way to test the blowout offset calculation
 const BLOWOUT_OFFSET_ANY: any = expect.any(Number)
 
-let mixinArgs
+let mixinArgs: $Shape<DistributeArgs>
 let invariantContext
 let robotStateWithTip
 let robotInitialStateNoTipsRemain
@@ -45,7 +45,7 @@ let blowoutSingleToSourceA1
 
 beforeEach(() => {
   mixinArgs = {
-    ...getFlowRateAndOffsetParams(),
+    ...getFlowRateAndOffsetParamsTransferLike(),
     commandCreatorFnName: 'distribute',
     name: 'distribute test',
     description: 'test blah blah',
@@ -725,7 +725,7 @@ describe('advanced settings: volume, mix, pre-wet tip, tip touch, tip position',
 
   describe('all advanced settings enabled', () => {
     it('should create commands in the expected order with expected params', () => {
-      const args = {
+      const args: $Shape<DistributeArgs> = {
         ...mixinArgs,
         sourceWell: 'A1',
         destWells: ['B1', 'B2'],
@@ -744,7 +744,6 @@ describe('advanced settings: volume, mix, pre-wet tip, tip touch, tip position',
         // dispense column
         dispenseDelay: { seconds: 12, mmFromBottom: 14 },
         touchTipAfterDispense: true,
-        blowoutLocation: 'trashId',
         blowoutFlowRateUlSec: 2.3,
         blowoutOffsetFromTopMm: 3.3,
       }

protocol-designer/src/step-generation/__tests__/mix.test.js

@@ -7,7 +7,7 @@ import {
   getSuccessResult,
   getErrorResult,
   replaceTipCommands,
-  getFlowRateAndOffsetParams,
+  getFlowRateAndOffsetParamsMix,
   DEFAULT_PIPETTE,
   SOURCE_LABWARE,
   DEST_LABWARE,
@@ -30,6 +30,7 @@ let mixinArgs
 
 beforeEach(() => {
   mixinArgs = {
+    ...getFlowRateAndOffsetParamsMix(),
     commandCreatorFnName: 'mix',
     name: 'mix test',
     description: 'test blah blah',
@@ -39,7 +40,9 @@ beforeEach(() => {
 
     blowoutLocation: null,
     touchTip: false,
-    ...getFlowRateAndOffsetParams(),
+
+    aspirateDelay: null,
+    dispenseDelay: null,
   }
 
   invariantContext = makeContext()
@@ -117,7 +120,6 @@ describe('mix: advanced options', () => {
       times,
       wells: ['A1'],
       changeTip: 'once',
-      ...getFlowRateAndOffsetParams(),
     }
 
     const result = mix(args, invariantContext, robotStateWithTip)

protocol-designer/src/step-generation/__tests__/transfer.test.js

@@ -8,7 +8,7 @@ import {
   DISPENSE_OFFSET_FROM_BOTTOM_MM,
   dropTipHelper,
   getErrorResult,
-  getFlowRateAndOffsetParams,
+  getFlowRateAndOffsetParamsTransferLike,
   getRobotStateWithTipStandard,
   getSuccessResult,
   makeAirGapHelper,
@@ -21,6 +21,7 @@ import {
   makeDispenseAirGapHelper,
 } from '../__fixtures__'
 import { transfer } from '../commandCreators/compound/transfer'
+import type { TransferArgs } from '../types'
 
 // well depth for 96 plate is 10.54, so need to add 1mm to top of well
 const airGapHelper = makeAirGapHelper({ offsetFromBottomMm: 11.54 })
@@ -33,11 +34,11 @@ const touchTipHelper = makeTouchTipHelper()
 
 let invariantContext
 let robotStateWithTip
-let mixinArgs
+let mixinArgs: $Shape<TransferArgs>
 
 beforeEach(() => {
   mixinArgs = {
-    ...getFlowRateAndOffsetParams(),
+    ...getFlowRateAndOffsetParamsTransferLike(),
     commandCreatorFnName: 'transfer',
     name: 'Transfer Test',
     description: 'test blah blah',

protocol-designer/src/step-generation/types.js

@@ -41,7 +41,7 @@ type CommonArgs = {|
 
 // ===== Processed form types. Used as args to call command creator fns =====
 
-export type SharedTransferLikeArgs = {
+export type SharedTransferLikeArgs = {|
   ...CommonArgs,
 
   pipette: string, // PipetteId
@@ -80,9 +80,10 @@ export type SharedTransferLikeArgs = {
   dispenseFlowRateUlSec: number,
   /** offset from bottom of well in mm */
   dispenseOffsetFromBottomMm: number,
-}
+|}
 
-export type ConsolidateArgs = {
+export type ConsolidateArgs = {|
+  ...SharedTransferLikeArgs,
   commandCreatorFnName: 'consolidate',
 
   sourceWells: Array<string>,
@@ -97,9 +98,10 @@ export type ConsolidateArgs = {
   mixFirstAspirate: ?InnerMixArgs,
   /** Mix in destination well after dispense */
   mixInDestination: ?InnerMixArgs,
-} & SharedTransferLikeArgs
+|}
 
-export type TransferArgs = {
+export type TransferArgs = {|
+  ...SharedTransferLikeArgs,
   commandCreatorFnName: 'transfer',
 
   sourceWells: Array<string>,
@@ -114,9 +116,10 @@ export type TransferArgs = {
   mixBeforeAspirate: ?InnerMixArgs,
   /** Mix in destination well after dispense */
   mixInDestination: ?InnerMixArgs,
-} & SharedTransferLikeArgs
+|}
 
-export type DistributeArgs = {
+export type DistributeArgs = {|
+  ...SharedTransferLikeArgs,
   commandCreatorFnName: 'distribute',
 
   sourceWell: string,
@@ -134,9 +137,9 @@ export type DistributeArgs = {
 
   /** Mix in first well in chunk */
   mixBeforeAspirate: ?InnerMixArgs,
-} & SharedTransferLikeArgs
+|}
 
-export type MixArgs = {
+export type MixArgs = {|
   ...$Exact<CommonArgs>,
   commandCreatorFnName: 'mix',
   labware: string,
@@ -163,7 +166,10 @@ export type MixArgs = {
   /** flow rates in uL/sec */
   aspirateFlowRateUlSec: number,
   dispenseFlowRateUlSec: number,
-}
+  /** delays */
+  aspirateDelay: ?InnerDelayArgs,
+  dispenseDelay: ?InnerDelayArgs,
+|}
 
 export type PauseArgs = {|
   ...$Exact<CommonArgs>,

protocol-designer/src/steplist/formLevel/stepFormToArgs/getDelayData.js

@@ -0,0 +1,30 @@
+// @flow
+import type { InnerDelayArgs } from '../../../step-generation'
+import type {
+  DelayCheckboxFields,
+  DelaySecondFields,
+} from '../../../form-types'
+
+export function getDelayData<F: any>(
+  hydratedFormData: F,
+  checkboxField: DelayCheckboxFields,
+  secondsField: DelaySecondFields,
+  mmFromBottomField:
+    | 'aspirate_delay_mmFromBottom'
+    | 'dispense_delay_mmFromBottom'
+    | 'mix_aspirate_delay_mmFromBottom'
+    | 'mix_dispense_delay_mmFromBottom'
+): InnerDelayArgs | null {
+  const checkbox = hydratedFormData[checkboxField]
+  const seconds = hydratedFormData[secondsField]
+  const mmFromBottom = hydratedFormData[mmFromBottomField]
+
+  if (
+    checkbox &&
+    (typeof seconds === 'number' && seconds > 0) &&
+    (typeof mmFromBottom === 'number' && mmFromBottom > 0)
+  ) {
+    return { seconds, mmFromBottom }
+  }
+  return null
+}

protocol-designer/src/steplist/formLevel/stepFormToArgs/mixFormToArgs.js

@@ -9,6 +9,7 @@ import {
   DEFAULT_MM_TOUCH_TIP_OFFSET_FROM_TOP,
 } from '../../../constants'
 import { getOrderedWells } from '../../utils'
+import { getDelayData } from './getDelayData'
 import type { HydratedMixFormDataLegacy } from '../../../form-types'
 import type { MixArgs } from '../../../step-generation'
 
@@ -71,6 +72,21 @@ export const mixFormToArgs = (
     ? DEFAULT_MM_BLOWOUT_OFFSET_FROM_TOP
     : 0
 
+  // Delay settings
+  const aspirateDelay = getDelayData<HydratedMixFormDataLegacy>(
+    hydratedFormData,
+    'aspirate_delay_checkbox',
+    'aspirate_delay_seconds',
+    'mix_aspirate_delay_mmFromBottom'
+  )
+
+  const dispenseDelay = getDelayData<HydratedMixFormDataLegacy>(
+    hydratedFormData,
+    'dispense_delay_checkbox',
+    'dispense_delay_seconds',
+    'mix_dispense_delay_mmFromBottom'
+  )
+
   return {
     commandCreatorFnName: 'mix',
     name: `Mix ${hydratedFormData.id}`, // TODO real name for steps
@@ -90,5 +106,7 @@ export const mixFormToArgs = (
     aspirateOffsetFromBottomMm,
     dispenseOffsetFromBottomMm,
     blowoutOffsetFromTopMm,
+    aspirateDelay,
+    dispenseDelay,
   }
 }