Merge remote-tracking branch 'upstream/master' into pr-osparc-add-notifications-service

Author: Andrei Neagu

.coveragerc

@@ -3,6 +3,7 @@ branch = True
 omit =
     */tests/*
     */generated_code/*
+    */_original_fastapi_encoders.py
 parallel = True
 
 [report]

.github/copilot-instructions.md

@@ -0,0 +1,45 @@
+# GitHub Copilot Instructions
+
+This document provides guidelines and best practices for using GitHub Copilot in the `osparc-simcore` repository and other Python and Node.js projects.
+
+## General Guidelines
+
+1. **Use Python 3.11**: Ensure that all Python-related suggestions align with Python 3.11 features and syntax.
+2. **Node.js Compatibility**: For Node.js projects, ensure compatibility with the version specified in the project (e.g., Node.js 14 or later).
+3. **Follow Coding Conventions**: Adhere to the coding conventions outlined in the `docs/coding-conventions.md` file.
+4. **Test-Driven Development**: Write unit tests for all new functions and features. Use `pytest` for Python and appropriate testing frameworks for Node.js.
+5. **Environment Variables**: Use environment variables as specified in `docs/env-vars.md` for configuration. Avoid hardcoding sensitive information.
+6. **Documentation**: Prefer self-explanatory code; add documentation only if explicitly requested by the developer.
+
+## Python-Specific Instructions
+
+- Always use type hints and annotations to improve code clarity and compatibility with tools like `mypy`.
+  - An exception to that rule is in `test_*` functions return type hint must not be added
+- Follow the dependency management practices outlined in `requirements/`.
+- Use `ruff` for code formatting and for linting.
+- Use `black` for code formatting and `pylint` for linting.
+- ensure we use `sqlalchemy` >2 compatible code.
+- ensure we use `pydantic` >2 compatible code.
+- ensure we use `fastapi` >0.100 compatible code
+
+
+## Node.js-Specific Instructions
+
+- Use ES6+ syntax and features.
+- Follow the `package.json` configuration for dependencies and scripts.
+- Use `eslint` for linting and `prettier` for code formatting.
+- Write modular and reusable code, adhering to the project's structure.
+
+## Copilot Usage Tips
+
+1. **Be Specific**: Provide clear and detailed prompts to Copilot for better suggestions.
+2. **Iterate**: Review and refine Copilot's suggestions to ensure they meet project standards.
+3. **Split Tasks**: Break down complex tasks into smaller, manageable parts for better suggestions.
+4. **Test Suggestions**: Always test Copilot-generated code to ensure it works as expected.
+
+## Additional Resources
+
+- [Python Coding Conventions](../docs/coding-conventions.md)
+- [Environment Variables Guide](../docs/env-vars.md)
+- [Steps to Upgrade Python](../docs/steps-to-upgrade-python.md)
+- [Node.js Installation Script](../scripts/install_nodejs_14.bash)

api/specs/web-server/_computations.py

@@ -1,10 +1,14 @@
-from fastapi import APIRouter, status
-from models_library.api_schemas_directorv2.comp_tasks import ComputationGet
-from models_library.api_schemas_webserver.computations import ComputationStart
+from typing import Annotated
+
+from fastapi import APIRouter, Depends, status
+from models_library.api_schemas_webserver.computations import (
+    ComputationGet,
+    ComputationPathParams,
+    ComputationStart,
+    ComputationStarted,
+)
 from models_library.generics import Envelope
-from models_library.projects import ProjectID
 from simcore_service_webserver._meta import API_VTAG
-from simcore_service_webserver.director_v2._handlers import _ComputationStarted
 
 router = APIRouter(
     prefix=f"/{API_VTAG}",
@@ -19,13 +23,12 @@
     "/computations/{project_id}",
     response_model=Envelope[ComputationGet],
 )
-async def get_computation(project_id: ProjectID):
-    ...
+async def get_computation(_path: Annotated[ComputationPathParams, Depends()]): ...
 
 
 @router.post(
     "/computations/{project_id}:start",
-    response_model=Envelope[_ComputationStarted],
+    response_model=Envelope[ComputationStarted],
     responses={
         status.HTTP_402_PAYMENT_REQUIRED: {
             "description": "Insufficient credits to run computation"
@@ -39,13 +42,14 @@ async def get_computation(project_id: ProjectID):
         status.HTTP_503_SERVICE_UNAVAILABLE: {"description": "Service not available"},
     },
 )
-async def start_computation(project_id: ProjectID, _start: ComputationStart):
-    ...
+async def start_computation(
+    _path: Annotated[ComputationPathParams, Depends()],
+    _body: ComputationStart,
+): ...
 
 
 @router.post(
     "/computations/{project_id}:stop",
     status_code=status.HTTP_204_NO_CONTENT,
 )
-async def stop_computation(project_id: ProjectID):
-    ...
+async def stop_computation(_path: Annotated[ComputationPathParams, Depends()]): ...

api/specs/web-server/_long_running_tasks_legacy.py

@@ -0,0 +1,61 @@
+# pylint: disable=redefined-outer-name
+# pylint: disable=unused-argument
+# pylint: disable=unused-variable
+# pylint: disable=too-many-arguments
+
+
+from typing import Annotated
+
+from fastapi import APIRouter, Depends, status
+from models_library.generics import Envelope
+from servicelib.aiohttp.long_running_tasks._routes import _PathParam
+from servicelib.long_running_tasks._models import TaskGet, TaskStatus
+from simcore_service_webserver._meta import API_VTAG
+
+router = APIRouter(
+    prefix=f"/{API_VTAG}/tasks-legacy",
+    tags=[
+        "long-running-tasks-legacy",
+    ],
+)
+
+
+@router.get(
+    "",
+    response_model=Envelope[list[TaskGet]],
+    name="list_tasks",
+    description="Lists all long running tasks",
+)
+def list_tasks(): ...
+
+
+@router.get(
+    "/{task_id}",
+    response_model=Envelope[TaskStatus],
+    name="get_task_status",
+    description="Retrieves the status of a task",
+)
+def get_task_status(
+    _path_params: Annotated[_PathParam, Depends()],
+): ...
+
+
+@router.delete(
+    "/{task_id}",
+    name="cancel_and_delete_task",
+    description="Cancels and deletes a task",
+    status_code=status.HTTP_204_NO_CONTENT,
+)
+def cancel_and_delete_task(
+    _path_params: Annotated[_PathParam, Depends()],
+): ...
+
+
+@router.get(
+    "/{task_id}/result",
+    name="get_task_result",
+    description="Retrieves the result of a task",
+)
+def get_task_result(
+    _path_params: Annotated[_PathParam, Depends()],
+): ...

api/specs/web-server/openapi.py

@@ -36,6 +36,7 @@
         "_exporter",
         "_folders",
         "_long_running_tasks",
+        "_long_running_tasks_legacy",
         "_licensed_items",
         "_licensed_items_purchases",
         "_licensed_items_checkouts",

docs/env-vars.md

@@ -6,5 +6,4 @@ The following rules must be followed:
 
 1. for each service that requires it, add it to the `services/docker-compose.yml` file (such as `MY_VAR=${MY_VAR}`)
 2. add a meaningful default value for development inside `.env-devel` so that developers can work, and that `osparc-simcore` is **self contained**.
-  - **NOTE** if the variable has a default inside the code, put the same value here
 3. inside the repo where devops keep all the secrets follow the instructions to add the new env var

packages/models-library/src/models_library/api_schemas_catalog/services.py

@@ -9,6 +9,7 @@
 from ..boot_options import BootOptions
 from ..emails import LowerCaseEmailStr
 from ..groups import GroupID
+from ..rest_filters import Filters
 from ..services_access import ServiceAccessRights, ServiceGroupAccessRightsV2
 from ..services_authoring import Author
 from ..services_enums import ServiceType
@@ -376,4 +377,13 @@ class MyServiceGet(CatalogOutputSchema):
     my_access_rights: ServiceGroupAccessRightsV2
 
 
+class ServiceListFilters(Filters):
+    service_type: Annotated[
+        ServiceType | None,
+        Field(
+            description="Filter only services of a given type. If None, then all types are returned"
+        ),
+    ] = None
+
+
 __all__: tuple[str, ...] = ("ServiceRelease",)