run_id can now be requested as an env var on request by a service

Author: Andrei Neagu

services/director-v2/src/simcore_service_director_v2/modules/dynamic_sidecar/docker_compose_specs.py

@@ -20,6 +20,7 @@
     ResourceValue,
     ServiceResourcesDict,
 )
+from models_library.services_types import RunID
 from models_library.users import UserID
 from models_library.utils.docker_compose import replace_env_vars_in_compose_spec
 from pydantic import ByteSize
@@ -278,6 +279,7 @@ async def assemble_spec(  # pylint: disable=too-many-arguments # noqa: PLR0913
     node_id: NodeID,
     simcore_user_agent: str,
     swarm_stack_name: str,
+    run_id: RunID,
 ) -> str:
     """
     returns a docker-compose spec used by
@@ -350,6 +352,7 @@ async def assemble_spec(  # pylint: disable=too-many-arguments # noqa: PLR0913
             product_name=product_name,
             project_id=project_id,
             node_id=node_id,
+            run_id=run_id,
         )
 
         add_egress_configuration(
@@ -388,6 +391,7 @@ async def assemble_spec(  # pylint: disable=too-many-arguments # noqa: PLR0913
         product_name=product_name,
         project_id=project_id,
         node_id=node_id,
+        run_id=run_id,
     )
 
     stringified_service_spec: str = replace_env_vars_in_compose_spec(

services/director-v2/src/simcore_service_director_v2/modules/dynamic_sidecar/scheduler/_core/_events_user_services.py

@@ -103,6 +103,7 @@ async def submit_compose_sepc(app: FastAPI, scheduler_data: SchedulerData) -> No
         node_id=scheduler_data.node_uuid,
         simcore_user_agent=scheduler_data.request_simcore_user_agent,
         swarm_stack_name=dynamic_services_scheduler_settings.SWARM_STACK_NAME,
+        run_id=scheduler_data.run_id,
     )
 
     _logger.debug(

services/director-v2/src/simcore_service_director_v2/modules/osparc_variables/substitutions.py

@@ -18,6 +18,7 @@
 from models_library.projects_nodes_io import NodeID
 from models_library.service_settings_labels import ComposeSpecLabelDict
 from models_library.services import ServiceKey, ServiceVersion
+from models_library.services_types import RunID
 from models_library.users import UserID
 from models_library.utils.specs_substitution import SpecsSubstitutionsResolver
 from pydantic import BaseModel
@@ -120,6 +121,7 @@ def create(cls, app: FastAPI):
             ("OSPARC_VARIABLE_NODE_ID", "node_id"),
             ("OSPARC_VARIABLE_PRODUCT_NAME", "product_name"),
             ("OSPARC_VARIABLE_STUDY_UUID", "project_id"),
+            ("OSPARC_VARIABLE_RUN_ID", "run_id"),
             ("OSPARC_VARIABLE_USER_ID", "user_id"),
             ("OSPARC_VARIABLE_API_HOST", "api_server_base_url"),
         ]:
@@ -181,6 +183,7 @@ async def resolve_and_substitute_session_variables_in_model(
     product_name: str,
     project_id: ProjectID,
     node_id: NodeID,
+    run_id: RunID,
 ) -> TBaseModel:
     result: TBaseModel = model
     try:
@@ -200,6 +203,7 @@ async def resolve_and_substitute_session_variables_in_model(
                 product_name=product_name,
                 project_id=project_id,
                 node_id=node_id,
+                run_id=run_id,
                 api_server_base_url=app.state.settings.DIRECTOR_V2_PUBLIC_API_BASE_URL,
             ),
         )
@@ -221,6 +225,7 @@ async def resolve_and_substitute_session_variables_in_specs(
     product_name: str,
     project_id: ProjectID,
     node_id: NodeID,
+    run_id: RunID,
 ) -> dict[str, Any]:
     table = OsparcSessionVariablesTable.get_from_app_state(app)
     resolver = SpecsSubstitutionsResolver(specs, upgrade=False)
@@ -241,6 +246,7 @@ async def resolve_and_substitute_session_variables_in_specs(
                     product_name=product_name,
                     project_id=project_id,
                     node_id=node_id,
+                    run_id=run_id,
                     api_server_base_url=app.state.settings.DIRECTOR_V2_PUBLIC_API_BASE_URL,
                 ),
             )

services/director-v2/src/simcore_service_director_v2/utils/osparc_variables.py

@@ -25,7 +25,7 @@ def _get_or_raise(context: ContextDict) -> Any:
         try:
             return context[parameter_name]
         except KeyError as err:
-            msg = "Parameter {keyname} missing from substitution context"
+            msg = f"{parameter_name=} missing from substitution context"
             raise CaptureError(msg) from err
 
     # For context["foo"] -> return operator.methodcaller("__getitem__", keyname)

services/director-v2/tests/unit/test_modules_osparc_variables.py

@@ -48,7 +48,9 @@
 def session_context(faker: Faker) -> ContextDict:
     return ContextDict(
         app=FastAPI(),
-        service_key=TypeAdapter(ServiceKey).validate_python("simcore/services/dynamic/foo"),
+        service_key=TypeAdapter(ServiceKey).validate_python(
+            "simcore/services/dynamic/foo"
+        ),
         service_version=TypeAdapter(ServiceVersion).validate_python("1.2.3"),
         compose_spec=generate_fake_docker_compose(faker),
         product_name=faker.word(),
@@ -101,7 +103,8 @@ async def request_user_email(app: FastAPI, user_id: UserID) -> SubstitutionValue
 
     # All values extracted from the context MUST be SubstitutionValue
     assert {
-        key: TypeAdapter(SubstitutionValue).validate_python(value) for key, value in environs.items()
+        key: TypeAdapter(SubstitutionValue).validate_python(value)
+        for key, value in environs.items()
     }
 
     for osparc_variable_name, context_name in [
@@ -170,6 +173,7 @@ async def test_resolve_and_substitute_session_variables_in_specs(
         "user_role": "${OSPARC_VARIABLE_USER_ROLE}",
         "api_key": "${OSPARC_VARIABLE_API_KEY}",
         "api_secret": "${OSPARC_VARIABLE_API_SECRET}",
+        "run_id": "${OSPARC_VARIABLE_RUN_ID}",
     }
     print("SPECS\n", specs)
 
@@ -180,6 +184,7 @@ async def test_resolve_and_substitute_session_variables_in_specs(
         product_name="a_product",
         project_id=faker.uuid4(cast_to=None),
         node_id=faker.uuid4(cast_to=None),
+        run_id="some_run_id",
     )
     print("REPLACED SPECS\n", replaced_specs)