Merge remote-tracking branch 'upstream/master' into pr-osparc-unping-and-update-aiohttp

Author: Andrei Neagu

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"""
 
 

api/specs/web-server/_long_running_tasks.py

@@ -10,7 +10,7 @@
 from models_library.generics import Envelope
 from models_library.rest_error import EnvelopedError
 from servicelib.aiohttp.long_running_tasks._routes import _PathParam
-from servicelib.long_running_tasks._models import TaskGet, TaskStatus
+from servicelib.long_running_tasks.models import TaskGet, TaskStatus
 from simcore_service_webserver._meta import API_VTAG
 from simcore_service_webserver.tasks._exception_handlers import (
     _TO_HTTP_ERROR_MAP as export_data_http_error_map,

api/specs/web-server/_long_running_tasks_legacy.py

@@ -9,7 +9,7 @@
 from fastapi import APIRouter, Depends, status
 from models_library.generics import Envelope
 from servicelib.aiohttp.long_running_tasks._routes import _PathParam
-from servicelib.long_running_tasks._models import TaskGet, TaskStatus
+from servicelib.long_running_tasks.models import TaskGet, TaskStatus
 from simcore_service_webserver._meta import API_VTAG
 
 router = APIRouter(

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/aiohttp/long_running_tasks/_dependencies.py

@@ -2,7 +2,7 @@
 
 from aiohttp import web
 
-from ...long_running_tasks._task import TasksManager
+from ...long_running_tasks.task import TasksManager
 from ._constants import (
     APP_LONG_RUNNING_TASKS_MANAGER_KEY,
     RQT_LONG_RUNNING_TASKS_CONTEXT_KEY,

packages/service-library/src/servicelib/aiohttp/long_running_tasks/_error_handlers.py

@@ -3,7 +3,7 @@
 from aiohttp import web
 from common_library.json_serialization import json_dumps
 
-from ...long_running_tasks._errors import (
+from ...long_running_tasks.errors import (
     TaskCancelledError,
     TaskNotCompletedError,
     TaskNotFoundError,

packages/service-library/src/servicelib/aiohttp/long_running_tasks/_routes.py

@@ -6,9 +6,9 @@
 from pydantic import BaseModel
 from servicelib.aiohttp import status
 
-from ...long_running_tasks._errors import TaskNotCompletedError, TaskNotFoundError
-from ...long_running_tasks._models import TaskGet, TaskId, TaskStatus
-from ...long_running_tasks._task import TrackedTask
+from ...long_running_tasks.errors import TaskNotCompletedError, TaskNotFoundError
+from ...long_running_tasks.models import TaskGet, TaskId, TaskStatus
+from ...long_running_tasks.task import TrackedTask
 from ..requests_validation import parse_request_path_parameters_as
 from ._dependencies import get_task_context, get_tasks_manager
 

packages/service-library/src/servicelib/aiohttp/long_running_tasks/_server.py

@@ -9,8 +9,8 @@
 from pydantic import AnyHttpUrl, PositiveFloat, TypeAdapter
 
 from ...aiohttp import status
-from ...long_running_tasks._models import TaskGet
-from ...long_running_tasks._task import (
+from ...long_running_tasks.models import TaskGet
+from ...long_running_tasks.task import (
     TaskContext,
     TaskProtocol,
     TasksManager,
@@ -136,11 +136,11 @@ def setup(
 
     async def on_cleanup_ctx(app: web.Application) -> AsyncGenerator[None, None]:
         # add components to state
-        app[
-            APP_LONG_RUNNING_TASKS_MANAGER_KEY
-        ] = long_running_task_manager = TasksManager(
-            stale_task_check_interval_s=stale_task_check_interval_s,
-            stale_task_detect_timeout_s=stale_task_detect_timeout_s,
+        app[APP_LONG_RUNNING_TASKS_MANAGER_KEY] = long_running_task_manager = (
+            TasksManager(
+                stale_task_check_interval_s=stale_task_check_interval_s,
+                stale_task_detect_timeout_s=stale_task_detect_timeout_s,
+            )
         )
 
         # add error handlers