👽️ Add endpoint for getting credit-price and study-job log files from api server (#5985)

Author: bisgaard-itis

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

@@ -24,7 +24,7 @@ class HttpApiCallCaptureModel(BaseModel):
     path: PathDescription | str
     query: str | None = None
     request_payload: dict[str, Any] | None = None
-    response_body: dict[str, Any] | list | None = None
+    response_body: list[Any] | dict[str, Any] | None = None
     status_code: HTTPStatus = Field(default=status.HTTP_200_OK)
 
     @classmethod

services/api-server/openapi.json

@@ -3,7 +3,7 @@
   "info": {
     "title": "osparc.io web API",
     "description": "osparc-simcore public API specifications",
-    "version": "0.5.1"
+    "version": "0.6.0"
   },
   "paths": {
     "/v0/meta": {
@@ -2175,7 +2175,7 @@
           "solvers"
         ],
         "summary": "Start Job",
-        "description": "Starts job job_id created with the solver solver_key:version\n\nNew in *version 0.4.3*: cluster_id",
+        "description": "Starts job job_id created with the solver solver_key:version\n\nNew in *version 0.4.3*: cluster_id\nNew in *version 0.6.0*: This endpoint responds with a 202 when successfully starting a computation",
         "operationId": "start_job",
         "parameters": [
           {
@@ -3571,6 +3571,7 @@
           "studies"
         ],
         "summary": "Start Study Job",
+        "description": "New in *version 0.6.0*: This endpoint responds with a 202 when successfully starting a computation",
         "operationId": "start_study_job",
         "parameters": [
           {
@@ -3896,6 +3897,90 @@
           }
         ]
       }
+    },
+    "/v0/studies/{study_id}/jobs/{job_id}/outputs/log-links": {
+      "get": {
+        "tags": [
+          "studies"
+        ],
+        "summary": "Get download links for study job log files",
+        "operationId": "get_study_job_output_logfile",
+        "parameters": [
+          {
+            "required": true,
+            "schema": {
+              "type": "string",
+              "format": "uuid",
+              "title": "Study Id"
+            },
+            "name": "study_id",
+            "in": "path"
+          },
+          {
+            "required": true,
+            "schema": {
+              "type": "string",
+              "format": "uuid",
+              "title": "Job Id"
+            },
+            "name": "job_id",
+            "in": "path"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/JobLogsMap"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "Validation Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HTTPValidationError"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "HTTPBasic": []
+          }
+        ]
+      }
+    },
+    "/v0/credits/price": {
+      "get": {
+        "tags": [
+          "credits"
+        ],
+        "summary": "Get Credits Price",
+        "operationId": "get_credits_price",
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/GetCreditPrice"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "HTTPBasic": []
+          }
+        ]
+      }
     }
   },
   "components": {
@@ -4097,6 +4182,33 @@
         ],
         "title": "FileUploadData"
       },
+      "GetCreditPrice": {
+        "properties": {
+          "productName": {
+            "type": "string",
+            "title": "Productname"
+          },
+          "usdPerCredit": {
+            "type": "number",
+            "minimum": 0.0,
+            "title": "Usdpercredit",
+            "description": "Price of a credit in USD. If None, then this product's price is UNDEFINED"
+          },
+          "minPaymentAmountUsd": {
+            "type": "integer",
+            "minimum": 0,
+            "title": "Minpaymentamountusd",
+            "description": "Minimum amount (included) in USD that can be paid for this productCan be None if this product's price is UNDEFINED"
+          }
+        },
+        "type": "object",
+        "required": [
+          "productName",
+          "usdPerCredit",
+          "minPaymentAmountUsd"
+        ],
+        "title": "GetCreditPrice"
+      },
       "Groups": {
         "properties": {
           "me": {
@@ -4259,6 +4371,23 @@
           }
         }
       },
+      "JobLogsMap": {
+        "properties": {
+          "log_links": {
+            "items": {
+              "$ref": "#/components/schemas/LogLink"
+            },
+            "type": "array",
+            "title": "Log Links",
+            "description": "Array of download links"
+          }
+        },
+        "type": "object",
+        "required": [
+          "log_links"
+        ],
+        "title": "JobLogsMap"
+      },
       "JobOutputs": {
         "properties": {
           "job_id": {
@@ -4397,6 +4526,27 @@
         "type": "object",
         "title": "Links"
       },
+      "LogLink": {
+        "properties": {
+          "node_name": {
+            "type": "string",
+            "title": "Node Name"
+          },
+          "download_link": {
+            "type": "string",
+            "maxLength": 65536,
+            "minLength": 1,
+            "format": "uri",
+            "title": "Download Link"
+          }
+        },
+        "type": "object",
+        "required": [
+          "node_name",
+          "download_link"
+        ],
+        "title": "LogLink"
+      },
       "Meta": {
         "properties": {
           "name": {

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

@@ -3,6 +3,7 @@
 from fastapi import APIRouter
 
 from ..core.settings import ApplicationSettings
+from .routes import credits as _credits
 from .routes import (
     files,
     health,
@@ -38,6 +39,7 @@ def create_router(settings: ApplicationSettings):
     router.include_router(studies.router, tags=["studies"], prefix="/studies")
     router.include_router(studies_jobs.router, tags=["studies"], prefix="/studies")
     router.include_router(wallets.router, tags=["wallets"], prefix="/wallets")
+    router.include_router(_credits.router, tags=["credits"], prefix="/credits")
 
     # NOTE: multiple-files upload is currently disabled
     # Web form to upload files at http://localhost:8000/v0/upload-form-view

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

@@ -0,0 +1,16 @@
+from typing import Annotated
+
+from fastapi import APIRouter, Depends, status
+from models_library.api_schemas_webserver.product import GetCreditPrice
+
+from ..dependencies.webserver import AuthSession, get_webserver_session
+
+router = APIRouter()
+
+
+@router.get("/price", status_code=status.HTTP_200_OK, response_model=GetCreditPrice)
+async def get_credits_price(
+    webserver_api: Annotated[AuthSession, Depends(get_webserver_session)],
+):
+    product_price = await webserver_api.get_product_price()
+    return product_price

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

@@ -31,7 +31,7 @@
 from ...models.schemas.jobs import ArgumentTypes, Job, JobID, JobMetadata, JobOutputs
 from ...models.schemas.solvers import SolverKeyId
 from ...services.catalog import CatalogApi
-from ...services.director_v2 import DirectorV2Api, DownloadLink, NodeName
+from ...services.director_v2 import DirectorV2Api
 from ...services.jobs import (
     get_custom_metadata,
     raise_if_job_not_associated_with_solver,
@@ -231,7 +231,7 @@ async def get_job_outputs(
     assert len(node_ids) == 1  # nosec
 
     product_price = await webserver_api.get_product_price()
-    if product_price is not None:
+    if product_price.usd_per_credit is not None:
         wallet = await webserver_api.get_project_wallet(project_id=project.uuid)
         if wallet is None:
             raise MissingWalletError(job_id=project.uuid)
@@ -295,24 +295,26 @@ async def get_job_output_logfile(
 
     project_id = job_id
 
-    logs_urls: dict[NodeName, DownloadLink] = await director2_api.get_computation_logs(
+    log_link_map = await director2_api.get_computation_logs(
         user_id=user_id, project_id=project_id
     )
+    logs_urls = log_link_map.log_links
 
     _logger.debug(
         "Found %d logfiles for %s %s: %s",
         len(logs_urls),
         f"{project_id=}",
         f"{user_id=}",
-        list(logs_urls.keys()),
+        list(elm.download_link for elm in logs_urls),
     )
 
     # if more than one node? should rezip all of them??
     assert (  # nosec
         len(logs_urls) <= 1
     ), "Current version only supports one node per solver"
 
-    for presigned_download_link in logs_urls.values():
+    for log_link in logs_urls:
+        presigned_download_link = log_link.download_link
         _logger.info(
             "Redirecting '%s' to %s ...",
             f"{solver_key}/releases/{version}/jobs/{job_id}/outputs/logfile",

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

@@ -4,7 +4,7 @@
 
 from fastapi import APIRouter, Depends, Header, Query, Request, status
 from fastapi.encoders import jsonable_encoder
-from fastapi.responses import JSONResponse, RedirectResponse
+from fastapi.responses import JSONResponse
 from models_library.api_schemas_webserver.projects import ProjectPatch
 from models_library.api_schemas_webserver.projects_nodes import NodeOutputs
 from models_library.clusters import ClusterID
@@ -33,7 +33,7 @@
     JobOutputs,
     JobStatus,
 )
-from ...models.schemas.studies import Study, StudyID
+from ...models.schemas.studies import JobLogsMap, Study, StudyID
 from ...services.director_v2 import DirectorV2Api
 from ...services.jobs import (
     get_custom_metadata,
@@ -302,15 +302,27 @@ async def get_study_job_outputs(
     return job_outputs
 
 
-@router.post(
-    "/{study_id}/jobs/{job_id}/outputs/logfile",
-    response_class=RedirectResponse,
-    include_in_schema=API_SERVER_DEV_FEATURES_ENABLED,
-    status_code=status.HTTP_501_NOT_IMPLEMENTED,
+@router.get(
+    "/{study_id}/jobs/{job_id}/outputs/log-links",
+    response_model=JobLogsMap,
+    status_code=status.HTTP_200_OK,
+    summary="Get download links for study job log files",
 )
-async def get_study_job_output_logfile(study_id: StudyID, job_id: JobID):
-    msg = f"get study job output logfile study_id={study_id!r} job_id={job_id!r}. SEE https://github.com/ITISFoundation/osparc-simcore/issues/4177"
-    raise NotImplementedError(msg)
+async def get_study_job_output_logfile(
+    study_id: StudyID,
+    job_id: JobID,
+    user_id: Annotated[PositiveInt, Depends(get_current_user_id)],
+    director2_api: Annotated[DirectorV2Api, Depends(get_api_client(DirectorV2Api))],
+):
+    with log_context(
+        logger=_logger,
+        level=logging.DEBUG,
+        msg=f"get study job output logfile study_id={study_id!r} job_id={job_id!r}.",
+    ):
+        log_link_map = await director2_api.get_computation_logs(
+            user_id=user_id, project_id=job_id
+        )
+        return log_link_map
 
 
 @router.get(

services/api-server/src/simcore_service_api_server/models/schemas/studies.py

@@ -1,16 +1,18 @@
-import typing
+from typing import TypeAlias
 
-import pydantic
 from models_library import projects, projects_nodes_io
 from models_library.utils import pydantic_tools_extension
+from pydantic import AnyUrl, BaseModel, Field
 
 from .. import api_resources
 from . import solvers
 
-StudyID: typing.TypeAlias = projects.ProjectID
+StudyID: TypeAlias = projects.ProjectID
+NodeName: TypeAlias = str
+DownloadLink: TypeAlias = AnyUrl
 
 
-class Study(pydantic.BaseModel):
+class Study(BaseModel):
     uid: StudyID
     title: str = pydantic_tools_extension.FieldNotRequired()
     description: str = pydantic_tools_extension.FieldNotRequired()
@@ -21,9 +23,18 @@ def compose_resource_name(cls, study_key) -> api_resources.RelativeResourceName:
 
 
 class StudyPort(solvers.SolverPort):
-    key: projects_nodes_io.NodeID = pydantic.Field(
+    key: projects_nodes_io.NodeID = Field(
         ...,
         description="port identifier name."
         "Correponds to the UUID of the parameter/probe node in the study",
         title="Key name",
     )
+
+
+class LogLink(BaseModel):
+    node_name: NodeName
+    download_link: DownloadLink
+
+
+class JobLogsMap(BaseModel):
+    log_links: list[LogLink] = Field(..., description="Array of download links")