test(pd): enable parameters for steps

[y3rsh]

Overview

• Steps may intake parameters

• Move away from switch and define handlers as Records.

• Use builder pattern for the steps list.

• No mapping or logic in runner since the handler is defined directly.

• Wait on test(protocol-designer): start of cypress happy path test for mix settings  #17320 to merge then update and get merged ASAP

Notes

The types are just OK. I was trying to get all the way having typescript enforce a parameter in addStep if the paramType is not undefined.

@sfoster1 got me on the right track and I love the typing and step mapping much better now.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 21.58%. Comparing base (44cfe58) to head (6e1a4e8).
Report is 2 commits behind head on edge.

Additional details and impacted files

@@            Coverage Diff             @@
##             edge   #17442      +/-   ##
==========================================
- Coverage   26.21%   21.58%   -4.64%     
==========================================
  Files        3198     2810     -388     
  Lines      230986   215792   -15194     
  Branches     9883     7919    -1964     
==========================================
- Hits        60562    46568   -13994     
+ Misses     170399   169224    -1175     
+ Partials       25        0      -25     

Flag	Coverage Δ
app	?
labware-library	?
opentrons-ai-client	?
protocol-designer	18.76% <ø> (+1.23%)	⬆️
step-generation	4.34% <ø> (+0.27%)	⬆️

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

see 595 files with indirect coverage changes

[sfoster1]

Oh there's one other way to do this that you might want to consider, which is that instead of the step builder being responsible for interning the call details for the handlers, the handlers are responsible for returning an object representing their future execution with a consistent call interface. Something like this, though I haven't actually run this through tsc:

export interface StepThunk {
   call: () => void
}

export const Steps {
  SelectLabwareByName: (labwareName: string): StepThunk => ({  
     // the outer param is lexically captured here
     call: () => void { doSomethingWith(labwareName) }
  }),
  SelectFlex: (): StepThunk => ({
     call: () => void { doSomething() }
  })
}

class StepBuilder {
   private readonly steps: StepThunk[]
   addStep(step: StepThunk): this {
      this.steps.add(step)
   }
   execute(): void {
      this.steps.forEach(step => step.call())
   }
}

const builder = new StepBuilder()
// works
builder.add(Steps.SelectLabwareByName("someName"))
// works
builder.add(Steps.SelectFlex())
// doesn't work because it is straightforwardly a normal function called with the wrong number of arguments
builder.add(Steps.SelectLabwareByName())

[alexjoel42]

Looks good to me!