🐛 Generate API base URL by active product ⚠️

.env-devel

@@ -119,7 +119,6 @@ DIRECTOR_V2_LOGLEVEL=INFO
 DIRECTOR_V2_NODE_PORTS_STORAGE_AUTH=null
 DIRECTOR_V2_PORT=8000
 DIRECTOR_V2_PROFILING=1
-DIRECTOR_V2_PUBLIC_API_BASE_URL=http://127.0.0.1:8006
 DIRECTOR_V2_SERVICES_CUSTOM_CONSTRAINTS=[]
 DIRECTOR_V2_DOCKER_HUB_REGISTRY=null
 DYNAMIC_SIDECAR_ENABLE_VOLUME_LIMITS=False

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):

packages/models-library/src/models_library/api_schemas_webserver/auth.py

@@ -55,10 +55,13 @@ class UnregisterCheck(InputSchema):
 
 class ApiKeyCreateRequest(InputSchema):
     display_name: Annotated[str, Field(..., min_length=3)]
-    expiration: timedelta | None = Field(
-        None,
-        description="Time delta from creation time to expiration. If None, then it does not expire.",
-    )
+    expiration: Annotated[
+        timedelta | None,
+        Field(
+            None,
+            description="Time delta from creation time to expiration. If None, then it does not expire.",
+        ),
+    ]
 
     model_config = ConfigDict(
         alias_generator=AliasGenerator(
@@ -86,11 +89,14 @@ class ApiKeyCreateRequest(InputSchema):
 class ApiKeyCreateResponse(OutputSchema):
     id: IDStr
     display_name: Annotated[str, Field(..., min_length=3)]
-    expiration: timedelta | None = Field(
-        None,
-        description="Time delta from creation time to expiration. If None, then it does not expire.",
-    )
-    api_base_url: HttpUrl
+    expiration: Annotated[
+        timedelta | None,
+        Field(
+            None,
+            description="Time delta from creation time to expiration. If None, then it does not expire.",
+        ),
+    ]
+    api_base_url: HttpUrl | None = None
     api_key: str
     api_secret: str
 

services/director-v2/.env-devel

@@ -25,8 +25,6 @@ DIRECTOR_V2_SELF_SIGNED_SSL_SECRET_ID=1234
 DIRECTOR_V2_SELF_SIGNED_SSL_SECRET_NAME=1234
 DIRECTOR_V2_SELF_SIGNED_SSL_FILENAME=filename
 
-DIRECTOR_V2_PUBLIC_API_BASE_URL=http://127.0.0.1:8006
-
 DIRECTOR_V2_GENERIC_RESOURCE_PLACEMENT_CONSTRAINTS_SUBSTITUTIONS='{}'
 
 LOG_LEVEL=DEBUG

services/director-v2/openapi.json

@@ -1,4 +1,4 @@
 {
   "openapi": "3.1.0",
   "info": {
     "title": "simcore-service-director-v2",
@@ -1291,6 +1291,13 @@
             "type": "string",
             "title": "Product Name"
           },
+          "product_api_base_url": {
+            "type": "string",
+            "minLength": 1,
+            "format": "uri",
+            "title": "Product Api Base Url",
+            "description": "Base url of the product"
+          },
           "subgraph": {
             "anyOf": [
               {
@@ -1347,7 +1354,8 @@
         "required": [
           "user_id",
           "project_id",
-          "product_name"
+          "product_name",
+          "product_api_base_url"
         ],
         "title": "ComputationCreate"
       },
@@ -1789,6 +1797,11 @@
             "title": "Product Name",
             "description": "Current product name"
           },
+          "product_api_base_url": {
+            "type": "string",
+            "title": "Product Api Base Url",
+            "description": "Current product API base URL"
+          },
           "can_save": {
             "type": "boolean",
             "title": "Can Save",
@@ -1825,7 +1838,7 @@
                 "type": "null"
               }
             ],
-            "description": "contains harware information (ex. aws_ec2_instances)"
+            "description": "contains hardware information (ex. aws_ec2_instances)"
           }
         },
         "type": "object",
@@ -1837,6 +1850,7 @@
           "service_uuid",
           "service_resources",
           "product_name",
+          "product_api_base_url",
           "can_save"
         ],
         "title": "DynamicServiceCreate",
@@ -1855,6 +1869,7 @@
             "pricing_unit_cost_id": 1,
             "pricing_unit_id": 1
           },
+          "product_api_base_url": "https://api.local/",
           "product_name": "osparc",
           "project_id": "dd1d04d9-d704-4f7e-8f0f-1ca60cc771fe",
           "service_resources": {
@@ -3002,6 +3017,18 @@
             ],
             "title": "Product Name",
             "description": "Current product upon which this service is scheduledIf set to None, the current product is undefined. Mostly for backwards compatibility"
+          },
+          "product_api_base_url": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Product Api Base Url",
+            "description": "Base URL for the current product's API."
           }
         },
         "additionalProperties": true,

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/core/settings.py

@@ -16,9 +16,7 @@
     NoAuthentication,
 )
 from pydantic import (
-    AfterValidator,
     AliasChoices,
-    AnyHttpUrl,
     AnyUrl,
     Field,
     NonNegativeInt,
@@ -233,14 +231,6 @@ class AppSettings(BaseApplicationSettings, MixinLoggingSettings):
         description="resource usage tracker service client's plugin",
     )
 
-    DIRECTOR_V2_PUBLIC_API_BASE_URL: Annotated[
-        AnyHttpUrl | str,
-        AfterValidator(lambda v: f"{v}".rstrip("/")),
-        Field(
-            ...,
-            description="Base URL used to access the public api e.g. http://127.0.0.1:6000 for development or https://api.osparc.io",
-        ),
-    ]
     DIRECTOR_V2_TRACING: TracingSettings | None = Field(
         json_schema_extra={"auto_default_from_env": True},
         description="settings for opentelemetry tracing",

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