openapi specs

Author: matusdrobuliak66

api/specs/web-server/_projects_wallet.py

@@ -8,15 +8,20 @@
 # pylint: disable=unused-variable
 # pylint: disable=too-many-arguments
 
+from typing import Annotated
 
 from _common import assert_handler_signature_against_model
-from fastapi import APIRouter
+from fastapi import APIRouter, Depends, status
 from models_library.api_schemas_webserver.wallets import WalletGet
 from models_library.generics import Envelope
 from models_library.projects import ProjectID
 from models_library.wallets import WalletID
 from simcore_service_webserver._meta import API_VTAG
 from simcore_service_webserver.projects._common.models import ProjectPathParams
+from simcore_service_webserver.projects._wallets_handlers import (
+    _PayProjectDebtBody,
+    _ProjectWalletPathParams,
+)
 
 router = APIRouter(
     prefix=f"/{API_VTAG}",
@@ -51,3 +56,17 @@ async def connect_wallet_to_project(
 
 
 assert_handler_signature_against_model(connect_wallet_to_project, ProjectPathParams)
+
+
+@router.post(
+    "/projects/{project_id}/wallet/{wallet_id}:pay-debt",
+    status_code=status.HTTP_204_NO_CONTENT,
+)
+async def pay_project_debt(
+    _path: Annotated[_ProjectWalletPathParams, Depends()],
+    _body: Annotated[_PayProjectDebtBody, Depends()],
+):
+    ...
+
+
+assert_handler_signature_against_model(connect_wallet_to_project, ProjectPathParams)

packages/service-library/src/servicelib/rabbitmq/rpc_interfaces/resource_usage_tracker/credit_transactions.py

@@ -56,13 +56,11 @@ async def pay_project_debt(
     current_wallet_transaction: CreditTransactionCreateBody,
     new_wallet_transaction: CreditTransactionCreateBody,
 ) -> None:
-    result = await rabbitmq_rpc_client.request(
+    await rabbitmq_rpc_client.request(
         RESOURCE_USAGE_TRACKER_RPC_NAMESPACE,
         _RPC_METHOD_NAME_ADAPTER.validate_python("pay_project_debt"),
         project_id=project_id,
         current_wallet_transaction=current_wallet_transaction,
         new_wallet_transaction=new_wallet_transaction,
         timeout_s=_DEFAULT_TIMEOUT_S,
     )
-    assert isinstance(result, None)  # nosec
-    return result

services/resource-usage-tracker/openapi.json

@@ -72,6 +72,39 @@
               "title": "Wallet Id",
               "minimum": 0
             }
+          },
+          {
+            "name": "transaction_status",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "anyOf": [
+                {
+                  "$ref": "#/components/schemas/CreditTransactionStatus"
+                },
+                {
+                  "type": "null"
+                }
+              ],
+              "title": "Transaction Status"
+            }
+          },
+          {
+            "name": "project_id",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "anyOf": [
+                {
+                  "type": "string",
+                  "format": "uuid"
+                },
+                {
+                  "type": "null"
+                }
+              ],
+              "title": "Project Id"
+            }
           }
         ],
         "responses": {
@@ -346,6 +379,17 @@
         "title": "CreditTransactionCreated",
         "description": "Response Create Credit Transaction V1 Credit Transactions Post"
       },
+      "CreditTransactionStatus": {
+        "type": "string",
+        "enum": [
+          "PENDING",
+          "BILLED",
+          "IN_DEBT",
+          "NOT_BILLED",
+          "REQUIRES_MANUAL_REVIEW"
+        ],
+        "title": "CreditTransactionStatus"
+      },
       "HTTPValidationError": {
         "properties": {
           "detail": {

services/resource-usage-tracker/src/simcore_service_resource_usage_tracker/api/rpc/_credit_transactions.py

@@ -44,6 +44,7 @@ async def pay_project_debt(
     return await credit_transactions.pay_project_debt(
         db_engine=app.state.engine,
         rabbitmq_client=app.state.rabbitmq_client,
+        rut_fire_and_forget_tasks=app.state.rut_fire_and_forget_tasks,
         project_id=project_id,
         current_wallet_transaction=current_wallet_transaction,
         new_wallet_transaction=new_wallet_transaction,

services/resource-usage-tracker/src/simcore_service_resource_usage_tracker/core/application.py

@@ -18,6 +18,7 @@
 from ..services.background_task_periodic_heartbeat_check_setup import (
     setup as setup_background_task_periodic_heartbeat_check,
 )
+from ..services.fire_and_forget_setup import setup as fire_and_forget_setup
 from ..services.modules.db import setup as setup_db
 from ..services.modules.rabbitmq import setup as setup_rabbitmq
 from ..services.modules.redis import setup as setup_redis
@@ -50,6 +51,7 @@ def create_app(settings: ApplicationSettings) -> FastAPI:
 
     # PLUGINS SETUP
     setup_api_routes(app)
+    fire_and_forget_setup(app)
 
     if settings.RESOURCE_USAGE_TRACKER_POSTGRES:
         setup_db(app)

services/resource-usage-tracker/src/simcore_service_resource_usage_tracker/services/credit_transactions.py

@@ -14,6 +14,7 @@
 )
 from models_library.wallets import WalletID
 from servicelib.rabbitmq import RabbitMQClient
+from servicelib.utils import fire_and_forget_task
 from simcore_postgres_database.utils_repos import transaction_context
 from sqlalchemy.ext.asyncio import AsyncEngine
 
@@ -92,15 +93,14 @@ async def sum_credit_transactions_by_product_and_wallet(
 
 
 async def pay_project_debt(
-    db_engine: Annotated[AsyncEngine, Depends(get_resource_tracker_db_engine)],
-    rabbitmq_client: Annotated[
-        RabbitMQClient, Depends(get_rabbitmq_client_from_request)
-    ],
+    db_engine: AsyncEngine,
+    rabbitmq_client: RabbitMQClient,
+    rut_fire_and_forget_tasks: set,
     project_id: ProjectID,
     current_wallet_transaction: CreditTransactionCreateBody,
     new_wallet_transaction: CreditTransactionCreateBody,
 ):
-    # `current_wallet_transaction` is Wallet in DEBT
+    # NOTE: `current_wallet_transaction` is the Wallet in DEBT
 
     total_project_debt_amount = (
         await credit_transactions_db.sum_credit_transactions_by_product_and_wallet(
@@ -177,15 +177,23 @@ async def pay_project_debt(
             transaction_status=CreditTransactionStatus.BILLED,
         )
 
-    await sum_credit_transactions_and_publish_to_rabbitmq(
-        db_engine,
-        rabbitmq_client,
-        new_wallet_transaction_create.product_name,
-        new_wallet_transaction_create.wallet_id,
+    fire_and_forget_task(
+        sum_credit_transactions_and_publish_to_rabbitmq(
+            db_engine,
+            rabbitmq_client,
+            new_wallet_transaction_create.product_name,
+            new_wallet_transaction_create.wallet_id,
+        ),
+        task_suffix_name=f"sum_and_publish_credits_wallet_id{new_wallet_transaction_create.wallet_id}",
+        fire_and_forget_tasks_collection=rut_fire_and_forget_tasks,
     )
-    await sum_credit_transactions_and_publish_to_rabbitmq(
-        db_engine,
-        rabbitmq_client,
-        current_wallet_transaction_create.product_name,
-        current_wallet_transaction_create.wallet_id,
+    fire_and_forget_task(
+        sum_credit_transactions_and_publish_to_rabbitmq(
+            db_engine,
+            rabbitmq_client,
+            current_wallet_transaction_create.product_name,
+            current_wallet_transaction_create.wallet_id,
+        ),
+        task_suffix_name=f"sum_and_publish_credits_wallet_id{current_wallet_transaction_create.wallet_id}",
+        fire_and_forget_tasks_collection=rut_fire_and_forget_tasks,
     )

services/resource-usage-tracker/src/simcore_service_resource_usage_tracker/services/fire_and_forget_setup.py

@@ -0,0 +1,41 @@
+import logging
+from collections.abc import Awaitable, Callable
+
+from fastapi import FastAPI
+from servicelib.logging_utils import log_catch, log_context
+
+_logger = logging.getLogger(__name__)
+
+
+def _on_app_startup(_app: FastAPI) -> Callable[[], Awaitable[None]]:
+    async def _startup() -> None:
+        with log_context(
+            _logger,
+            logging.INFO,
+            msg="Resource Usage Tracker setup fire and forget tasks..",
+        ), log_catch(_logger, reraise=False):
+            _app.state.rut_fire_and_forget_tasks = set()
+
+    return _startup
+
+
+def _on_app_shutdown(
+    _app: FastAPI,
+) -> Callable[[], Awaitable[None]]:
+    async def _stop() -> None:
+        with log_context(
+            _logger,
+            logging.INFO,
+            msg="Resource Usage Tracker fire and forget tasks shutdown..",
+        ), log_catch(_logger, reraise=False):
+            assert _app  # nosec
+            if _app.state.rut_fire_and_forget_tasks:
+                for task in _app.state.rut_fire_and_forget_tasks:
+                    task.cancel()
+
+    return _stop
+
+
+def setup(app: FastAPI) -> None:
+    app.add_event_handler("startup", _on_app_startup(app))
+    app.add_event_handler("shutdown", _on_app_shutdown(app))

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

@@ -5153,6 +5153,39 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Envelope_WalletGet_'
+  /v0/projects/{project_id}/wallet/{wallet_id}:pay-debt:
+    post:
+      tags:
+      - projects
+      summary: Pay Project Debt
+      operationId: pay_project_debt
+      parameters:
+      - name: project_id
+        in: path
+        required: true
+        schema:
+          type: string
+          format: uuid
+          title: Project Id
+      - name: wallet_id
+        in: path
+        required: true
+        schema:
+          type: integer
+          exclusiveMinimum: true
+          title: Wallet Id
+          minimum: 0
+      - name: amount
+        in: query
+        required: true
+        schema:
+          anyOf:
+          - type: number
+          - type: string
+          title: Amount
+      responses:
+        '204':
+          description: Successful Response
   /v0/projects/{project_id}/workspaces/{workspace_id}:move:
     post:
       tags:

services/web/server/src/simcore_service_webserver/projects/_wallets_handlers.py

@@ -22,7 +22,7 @@
 from .._meta import API_VTAG
 from ..login.decorators import login_required
 from ..security.decorators import permission_required
-from ..wallets.errors import WalletAccessForbiddenError
+from ..wallets.errors import WalletAccessForbiddenError, WalletNotFoundError
 from . import _wallets_api as wallets_api
 from . import projects_api
 from ._common.models import ProjectPathParams, RequestContext
@@ -40,6 +40,9 @@ async def wrapper(request: web.Request) -> web.StreamResponse:
         except ProjectNotFoundError as exc:
             raise web.HTTPNotFound(reason=f"{exc}") from exc
 
+        except WalletNotFoundError as exc:
+            raise web.HTTPNotFound(reason=f"{exc}") from exc
+
         except (WalletAccessForbiddenError, ProjectInvalidRightsError) as exc:
             raise web.HTTPForbidden(reason=f"{exc}") from exc
 
@@ -132,14 +135,17 @@ async def pay_project_debt(request: web.Request):
         include_state=False,
     )
 
-    # Ensure the wallet is associated with the project
-    wallet: WalletGet | None = await wallets_api.get_project_wallet(
+    # Get curently associated wallet with the project
+    current_wallet: WalletGet | None = await wallets_api.get_project_wallet(
         request.app, path_params.project_id
     )
-    if not wallet:
-        raise web.HTTPNotFound(reason="Wallet not associated with the project")
+    if not current_wallet:
+        _logger.warning("This should not happen?")
+        raise web.HTTPNotFound(
+            reason="Project doesn't have any wallet associated to the project"
+        )
 
-    if wallet.wallet_id == path_params.wallet_id:
+    if current_wallet.wallet_id == path_params.wallet_id:
         # NOTE: Currently, this option is not supported. The only way a user can
         # access their project with the same wallet is by topping it up to achieve
         # a positive balance. (This could potentially be improved in the future;
@@ -148,21 +154,19 @@ async def pay_project_debt(request: web.Request):
         # At present, once the wallet balance becomes positive, RUT updates all
         # projects connected to that wallet from IN_DEBT to BILLED.
 
-        web.json_response(status=status.HTTP_501_NOT_IMPLEMENTED)
-    else:
-        # The debt is being paid using a different wallet than the one currently connected to the project.
-        # Steps:
-        # 1. Transfer the required credits from the specified wallet to the connected wallet.
-        # 2. Mark the transaction as billed (This will allow to )
-
-        await wallets_api.pay_debt_with_different_wallet(
-            app=request.app,
-            product_name=req_ctx.product_name,
-            project_id=path_params.project_id,
-            user_id=req_ctx.user_id,
-            current_wallet_id=wallet.wallet_id,
-            new_wallet_id=path_params.wallet_id,
-            debt_amount=body_params.amount,
-        )
+        return web.json_response(status=status.HTTP_501_NOT_IMPLEMENTED)
 
-    return envelope_json_response(payment_result)
+    # The debt is being paid using a different wallet than the one currently connected to the project.
+    # Steps:
+    # 1. Transfer the required credits from the specified wallet to the connected wallet.
+    # 2. Mark the project transactions as billed
+    await wallets_api.pay_debt_with_different_wallet(
+        app=request.app,
+        product_name=req_ctx.product_name,
+        project_id=path_params.project_id,
+        user_id=req_ctx.user_id,
+        current_wallet_id=path_params.wallet_id,
+        new_wallet_id=path_params.wallet_id,
+        debt_amount=body_params.amount,
+    )
+    return envelope_json_response(web.json_response(status=status.HTTP_204_NO_CONTENT))