♻️ webserver: fixes last mypy issues and activating in CI's job (#4519)

Author: pcrespov

.github/workflows/ci-testing-deploy.yml

@@ -292,7 +292,10 @@ jobs:
         run: ./ci/helpers/show_system_versions.bash
       - name: install webserver
         run: ./ci/github/unit-testing/webserver.bash install
+      - name: typecheck
+        run: ./ci/github/unit-testing/webserver.bash typecheck
       - name: test isolated
+        if: always()
         run: ./ci/github/unit-testing/webserver.bash test_isolated
       - name: test
         run: ./ci/github/unit-testing/webserver.bash test_with_db 01

services/web/server/src/simcore_service_webserver/announcements/_models.py

@@ -29,7 +29,7 @@ def check_start_before_end(cls, v, values):
         return v
 
     def expired(self) -> bool:
-        return self.end <= arrow.utcnow().datetime
+        return self.end <= arrow.utcnow().datetime  # type: ignore[no-any-return]
 
     class Config:
         schema_extra: ClassVar[dict[str, Any]] = {

services/web/server/src/simcore_service_webserver/catalog/plugin.py

@@ -23,7 +23,7 @@
 def setup_catalog(app: web.Application):
     # ensures routes are names that corresponds to function names
     for route_def in _handlers.routes:
-        route_def.kwargs["name"] = route_def.handler.__name__  # type: ignore
+        route_def.kwargs["name"] = route_def.handler.__name__
 
     app.add_routes(_handlers.routes)
 

services/web/server/src/simcore_service_webserver/login/_registration.py

@@ -5,22 +5,14 @@
 """
 
 import logging
+from collections.abc import Iterator
 from contextlib import contextmanager
 from datetime import datetime
-from typing import Iterator, Literal
 
 from aiohttp import web
 from models_library.basic_types import IdInt
 from models_library.emails import LowerCaseEmailStr
-from pydantic import (
-    BaseModel,
-    Field,
-    Json,
-    PositiveInt,
-    ValidationError,
-    parse_raw_as,
-    validator,
-)
+from pydantic import BaseModel, Field, Json, PositiveInt, ValidationError, validator
 from servicelib.mimetype_constants import MIMETYPE_APPLICATION_JSON
 from simcore_postgres_database.models.confirmations import ConfirmationAction
 from yarl import URL
@@ -31,11 +23,7 @@
     is_service_invitation_code,
     validate_invitation_url,
 )
-from ._confirmation import (
-    get_expiration_date,
-    is_confirmation_expired,
-    validate_confirmation_code,
-)
+from ._confirmation import is_confirmation_expired, validate_confirmation_code
 from ._constants import MSG_EMAIL_EXISTS, MSG_INVITATIONS_CONTACT_SUFFIX
 from .settings import LoginOptions
 from .storage import AsyncpgStorage, BaseConfirmationTokenDict, ConfirmationTokenDict
@@ -65,7 +53,7 @@ class InvitationData(BaseModel):
 
 
 class _InvitationValidator(BaseModel):
-    action: Literal[ConfirmationAction.INVITATION]
+    action: ConfirmationAction
     data: Json[InvitationData]  # pylint: disable=unsubscriptable-object
 
     @validator("action", pre=True)
@@ -87,7 +75,6 @@ async def check_other_registrations(
     db: AsyncpgStorage,
     cfg: LoginOptions,
 ) -> None:
-
     if user := await db.get_user({"email": email}):
         # An account already registered with this email
         #
@@ -150,12 +137,11 @@ async def create_invitation_token(
             "trial_account_days": trial_days,
         }
     )
-    confirmation = await db.create_confirmation(
+    return await db.create_confirmation(
         user_id=user_id,
         action=ConfirmationAction.INVITATION.name,
         data=data_model.json(),
     )
-    return confirmation
 
 
 @contextmanager
@@ -283,25 +269,3 @@ def get_invitation_url(
     # https://some-web-url.io/#/registration/?invitation={code}
     # NOTE: Uniform encoding in front-end fragments https://github.com/ITISFoundation/osparc-simcore/issues/1975
     return origin.with_fragment(f"/registration/?invitation={code}")
-
-
-def get_confirmation_info(
-    cfg: LoginOptions, confirmation: ConfirmationTokenDict
-) -> ConfirmationTokenInfoDict:
-    """
-    Extends ConfirmationTokenDict by adding extra info and
-    deserializing action's data entry
-    """
-    info: ConfirmationTokenInfoDict = ConfirmationTokenInfoDict(**confirmation)
-
-    action = ConfirmationAction(confirmation["action"])
-    if (data_type := ACTION_TO_DATA_TYPE[action]) and (data := confirmation["data"]):
-        info["data"] = parse_raw_as(data_type, data)
-
-    # extra
-    info["expires"] = get_expiration_date(cfg, confirmation)
-
-    if confirmation["action"] == ConfirmationAction.INVITATION.name:
-        info["url"] = f"{get_invitation_url(confirmation)}"
-
-    return info

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

@@ -30,7 +30,7 @@
 from ..security.decorators import permission_required
 from ..utils_aiohttp import envelope_json_response
 from . import _comments_api, projects_api
-from ._handlers_crud import RequestContext
+from ._common_models import RequestContext
 from .exceptions import ProjectNotFoundError
 
 _logger = logging.getLogger(__name__)
@@ -42,7 +42,7 @@ async def wrapper(request: web.Request) -> web.StreamResponse:
         try:
             return await handler(request)
 
-        except (ProjectNotFoundError) as exc:
+        except ProjectNotFoundError as exc:
             raise web.HTTPNotFound(reason=f"{exc}") from exc
 
     return wrapper

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

@@ -33,7 +33,7 @@
 from ..security.decorators import permission_required
 from ..users import api
 from . import projects_api
-from ._handlers_crud import ProjectPathParams, RequestContext
+from ._common_models import ProjectPathParams, RequestContext
 from .exceptions import (
     ProjectInvalidRightsError,
     ProjectNotFoundError,

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

@@ -123,7 +123,7 @@ async def fake_screenshots_factory(
             file_url = await get_download_link(request.app, user_id, filelink)
             screenshots.append(
                 NodeScreenshot(
-                    thumbnail_url=f"https://placehold.co/170x120?text={text}",
+                    thumbnail_url=f"https://placehold.co/170x120?text={text}",  # type: ignore[arg-type]
                     file_url=file_url,
                 )
             )
@@ -148,16 +148,16 @@ async def fake_screenshots_factory(
         screenshots = [
             *(
                 NodeScreenshot(
-                    thumbnail_url=f"https://picsum.photos/seed/{node_id.int + n}/170/120",
-                    file_url=f"https://picsum.photos/seed/{node_id.int + n}/500",
+                    thumbnail_url=f"https://picsum.photos/seed/{node_id.int + n}/170/120",  # type: ignore[arg-type]
+                    file_url=f"https://picsum.photos/seed/{node_id.int + n}/500",  # type: ignore[arg-type]
                     mimetype="image/jpeg",
                 )
                 for n in range(count)
             ),
             *(
                 NodeScreenshot(
-                    thumbnail_url=f"https://placehold.co/170x120?text={text}",
-                    file_url=f"https://placehold.co/500x500?text={text}",
+                    thumbnail_url=f"https://placehold.co/170x120?text={text}",  # type: ignore[arg-type]
+                    file_url=f"https://placehold.co/500x500?text={text}",  # type: ignore[arg-type]
                     mimetype="image/svg+xml",
                 )
                 for n in range(count)

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

@@ -38,7 +38,7 @@
 from simcore_postgres_database.models.users import UserRole
 
 from .._constants import APP_SETTINGS_KEY, MSG_UNDER_DEVELOPMENT
-from .._meta import api_version_prefix as VTAG
+from .._meta import API_VTAG as VTAG
 from ..catalog import client as catalog_client
 from ..director_v2 import api
 from ..director_v2.exceptions import DirectorServiceError
@@ -47,7 +47,7 @@
 from ..users.api import get_user_role
 from ..utils_aiohttp import envelope_json_response
 from . import projects_api
-from ._handlers_crud import ProjectPathParams, RequestContext
+from ._common_models import ProjectPathParams, RequestContext
 from ._nodes_api import NodeScreenshot, fake_screenshots_factory
 from .db import ProjectDBAPI
 from .exceptions import (

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

@@ -1,6 +1,7 @@
 import asyncio
 import logging
-from typing import Any, Callable, Coroutine, cast
+from collections.abc import Callable, Coroutine
+from typing import Any, cast
 
 from aiohttp import web
 from models_library.api_schemas_webserver.permalinks import ProjectPermalink
@@ -19,20 +20,17 @@
 
 def register_factory(app: web.Application, factory_coro: _CreateLinkCallable):
     if _create := app.get(_PROJECT_PERMALINK):
-        raise PermalinkFactoryError(
-            f"Permalink factory can only be set once: registered {_create}"
-        )
+        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:
-
     if _create := app.get(_PROJECT_PERMALINK):
         return cast(_CreateLinkCallable, _create)
 
-    raise PermalinkFactoryError(
-        "Undefined permalink factory. Check plugin initialization."
-    )
+    msg = "Undefined permalink factory. Check plugin initialization."
+    raise PermalinkFactoryError(msg)
 
 
 _PERMALINK_CREATE_TIMEOUT_S = 2
@@ -41,7 +39,6 @@ def _get_factory(app: web.Application) -> _CreateLinkCallable:
 async def _create_permalink(
     request: web.Request, project_id: ProjectID
 ) -> ProjectPermalink:
-
     create = _get_factory(request.app)
     assert create  # nosec
 
@@ -51,9 +48,8 @@ async def _create_permalink(
         )
         return permalink
     except asyncio.TimeoutError as err:
-        raise PermalinkFactoryError(
-            f"Permalink factory callback '{create}' timed out after {_PERMALINK_CREATE_TIMEOUT_S} secs"
-        ) from err
+        msg = f"Permalink factory callback '{create}' timed out after {_PERMALINK_CREATE_TIMEOUT_S} secs"
+        raise PermalinkFactoryError(msg) from err
 
 
 async def update_or_pop_permalink_in_project(
@@ -77,3 +73,6 @@ async def update_or_pop_permalink_in_project(
         project.pop("permalink", None)
 
     return None
+
+
+__all__: tuple[str, ...] = ("ProjectPermalink",)

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

@@ -24,7 +24,7 @@
 from ..login.decorators import login_required
 from ..security.decorators import permission_required
 from . import _ports_api, projects_api
-from ._handlers_crud import ProjectPathParams, RequestContext
+from ._common_models import ProjectPathParams, RequestContext
 from .db import ProjectDBAPI
 from .exceptions import (
     NodeNotFoundError,
@@ -70,7 +70,6 @@ async def wrapper(request: web.Request) -> web.Response:
 async def _get_validated_workbench_model(
     app: web.Application, project_id: ProjectID, user_id: UserID
 ) -> dict[NodeID, Node]:
-
     project: ProjectDict = await projects_api.get_project_for_user(
         app,
         project_uuid=f"{project_id}",