🐛 Generate API base URL by active product ⚠️

packages/common-library/src/common_library/network.py

@@ -0,0 +1,9 @@
+import ipaddress
+
+
+def is_ip_address(host: str) -> bool:
+    try:
+        ipaddress.ip_address(host)
+        return True
+    except ValueError:
+        return False

packages/common-library/src/common_library/test_network.py

@@ -0,0 +1,19 @@
+import pytest
+from common_library.network import is_ip_address
+
+
+@pytest.mark.parametrize(
+    "host, expected",
+    [
+        ("127.0.0.1", True),
+        ("::1", True),
+        ("192.168.1.1", True),
+        ("2001:0db8:85a3:0000:0000:8a2e:0370:7334", True),
+        ("256.256.256.256", False),
+        ("invalid_host", False),
+        ("", False),
+        ("1234:5678:9abc:def0:1234:5678:9abc:defg", False),
+    ],
+)
+def test_is_ip_address(host: str, expected: bool):
+    assert is_ip_address(host) == expected

packages/models-library/src/models_library/api_schemas_directorv2/computations.py

@@ -44,6 +44,10 @@ class ComputationCreate(BaseModel):
         Field(description="if True the computation pipeline will start right away"),
     ] = False
     product_name: Annotated[str, Field()]
+    product_api_base_url: Annotated[
+        AnyHttpUrl,
+        Field(description="Base url of the product"),
+    ]
     subgraph: Annotated[
         list[NodeID] | None,
         Field(

packages/models-library/src/models_library/api_schemas_directorv2/dynamic_services.py

@@ -1,6 +1,7 @@
-from typing import TypeAlias
+from typing import Annotated, TypeAlias
 
-from pydantic import BaseModel, ByteSize, ConfigDict, Field
+from pydantic import AnyHttpUrl, BaseModel, BeforeValidator, ByteSize, ConfigDict, Field
+from pydantic.config import JsonDict
 
 from ..resource_tracker import HardwareInfo, PricingInfo
 from ..services import ServicePortKey
@@ -38,39 +39,61 @@ def from_transferred_bytes(
 class DynamicServiceCreate(ServiceDetails):
     service_resources: ServiceResourcesDict
 
-    product_name: str = Field(..., description="Current product name")
-    can_save: bool = Field(
-        ..., description="the service data must be saved when closing"
-    )
-    wallet_info: WalletInfo | None = Field(
-        default=None,
-        description="contains information about the wallet used to bill the running service",
-    )
-    pricing_info: PricingInfo | None = Field(
-        default=None,
-        description="contains pricing information (ex. pricing plan and unit ids)",
-    )
-    hardware_info: HardwareInfo | None = Field(
-        default=None,
-        description="contains harware information (ex. aws_ec2_instances)",
-    )
-    model_config = ConfigDict(
-        json_schema_extra={
-            "example": {
-                "key": "simcore/services/dynamic/3dviewer",
-                "version": "2.4.5",
-                "user_id": 234,
-                "project_id": "dd1d04d9-d704-4f7e-8f0f-1ca60cc771fe",
-                "node_uuid": "75c7f3f4-18f9-4678-8610-54a2ade78eaa",
-                "basepath": "/x/75c7f3f4-18f9-4678-8610-54a2ade78eaa",
-                "product_name": "osparc",
-                "can_save": True,
-                "service_resources": ServiceResourcesDictHelpers.model_config["json_schema_extra"]["examples"][0],  # type: ignore [index]
-                "wallet_info": WalletInfo.model_config["json_schema_extra"]["examples"][0],  # type: ignore [index]
-                "pricing_info": PricingInfo.model_config["json_schema_extra"]["examples"][0],  # type: ignore [index]
-                "hardware_info": HardwareInfo.model_config["json_schema_extra"]["examples"][0],  # type: ignore [index]
+    product_name: Annotated[str, Field(..., description="Current product name")]
+    product_api_base_url: Annotated[
+        str,
+        BeforeValidator(lambda v: f"{AnyHttpUrl(v)}"),
+        Field(..., description="Current product API base URL"),
+    ]
+    can_save: Annotated[
+        bool, Field(..., description="the service data must be saved when closing")
+    ]
+    wallet_info: Annotated[
+        WalletInfo | None,
+        Field(
+            default=None,
+            description="contains information about the wallet used to bill the running service",
+        ),
+    ]
+    pricing_info: Annotated[
+        PricingInfo | None,
+        Field(
+            default=None,
+            description="contains pricing information (ex. pricing plan and unit ids)",
+        ),
+    ]
+    hardware_info: Annotated[
+        HardwareInfo | None,
+        Field(
+            default=None,
+            description="contains hardware information (ex. aws_ec2_instances)",
+        ),
+    ]
+
+    @staticmethod
+    def _update_json_schema_extra(schema: JsonDict) -> None:
+        schema.update(
+            {
+                "example": {
+                    "key": "simcore/services/dynamic/3dviewer",
+                    "version": "2.4.5",
+                    "user_id": 234,
+                    "project_id": "dd1d04d9-d704-4f7e-8f0f-1ca60cc771fe",
+                    "node_uuid": "75c7f3f4-18f9-4678-8610-54a2ade78eaa",
+                    "basepath": "/x/75c7f3f4-18f9-4678-8610-54a2ade78eaa",
+                    "product_name": "osparc",
+                    "product_api_base_url": "https://api.local/",
+                    "can_save": True,
+                    "service_resources": ServiceResourcesDictHelpers.model_config["json_schema_extra"]["examples"][0],  # type: ignore [index]
+                    "wallet_info": WalletInfo.model_config["json_schema_extra"]["examples"][0],  # type: ignore [index]
+                    "pricing_info": PricingInfo.model_config["json_schema_extra"]["examples"][0],  # type: ignore [index]
+                    "hardware_info": HardwareInfo.model_config["json_schema_extra"]["examples"][0],  # type: ignore [index]
+                }
             }
-        }
+        )
+
+    model_config = ConfigDict(
+        json_schema_extra=_update_json_schema_extra,
     )
 
 

packages/models-library/src/models_library/api_schemas_dynamic_scheduler/dynamic_services.py

@@ -6,33 +6,39 @@
 from models_library.users import UserID
 from models_library.wallets import WalletInfo
 from pydantic import BaseModel, ConfigDict
+from pydantic.config import JsonDict
 
 
 class DynamicServiceStart(DynamicServiceCreate):
     request_dns: str
     request_scheme: str
     simcore_user_agent: str
 
-    model_config = ConfigDict(
-        json_schema_extra={
-            "example": {
-                "product_name": "osparc",
-                "can_save": True,
-                "user_id": 234,
-                "project_id": "dd1d04d9-d704-4f7e-8f0f-1ca60cc771fe",
-                "service_key": "simcore/services/dynamic/3dviewer",
-                "service_version": "2.4.5",
-                "service_uuid": "75c7f3f4-18f9-4678-8610-54a2ade78eaa",
-                "request_dns": "some.local",
-                "request_scheme": "http",
-                "simcore_user_agent": "",
-                "service_resources": ServiceResourcesDictHelpers.model_config["json_schema_extra"]["examples"][0],  # type: ignore [index]
-                "wallet_info": WalletInfo.model_config["json_schema_extra"]["examples"][0],  # type: ignore [index]
-                "pricing_info": PricingInfo.model_config["json_schema_extra"]["examples"][0],  # type: ignore [index]
-                "hardware_info": HardwareInfo.model_config["json_schema_extra"]["examples"][0],  # type: ignore [index]
+    @staticmethod
+    def _update_json_schema_extra(schema: JsonDict) -> None:
+        schema.update(
+            {
+                "example": {
+                    "product_name": "osparc",
+                    "product_api_base_url": "https://api.local",
+                    "can_save": True,
+                    "user_id": 234,
+                    "project_id": "dd1d04d9-d704-4f7e-8f0f-1ca60cc771fe",
+                    "service_key": "simcore/services/dynamic/3dviewer",
+                    "service_version": "2.4.5",
+                    "service_uuid": "75c7f3f4-18f9-4678-8610-54a2ade78eaa",
+                    "request_dns": "some.local",
+                    "request_scheme": "http",
+                    "simcore_user_agent": "",
+                    "service_resources": ServiceResourcesDictHelpers.model_config["json_schema_extra"]["examples"][0],  # type: ignore [index]
+                    "wallet_info": WalletInfo.model_config["json_schema_extra"]["examples"][0],  # type: ignore [index]
+                    "pricing_info": PricingInfo.model_config["json_schema_extra"]["examples"][0],  # type: ignore [index]
+                    "hardware_info": HardwareInfo.model_config["json_schema_extra"]["examples"][0],  # type: ignore [index]
+                }
             }
-        }
-    )
+        )
+
+    model_config = ConfigDict(json_schema_extra=_update_json_schema_extra)
 
 
 class DynamicServiceStop(BaseModel):

services/director-v2/src/simcore_service_director_v2/constants.py

@@ -24,3 +24,4 @@
 
 UNDEFINED_STR_METADATA = "undefined-metadata"
 UNDEFINED_DOCKER_LABEL = "undefined-label"
+UNDEFINED_API_BASE_URL = "https://api.local"

services/director-v2/src/simcore_service_director_v2/models/comp_runs.py

@@ -30,6 +30,7 @@ class RunMetadataDict(TypedDict, total=False):
     node_id_names_map: dict[NodeID, str]
     project_name: str
     product_name: str
+    product_api_base_url: str
     simcore_user_agent: str
     user_email: str
     wallet_id: int | None

services/director-v2/src/simcore_service_director_v2/models/dynamic_services_scheduler.py

@@ -35,6 +35,7 @@
 from pydantic import (
     AnyHttpUrl,
     BaseModel,
+    BeforeValidator,
     ConfigDict,
     Field,
     StringConstraints,
@@ -475,6 +476,14 @@ def get_proxy_endpoint(self) -> AnyHttpUrl:
         ),
     ] = None
 
+    product_api_base_url: Annotated[
+        str | None,
+        BeforeValidator(lambda v: f"{AnyHttpUrl(v)}"),
+        Field(
+            description="Base URL for the current product's API.",
+        ),
+    ] = None
+
     @classmethod
     def from_http_request(
         # pylint: disable=too-many-arguments
@@ -502,6 +511,7 @@ def from_http_request(
             "version": service.version,
             "service_resources": service.service_resources,
             "product_name": service.product_name,
+            "product_api_base_url": service.product_api_base_url,
             "paths_mapping": simcore_service_labels.paths_mapping,
             "callbacks_mapping": simcore_service_labels.callbacks_mapping,
             "compose_spec": json_dumps(simcore_service_labels.compose_spec),

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

@@ -277,6 +277,7 @@ async def assemble_spec(  # pylint: disable=too-many-arguments # noqa: PLR0913
     simcore_service_labels: SimcoreServiceLabels,
     allow_internet_access: bool,
     product_name: ProductName,
+    product_api_base_url: str,
     user_id: UserID,
     project_id: ProjectID,
     node_id: NodeID,
@@ -354,6 +355,7 @@ async def assemble_spec(  # pylint: disable=too-many-arguments # noqa: PLR0913
             safe=False,
             user_id=user_id,
             product_name=product_name,
+            product_api_base_url=product_api_base_url,
             project_id=project_id,
             node_id=node_id,
             service_run_id=service_run_id,
@@ -394,6 +396,7 @@ async def assemble_spec(  # pylint: disable=too-many-arguments # noqa: PLR0913
         user_id=user_id,
         safe=True,
         product_name=product_name,
+        product_api_base_url=product_api_base_url,
         project_id=project_id,
         node_id=node_id,
         service_run_id=service_run_id,

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

@@ -73,6 +73,9 @@ async def submit_compose_sepc(app: FastAPI, scheduler_data: SchedulerData) -> No
     assert (
         scheduler_data.product_name is not None  # nosec
     ), "ONLY for legacy. This function should not be called with product_name==None"
+    assert (
+        scheduler_data.product_api_base_url is not None  # nosec
+    ), "ONLY for legacy. This function should not be called with product_api_base_url==None"
     allow_internet_access: bool = await groups_extra_properties.has_internet_access(
         user_id=scheduler_data.user_id, product_name=scheduler_data.product_name
     )
@@ -95,6 +98,7 @@ async def submit_compose_sepc(app: FastAPI, scheduler_data: SchedulerData) -> No
         simcore_service_labels=simcore_service_labels,
         allow_internet_access=allow_internet_access,
         product_name=scheduler_data.product_name,
+        product_api_base_url=scheduler_data.product_api_base_url,
         user_id=scheduler_data.user_id,
         project_id=scheduler_data.project_id,
         node_id=scheduler_data.node_uuid,

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

@@ -23,7 +23,6 @@
 from pydantic import BaseModel
 from servicelib.fastapi.app_state import SingletonInAppStateMixin
 from servicelib.logging_utils import log_context
-from simcore_service_director_v2.core.settings import get_application_settings
 
 from ...utils.db import get_repository
 from ...utils.osparc_variables import (
@@ -180,6 +179,7 @@ async def resolve_and_substitute_session_variables_in_model(
     safe: bool = True,
     user_id: UserID,
     product_name: str,
+    product_api_base_url: str | None,
     project_id: ProjectID,
     node_id: NodeID,
     service_run_id: ServiceRunID,
@@ -194,7 +194,6 @@ async def resolve_and_substitute_session_variables_in_model(
             # if it raises an error vars need replacement
             raise_if_unresolved_osparc_variable_identifier_found(model)
     except UnresolvedOsparcVariableIdentifierError:
-        app_settings = get_application_settings(app)
         table = OsparcSessionVariablesTable.get_from_app_state(app)
         identifiers = await resolve_variables_from_context(
             table.copy(),
@@ -206,7 +205,7 @@ async def resolve_and_substitute_session_variables_in_model(
                 node_id=node_id,
                 run_id=service_run_id,
                 wallet_id=wallet_id,
-                api_server_base_url=app_settings.DIRECTOR_V2_PUBLIC_API_BASE_URL,
+                api_server_base_url=product_api_base_url,
             ),
         )
         _logger.debug("replacing with the identifiers=%s", identifiers)
@@ -225,6 +224,7 @@ async def resolve_and_substitute_session_variables_in_specs(
     safe: bool = True,
     user_id: UserID,
     product_name: str,
+    product_api_base_url: str,
     project_id: ProjectID,
     node_id: NodeID,
     service_run_id: ServiceRunID,
@@ -241,7 +241,6 @@ async def resolve_and_substitute_session_variables_in_specs(
             identifiers_to_replace,
         )
         if identifiers_to_replace:
-            app_settings = get_application_settings(app)
             environs = await resolve_variables_from_context(
                 table.copy(include=identifiers_to_replace),
                 context=ContextDict(
@@ -252,7 +251,7 @@ async def resolve_and_substitute_session_variables_in_specs(
                     node_id=node_id,
                     run_id=service_run_id,
                     wallet_id=wallet_id,
-                    api_server_base_url=app_settings.DIRECTOR_V2_PUBLIC_API_BASE_URL,
+                    api_server_base_url=product_api_base_url,
                 ),
             )
 

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

@@ -41,7 +41,7 @@
 from simcore_sdk.node_ports_v2.links import ItemValue as _NPItemValue
 from sqlalchemy.ext.asyncio import AsyncEngine
 
-from ..constants import UNDEFINED_DOCKER_LABEL
+from ..constants import UNDEFINED_API_BASE_URL, UNDEFINED_DOCKER_LABEL
 from ..core.errors import (
     ComputationalBackendNotConnectedError,
     ComputationalSchedulerChangedError,
@@ -318,6 +318,7 @@ async def compute_task_envs(
     wallet_id: WalletID | None,
 ) -> ContainerEnvsDict:
     product_name = metadata.get("product_name", UNDEFINED_DOCKER_LABEL)
+    product_api_base_url = metadata.get("product_api_base_url", UNDEFINED_API_BASE_URL)
     task_envs = node_image.envs
     if task_envs:
         vendor_substituted_envs = await substitute_vendor_secrets_in_specs(
@@ -332,6 +333,7 @@ async def compute_task_envs(
             vendor_substituted_envs,
             user_id=user_id,
             product_name=product_name,
+            product_api_base_url=product_api_base_url,
             project_id=project_id,
             node_id=node_id,
             service_run_id=resource_tracking_run_id,