chore(api): load new evotips labware on api >= 2.23 (#17749)

Loads the new adapter defs from #17675 by default on api versions about
2.23.

Tested by simulating the protocol from that PR and making sure the
correct version gets loaded on 2.23 and the old one gets loaded (well,
the protocol fails because the old version doesn't have stacking offsets
for the new variants, which is proof enough) on 2.22.

Author: sfoster1

api/src/opentrons/protocol_api/core/engine/load_labware_params.py

@@ -2,6 +2,7 @@
 
 from opentrons.protocols.api_support.constants import OPENTRONS_NAMESPACE
 from opentrons.protocol_engine.state.labware import LabwareLoadParams
+from opentrons.protocols.api_support.types import APIVersion
 
 
 # Default versions of Opentrons standard labware definitions in Python Protocol API
@@ -34,6 +35,11 @@
     "corning_24_wellplate_3.4ml_flat": 2,
 }
 
+_APILEVEL_2_23_OT_DEFAULT_VERSIONS: Dict[str, int] = {
+    "evotips_opentrons_96_labware": 2,
+    "evotips_flex_96_tiprack_adapter": 2,
+}
+
 
 class AmbiguousLoadLabwareParamsError(RuntimeError):
     """Error raised when specific labware parameters cannot be found due to multiple matching labware definitions."""
@@ -44,6 +50,7 @@ def resolve(
     namespace: Optional[str],
     version: Optional[int],
     custom_load_labware_params: List[LabwareLoadParams],
+    api_version: APIVersion,
 ) -> Tuple[str, int]:
     """Resolve the load labware parameters that best matches any custom labware, or default to opentrons standards
 
@@ -82,7 +89,9 @@ def matches_params(custom_params: LabwareLoadParams) -> bool:
         resolved_version = (
             version
             if version is not None
-            else _get_default_version_for_standard_labware(load_name=load_name)
+            else _get_default_version_for_standard_labware(
+                load_name=load_name, api_version=api_version
+            )
         )
 
     elif len(filtered_custom_params) > 1:
@@ -99,7 +108,15 @@ def matches_params(custom_params: LabwareLoadParams) -> bool:
     return resolved_namespace, resolved_version
 
 
-def _get_default_version_for_standard_labware(load_name: str) -> int:
+def _get_default_version_for_standard_labware(
+    load_name: str, api_version: APIVersion
+) -> int:
     # We know the protocol is running at least apiLevel 2.14 by this point because
     # apiLevel 2.13 and below has its own separate code path for resolving labware.
-    return _APILEVEL_2_14_OT_DEFAULT_VERSIONS.get(load_name, 1)
+    if (
+        api_version >= APIVersion(2, 23)
+        and load_name in _APILEVEL_2_23_OT_DEFAULT_VERSIONS
+    ):
+        return _APILEVEL_2_23_OT_DEFAULT_VERSIONS[load_name]
+    else:
+        return _APILEVEL_2_14_OT_DEFAULT_VERSIONS.get(load_name, 1)

api/src/opentrons/protocol_api/core/engine/module_core.py

@@ -759,7 +759,11 @@ def set_stored_labware(
         )
 
         main_namespace, main_version = load_labware_params.resolve(
-            main_load_name, main_namespace, main_version, custom_labware_params
+            main_load_name,
+            main_namespace,
+            main_version,
+            custom_labware_params,
+            self._api_version,
         )
         main_labware = cmd.flex_stacker.StackerStoredLabwareDetails(
             loadName=main_load_name, namespace=main_namespace, version=main_version
@@ -769,7 +773,11 @@ def set_stored_labware(
 
         if lid_load_name:
             lid_namespace, lid_version = load_labware_params.resolve(
-                lid_load_name, lid_namespace, lid_version, custom_labware_params
+                lid_load_name,
+                lid_namespace,
+                lid_version,
+                custom_labware_params,
+                self._api_version,
             )
             lid_labware = cmd.flex_stacker.StackerStoredLabwareDetails(
                 loadName=lid_load_name, namespace=lid_namespace, version=lid_version
@@ -783,6 +791,7 @@ def set_stored_labware(
                 adapter_namespace,
                 adapter_version,
                 custom_labware_params,
+                self._api_version,
             )
             adapter_labware = cmd.flex_stacker.StackerStoredLabwareDetails(
                 loadName=adapter_load_name,

api/src/opentrons/protocol_api/core/engine/protocol.py

@@ -1,4 +1,5 @@
 """ProtocolEngine-based Protocol API core implementation."""
+
 from __future__ import annotations
 from typing import Dict, Optional, Type, Union, List, Tuple, TYPE_CHECKING
 
@@ -224,7 +225,7 @@ def load_labware(
             self._engine_client.state.labware.find_custom_labware_load_params()
         )
         namespace, version = load_labware_params.resolve(
-            load_name, namespace, version, custom_labware_params
+            load_name, namespace, version, custom_labware_params, self._api_version
         )
 
         load_result = self._engine_client.execute_command_without_recovery(
@@ -295,7 +296,7 @@ def load_adapter(
             self._engine_client.state.labware.find_custom_labware_load_params()
         )
         namespace, version = load_labware_params.resolve(
-            load_name, namespace, version, custom_labware_params
+            load_name, namespace, version, custom_labware_params, self._api_version
         )
         load_result = self._engine_client.execute_command_without_recovery(
             cmd.LoadLabwareParams(
@@ -343,7 +344,7 @@ def load_lid(
             self._engine_client.state.labware.find_custom_labware_load_params()
         )
         namespace, version = load_labware_params.resolve(
-            load_name, namespace, version, custom_labware_params
+            load_name, namespace, version, custom_labware_params, self._api_version
         )
         load_result = self._engine_client.execute_command_without_recovery(
             cmd.LoadLidParams(
@@ -960,7 +961,7 @@ def load_lid_stack(
             self._engine_client.state.labware.find_custom_labware_load_params()
         )
         namespace, version = load_labware_params.resolve(
-            load_name, namespace, version, custom_labware_params
+            load_name, namespace, version, custom_labware_params, self._api_version
         )
 
         load_result = self._engine_client.execute_command_without_recovery(
@@ -1162,7 +1163,7 @@ def _get_non_stacked_location(
             OffDeckType,
             WasteChute,
             TrashBin,
-        ]
+        ],
     ) -> NonStackedLocation:
         if isinstance(location, (ModuleCore, NonConnectedModuleCore)):
             return ModuleLocation(moduleId=location.module_id)

api/tests/opentrons/protocol_api/core/engine/test_flex_stacker_core.py

@@ -81,17 +81,29 @@ def test_set_stored_labware_all_elements(
     ).then_return(sentinel.custom_labware_load_params)
     decoy.when(
         load_labware_params.resolve(
-            "main-name", "main-namespace", 1, sentinel.custom_labware_load_params
+            "main-name",
+            "main-namespace",
+            1,
+            sentinel.custom_labware_load_params,
+            MAX_SUPPORTED_VERSION,
         )
     ).then_return(("main-namespace-verified", 10))
     decoy.when(
         load_labware_params.resolve(
-            "adapter-name", "adapter-namespace", 2, sentinel.custom_labware_load_params
+            "adapter-name",
+            "adapter-namespace",
+            2,
+            sentinel.custom_labware_load_params,
+            MAX_SUPPORTED_VERSION,
         )
     ).then_return(("adapter-namespace-verified", 20))
     decoy.when(
         load_labware_params.resolve(
-            "lid-name", "lid-namespace", 3, sentinel.custom_labware_load_params
+            "lid-name",
+            "lid-namespace",
+            3,
+            sentinel.custom_labware_load_params,
+            MAX_SUPPORTED_VERSION,
         )
     ).then_return(("lid-namespace-verified", 30))
 
@@ -139,7 +151,11 @@ def test_set_stored_labware_only_checks_load_name_for_lid_and_adapter_valid(
     ).then_return(sentinel.custom_labware_load_params)
     decoy.when(
         load_labware_params.resolve(
-            "main-name", "main-namespace", 1, sentinel.custom_labware_load_params
+            "main-name",
+            "main-namespace",
+            1,
+            sentinel.custom_labware_load_params,
+            MAX_SUPPORTED_VERSION,
         )
     ).then_return(("main-namespace-verified", 10))
 

api/tests/opentrons/protocol_api/core/engine/test_load_labware_params.py

@@ -1,10 +1,12 @@
 """Tests for Protocol API engine parameter validation."""
+
 import pytest
 from typing import List, Optional
 
 from opentrons.protocol_api.core.engine import load_labware_params as subject
 from opentrons.protocol_engine.state.labware import LabwareLoadParams
 from opentrons.protocols.api_support.constants import OPENTRONS_NAMESPACE
+from opentrons.protocols.api_support.types import APIVersion
 
 
 @pytest.mark.parametrize(
@@ -15,12 +17,13 @@
         "custom_labware_params",
         "expected_namespace",
         "expected_version",
+        "current_api_version",
     ],
     argvalues=[
-        ("hello", "world", 123, [], "world", 123),
-        ("hello", "world", None, [], "world", 1),
-        ("hello", None, 123, [], OPENTRONS_NAMESPACE, 123),
-        ("hello", None, None, [], OPENTRONS_NAMESPACE, 1),
+        ("hello", "world", 123, [], "world", 123, APIVersion(2, 15)),
+        ("hello", "world", None, [], "world", 1, APIVersion(2, 22)),
+        ("hello", None, 123, [], OPENTRONS_NAMESPACE, 123, APIVersion(2, 14)),
+        ("hello", None, None, [], OPENTRONS_NAMESPACE, 1, APIVersion(2, 16)),
         (
             "hello",
             "world",
@@ -31,6 +34,7 @@
             ],
             "world",
             123,
+            APIVersion(2, 17),
         ),
         (
             "hello",
@@ -42,6 +46,7 @@
             ],
             "world",
             123,
+            APIVersion(2, 19),
         ),
         (
             "hello",
@@ -53,6 +58,7 @@
             ],
             "world",
             123,
+            APIVersion(2, 21),
         ),
     ],
 )
@@ -63,9 +69,12 @@ def test_resolve_load_labware_params(
     custom_labware_params: List[LabwareLoadParams],
     expected_namespace: str,
     expected_version: int,
+    current_api_version: APIVersion,
 ) -> None:
     """It should get a namespace and version based on custom labware available or defaults."""
-    result = subject.resolve(load_name, namespace, version, custom_labware_params)
+    result = subject.resolve(
+        load_name, namespace, version, custom_labware_params, current_api_version
+    )
 
     assert result == (expected_namespace, expected_version)
 
@@ -82,6 +91,8 @@ def test_resolve_load_labware_params(
         "nest_96_wellplate_2ml_deep",
         "opentrons_96_wellplate_200ul_pcr_full_skirt",
         "biorad_96_wellplate_200ul_pcr",
+        "evotips_opentrons_96_labware",
+        "evotips_flex_96_tiprack_adapter",
     ],
 )
 @pytest.mark.parametrize("namespace", [OPENTRONS_NAMESPACE, None])
@@ -107,6 +118,7 @@ def test_version_two_and_above_default_versioning(
         namespace=namespace,
         version=version,
         custom_load_labware_params=[],
+        api_version=APIVersion(2, 23),
     )
     assert result == (OPENTRONS_NAMESPACE, expected_version)
 
@@ -122,4 +134,5 @@ def test_resolve_load_labware_params_raises() -> None:
                 LabwareLoadParams("hello", "world", 123),
                 LabwareLoadParams("hello", "world", 456),
             ],
+            api_version=APIVersion(2, 23),
         )

api/tests/opentrons/protocol_api/core/engine/test_protocol_core.py

@@ -347,6 +347,7 @@ def test_load_labware(
             "a_namespace",
             456,
             [EngineLabwareLoadParams("hello", "world", 654)],
+            subject.api_version,
         )
     ).then_return(("some_namespace", 9001))
 
@@ -421,6 +422,7 @@ def test_load_labware_on_staging_slot(
             "a_namespace",
             456,
             [EngineLabwareLoadParams("hello", "world", 654)],
+            subject.api_version,
         )
     ).then_return(("some_namespace", 9001))
 
@@ -498,6 +500,7 @@ def test_load_labware_on_labware(
             "a_namespace",
             456,
             [EngineLabwareLoadParams("hello", "world", 654)],
+            subject.api_version,
         )
     ).then_return(("some_namespace", 9001))
 
@@ -568,6 +571,7 @@ def test_load_labware_off_deck(
             "a_namespace",
             456,
             [EngineLabwareLoadParams("hello", "world", 654)],
+            subject.api_version,
         )
     ).then_return(("some_namespace", 9001))
 
@@ -632,6 +636,7 @@ def test_load_adapter(
             "a_namespace",
             456,
             [EngineLabwareLoadParams("hello", "world", 654)],
+            subject.api_version,
         )
     ).then_return(("some_namespace", 9001))
 
@@ -704,6 +709,7 @@ def test_load_adapter_on_staging_slot(
             "a_namespace",
             456,
             [EngineLabwareLoadParams("hello", "world", 654)],
+            subject.api_version,
         )
     ).then_return(("some_namespace", 9001))
 
@@ -778,6 +784,7 @@ def test_load_lid(
             "a_namespace",
             456,
             [EngineLabwareLoadParams("hello", "world", 654)],
+            subject.api_version,
         )
     ).then_return(("some_namespace", 9001))
 
@@ -849,6 +856,7 @@ def test_load_lid_stack(
             "a_namespace",
             456,
             [EngineLabwareLoadParams("hello", "world", 654)],
+            subject.api_version,
         )
     ).then_return(("some_namespace", 9001))
 
@@ -1193,6 +1201,7 @@ def test_load_labware_on_module(
             "a_namespace",
             456,
             [EngineLabwareLoadParams("hello", "world", 654)],
+            subject.api_version,
         )
     ).then_return(("some_namespace", 9001))
 
@@ -1270,6 +1279,7 @@ def test_load_labware_on_non_connected_module(
             "a_namespace",
             456,
             [EngineLabwareLoadParams("hello", "world", 654)],
+            subject.api_version,
         )
     ).then_return(("some_namespace", 9001))
 

app/src/local-resources/labware/hooks/useAllLabware.ts

@@ -8,6 +8,8 @@ import type { LabwareSort, LabwareFilter, LabwareDefAndDate } from '../types'
 const LABWARE_LOADNAME_BLOCKLIST = [
   'evotips_flex_96_tiprack_adapter',
   'evotips_opentrons_96_labware',
+  'evotips_tiprack_adapter',
+  'evotips_reservoir_adapter',
 ]
 
 export function useAllLabware(

shared-data/js/getLabware.ts

@@ -47,6 +47,8 @@ export const LABWAREV2_DO_NOT_LIST = [
   // temporarily blocking evotips until it is out of beta
   'evotips_flex_96_tiprack_adapter',
   'evotips_opentrons_96_labware',
+  'evotips_tiprack_adapter',
+  'evotips_reservoir_adapter',
   // temporarily blocking tiprack lids until stacker launches
   'opentrons_flex_tiprack_lid',
   // temporarily blocking 20 uL Flex tip racks until they launch
@@ -71,6 +73,8 @@ export const PD_DO_NOT_LIST = [
   //  temporarily blocking evotips until it is supported in PD
   'evotips_flex_96_tiprack_adapter',
   'evotips_opentrons_96_labware',
+  'evotips_tiprack_adapter',
+  'evotips_reservoir_adapter',
   // temporarily blocking tiprack lids until stacker launches
   'opentrons_flex_tiprack_lid',
   // temporarily blocking 20 uL Flex tip racks until they launch