models

Author: pcrespov

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

@@ -7,34 +7,37 @@
     ComputationGet as _ComputationGetDirectorV2,
 )
 from ..projects import CommitID, ProjectID
-from ._base import InputSchema, OutputSchema
+from ._base import InputSchemaWithoutCamelCase, OutputSchemaWithoutCamelCase
 
 
 class ComputationPathParams(BaseModel):
     project_id: ProjectID
 
 
-class ComputationGet(_ComputationGetDirectorV2, OutputSchema):
-    # FIXME: camelcase!!
+class ComputationGet(_ComputationGetDirectorV2, OutputSchemaWithoutCamelCase):
     # NOTE: this is a copy of the same class in models_library.api_schemas_directorv2
     #       but it is used in a different context (webserver)
     #       and we need to add the `OutputSchema` mixin
     #       so that it can be used as a response model in FastAPI
     pass
 
 
-class ComputationStart(InputSchema):
-    # FIXME: camelcase!!
+class ComputationStart(InputSchemaWithoutCamelCase):
     force_restart: bool = False
-    subgraph: Annotated[set[str], Field(default_factory=set)]
+    subgraph: Annotated[
+        set[str], Field(default_factory=set, json_schema_extra={"default": []})
+    ] = DEFAULT_FACTORY
 
 
-class ComputationStarted(OutputSchema):
-    # FIXME: camelcase!!
+class ComputationStarted(OutputSchemaWithoutCamelCase):
     pipeline_id: Annotated[
         ProjectID, Field(description="ID for created pipeline (=project identifier)")
     ]
     ref_ids: Annotated[
         list[CommitID],
-        Field(default_factory=list, description="Checkpoints IDs for created pipeline"),
+        Field(
+            default_factory=list,
+            description="Checkpoints IDs for created pipeline",
+            json_schema_extra={"default": []},
+        ),
     ] = DEFAULT_FACTORY

services/web/server/src/simcore_service_webserver/api/v0/openapi.yaml

@@ -2505,7 +2505,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/Envelope__ComputationStarted_'
+                $ref: '#/components/schemas/Envelope_ComputationStarted_'
         '402':
           description: Insufficient credits to run computation
         '404':
@@ -8582,9 +8582,25 @@ components:
           type: array
           uniqueItems: true
           title: Subgraph
-          default: []
       type: object
       title: ComputationStart
+    ComputationStarted:
+      properties:
+        pipeline_id:
+          type: string
+          format: uuid
+          title: Pipeline Id
+          description: ID for created pipeline (=project identifier)
+        ref_ids:
+          items:
+            type: integer
+          type: array
+          title: Ref Ids
+          description: Checkpoints IDs for created pipeline
+      type: object
+      required:
+      - pipeline_id
+      title: ComputationStarted
     ConnectServiceToPricingPlanBodyParams:
       properties:
         serviceKey:
@@ -8986,6 +9002,19 @@ components:
           title: Error
       type: object
       title: Envelope[ComputationGet]
+    Envelope_ComputationStarted_:
+      properties:
+        data:
+          anyOf:
+          - $ref: '#/components/schemas/ComputationStarted'
+          - type: 'null'
+        error:
+          anyOf:
+          - {}
+          - type: 'null'
+          title: Error
+      type: object
+      title: Envelope[ComputationStarted]
     Envelope_CreditPriceGet_:
       properties:
         data:
@@ -9747,19 +9776,6 @@ components:
           title: Error
       type: object
       title: Envelope[WorkspaceGroupGet]
-    Envelope__ComputationStarted_:
-      properties:
-        data:
-          anyOf:
-          - $ref: '#/components/schemas/_ComputationStarted'
-          - type: 'null'
-        error:
-          anyOf:
-          - {}
-          - type: 'null'
-          title: Error
-      type: object
-      title: Envelope[_ComputationStarted]
     Envelope__ProjectGroupAccess_:
       properties:
         data:
@@ -16251,23 +16267,6 @@ components:
       - write
       - delete
       title: WorkspacesGroupsBodyParams
-    _ComputationStarted:
-      properties:
-        pipeline_id:
-          type: string
-          format: uuid
-          title: Pipeline Id
-          description: ID for created pipeline (=project identifier)
-        ref_ids:
-          items:
-            type: integer
-          type: array
-          title: Ref Ids
-          description: Checkpoints IDs for created pipeline
-      type: object
-      required:
-      - pipeline_id
-      title: _ComputationStarted
     _ItisVipResourceRestData:
       properties:
         source:

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

@@ -3,12 +3,22 @@
 from typing import Any
 
 from aiohttp import web
-from common_library.json_serialization import json_dumps
-from models_library.api_schemas_directorv2.computations import ComputationGet
-from models_library.api_schemas_webserver.computations import ComputationStart
+from models_library.api_schemas_directorv2.computations import (
+    ComputationGet as _ComputationGetDirectorV2,
+)
+from models_library.api_schemas_webserver.computations import (
+    ComputationGet,
+    ComputationPathParams,
+    ComputationStart,
+    ComputationStarted,
+)
 from models_library.projects import ProjectID
-from pydantic import BaseModel, Field, TypeAdapter, ValidationError
+from pydantic import TypeAdapter, ValidationError
 from servicelib.aiohttp import status
+from servicelib.aiohttp.requests_validation import (
+    parse_request_body_as,
+    parse_request_path_parameters_as,
+)
 from servicelib.aiohttp.rest_responses import create_http_error, exception_to_response
 from servicelib.aiohttp.web_exceptions_extension import get_http_error_class_or_none
 from servicelib.common_headers import (
@@ -40,45 +50,25 @@
 routes = web.RouteTableDef()
 
 
-class _ComputationStarted(BaseModel):
-    pipeline_id: ProjectID = Field(
-        ..., description="ID for created pipeline (=project identifier)"
-    )
-    ref_ids: list[CommitID] = Field(
-        default_factory=list, description="Checkpoints IDs for created pipeline"
-    )
-
-
 @routes.post(f"/{VTAG}/computations/{{project_id}}:start", name="start_computation")
 @login_required
 @permission_required("services.pipeline.*")
 @permission_required("project.read")
 async def start_computation(request: web.Request) -> web.Response:
     # pylint: disable=too-many-statements
     try:
+        simcore_user_agent = request.headers.get(
+            X_SIMCORE_USER_AGENT, UNDEFINED_DEFAULT_SIMCORE_USER_AGENT_VALUE
+        )
         req_ctx = RequestContext.model_validate(request)
-        computations = ComputationsApi(request.app)
-
-        run_policy = get_project_run_policy(request.app)
-        assert run_policy  # nosec
-
-        project_id = ProjectID(request.match_info["project_id"])
+        path_params = parse_request_path_parameters_as(ComputationPathParams, request)
 
         subgraph: set[str] = set()
         force_restart: bool = False  # NOTE: deprecate this entry
-
         if request.can_read_body:
-            body = await request.json()
-            assert (
-                TypeAdapter(ComputationStart).validate_python(body) is not None
-            )  # nosec
-
-            subgraph = body.get("subgraph", [])
-            force_restart = bool(body.get("force_restart", force_restart))
-
-        simcore_user_agent = request.headers.get(
-            X_SIMCORE_USER_AGENT, UNDEFINED_DEFAULT_SIMCORE_USER_AGENT_VALUE
-        )
+            body_params = await parse_request_body_as(ComputationStart, request)
+            subgraph = body_params.subgraph
+            force_restart = body_params.force_restart
 
         async with get_database_engine(request.app).acquire() as conn:
             group_properties = (
@@ -93,7 +83,7 @@ async def start_computation(request: web.Request) -> web.Response:
             request.app,
             product=product,
             user_id=req_ctx.user_id,
-            project_id=project_id,
+            project_id=path_params.project_id,
             product_name=req_ctx.product_name,
         )
 
@@ -106,16 +96,21 @@ async def start_computation(request: web.Request) -> web.Response:
             "wallet_info": wallet_info,
         }
 
+        run_policy = get_project_run_policy(request.app)
+        assert run_policy  # nosec
+
         running_project_ids: list[ProjectID]
         project_vc_commits: list[CommitID]
 
         (
             running_project_ids,
             project_vc_commits,
-        ) = await run_policy.get_or_create_runnable_projects(request, project_id)
+        ) = await run_policy.get_or_create_runnable_projects(
+            request, path_params.project_id
+        )
         _logger.debug(
             "Project %s will start %d variants: %s",
-            f"{project_id=}",
+            f"{path_params.project_id=}",
             len(running_project_ids),
             f"{running_project_ids=}",
         )
@@ -127,6 +122,7 @@ async def start_computation(request: web.Request) -> web.Response:
             else True
         )
 
+        computations = ComputationsApi(request.app)
         _started_pipelines_ids: list[str] = await asyncio.gather(
             *[
                 computations.start(
@@ -141,14 +137,14 @@ async def start_computation(request: web.Request) -> web.Response:
         )  # nosec
 
         data: dict[str, Any] = {
-            "pipeline_id": project_id,
+            "pipeline_id": path_params.project_id,
         }
         # Optional
         if project_vc_commits:
             data["ref_ids"] = project_vc_commits
 
         assert (
-            TypeAdapter(_ComputationStarted).validate_python(data) is not None
+            TypeAdapter(ComputationStarted).validate_python(data) is not None
         )  # nosec
 
         return envelope_json_response(data, status_cls=web.HTTPCreated)
@@ -221,7 +217,9 @@ async def get_computation(request: web.Request) -> web.Response:
             request, project_id
         )
         _logger.debug("Project %s will get %d variants", project_id, len(project_ids))
-        list_computation_tasks = TypeAdapter(list[ComputationGet]).validate_python(
+        list_computation_tasks = TypeAdapter(
+            list[_ComputationGetDirectorV2]
+        ).validate_python(
             await asyncio.gather(
                 *[
                     computations.get(project_id=pid, user_id=user_id)
@@ -231,10 +229,13 @@ async def get_computation(request: web.Request) -> web.Response:
         )
         assert len(list_computation_tasks) == len(project_ids)  # nosec
 
-        return web.json_response(
-            data={"data": list_computation_tasks[0].model_dump(by_alias=True)},
-            dumps=json_dumps,
+        return envelope_json_response(
+            [
+                ComputationGet.model_construct(**m.model_dump(exclude_unset=True))
+                for m in list_computation_tasks
+            ],
         )
+
     except DirectorServiceError as exc:
         return create_http_error(
             exc,