permalink factory: changes interface

Author: pcrespov

services/web/server/src/simcore_service_webserver/projects/_crud_api_create.py

@@ -413,7 +413,7 @@ async def create_project(  # pylint: disable=too-many-arguments,too-many-branche
         task_progress.update()
 
         # Adds permalink
-        await update_or_pop_permalink_in_project(request, new_project)
+        await update_or_pop_permalink_in_project(request.app, new_project)
 
         # Adds folderId
         user_specific_project_data_db = (

services/web/server/src/simcore_service_webserver/projects/_crud_api_read.py

@@ -44,7 +44,7 @@ async def _update_project_dict(
     )
 
     # permalink
-    await update_or_pop_permalink_in_project(request, project)
+    await update_or_pop_permalink_in_project(request.app, project)
 
     return project
 

services/web/server/src/simcore_service_webserver/projects/_crud_handlers.py

@@ -312,7 +312,7 @@ async def get_active_project(request: web.Request) -> web.Response:
             )
 
             # updates project's permalink field
-            await update_or_pop_permalink_in_project(request, project)
+            await update_or_pop_permalink_in_project(request.app, project)
 
             data = ProjectGet.from_domain_model(project).data(exclude_unset=True)
 
@@ -370,7 +370,7 @@ async def get_project(request: web.Request):
             project["uuid"] = new_uuid
 
         # Adds permalink
-        await update_or_pop_permalink_in_project(request, project)
+        await update_or_pop_permalink_in_project(request.app, project)
 
         data = ProjectGet.from_domain_model(project).data(exclude_unset=True)
         return web.json_response({"data": data}, dumps=json_dumps)

services/web/server/src/simcore_service_webserver/projects/_permalink_api.py

@@ -1,7 +1,6 @@
 import asyncio
 import logging
-from collections.abc import Callable, Coroutine
-from typing import Any, cast
+from typing import Protocol, cast
 
 from aiohttp import web
 from models_library.api_schemas_webserver.permalinks import ProjectPermalink
@@ -13,21 +12,24 @@
 _PROJECT_PERMALINK = f"{__name__}"
 _logger = logging.getLogger(__name__)
 
-_CreateLinkCallable = Callable[
-    [web.Request, ProjectID], Coroutine[Any, Any, ProjectPermalink]
-]
 
+class CreateLinkCoroutine(Protocol):
+    async def __call__(
+        self, app: web.Application, project_id: ProjectID
+    ) -> ProjectPermalink:
+        ...
 
-def register_factory(app: web.Application, factory_coro: _CreateLinkCallable):
+
+def register_factory(app: web.Application, factory_coro: CreateLinkCoroutine):
     if _create := app.get(_PROJECT_PERMALINK):
         msg = f"Permalink factory can only be set once: registered {_create}"
         raise PermalinkFactoryError(msg)
     app[_PROJECT_PERMALINK] = factory_coro
 
 
-def _get_factory(app: web.Application) -> _CreateLinkCallable:
+def _get_factory(app: web.Application) -> CreateLinkCoroutine:
     if _create := app.get(_PROJECT_PERMALINK):
-        return cast(_CreateLinkCallable, _create)
+        return cast(CreateLinkCoroutine, _create)
 
     msg = "Undefined permalink factory. Check plugin initialization."
     raise PermalinkFactoryError(msg)
@@ -37,22 +39,23 @@ def _get_factory(app: web.Application) -> _CreateLinkCallable:
 
 
 async def _create_permalink(
-    request: web.Request, project_id: ProjectID
+    app: web.Application, project_id: ProjectID
 ) -> ProjectPermalink:
-    create = _get_factory(request.app)
+    create_coro: CreateLinkCoroutine = _get_factory(app)
 
     try:
         permalink: ProjectPermalink = await asyncio.wait_for(
-            create(request, project_id), timeout=_PERMALINK_CREATE_TIMEOUT_S
+            create_coro(app, project_id),
+            timeout=_PERMALINK_CREATE_TIMEOUT_S,
         )
         return permalink
-    except asyncio.TimeoutError as err:
-        msg = f"Permalink factory callback '{create}' timed out after {_PERMALINK_CREATE_TIMEOUT_S} secs"
+    except TimeoutError as err:
+        msg = f"Permalink factory callback '{create_coro}' timed out after {_PERMALINK_CREATE_TIMEOUT_S} secs"
         raise PermalinkFactoryError(msg) from err
 
 
 async def update_or_pop_permalink_in_project(
-    request: web.Request, project: ProjectDict
+    app: web.Application, project: ProjectDict
 ) -> ProjectPermalink | None:
     """Updates permalink entry in project
 
@@ -61,7 +64,7 @@ async def update_or_pop_permalink_in_project(
     If fails, it pops it from project (so it is not set in the pydantic model. SEE ProjectGet.permalink)
     """
     try:
-        permalink = await _create_permalink(request, project_id=project["uuid"])
+        permalink = await _create_permalink(app, project_id=project["uuid"])
 
         assert permalink  # nosec
         project["permalink"] = permalink

services/web/server/src/simcore_service_webserver/studies_dispatcher/_projects_permalinks.py

@@ -74,14 +74,14 @@ def create_permalink_for_study(
 
 
 async def permalink_factory(
-    request: web.Request, project_uuid: ProjectID
+    app: web.Application, project_uuid: ProjectID
 ) -> ProjectPermalink:
     """
     - Assumes project_id is up-to-date in the database
 
     """
     # NOTE: next iterations will mobe this as part of the project repository pattern
-    engine = get_database_engine(request.app)
+    engine = get_database_engine(app)
     async with engine.acquire() as conn:
         access_rights_subquery = (
             sa.select(