Merge branch 'master' into enh/cache-calls

Author: odeimaiz

api/specs/web-server/_auth_api_keys.py

@@ -1,10 +1,12 @@
 from typing import Annotated
 
+from _common import as_query
 from fastapi import APIRouter, Depends, status
 from models_library.api_schemas_webserver.auth import (
     ApiKeyCreateRequest,
     ApiKeyCreateResponse,
     ApiKeyGet,
+    ApiKeyListQueryParams,
 )
 from models_library.generics import Envelope
 from models_library.rest_error import EnvelopedError
@@ -39,7 +41,9 @@ async def create_api_key(_body: ApiKeyCreateRequest):
     response_model=Envelope[list[ApiKeyGet]],
     status_code=status.HTTP_200_OK,
 )
-async def list_api_keys():
+async def list_api_keys(
+    _query: Annotated[as_query(ApiKeyListQueryParams), Depends()],
+):
     """lists API keys by this user"""
 
 

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

@@ -2,6 +2,7 @@
 from typing import Annotated, Any
 
 from models_library.basic_types import IDStr
+from models_library.rest_base import RequestParameters
 from pydantic import AliasGenerator, ConfigDict, Field, HttpUrl, SecretStr
 from pydantic.alias_generators import to_camel
 
@@ -53,6 +54,17 @@ class UnregisterCheck(InputSchema):
 #
 
 
+class ApiKeyListQueryParams(RequestParameters):
+    include_autogenerated: Annotated[
+        bool,
+        Field(
+            alias="includeAutogenerated",
+            description="If True, then the list includes autogenerated API keys. "
+            "Otherwise, only user-created API keys are returned.",
+        ),
+    ] = False
+
+
 class ApiKeyCreateRequest(InputSchema):
     display_name: Annotated[str, Field(..., min_length=3)]
     expiration: Annotated[

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

@@ -0,0 +1,8 @@
+from typing import Final
+
+from models_library.rpc.webserver.auth.api_keys import generate_api_key_prefix
+
+API_KEY_AUTOGENERATED_DISPLAY_NAME_PREFIX: Final[str] = "__auto_"
+API_KEY_AUTOGENERATED_KEY_PREFIX: Final[str] = generate_api_key_prefix(
+    API_KEY_AUTOGENERATED_DISPLAY_NAME_PREFIX
+)

packages/models-library/src/models_library/rpc/webserver/auth/api_keys.py

@@ -16,8 +16,12 @@
 _SECRET_LEN: Final = 20
 
 
+def generate_api_key_prefix(name: str) -> str:
+    return _PUNCTUATION_REGEX.sub("_", name[:5])
+
+
 def generate_unique_api_key(name: str, length: int = _KEY_LEN) -> str:
-    prefix = _PUNCTUATION_REGEX.sub("_", name[:5])
+    prefix = generate_api_key_prefix(name)
     hashed = hashlib.sha256(name.encode()).hexdigest()
     return f"{prefix}_{hashed[:length]}"
 

packages/service-library/src/servicelib/long_running_tasks/task.py

@@ -6,7 +6,7 @@
 from collections import deque
 from contextlib import suppress
 from datetime import datetime
-from typing import Any, Protocol
+from typing import Any, Protocol, TypeAlias
 from uuid import uuid4
 
 from models_library.api_schemas_long_running_tasks.base import (
@@ -53,8 +53,8 @@ def _mark_task_to_remove_if_required(
             tasks_to_remove.append(task_id)
 
 
-TrackedTaskGroupDict = dict[TaskId, TrackedTask]
-TaskContext = dict[str, Any]
+TrackedTaskGroupDict: TypeAlias = dict[TaskId, TrackedTask]
+TaskContext: TypeAlias = dict[str, Any]
 
 
 class TasksManager:

services/api-server/src/simcore_service_api_server/api/dependencies/services.py

@@ -12,6 +12,7 @@
 from ..._service_programs import ProgramService
 from ..._service_solvers import SolverService
 from ..._service_studies import StudyService
+from ...services_http.webserver import AuthSession
 from ...services_rpc.catalog import CatalogService
 from ...services_rpc.wb_api_server import WbApiRpcClient
 from ...utils.client_base import BaseServiceClientApi

services/api-server/src/simcore_service_api_server/api/dependencies/webserver_http.py

@@ -5,13 +5,16 @@
 from cryptography.fernet import Fernet
 from fastapi import Depends, FastAPI, HTTPException, status
 from fastapi.requests import Request
-from servicelib.rest_constants import X_PRODUCT_NAME_HEADER
 
 from ..._constants import MSG_BACKEND_SERVICE_UNAVAILABLE
 from ...core.settings import ApplicationSettings, WebServerSettings
 from ...services_http.webserver import AuthSession
 from .application import get_app, get_settings
-from .authentication import Identity, get_active_user_email, get_current_identity
+from .authentication import (
+    Identity,
+    get_active_user_email,
+    get_current_identity,
+)
 
 
 def _get_settings(
@@ -68,14 +71,14 @@ def get_webserver_session(
     Lifetime of AuthSession wrapper is one request because it needs different session cookies
     Lifetime of embedded client is attached to the app lifetime
     """
-    product_header: dict[str, str] = {X_PRODUCT_NAME_HEADER: f"{identity.product_name}"}
-    session = AuthSession.create(app, session_cookies, product_header)
+    session = AuthSession.create(
+        app,
+        session_cookies=session_cookies,
+        product_name=identity.product_name,
+        user_id=identity.user_id,
+    )
     assert isinstance(session, AuthSession)  # nosec
     return session
 
 
-__all__: tuple[str, ...] = (
-    "AuthSession",
-    "get_session_cookie",
-    "get_webserver_session",
-)
+__all__: tuple[str, ...] = ("AuthSession",)