✨👽️ Add log zip endpoints in api-server (ITISFoundation#8056)

Author: bisgaard-itis

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

@@ -13,7 +13,7 @@
 
 from ..basic_types import IDStr
 from ..projects import ProjectID
-from ..projects_nodes_io import NodeID
+from ..projects_nodes_io import NodeID, SimcoreS3FileID
 from ..projects_pipeline import ComputationTask
 from ..users import UserID
 from ..wallets import WalletInfo
@@ -126,6 +126,30 @@ class TaskLogFileGet(BaseModel):
     ] = None
 
 
+class TaskLogFileIdGet(BaseModel):
+    task_id: NodeID
+    file_id: SimcoreS3FileID | None
+
+    model_config = ConfigDict(
+        json_schema_extra={
+            "examples": [
+                {
+                    "task_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+                    "file_id": "1c46752c-b096-11ea-a3c4-02420a00392e/3fa85f64-5717-4562-b3fc-2c963f66afa6/logs/task_logs.txt",
+                },
+                {
+                    "task_id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
+                    "file_id": "1c46752c-b096-11ea-a3c4-02420a00392e/6ba7b810-9dad-11d1-80b4-00c04fd430c8/logs/debug.log",
+                },
+                {
+                    "task_id": "6ba7b811-9dad-11d1-80b4-00c04fd430c8",
+                    "file_id": None,
+                },
+            ]
+        }
+    )
+
+
 class TasksSelection(BaseModel):
     nodes_ids: list[NodeID]
 

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

@@ -30,6 +30,17 @@ class AsyncJobResult(BaseModel):
 
 
 class AsyncJobGet(BaseModel):
+    model_config = ConfigDict(
+        json_schema_extra={
+            "examples": [
+                {
+                    "job_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+                    "job_name": "export_data_task",
+                }
+            ]
+        }
+    )
+
     job_id: AsyncJobId
     job_name: AsyncJobName
 
@@ -42,6 +53,18 @@ class AsyncJobAbort(BaseModel):
 class AsyncJobFilter(AsyncJobFilterBase):
     """Data for controlling access to an async job"""
 
+    model_config = ConfigDict(
+        json_schema_extra={
+            "examples": [
+                {
+                    "product_name": "osparc",
+                    "user_id": 123,
+                    "client_name": "web_client",
+                }
+            ]
+        },
+    )
+
     product_name: ProductName
     user_id: UserID
     client_name: Annotated[

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

@@ -0,0 +1,30 @@
+# pylint: disable=no-self-use
+# pylint: disable=not-context-manager
+# pylint: disable=protected-access
+# pylint: disable=redefined-outer-name
+# pylint: disable=unused-argument
+# pylint: disable=unused-variable
+
+
+from models_library.api_schemas_directorv2.computations import TaskLogFileIdGet
+from models_library.projects import ProjectID
+from pydantic import TypeAdapter, validate_call
+from pytest_mock import MockType
+from servicelib.rabbitmq._client_rpc import RabbitMQRPCClient
+
+
+class DirectorV2SideEffects:
+    # pylint: disable=no-self-use
+    @validate_call(config={"arbitrary_types_allowed": True})
+    async def get_computation_task_log_file_ids(
+        self,
+        rpc_client: RabbitMQRPCClient | MockType,
+        *,
+        project_id: ProjectID,
+    ) -> list[TaskLogFileIdGet]:
+        assert rpc_client
+        assert project_id
+
+        return TypeAdapter(list[TaskLogFileIdGet]).validate_python(
+            TaskLogFileIdGet.model_json_schema()["examples"],
+        )

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

@@ -0,0 +1,48 @@
+# pylint: disable=no-self-use
+# pylint: disable=not-context-manager
+# pylint: disable=protected-access
+# pylint: disable=redefined-outer-name
+# pylint: disable=unused-argument
+# pylint: disable=unused-variable
+
+
+from typing import Literal
+
+from models_library.api_schemas_rpc_async_jobs.async_jobs import (
+    AsyncJobFilter,
+    AsyncJobGet,
+)
+from models_library.api_schemas_webserver.storage import PathToExport
+from models_library.products import ProductName
+from models_library.users import UserID
+from pydantic import TypeAdapter, validate_call
+from pytest_mock import MockType
+from servicelib.rabbitmq._client_rpc import RabbitMQRPCClient
+
+
+class StorageSideEffects:
+    # pylint: disable=no-self-use
+    @validate_call(config={"arbitrary_types_allowed": True})
+    async def start_export_data(
+        self,
+        rabbitmq_rpc_client: RabbitMQRPCClient | MockType,
+        *,
+        user_id: UserID,
+        product_name: ProductName,
+        paths_to_export: list[PathToExport],
+        export_as: Literal["path", "download_link"],
+    ) -> tuple[AsyncJobGet, AsyncJobFilter]:
+        assert rabbitmq_rpc_client
+        assert user_id
+        assert product_name
+        assert paths_to_export
+        assert export_as
+
+        async_job_get = TypeAdapter(AsyncJobGet).validate_python(
+            AsyncJobGet.model_json_schema()["examples"][0],
+        )
+        async_job_filter = TypeAdapter(AsyncJobFilter).validate_python(
+            AsyncJobFilter.model_json_schema()["examples"][0],
+        )
+
+        return async_job_get, async_job_filter

packages/service-library/src/servicelib/rabbitmq/rpc_interfaces/director_v2/computations_tasks.py

@@ -0,0 +1,41 @@
+# pylint: disable=too-many-arguments
+import logging
+from typing import Final
+
+from models_library.api_schemas_directorv2 import (
+    DIRECTOR_V2_RPC_NAMESPACE,
+)
+from models_library.api_schemas_directorv2.computations import TaskLogFileIdGet
+from models_library.projects import ProjectID
+from models_library.rabbitmq_basic_types import RPCMethodName
+from pydantic import TypeAdapter
+
+from ....logging_utils import log_decorator
+from ... import RabbitMQRPCClient
+
+_logger = logging.getLogger(__name__)
+
+
+_RPC_METHOD_NAME_ADAPTER: TypeAdapter[RPCMethodName] = TypeAdapter(RPCMethodName)
+
+_GET_COMPUTATION_TASK_LOG_FILE_IDS: Final[RPCMethodName] = (
+    _RPC_METHOD_NAME_ADAPTER.validate_python("get_computation_task_log_file_ids")
+)
+
+
+@log_decorator(_logger, level=logging.DEBUG)
+async def get_computation_task_log_file_ids(
+    rabbitmq_rpc_client: RabbitMQRPCClient, *, project_id: ProjectID
+) -> list[TaskLogFileIdGet]:
+    """
+    Raises:
+        ComputationalTaskMissingError
+    """
+    result = await rabbitmq_rpc_client.request(
+        DIRECTOR_V2_RPC_NAMESPACE,
+        _GET_COMPUTATION_TASK_LOG_FILE_IDS,
+        project_id=project_id,
+    )
+    assert isinstance(result, list)  # nosec
+    assert all(isinstance(item, TaskLogFileIdGet) for item in result)  # nosec
+    return result

packages/service-library/src/servicelib/rabbitmq/rpc_interfaces/director_v2/errors.py

@@ -0,0 +1,9 @@
+from ..._errors import RPCInterfaceError
+
+
+class BaseRpcError(RPCInterfaceError):
+    pass
+
+
+class ComputationalTaskMissingError(BaseRpcError):
+    msg_template = "Computational run not found for project {project_id}"

services/api-server/VERSION

@@ -1 +1 @@
-0.9.2
+0.10.0