✨ Add storage dummy rpc endpoints for zipping (ITISFoundation#7202)

Author: bisgaard-itis

api/specs/web-server/_storage.py

@@ -7,7 +7,9 @@
 from typing import TypeAlias
 
 from fastapi import APIRouter, Query, status
-from models_library.api_schemas_storage import (
+from models_library.generics import Envelope
+from models_library.projects_nodes_io import LocationID
+from models_library.storage_schemas import (
     FileLocation,
     FileMetaDataGet,
     FileUploadCompleteFutureResponse,
@@ -17,8 +19,6 @@
     LinkType,
     PresignedLink,
 )
-from models_library.generics import Envelope
-from models_library.projects_nodes_io import LocationID
 from pydantic import AnyUrl, ByteSize
 from simcore_service_webserver._meta import API_VTAG
 from simcore_service_webserver.storage.schemas import DatasetMetaData, FileMetaData

packages/aws-library/src/aws_library/s3/_client.py

@@ -13,8 +13,8 @@
 from boto3.s3.transfer import TransferConfig
 from botocore import exceptions as botocore_exc
 from botocore.client import Config
-from models_library.api_schemas_storage import ETag, S3BucketName, UploadedPart
 from models_library.basic_types import SHA256Str
+from models_library.storage_schemas import ETag, S3BucketName, UploadedPart
 from pydantic import AnyUrl, ByteSize, TypeAdapter
 from servicelib.logging_utils import log_catch, log_context
 from servicelib.utils import limited_gather

packages/aws-library/src/aws_library/s3/_models.py

@@ -2,8 +2,8 @@
 from dataclasses import dataclass
 from typing import TypeAlias
 
-from models_library.api_schemas_storage import ETag
 from models_library.basic_types import SHA256Str
+from models_library.storage_schemas import ETag
 from pydantic import AnyUrl, BaseModel, ByteSize
 from types_aiobotocore_s3.type_defs import HeadObjectOutputTypeDef, ObjectTypeDef
 

packages/aws-library/tests/test_s3_client.py

@@ -29,8 +29,8 @@
 )
 from aws_library.s3._models import MultiPartUploadLinks
 from faker import Faker
-from models_library.api_schemas_storage import S3BucketName, UploadedPart
 from models_library.basic_types import SHA256Str
+from models_library.storage_schemas import S3BucketName, UploadedPart
 from moto.server import ThreadedMotoServer
 from pydantic import AnyUrl, ByteSize, TypeAdapter
 from pytest_benchmark.plugin import BenchmarkFixture

packages/models-library/src/models_library/api_schemas_rpc_data_export/__init__.py

@@ -0,0 +1,36 @@
+from datetime import datetime
+from typing import Any, TypeAlias
+from uuid import UUID
+
+from pydantic import BaseModel, Field, PositiveFloat, model_validator
+from typing_extensions import Self
+
+TaskRpcId: TypeAlias = UUID
+
+
+class TaskRpcStatus(BaseModel):
+    task_id: TaskRpcId
+    task_progress: PositiveFloat = Field(..., ge=0.0, le=1.0)
+    done: bool
+    started: datetime
+    stopped: datetime | None
+
+    @model_validator(mode="after")
+    def _check_consistency(self) -> Self:
+        is_done = self.done
+        is_stopped = self.stopped is not None
+
+        if is_done != is_stopped:
+            msg = f"Inconsistent data: {self.done=}, {self.stopped=}"
+            raise ValueError(msg)
+        return self
+
+
+class TaskRpcResult(BaseModel):
+    result: Any | None
+    error: Any | None
+
+
+class TaskRpcGet(BaseModel):
+    task_id: TaskRpcId
+    task_name: str

packages/models-library/src/models_library/api_schemas_rpc_data_export/tasks.py

@@ -0,0 +1,9 @@
+from typing import Final
+
+from pydantic import TypeAdapter
+
+from ..rabbitmq_basic_types import RPCNamespace
+
+STORAGE_RPC_NAMESPACE: Final[RPCNamespace] = TypeAdapter(RPCNamespace).validate_python(
+    "storage"
+)

packages/models-library/src/models_library/api_schemas_storage/__init__.py

@@ -0,0 +1,14 @@
+# pylint: disable=R6301
+from pathlib import Path
+
+from models_library.api_schemas_rpc_data_export.tasks import TaskRpcId
+from pydantic import BaseModel, Field
+
+
+class DataExportTaskStartInput(BaseModel):
+    paths: list[Path] = Field(..., min_length=1)
+
+
+class DataExportTaskAbortOutput(BaseModel):
+    result: bool
+    task_id: TaskRpcId

packages/models-library/src/models_library/api_schemas_storage/data_export_tasks.py

@@ -8,7 +8,7 @@
 import orjson
 from aws_library.s3 import MultiPartUploadLinks
 from fastapi import status
-from models_library.api_schemas_storage import ETag, FileUploadSchema, UploadedPart
+from models_library.storage_schemas import ETag, FileUploadSchema, UploadedPart
 from pydantic import AnyUrl, ByteSize, TypeAdapter
 from servicelib.utils import limited_as_completed, logged_gather
 from types_aiobotocore_s3 import S3Client