rename storage schemas exposed via webserver

Author: bisgaard-itis

packages/models-library/src/models_library/api_schemas_rpc_async_jobs/async_jobs.py

@@ -2,15 +2,16 @@
 from typing import Any, TypeAlias
 from uuid import UUID
 
-from pydantic import BaseModel, Field, PositiveFloat, model_validator
+from pydantic import BaseModel, model_validator
+from servicelib.progress_bar import ProgressBarData
 from typing_extensions import Self
 
 AsyncJobId: TypeAlias = UUID
 
 
 class AsyncJobStatus(BaseModel):
     job_id: AsyncJobId
-    progress: PositiveFloat = Field(..., ge=0.0, le=1.0)
+    progress: ProgressBarData
     done: bool
     started: datetime
     stopped: datetime | None

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

@@ -0,0 +1,70 @@
+from datetime import datetime
+from pathlib import Path
+from typing import Any
+
+from pydantic import BaseModel
+
+from ..api_schemas_rpc_async_jobs.async_jobs import (
+    AsyncJobGet,
+    AsyncJobId,
+    AsyncJobResult,
+    AsyncJobStatus,
+    ProgressBarData,
+)
+from ..api_schemas_storage.data_export_async_jobs import DataExportTaskStartInput
+from ..projects_nodes_io import LocationID
+from ..users import UserID
+
+
+class DataExportPost(BaseModel):
+    paths: list[Path]
+
+    def to_storage_model(
+        self, user_id: UserID, location_id: LocationID
+    ) -> DataExportTaskStartInput:
+        return DataExportTaskStartInput(
+            paths=self.paths, user_id=user_id, location_id=location_id
+        )
+
+
+class StorageAsyncJobGet(BaseModel):
+    job_id: AsyncJobId
+
+    @classmethod
+    def from_async_job_rpc_get(
+        cls, async_job_rpc_get: AsyncJobGet
+    ) -> "StorageAsyncJobGet":
+        return StorageAsyncJobGet(job_id=async_job_rpc_get.job_id)
+
+
+class StorageAsyncJobStatus(BaseModel):
+    job_id: AsyncJobId
+    progress: ProgressBarData
+    done: bool
+    started: datetime
+    stopped: datetime | None
+
+    @classmethod
+    def from_async_job_rpc_status(
+        cls, async_job_rpc_status: AsyncJobStatus
+    ) -> "StorageAsyncJobStatus":
+        return StorageAsyncJobStatus(
+            job_id=async_job_rpc_status.job_id,
+            progress=async_job_rpc_status.progress,
+            done=async_job_rpc_status.done,
+            started=async_job_rpc_status.started,
+            stopped=async_job_rpc_status.stopped,
+        )
+
+
+class StorageAsyncJobResult(BaseModel):
+    result: Any | None
+    error: Any | None
+
+    @classmethod
+    def from_async_job_rpc_result(
+        cls, async_job_rpc_result: AsyncJobResult
+    ) -> "StorageAsyncJobResult":
+        return StorageAsyncJobResult(
+            result=async_job_rpc_result.result, error=async_job_rpc_result.error
+        )

packages/models-library/src/models_library/storage_schemas.py

@@ -10,7 +10,6 @@
 from enum import Enum
 
 # /data-export
-from pathlib import Path
 from typing import Annotated, Any, Literal, Self, TypeAlias
 from uuid import UUID
 
@@ -21,7 +20,6 @@
     ByteSize,
     ConfigDict,
     Field,
-    PositiveFloat,
     PositiveInt,
     RootModel,
     StringConstraints,
@@ -30,12 +28,6 @@
 )
 from pydantic.networks import AnyUrl
 
-from .api_schemas_rpc_async_jobs.async_jobs import (
-    AsyncJobGet,
-    AsyncJobResult,
-    AsyncJobStatus,
-)
-from .api_schemas_storage.data_export_async_jobs import DataExportTaskStartInput
 from .basic_regex import DATCORE_DATASET_NAME_RE, S3_BUCKET_NAME_RE
 from .basic_types import SHA256Str
 from .generics import ListModel
@@ -378,55 +370,3 @@ def ensure_consistent_entries(self: Self) -> Self:
 
 class SoftCopyBody(BaseModel):
     link_id: SimcoreS3FileID
-
-
-class DataExportPost(BaseModel):
-    paths: list[Path]
-
-    def to_storage_model(
-        self, user_id: UserID, location_id: LocationID
-    ) -> DataExportTaskStartInput:
-        return DataExportTaskStartInput(
-            paths=self.paths, user_id=user_id, location_id=location_id
-        )
-
-
-class AsyncJobGet(BaseModel):
-    job_id: UUID
-
-    @classmethod
-    def from_async_job_rpc_get(cls, async_job_rpc_get: AsyncJobGet) -> "AsyncJobGet":
-        return AsyncJobGet(job_id=async_job_rpc_get.job_id)
-
-
-class AsyncJobStatus(BaseModel):
-    job_id: UUID
-    task_progress: PositiveFloat = Field(..., ge=0.0, le=1.0)
-    done: bool
-    started: datetime
-    stopped: datetime | None
-
-    @classmethod
-    def from_async_job_rpc_status(
-        cls, async_job_rpc_status: AsyncJobStatus
-    ) -> "AsyncJobStatus":
-        return AsyncJobStatus(
-            job_id=async_job_rpc_status.job_id,
-            task_progress=async_job_rpc_status.task_progress,
-            done=async_job_rpc_status.done,
-            started=async_job_rpc_status.started,
-            stopped=async_job_rpc_status.stopped,
-        )
-
-
-class AsyncJobResult(BaseModel):
-    result: Any | None
-    error: Any | None
-
-    @classmethod
-    def from_async_job_rpc_result(
-        cls, async_job_rpc_result: AsyncJobResult
-    ) -> "AsyncJobResult":
-        return AsyncJobResult(
-            result=async_job_rpc_result.result, error=async_job_rpc_result.error
-        )

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

@@ -10,13 +10,15 @@
 
 from aiohttp import ClientTimeout, web
 from models_library.api_schemas_storage import STORAGE_RPC_NAMESPACE
+from models_library.api_schemas_webserver.storage import (
+    DataExportPost,
+    StorageAsyncJobGet,
+    StorageAsyncJobResult,
+    StorageAsyncJobStatus,
+)
 from models_library.projects_nodes_io import LocationID
 from models_library.rest_base import RequestParameters
 from models_library.storage_schemas import (
-    AsyncJobGet,
-    AsyncJobResult,
-    AsyncJobStatus,
-    DataExportPost,
     FileUploadCompleteResponse,
     FileUploadCompletionBody,
     FileUploadSchema,
@@ -405,7 +407,7 @@ class _PathParams(BaseModel):
         ),
     )
     return create_data_response(
-        AsyncJobGet.from_async_job_rpc_get(async_job_rpc_get),
+        StorageAsyncJobGet.from_async_job_rpc_get(async_job_rpc_get),
         status=status.HTTP_202_ACCEPTED,
     )
 
@@ -420,14 +422,14 @@ class _PathParams(BaseModel):
 async def get_async_job_status(request: web.Request) -> web.Response:
     rabbitmq_rpc_client = get_rabbitmq_rpc_client(request.app)
 
-    async_job_get = parse_request_path_parameters_as(AsyncJobGet, request)
+    async_job_get = parse_request_path_parameters_as(StorageAsyncJobGet, request)
     async_job_rpc_status = await get_status(
         rabbitmq_rpc_client=rabbitmq_rpc_client,
         rpc_namespace=STORAGE_RPC_NAMESPACE,
         job_id=async_job_get.job_id,
     )
     return create_data_response(
-        AsyncJobStatus.from_async_job_rpc_status(async_job_rpc_status),
+        StorageAsyncJobStatus.from_async_job_rpc_status(async_job_rpc_status),
         status=status.HTTP_200_OK,
     )
 
@@ -441,7 +443,7 @@ async def get_async_job_status(request: web.Request) -> web.Response:
 @handle_data_export_exceptions
 async def abort_async_job(request: web.Request) -> web.Response:
     rabbitmq_rpc_client = get_rabbitmq_rpc_client(request.app)
-    async_job_get = parse_request_path_parameters_as(AsyncJobGet, request)
+    async_job_get = parse_request_path_parameters_as(StorageAsyncJobGet, request)
     async_job_rpc_abort = await abort(
         rabbitmq_rpc_client=rabbitmq_rpc_client,
         rpc_namespace=STORAGE_RPC_NAMESPACE,
@@ -463,13 +465,13 @@ async def abort_async_job(request: web.Request) -> web.Response:
 @handle_data_export_exceptions
 async def get_async_job_result(request: web.Request) -> web.Response:
     rabbitmq_rpc_client = get_rabbitmq_rpc_client(request.app)
-    async_job_get = parse_request_path_parameters_as(AsyncJobGet, request)
+    async_job_get = parse_request_path_parameters_as(StorageAsyncJobGet, request)
     async_job_rpc_result = await get_result(
         rabbitmq_rpc_client=rabbitmq_rpc_client,
         rpc_namespace=STORAGE_RPC_NAMESPACE,
         job_id=async_job_get.job_id,
     )
     return create_data_response(
-        AsyncJobResult.from_async_job_rpc_result(async_job_rpc_result),
+        StorageAsyncJobResult.from_async_job_rpc_result(async_job_rpc_result),
         status=status.HTTP_200_OK,
     )