feat(robot-server): update run creation endpoint to accept runtime parameter values

[jbleon95]

Overview

Closes AUTH-130

This PR adds a new, optional argument runTimeParameterValues to the request body of the POST /runs endpoint to start a run with new runtime parameter values. It is the same shape as the argument for the /protocols endpoint (a dictionary/map of variable names to the parameter values), but since this endpoint does not take form data, it does not need to be parsed with in the body of the run create function.

These values are then fed to the ProtocolRunner load method which will bind those to the execute function, so that when the protocol starts it will evaluate and use those values when running the protocol. (assuming there are no errors in setting the parameter values).

Since re-analysis has not been implemented yet, when starting a run with overridden values, the frontend will show an incorrect analysis for the run. This will be addressed in a future PR so that it reflects the values (and therefore potentially labware, pipettes, modules used) used in the actual run.

Test Plan

Continuing to use this test protocol seen in other PRs to test parameter values. Using postman, I was able to post the protocol with default values, then start a run with new overridden values:

• Posting a run with no runTimeParameterValues uses the default values
• Posting a run with valid overridden values uses that in the actual run execution
• Posting a run with invalid overridden values causes the run to fail

metadata = {
    'protocolName': 'RTP Test 2 - Default only, all types',
}

requirements = {
    "robotType": "Flex",
    "apiLevel": "2.18"
}


def add_parameters(parameters):
    parameters.add_int(
        display_name="Sample count",
        variable_name="sample_count",
        default=6,
        minimum=1,
        maximum=12,
        description="How many samples to process."
    )
    parameters.add_float(
        display_name="Pipette volume",
        variable_name="volume",
        default=20.1,
        choices=[
            {"display_name": "Low Volume", "value": 10.23},
            {"display_name": "Medium Volume", "value": 20.1},
            {"display_name": "High Volume", "value": 50.5},
        ],
        description="How many microliters to pipette of each sample.",
        unit="µL"
    )
    parameters.add_bool(
        display_name="Dry Run",
        variable_name="dry_run",
        default=False,
        description="Skip aspirate and dispense steps."
    )
    parameters.add_str(
        display_name="Pipette Name",
        variable_name="pipette",
        choices=[
            {"display_name": "Single channel 50µL", "value": "flex_1channel_50"},
            {"display_name": "Single channel 1000µL", "value": "flex_1channel_1000"},
            {"display_name": "Eight Channel 50µL", "value": "flex_8channel_50"},
            {"display_name": "Eight Channel 1000µL", "value": "flex_8channel_1000"},
        ],
        default="flex_1channel_50",
        description="What pipette to use during the protocol.",
    )



def run(context):
    trash_bin = context.load_trash_bin('A3')
    tip_rack = context.load_labware('opentrons_flex_96_tiprack_50ul', 'D2')
    source = context.load_labware('opentrons_96_wellplate_200ul_pcr_full_skirt', 'C1')
    destination = context.load_labware('opentrons_96_wellplate_200ul_pcr_full_skirt', 'C3')

    pipette = context.load_instrument(context.params.pipette, mount="left", tip_racks=[tip_rack])

    for i in range(context.params.sample_count):
        source_well = source.wells()[i]
        destination_well = destination.wells()[i]

        pipette.pick_up_tip()
        pipette.move_to(source_well.top())
        if not context.params.dry_run:
            pipette.aspirate(context.params.volume, source_well)
            pipette.dispense(context.params.volume, destination_well)

        pipette.drop_tip()

Changelog

• added runTimeParameterValues argument to POST /runs
• connected the runtime parameter values to the engine creation so that runs use those values sent

Review requests

Risk assessment

Low

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.19%. Comparing base (cf93d9c) to head (aa492eb).
Report is 13 commits behind head on edge.

Additional details and impacted files

@@           Coverage Diff           @@
##             edge   #14776   +/-   ##
=======================================
  Coverage   67.19%   67.19%           
=======================================
  Files        2495     2495           
  Lines       71388    71388           
  Branches     8984     8984           
=======================================
  Hits        47972    47972           
  Misses      21301    21301           
  Partials     2115     2115           

Flag	Coverage Δ
g-code-testing	92.43% <ø> (ø)

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

Files	Coverage Δ
robot-server/robot_server/runs/engine_store.py	95.83% <ø> (ø)
...bot-server/robot_server/runs/router/base_router.py	96.19% <ø> (ø)
robot-server/robot_server/runs/run_models.py	100.00% <ø> (ø)

[sanni-t]

Nice!