review @pcrespov

Author: matusdrobuliak66

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

@@ -164,13 +164,11 @@ class ComputationTaskRestGet(OutputSchema):
 class ComputationCollectionRunListQueryParams(
     PageQueryParameters,
 ):
-    filter_only_running: bool = Field(
-        default=False,
-        description="If true, only running collection runs are returned",
-    )
-    filter_by_root_project_id: ProjectID | None = Field(
-        default=None,
-    )
+    filter_only_running: Annotated[
+        bool, Field(description="If true, only running collection runs are returned")
+    ] = False
+
+    filter_by_root_project_id: ProjectID | None = None
 
     _null_or_none_to_none = field_validator("filter_by_root_project_id", mode="before")(
         null_or_none_str_to_none_validator

packages/postgres-database/src/simcore_postgres_database/migration/versions/42ec7816c0b4_computational_collection_runs.py

@@ -31,7 +31,7 @@ def upgrade():
         sa.Column(
             "client_or_system_generated_display_name", sa.String(), nullable=False
         ),
-        sa.Column("generated_by_system", sa.Boolean(), nullable=False),
+        sa.Column("is_generated_by_system", sa.Boolean(), nullable=False),
         sa.Column(
             "created",
             sa.DateTime(timezone=True),
@@ -68,7 +68,7 @@ def upgrade():
             collection_run_id,
             client_or_system_generated_id,
             client_or_system_generated_display_name,
-            generated_by_system
+            is_generated_by_system
         )
         SELECT DISTINCT
             gen_random_uuid(),

packages/postgres-database/src/simcore_postgres_database/models/comp_runs_collections.py

@@ -1,5 +1,3 @@
-"""Computational Runs Table"""
-
 import sqlalchemy as sa
 from sqlalchemy.dialects.postgresql import UUID
 
@@ -13,21 +11,21 @@
         "collection_run_id",
         UUID(as_uuid=True),
         server_default=sa.text("gen_random_uuid()"),
-        nullable=False,
         primary_key=True,
     ),
     sa.Column(
         "client_or_system_generated_id",
         sa.String,
         nullable=False,
+        doc="Unique identifier for the collection run, generated by the client (ex. Third party using our public api) or system (ex. osparc webserver)",
     ),
     sa.Column(
         "client_or_system_generated_display_name",
         sa.String,
         nullable=False,
     ),
     sa.Column(
-        "generated_by_system",
+        "is_generated_by_system",
         sa.Boolean,
         nullable=False,
     ),

packages/pytest-simcore/src/pytest_simcore/helpers/webserver_workspaces.py

@@ -5,7 +5,7 @@
 from simcore_postgres_database.models.workspaces_access_rights import (
     workspaces_access_rights,
 )
-from simcore_service_webserver.db.plugin import get_database_engine
+from simcore_service_webserver.db.plugin import get_database_engine_legacy
 from sqlalchemy.dialects.postgresql import insert as pg_insert
 
 
@@ -18,7 +18,7 @@ async def update_or_insert_workspace_group(
     write: bool,
     delete: bool,
 ) -> None:
-    async with get_database_engine(app).acquire() as conn:
+    async with get_database_engine_legacy(app).acquire() as conn:
         insert_stmt = pg_insert(workspaces_access_rights).values(
             workspace_id=workspace_id,
             gid=group_id,

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

@@ -1,6 +1,4 @@
-""" database submodule associated to the postgres uservice
-
-"""
+"""database submodule associated to the postgres uservice"""
 
 import logging
 
@@ -14,7 +12,7 @@
 
 
 # API
-get_database_engine = _aiopg.get_database_engine
+get_database_engine_legacy = _aiopg.get_database_engine
 get_engine_state = _aiopg.get_engine_state
 is_service_responsive = _aiopg.is_service_responsive
 is_service_enabled = _aiopg.is_service_enabled
@@ -34,7 +32,7 @@ def setup_db(app: web.Application):
 
     # ensures keys exist
     app[APP_AIOPG_ENGINE_KEY] = None
-    assert get_database_engine(app) is None  # nosec
+    assert get_database_engine_legacy(app) is None  # nosec
 
     # init engines
     app.cleanup_ctx.append(_aiopg.postgres_cleanup_ctx)

services/web/server/src/simcore_service_webserver/db_listener/_db_comp_tasks_listening_task.py

@@ -22,7 +22,7 @@
 from simcore_postgres_database.webserver_models import DB_CHANNEL_NAME, projects
 from sqlalchemy.sql import select
 
-from ..db.plugin import get_database_engine
+from ..db.plugin import get_database_engine_legacy
 from ..projects import _projects_service, exceptions
 from ..projects.nodes_utils import update_node_outputs
 from ._models import CompTaskNotificationPayload
@@ -126,7 +126,7 @@ async def _handle_db_notification(
 
 async def _listen(app: web.Application) -> NoReturn:
     listen_query = f"LISTEN {DB_CHANNEL_NAME};"
-    db_engine = get_database_engine(app)
+    db_engine = get_database_engine_legacy(app)
     async with db_engine.acquire() as conn:
         assert conn.connection  # nosec
         await conn.execute(listen_query)

services/web/server/src/simcore_service_webserver/director_v2/_comp_runs_collections_models.py

@@ -11,7 +11,7 @@ class CompRunCollectionDBGet(BaseModel):
     collection_run_id: CollectionRunID
     client_or_system_generated_id: str
     client_or_system_generated_display_name: str
-    generated_by_system: bool
+    is_generated_by_system: bool
     created: datetime
 
     model_config = ConfigDict(from_attributes=True)

services/web/server/src/simcore_service_webserver/director_v2/_comp_runs_collections_repository.py

@@ -18,15 +18,15 @@ async def create_comp_run_collection(
     conn,
     client_or_system_generated_id: str,
     client_or_system_generated_display_name: str,
-    generated_by_system: bool,
+    is_generated_by_system: bool,
 ) -> CollectionRunID:
     """Create a new computational run collection."""
     result = await conn.execute(
         comp_runs_collections.insert()
         .values(
             client_or_system_generated_id=client_or_system_generated_id,
             client_or_system_generated_display_name=client_or_system_generated_display_name,
-            generated_by_system=generated_by_system,
+            is_generated_by_system=is_generated_by_system,
             created=func.now(),
             modified=func.now(),
         )

services/web/server/src/simcore_service_webserver/director_v2/_comp_runs_collections_service.py

@@ -3,7 +3,7 @@
 from aiohttp import web
 from models_library.computations import CollectionRunID
 
-from ..db.plugin import get_database_engine
+from ..db.plugin import get_database_engine_legacy
 from . import _comp_runs_collections_repository
 from ._comp_runs_collections_models import CompRunCollectionDBGet
 
@@ -12,34 +12,36 @@
 
 async def create_comp_run_collection(
     app: web.Application,
+    *,
     client_or_system_generated_id: str,
     client_or_system_generated_display_name: str,
-    generated_by_system: bool,
+    is_generated_by_system: bool,
 ) -> CollectionRunID:
     """raises: ProjectNotFoundError"""
-    async with get_database_engine(app).acquire() as conn:
+    async with get_database_engine_legacy(app).acquire() as conn:
         return await _comp_runs_collections_repository.create_comp_run_collection(
             conn=conn,
             client_or_system_generated_id=client_or_system_generated_id,
             client_or_system_generated_display_name=client_or_system_generated_display_name,
-            generated_by_system=generated_by_system,
+            is_generated_by_system=is_generated_by_system,
         )
 
 
 async def get_comp_run_collection_or_none_by_id(
-    app: web.Application, collection_run_id: CollectionRunID
+    app: web.Application, *, collection_run_id: CollectionRunID
 ) -> CompRunCollectionDBGet | None:
-    async with get_database_engine(app).acquire() as conn:
+    async with get_database_engine_legacy(app).acquire() as conn:
         return await _comp_runs_collections_repository.get_comp_run_collection_or_none_by_id(
             conn=conn, collection_run_id=collection_run_id
         )
 
 
 async def get_comp_run_collection_or_none_by_client_generated_id(
     app: web.Application,
+    *,
     client_or_system_generated_id: str,
 ) -> CompRunCollectionDBGet | None:
-    async with get_database_engine(app).acquire() as conn:
+    async with get_database_engine_legacy(app).acquire() as conn:
         return await _comp_runs_collections_repository.get_comp_run_collection_or_none_by_client_generated_id(
             conn=conn, client_or_system_generated_id=client_or_system_generated_id
         )

services/web/server/src/simcore_service_webserver/director_v2/_computations_service.py

@@ -373,7 +373,7 @@ async def list_computation_collection_runs(
             ended_at=item.ended_at,
             name=(
                 run_collection.client_or_system_generated_display_name
-                if run_collection and run_collection.generated_by_system is False
+                if run_collection and run_collection.is_generated_by_system is False
                 else project_root_name
             ),
         )