🎨 add running_time_in_hours to /services/-/aggregated-usages (#6350)

matusdrobuliak66 · web-flow · commit 1692f4bf0f60 · 2024-09-12T08:59:57.000+02:00
diff --git a/api/specs/web-server/_resource_usage.py b/api/specs/web-server/_resource_usage.py
@@ -13,6 +13,9 @@
 
 from _common import assert_handler_signature_against_model
 from fastapi import APIRouter, Query, status
+from models_library.api_schemas_resource_usage_tracker.service_runs import (
+    OsparcCreditsAggregatedByServiceGet,
+)
 from models_library.api_schemas_webserver.resource_usage import (
     ConnectServiceToPricingPlanBodyParams,
     CreatePricingPlanBodyParams,
@@ -93,7 +96,7 @@ async def list_resource_usage_services(
 
 @router.get(
     "/services/-/aggregated-usages",
-    response_model=Envelope[list[ServiceRunGet]],
+    response_model=Envelope[list[OsparcCreditsAggregatedByServiceGet]],
     summary="Used credits based on aggregate by type, currently supported `services`. (user and product are taken from context, optionally wallet_id parameter might be provided).",
     tags=["usage"],
 )
diff --git a/packages/models-library/src/models_library/api_schemas_resource_usage_tracker/service_runs.py b/packages/models-library/src/models_library/api_schemas_resource_usage_tracker/service_runs.py
@@ -43,6 +43,7 @@ class ServiceRunPage(NamedTuple):
 class OsparcCreditsAggregatedByServiceGet(BaseModel):
     osparc_credits: Decimal
     service_key: ServiceKey
+    running_time_in_hours: Decimal
 
 
 class OsparcCreditsAggregatedUsagesPage(NamedTuple):
diff --git a/services/resource-usage-tracker/src/simcore_service_resource_usage_tracker/models/resource_tracker_service_runs.py b/services/resource-usage-tracker/src/simcore_service_resource_usage_tracker/models/resource_tracker_service_runs.py
@@ -109,6 +109,7 @@ class Config:
 class OsparcCreditsAggregatedByServiceKeyDB(BaseModel):
     osparc_credits: Decimal
     service_key: ServiceKey
+    running_time_in_hours: Decimal
 
     class Config:
         orm_mode = True
diff --git a/services/resource-usage-tracker/src/simcore_service_resource_usage_tracker/modules/db/repositories/resource_tracker.py b/services/resource-usage-tracker/src/simcore_service_resource_usage_tracker/modules/db/repositories/resource_tracker.py
@@ -329,6 +329,22 @@ async def get_osparc_credits_aggregated_by_service(
                     sa.func.SUM(
                         resource_tracker_credit_transactions.c.osparc_credits
                     ).label("osparc_credits"),
+                    sa.func.SUM(
+                        sa.func.round(
+                            (
+                                sa.func.extract(
+                                    "epoch",
+                                    resource_tracker_service_runs.c.stopped_at,
+                                )
+                                - sa.func.extract(
+                                    "epoch",
+                                    resource_tracker_service_runs.c.started_at,
+                                )
+                            )
+                            / 3600,
+                            2,
+                        )
+                    ).label("running_time_in_hours"),
                 )
                 .select_from(
                     resource_tracker_service_runs.join(
diff --git a/services/resource-usage-tracker/src/simcore_service_resource_usage_tracker/services/resource_tracker_service_runs.py b/services/resource-usage-tracker/src/simcore_service_resource_usage_tracker/services/resource_tracker_service_runs.py
@@ -219,6 +219,7 @@ async def get_osparc_credits_aggregated_usages_page(
             OsparcCreditsAggregatedByServiceGet.construct(
                 osparc_credits=item.osparc_credits,
                 service_key=item.service_key,
+                running_time_in_hours=item.running_time_in_hours,
             )
         )
 
diff --git a/services/resource-usage-tracker/tests/unit/with_dbs/test_api_resource_tracker_service_runs__list_aggregated_usages.py b/services/resource-usage-tracker/tests/unit/with_dbs/test_api_resource_tracker_service_runs__list_aggregated_usages.py
@@ -51,37 +51,49 @@ def resource_tracker_setup_db(
                     random_resource_tracker_service_run(
                         user_id=_USER_ID_1,
                         service_run_id=_SERVICE_RUN_ID_1,
-                        started_at=datetime.now(tz=timezone.utc),
+                        started_at=datetime.now(tz=timezone.utc) - timedelta(hours=1),
+                        stopped_at=datetime.now(tz=timezone.utc),
+                        service_run_status="SUCCESS",
                         service_key="simcore/services/dynamic/jupyter-smash",
                     ),
                     random_resource_tracker_service_run(
                         user_id=_USER_ID_2,
                         service_run_id=_SERVICE_RUN_ID_2,
-                        started_at=datetime.now(tz=timezone.utc),
+                        started_at=datetime.now(tz=timezone.utc) - timedelta(hours=1),
+                        stopped_at=datetime.now(tz=timezone.utc),
+                        service_run_status="SUCCESS",
                         service_key="simcore/services/dynamic/jupyter-smash",
                     ),
                     random_resource_tracker_service_run(
                         user_id=_USER_ID_1,
                         service_run_id=_SERVICE_RUN_ID_3,
-                        started_at=datetime.now(tz=timezone.utc),
+                        started_at=datetime.now(tz=timezone.utc) - timedelta(hours=1),
+                        stopped_at=datetime.now(tz=timezone.utc),
+                        service_run_status="SUCCESS",
                         service_key="simcore/services/dynamic/jupyter-smash",
                     ),
                     random_resource_tracker_service_run(
                         user_id=_USER_ID_1,
                         service_run_id=_SERVICE_RUN_ID_4,
-                        started_at=datetime.now(tz=timezone.utc),
+                        started_at=datetime.now(tz=timezone.utc) - timedelta(hours=1),
+                        stopped_at=datetime.now(tz=timezone.utc),
+                        service_run_status="SUCCESS",
                         service_key="simcore/services/dynamic/jupyter-smash",
                     ),
                     random_resource_tracker_service_run(
                         user_id=_USER_ID_1,
                         service_run_id=_SERVICE_RUN_ID_5,
                         started_at=datetime.now(tz=timezone.utc) - timedelta(days=3),
+                        stopped_at=datetime.now(tz=timezone.utc),
+                        service_run_status="SUCCESS",
                         service_key="simcore/services/dynamic/jupyter-smash",
                     ),
                     random_resource_tracker_service_run(
                         user_id=_USER_ID_1,
                         service_run_id=_SERVICE_RUN_ID_6,
                         started_at=datetime.now(tz=timezone.utc) - timedelta(days=10),
+                        stopped_at=datetime.now(tz=timezone.utc),
+                        service_run_status="SUCCESS",
                         service_key="simcore/services/dynamic/sim4life",
                     ),
                 ]
diff --git a/services/web/server/src/simcore_service_webserver/api/v0/openapi.yaml b/services/web/server/src/simcore_service_webserver/api/v0/openapi.yaml
@@ -4258,7 +4258,7 @@ paths:
         '403':
           description: ProjectInvalidRightsError
         '404':
-          description: ProjectNotFoundError, UserDefaultWalletNotFoundError
+          description: UserDefaultWalletNotFoundError, ProjectNotFoundError
         '409':
           description: ProjectTooManyProjectOpenedError
         '422':
@@ -4579,7 +4579,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/Envelope_list_models_library.api_schemas_webserver.resource_usage.ServiceRunGet__'
+                $ref: '#/components/schemas/Envelope_list_models_library.api_schemas_resource_usage_tracker.service_runs.OsparcCreditsAggregatedByServiceGet__'
   /v0/services/-/usage-report:
     get:
       tags:
@@ -7641,6 +7641,17 @@ components:
             $ref: '#/components/schemas/TaskGet'
         error:
           title: Error
+    Envelope_list_models_library.api_schemas_resource_usage_tracker.service_runs.OsparcCreditsAggregatedByServiceGet__:
+      title: Envelope[list[models_library.api_schemas_resource_usage_tracker.service_runs.OsparcCreditsAggregatedByServiceGet]]
+      type: object
+      properties:
+        data:
+          title: Data
+          type: array
+          items:
+            $ref: '#/components/schemas/OsparcCreditsAggregatedByServiceGet'
+        error:
+          title: Error
     Envelope_list_models_library.api_schemas_storage.FileMetaDataGet__:
       title: Envelope[list[models_library.api_schemas_storage.FileMetaDataGet]]
       type: object
@@ -9339,6 +9350,24 @@ components:
       - WALLET_SHARED
       type: string
       description: An enumeration.
+    OsparcCreditsAggregatedByServiceGet:
+      title: OsparcCreditsAggregatedByServiceGet
+      required:
+      - osparc_credits
+      - service_key
+      - running_time_in_hours
+      type: object
+      properties:
+        osparc_credits:
+          title: Osparc Credits
+          type: number
+        service_key:
+          title: Service Key
+          pattern: ^simcore/services/((comp|dynamic|frontend))/([a-z0-9][a-z0-9_.-]*/)*([a-z0-9-_]+[a-z0-9])$
+          type: string
+        running_time_in_hours:
+          title: Running Time In Hours
+          type: number
     Owner:
       title: Owner
       required:
diff --git a/services/web/server/tests/unit/with_dbs/03/resource_usage/test_list_osparc_credits_aggregated_usages.py b/services/web/server/tests/unit/with_dbs/03/resource_usage/test_list_osparc_credits_aggregated_usages.py
@@ -30,6 +30,7 @@
             **{
                 "osparc_credits": Decimal(-50),
                 "service_key": "simcore/services/comp/itis/sleeper",
+                "running_time_in_hours": Decimal(0.5),
             }
         )
     ],

Original file line number	Diff line number	Diff line change
`@@ -219,6 +219,7 @@ async def get_osparc_credits_aggregated_usages_page(`
`219`	`219`	`OsparcCreditsAggregatedByServiceGet.construct(`
`220`	`220`	`osparc_credits=item.osparc_credits,`
`221`	`221`	`service_key=item.service_key,`
	`222`	`+ running_time_in_hours=item.running_time_in_hours,`
`222`	`223`	`)`
`223`	`224`	`)`
`224`	`225`
Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,7 @@`
`30`	`30`	`**{`
`31`	`31`	`"osparc_credits": Decimal(-50),`
`32`	`32`	`"service_key": "simcore/services/comp/itis/sleeper",`
	`33`	`+ "running_time_in_hours": Decimal(0.5),`
`33`	`34`	`}`
`34`	`35`	`)`
`35`	`36`	`],`