fix(sdk): Remove exp engine passkey when retrieving routers from the API server (caraml-dev#377)

* Add steps to remove exp engine passkey when retrieving routers from the API server

* Fix unit tests

* Pin pytest versions

* Add additional existence check before removing passkeys

* Add comment to describe rationale behind setting experiment engine passkey value to none

Author: deadlycoconuts

engines/pyfunc-ensembler-service/requirements.dev.txt

@@ -1,4 +1,5 @@
 black==22.6.0
-pytest
+# The next release 8.2.0 of pytest breaks the unit tests
+pytest<=8.1.2
 pytest-cov
 pylint

sdk/requirements.dev.txt

@@ -2,7 +2,8 @@ black==22.6.0
 setuptools>=21.0.0
 wheel
 twine
-pytest
+# The next release 8.0.0 of pytest breaks the unit tests
+pytest<=7.4.4
 pytest-cov
 urllib3-mock>=0.3.3
 caraml-upi-protos

sdk/tests/router/config/router_version_test.py

@@ -49,9 +49,16 @@ def test_create_version(
         assert actual_response.rules[i].to_open_api() == generic_router_version.rules[i]
 
     assert actual_response.default_route_id == generic_router_version.default_route_id
+
+    # Assert the response against an experiment engine object that has its passkey removed
+    expected_experiment_engine = generic_router_version.experiment_engine
+    if expected_experiment_engine.config is not None and \
+            expected_experiment_engine.config.get("client") is not None and \
+            expected_experiment_engine.config["client"].get("passkey") != "":
+        expected_experiment_engine.config["client"]["passkey"] = None
     assert (
         actual_response.experiment_engine.to_open_api()
-        == generic_router_version.experiment_engine
+        == expected_experiment_engine
     )
     assert (
         actual_response.resource_request.to_open_api()

sdk/turing/router/config/router_config.py

@@ -211,6 +211,16 @@ def experiment_engine(self, experiment_engine: Union[ExperimentConfig, Dict]):
             self._experiment_engine = experiment_engine
         elif isinstance(experiment_engine, dict):
             self._experiment_engine = ExperimentConfig(**experiment_engine)
+            # This block sets the passkey (encrypted when retrieved from the Turing API server) to None to prevent users
+            # from sending a router config with an already encrypted passkey back to API server when updating a router.
+            #
+            # When the passkey value is not set, the Turing API server is able to automatically retrieve the correct
+            # passkey from the existing router version (assuming it has been configured with the same standard
+            # experiment engine and the same client username).
+            if self._experiment_engine.config is not None and \
+                    self._experiment_engine.config.get("client") is not None and \
+                    self._experiment_engine.config["client"].get("passkey") != "":
+                self._experiment_engine.config["client"]["passkey"] = None
         else:
             self._experiment_engine = experiment_engine