Merge branch 'master' into feature/wallets-direct-link

Author: odeimaiz

api/specs/web-server/_projects_crud.py

@@ -12,23 +12,23 @@
 from typing import Annotated
 
 from fastapi import APIRouter, Depends, status
+from models_library.api_schemas_long_running_tasks.tasks import TaskGet
 from models_library.api_schemas_webserver.projects import (
     ProjectCopyOverride,
     ProjectCreateNew,
     ProjectGet,
     ProjectListItem,
     ProjectReplace,
     ProjectUpdate,
-    TaskGet,
 )
 from models_library.generics import Envelope
 from models_library.projects import ProjectID
 from models_library.rest_pagination import Page
-from servicelib.aiohttp.long_running_tasks.server import TaskGet
 from simcore_service_webserver._meta import API_VTAG
+from simcore_service_webserver.projects._common_models import ProjectPathParams
 from simcore_service_webserver.projects._crud_handlers import (
-    _ProjectCreateParams,
-    _ProjectListParams,
+    ProjectCreateParams,
+    ProjectListParams,
 )
 
 router = APIRouter(
@@ -39,19 +39,14 @@
 )
 
 
-#
-# API entrypoints
-#
-
-
 @router.post(
     "/projects",
     response_model=Envelope[TaskGet],
     summary="Creates a new project or copies an existing one",
     status_code=status.HTTP_201_CREATED,
 )
 async def create_project(
-    _params: Annotated[_ProjectCreateParams, Depends()],
+    _params: Annotated[ProjectCreateParams, Depends()],
     _create: ProjectCreateNew | ProjectCopyOverride,
 ):
     ...
@@ -61,7 +56,7 @@ async def create_project(
     "/projects",
     response_model=Page[ProjectListItem],
 )
-async def list_projects(_params: Annotated[_ProjectListParams, Depends()]):
+async def list_projects(_params: Annotated[ProjectListParams, Depends()]):
     ...
 
 
@@ -103,3 +98,14 @@ async def update_project(project_id: ProjectID, update: ProjectUpdate):
 )
 async def delete_project(project_id: ProjectID):
     ...
+
+
+@router.post(
+    "/projects/{project_id}:clone",
+    response_model=Envelope[TaskGet],
+    status_code=status.HTTP_201_CREATED,
+)
+async def clone_project(
+    _params: Annotated[ProjectPathParams, Depends()],
+):
+    ...

packages/service-library/src/servicelib/aiohttp/long_running_tasks/client.py

@@ -1,9 +1,9 @@
 import asyncio
+from collections.abc import AsyncGenerator, Coroutine
 from dataclasses import dataclass
-from typing import Any, AsyncGenerator, Coroutine, Final, Optional
+from typing import Any, Final, TypeAlias
 
 from aiohttp import ClientConnectionError, ClientSession, web
-from pydantic import Json
 from tenacity import TryAgain, retry
 from tenacity._asyncio import AsyncRetrying
 from tenacity.retry import retry_if_exception_type
@@ -14,30 +14,27 @@
 from ..rest_responses import unwrap_envelope
 from .server import TaskGet, TaskId, TaskProgress, TaskStatus
 
-RequestBody = Json
+RequestBody: TypeAlias = Any
 
-_MINUTE: Final[int] = 60
-_HOUR: Final[int] = 60 * _MINUTE
+_MINUTE: Final[int] = 60  # in secs
+_HOUR: Final[int] = 60 * _MINUTE  # in secs
 _DEFAULT_POLL_INTERVAL_S: Final[float] = 1
-_DEFAULT_AIOHTTP_RETRY_POLICY = dict(
-    retry=retry_if_exception_type(ClientConnectionError),
-    wait=wait_random_exponential(max=20),
-    stop=stop_after_delay(60),
-    reraise=True,
-)
+_DEFAULT_AIOHTTP_RETRY_POLICY = {
+    "retry": retry_if_exception_type(ClientConnectionError),
+    "wait": wait_random_exponential(max=20),
+    "stop": stop_after_delay(60),
+    "reraise": True,
+}
 
 
 @retry(**_DEFAULT_AIOHTTP_RETRY_POLICY)
-async def _start(
-    session: ClientSession, url: URL, json: Optional[RequestBody]
-) -> TaskGet:
+async def _start(session: ClientSession, url: URL, json: RequestBody | None) -> TaskGet:
     async with session.post(url, json=json) as response:
         response.raise_for_status()
         data, error = unwrap_envelope(await response.json())
     assert not error  # nosec
     assert data is not None  # nosec
-    task = TaskGet.parse_obj(data)
-    return task
+    return TaskGet.parse_obj(data)
 
 
 @retry(**_DEFAULT_AIOHTTP_RETRY_POLICY)
@@ -48,7 +45,6 @@ async def _wait_for_completion(
     client_timeout: int,
 ) -> AsyncGenerator[TaskProgress, None]:
     try:
-
         async for attempt in AsyncRetrying(
             stop=stop_after_delay(client_timeout),
             reraise=True,
@@ -70,16 +66,13 @@ async def _wait_for_completion(
                             )
                         )
                     )
-                    raise TryAgain(
-                        f"{task_id=}, {task_status.started=} has "
-                        f"status: '{task_status.task_progress.message}'"
-                        f" {task_status.task_progress.percent}%"
-                    )
+                    msg = f"{task_id=}, {task_status.started=} has status: '{task_status.task_progress.message}' {task_status.task_progress.percent}%"
+                    raise TryAgain(msg)  # noqa: TRY301
+
     except TryAgain as exc:
         # this is a timeout
-        raise asyncio.TimeoutError(
-            f"Long running task {task_id}, calling to {status_url} timed-out after {client_timeout} seconds"
-        ) from exc
+        msg = f"Long running task {task_id}, calling to {status_url} timed-out after {client_timeout} seconds"
+        raise asyncio.TimeoutError(msg) from exc
 
 
 @retry(**_DEFAULT_AIOHTTP_RETRY_POLICY)
@@ -91,6 +84,7 @@ async def _task_result(session: ClientSession, result_url: URL) -> Any:
             assert not error  # nosec
             assert data  # nosec
             return data
+        return None
 
 
 @retry(**_DEFAULT_AIOHTTP_RETRY_POLICY)
@@ -105,21 +99,22 @@ async def _abort_task(session: ClientSession, abort_url: URL) -> None:
 @dataclass(frozen=True)
 class LRTask:
     progress: TaskProgress
-    _result: Optional[Coroutine[Any, Any, Any]] = None
+    _result: Coroutine[Any, Any, Any] | None = None
 
     def done(self) -> bool:
         return self._result is not None
 
     async def result(self) -> Any:
         if not self._result:
-            raise ValueError("No result ready!")
+            msg = "No result ready!"
+            raise ValueError(msg)
         return await self._result
 
 
 async def long_running_task_request(
     session: ClientSession,
     url: URL,
-    json: Optional[RequestBody] = None,
+    json: RequestBody | None = None,
     client_timeout: int = 1 * _HOUR,
 ) -> AsyncGenerator[LRTask, None]:
     """Will use the passed `ClientSession` to call an oSparc long

services/api-server/src/simcore_service_api_server/api/routes/solvers_jobs.py

@@ -99,7 +99,9 @@ async def list_jobs(
     )
     _logger.debug("Listing Jobs in Solver '%s'", solver.name)
 
-    projects_page = await webserver_api.list_projects(solver.name, limit=20, offset=0)
+    projects_page = await webserver_api.get_projects_w_solver_page(
+        solver.name, limit=20, offset=0
+    )
 
     jobs: deque[Job] = deque()
     for prj in projects_page.data:
@@ -140,7 +142,7 @@ async def get_jobs_page(
     )
     _logger.debug("Listing Jobs in Solver '%s'", solver.name)
 
-    projects_page = await webserver_api.list_projects(
+    projects_page = await webserver_api.get_projects_w_solver_page(
         solver.name, limit=page_params.limit, offset=page_params.offset
     )
 

services/api-server/src/simcore_service_api_server/api/routes/studies.py

@@ -47,7 +47,7 @@ async def list_studies(
 
     New in *version 0.5.0* (only with API_SERVER_DEV_FEATURES_ENABLED=1)
     """
-    projects_page = await webserver_api.list_user_projects(
+    projects_page = await webserver_api.get_projects_page(
         limit=page_params.limit, offset=page_params.offset
     )
 
@@ -63,7 +63,7 @@ async def list_studies(
 
 
 @router.get(
-    "/{study_id}",
+    "/{study_id:uuid}",
     response_model=Study,
     responses={**_COMMON_ERROR_RESPONSES},
     include_in_schema=API_SERVER_DEV_FEATURES_ENABLED,
@@ -87,8 +87,19 @@ async def get_study(
         )
 
 
+@router.post(
+    "/{study_id:uuid}",
+    response_model=Study,
+    responses={**_COMMON_ERROR_RESPONSES},
+    include_in_schema=API_SERVER_DEV_FEATURES_ENABLED,
+)
+async def clone_study(study_id: StudyID):
+    msg = f"cloning study with study_id={study_id!r}. SEE https://github.com/ITISFoundation/osparc-simcore/issues/4651"
+    raise NotImplementedError(msg)
+
+
 @router.get(
-    "/{study_id}/ports",
+    "/{study_id:uuid}/ports",
     response_model=OnePage[StudyPort],
     responses={**_COMMON_ERROR_RESPONSES},
     include_in_schema=API_SERVER_DEV_FEATURES_ENABLED,

services/api-server/src/simcore_service_api_server/services/webserver.py

@@ -248,7 +248,7 @@ async def get_project(self, project_id: UUID) -> ProjectGet:
         data: JSON | None = self._get_data_or_raise_http_exception(response)
         return ProjectGet.parse_obj(data)
 
-    async def list_projects(
+    async def get_projects_w_solver_page(
         self, solver_name: str, limit: int, offset: int
     ) -> Page[ProjectGet]:
         return await self._page_projects(
@@ -260,7 +260,7 @@ async def list_projects(
             search=urllib.parse.quote(solver_name, safe=""),
         )
 
-    async def list_user_projects(self, limit: int, offset: int):
+    async def get_projects_page(self, limit: int, offset: int):
         return await self._page_projects(
             limit=limit,
             offset=offset,

services/api-server/tests/unit/api_studies/test_api_routes_studies.py

@@ -128,3 +128,15 @@ async def test_list_study_ports(
     resp = await client.get(f"/v0/studies/{study_id}/ports", auth=auth)
     assert resp.status_code == status.HTTP_200_OK
     assert resp.json() == {"items": fake_study_ports, "total": len(fake_study_ports)}
+
+
+@pytest.mark.xfail(
+    reason="Under dev: https://github.com/ITISFoundation/osparc-simcore/issues/4651"
+)
+async def test_clone_study(
+    client: httpx.AsyncClient,
+    auth: httpx.BasicAuth,
+    study_id: StudyID,
+):
+    resp = await client.post(f"/v0/studies/{study_id}:clone", auth=auth)
+    assert resp.status_code == status.HTTP_201_CREATED

services/web/server/VERSION

@@ -1 +1 @@
-0.25.0
+0.26.0

services/web/server/setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.25.0
+current_version = 0.26.0
 commit = True
 message = services/webserver api version: {current_version} → {new_version}
 tag = False
@@ -12,7 +12,7 @@ commit_args = --no-verify
 [tool:pytest]
 addopts = --strict-markers
 asyncio_mode = auto
-markers =
+markers = 
 	slow: marks tests as slow (deselect with '-m "not slow"')
 	acceptance_test: "marks tests as 'acceptance tests' i.e. does the system do what the user expects? Typically those are workflows."
 	testit: "marks test to run during development"

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

@@ -3,7 +3,7 @@ info:
   title: simcore-service-webserver
   description: ' Main service with an interface (http-API & websockets) to the web
     front-end'
-  version: 0.25.0
+  version: 0.26.0
 servers:
 - url: ''
   description: webserver
@@ -2136,6 +2136,27 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Envelope_ProjectGet_'
+  /v0/projects/{project_id}:clone:
+    post:
+      tags:
+      - projects
+      summary: Clone Project
+      operationId: clone_project
+      parameters:
+      - required: true
+        schema:
+          title: Project Id
+          type: string
+          format: uuid
+        name: project_id
+        in: path
+      responses:
+        '201':
+          description: Successful Response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Envelope_TaskGet_'
   /v0/projects/{project_id}/metadata:
     get:
       tags:
@@ -6968,13 +6989,11 @@ components:
             exclusiveMinimum: true
             type: integer
             minimum: 0
-          default: []
         classifiers:
           title: Classifiers
           type: array
           items:
             type: string
-          default: []
       additionalProperties: false
       description: 'inspired by Docker API https://docs.docker.com/engine/api/v1.43/#tag/Container/operation/ContainerList.