🐛 Generate API base URL by active product ⚠️

services/web/server/src/simcore_service_webserver/api_keys/_controller/rest.py

@@ -21,7 +21,8 @@
 from ...login.decorators import login_required
 from ...models import RequestContext
 from ...security.decorators import permission_required
-from ...utils_aiohttp import envelope_json_response
+from ...utils import is_ip_address
+from ...utils_aiohttp import envelope_json_response, iter_originating_hosts
 from .. import _service
 from ..models import ApiKey
 from .rest_exceptions import handle_plugin_requests_exceptions
@@ -36,6 +37,16 @@ class ApiKeysPathParams(StrictRequestParameters):
     api_key_id: IDStr
 
 
+def _get_api_base_url(request: web.Request) -> str:
+    originating_host = next(iter_originating_hosts(request))
+    api_host = (
+        f"api.{originating_host}"
+        if not is_ip_address(originating_host)
+        else originating_host
+    )
+    return f"{request.url.with_host(api_host).with_port(None).with_path('')}"
+
+
 @routes.post(f"/{API_VTAG}/auth/api-keys", name="create_api_key")
 @login_required
 @permission_required("user.apikey.*")
@@ -55,8 +66,8 @@ async def create_api_key(request: web.Request):
     api_key = ApiKeyCreateResponse.model_validate(
         {
             **asdict(created_api_key),
-            "api_base_url": "http://localhost:8000",
-        }  # TODO: https://github.com/ITISFoundation/osparc-simcore/issues/6340 # @pcrespov
+            "api_base_url": _get_api_base_url(request),
+        }
     )
 
     return envelope_json_response(api_key)

services/web/server/src/simcore_service_webserver/products/_web_middlewares.py

@@ -8,6 +8,7 @@
 
 from .._meta import API_VTAG
 from ..constants import APP_PRODUCTS_KEY, RQ_PRODUCT_KEY
+from ..utils_aiohttp import iter_originating_hosts
 from .models import Product
 
 _logger = logging.getLogger(__name__)
@@ -20,16 +21,9 @@ def _get_default_product_name(app: web.Application) -> str:
 
 def _discover_product_by_hostname(request: web.Request) -> str | None:
     products: OrderedDict[str, Product] = request.app[APP_PRODUCTS_KEY]
-    #
-    # SEE https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host
-    # SEE https://doc.traefik.io/traefik/getting-started/faq/#what-are-the-forwarded-headers-when-proxying-http-requests
-    originating_hosts = [
-        request.headers.get("X-Forwarded-Host"),
-        request.host,
-    ]
     for product in products.values():
-        for host in originating_hosts:
-            if host and product.host_regex.search(host):
+        for host in iter_originating_hosts(request):
+            if product.host_regex.search(host):
                 product_name: str = product.name
                 return product_name
     return None

services/web/server/src/simcore_service_webserver/utils.py

@@ -4,6 +4,7 @@
 
 import asyncio
 import hashlib
+import ipaddress
 import logging
 import os
 import sys
@@ -173,3 +174,17 @@ def compose_support_error_msg(
 
 def get_traceback_string(exception: BaseException) -> str:
     return "".join(traceback.format_exception(exception))
+
+
+# -----------------------------------------------
+#
+# NETWORK
+#
+
+
+def is_ip_address(host: str) -> bool:
+    try:
+        ipaddress.ip_address(host)
+        return True
+    except ValueError:
+        return False

services/web/server/src/simcore_service_webserver/utils_aiohttp.py

@@ -1,6 +1,6 @@
 import io
 import logging
-from collections.abc import Callable
+from collections.abc import Callable, Generator
 from typing import Any, Generic, Literal, TypeAlias, TypeVar
 
 from aiohttp import web
@@ -128,3 +128,15 @@ class NextPage(BaseModel, Generic[PageParameters]):
         ..., description="Code name to the front-end page. Ideally a PageStr"
     )
     parameters: PageParameters | None = None
+
+
+def iter_originating_hosts(request) -> Generator[str, None, None]:
+    #
+    # SEE https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host
+    # SEE https://doc.traefik.io/traefik/getting-started/faq/#what-are-the-forwarded-headers-when-proxying-http-requests
+    for host in (
+        request.headers.get("X-Forwarded-Host"),
+        request.url.host,
+    ):
+        if host:
+            yield host

services/web/server/tests/unit/with_dbs/01/test_api_keys.py

@@ -109,14 +109,20 @@ async def test_create_api_key(
     expected: HTTPStatus,
 ):
     display_name = "foo"
-    resp = await client.post("/v0/auth/api-keys", json={"displayName": display_name})
+    resp = await client.post(
+        "/v0/auth/api-keys",
+        json={"displayName": display_name},
+        headers={"X-Forwarded-Host": "osparc.io"},
+    )
 
     data, errors = await assert_status(resp, expected)
 
     if not errors:
         assert data["displayName"] == display_name
         assert "apiKey" in data
         assert "apiSecret" in data
+        assert "apiBaseUrl" in data
+        assert data["apiBaseUrl"] == "http://api.osparc.io/"
 
         resp = await client.get("/v0/auth/api-keys")
         data, _ = await assert_status(resp, expected)