Add volume cost (#2541)

* Add Volume.cost

* Show volume cost and finished time

Author: r4victor

frontend/src/locale/en.json

@@ -496,9 +496,10 @@
     "region": "Region",
     "backend": "Backend",
     "status": "Status",
-    "created_at": "Created at",
-    "price": "Price",
-
+    "created": "Created",
+    "finished": "Finished",
+    "price": "Price (per month)",
+    "cost": "Cost",
     "statuses": {
       "failed": "Failed",
       "submitted": "Submitted",

frontend/src/pages/Volumes/List/hooks.tsx

@@ -85,17 +85,29 @@ export const useColumnsDefinitions = () => {
                 ),
         },
         {
-            id: 'created_at',
-            header: t('volume.created_at'),
+            id: 'created',
+            header: t('volume.created'),
             cell: (item: IVolume) => format(new Date(item.created_at), DATE_TIME_FORMAT),
         },
+        {
+            id: 'finished',
+            header: t('volume.finished'),
+            cell: (item: IVolume) => getVolumeFinised(item),
+        },
         {
             id: 'price',
             header: `${t('volume.price')}`,
             cell: (item: IVolume) => {
                 return item?.provisioning_data?.price ? `$${item.provisioning_data.price.toFixed(2)}` : '-';
             },
         },
+        {
+            id: 'cost',
+            header: `${t('volume.cost')}`,
+            cell: (item: IVolume) => {
+                return item?.cost ? `$${item.cost.toFixed(2)}` : '-';
+            },
+        },
     ];
 
     return { columns } as const;
@@ -167,3 +179,14 @@ export const useVolumesDelete = () => {
 
     return { isDeleting, deleteVolumes };
 };
+
+const getVolumeFinised = (volume: IVolume): string => {
+    if (!volume.deleted_at && volume.status != 'failed') {
+        return '-';
+    }
+    let finished = volume.last_processed_at
+    if (volume.deleted_at) {
+        finished = volume.deleted_at
+    }
+    return format(new Date(finished), DATE_TIME_FORMAT);
+};

frontend/src/types/volume.d.ts

@@ -33,12 +33,15 @@ declare interface IVolume {
     project_name: string,
     external: boolean,
     created_at: string,
+    last_processed_at: string,
     status: "submitted" | "provisioning" | "active" | "failed"
     status_message?: string
     deleted: boolean
+    deleted_at?: string
     volume_id?: string;
     configuration: IVolumeConfiguration,
     provisioning_data: IVolumeProvisioningData
+    cost: number
     attachment_data: {
         device_name?: string
     }

src/dstack/_internal/core/models/volumes.py

@@ -104,11 +104,14 @@ class Volume(CoreModel):
     configuration: VolumeConfiguration
     external: bool
     created_at: datetime
+    last_processed_at: datetime
     status: VolumeStatus
     status_message: Optional[str] = None
     deleted: bool
+    deleted_at: Optional[datetime] = None
     volume_id: Optional[str] = None  # id of the volume in the cloud
     provisioning_data: Optional[VolumeProvisioningData] = None
+    cost: float = 0
     attachments: Optional[List[VolumeAttachment]] = None
     # attachment_data is deprecated in favor of attachments.
     # It's only set for volumes that were attached before attachments.

src/dstack/_internal/server/services/volumes.py

@@ -1,5 +1,5 @@
 import uuid
-from datetime import datetime, timezone
+from datetime import datetime, timedelta, timezone
 from typing import List, Optional
 
 from sqlalchemy import and_, func, or_, select, update
@@ -309,22 +309,29 @@ def volume_model_to_volume(volume_model: VolumeModel) -> Volume:
                 attachment_data=get_attachment_data(volume_attachment_model),
             )
         )
-    return Volume(
+    deleted_at = None
+    if volume_model.deleted_at is not None:
+        deleted_at = volume_model.deleted_at.replace(tzinfo=timezone.utc)
+    volume = Volume(
         name=volume_model.name,
         project_name=volume_model.project.name,
         user=volume_model.user.name,
         configuration=configuration,
         external=configuration.volume_id is not None,
         created_at=volume_model.created_at.replace(tzinfo=timezone.utc),
+        last_processed_at=volume_model.last_processed_at.replace(tzinfo=timezone.utc),
         status=volume_model.status,
         status_message=volume_model.status_message,
         deleted=volume_model.deleted,
+        deleted_at=deleted_at,
         volume_id=vpd.volume_id if vpd is not None else None,
         provisioning_data=vpd,
         attachments=attachments,
         attachment_data=vad,
         id=volume_model.id,
     )
+    volume.cost = _get_volume_cost(volume)
+    return volume
 
 
 def get_volume_configuration(volume_model: VolumeModel) -> VolumeConfiguration:
@@ -417,3 +424,23 @@ async def _delete_volume(session: AsyncSession, project: ProjectModel, volume_mo
         compute.delete_volume,
         volume=volume,
     )
+
+
+# Clouds charge volumes assuming 30-day months, e.g. https://aws.amazon.com/ebs/pricing/
+_VOLUME_PRICING_PERIOD = timedelta(days=30)
+
+
+def _get_volume_cost(volume: Volume) -> float:
+    if volume.provisioning_data is None or volume.provisioning_data.price is None:
+        return 0.0
+    finished_at = common.get_current_datetime()
+    if volume.deleted_at:
+        finished_at = volume.deleted_at
+    elif not volume.status.is_active():
+        finished_at = volume.last_processed_at
+    volume_age = finished_at - volume.created_at
+    return (
+        volume_age.total_seconds()
+        * volume.provisioning_data.price
+        / _VOLUME_PRICING_PERIOD.total_seconds()
+    )

src/dstack/_internal/server/testing/common.py

@@ -692,6 +692,7 @@ async def create_volume(
     user: UserModel,
     status: VolumeStatus = VolumeStatus.SUBMITTED,
     created_at: datetime = datetime(2023, 1, 2, 3, 4, tzinfo=timezone.utc),
+    last_processed_at: Optional[datetime] = None,
     configuration: Optional[VolumeConfiguration] = None,
     volume_provisioning_data: Optional[VolumeProvisioningData] = None,
     deleted_at: Optional[datetime] = None,
@@ -700,12 +701,15 @@ async def create_volume(
 ) -> VolumeModel:
     if configuration is None:
         configuration = get_volume_configuration(backend=backend, region=region)
+    if last_processed_at is None:
+        last_processed_at = created_at
     vm = VolumeModel(
         project=project,
         user_id=user.id,
         name=configuration.name,
         status=status,
         created_at=created_at,
+        last_processed_at=last_processed_at,
         configuration=configuration.json(),
         volume_provisioning_data=volume_provisioning_data.json()
         if volume_provisioning_data
@@ -727,9 +731,11 @@ def get_volume(
     configuration: Optional[VolumeConfiguration] = None,
     external: bool = False,
     created_at: datetime = datetime(2023, 1, 2, 3, 4, tzinfo=timezone.utc),
+    last_processed_at: datetime = datetime(2023, 1, 2, 3, 4, tzinfo=timezone.utc),
     status: VolumeStatus = VolumeStatus.ACTIVE,
     status_message: Optional[str] = None,
     deleted: bool = False,
+    deleted_at: Optional[datetime] = None,
     volume_id: Optional[str] = None,
     provisioning_data: Optional[VolumeProvisioningData] = None,
     attachments: Optional[List[VolumeAttachment]] = None,
@@ -748,9 +754,11 @@ def get_volume(
         configuration=configuration,
         external=external,
         created_at=created_at,
+        last_processed_at=last_processed_at,
         status=status,
         status_message=status_message,
         deleted=deleted,
+        deleted_at=deleted_at,
         volume_id=volume_id,
         provisioning_data=provisioning_data,
         attachments=attachments,
@@ -777,6 +785,7 @@ def get_volume_provisioning_data(
     volume_id: str = "vol-1234",
     size_gb: int = 100,
     availability_zone: Optional[str] = None,
+    price: Optional[float] = 1.0,
     backend_data: Optional[str] = None,
     backend: Optional[BackendType] = None,
 ) -> VolumeProvisioningData:
@@ -785,6 +794,7 @@ def get_volume_provisioning_data(
         volume_id=volume_id,
         size_gb=size_gb,
         availability_zone=availability_zone,
+        price=price,
         backend_data=backend_data,
     )
 

src/tests/_internal/server/routers/test_volumes.py

@@ -71,11 +71,14 @@ async def test_lists_volumes_across_projects(
                 "configuration": json.loads(volume2.configuration),
                 "external": False,
                 "created_at": "2023-01-02T03:05:00+00:00",
+                "last_processed_at": "2023-01-02T03:05:00+00:00",
                 "status": "submitted",
                 "status_message": None,
                 "deleted": False,
+                "deleted_at": None,
                 "volume_id": None,
                 "provisioning_data": None,
+                "cost": 0.0,
                 "attachments": [],
                 "attachment_data": None,
             },
@@ -87,11 +90,14 @@ async def test_lists_volumes_across_projects(
                 "configuration": json.loads(volume1.configuration),
                 "external": False,
                 "created_at": "2023-01-02T03:04:00+00:00",
+                "last_processed_at": "2023-01-02T03:04:00+00:00",
                 "status": "submitted",
                 "status_message": None,
                 "deleted": False,
+                "deleted_at": None,
                 "volume_id": None,
                 "provisioning_data": None,
+                "cost": 0.0,
                 "attachments": [],
                 "attachment_data": None,
             },
@@ -114,11 +120,14 @@ async def test_lists_volumes_across_projects(
                 "configuration": json.loads(volume1.configuration),
                 "external": False,
                 "created_at": "2023-01-02T03:04:00+00:00",
+                "last_processed_at": "2023-01-02T03:04:00+00:00",
                 "status": "submitted",
                 "status_message": None,
                 "deleted": False,
+                "deleted_at": None,
                 "volume_id": None,
                 "provisioning_data": None,
+                "cost": 0.0,
                 "attachments": [],
                 "attachment_data": None,
             },
@@ -168,11 +177,14 @@ async def test_non_admin_cannot_see_others_projects(
                 "configuration": json.loads(volume1.configuration),
                 "external": False,
                 "created_at": "2023-01-02T03:04:00+00:00",
+                "last_processed_at": "2023-01-02T03:04:00+00:00",
                 "status": "submitted",
                 "status_message": None,
                 "deleted": False,
+                "deleted_at": None,
                 "volume_id": None,
                 "provisioning_data": None,
+                "cost": 0.0,
                 "attachments": [],
                 "attachment_data": None,
             },
@@ -216,11 +228,14 @@ async def test_lists_volumes(self, test_db, session: AsyncSession, client: Async
                 "configuration": json.loads(volume.configuration),
                 "external": False,
                 "created_at": "2023-01-02T03:04:00+00:00",
+                "last_processed_at": "2023-01-02T03:04:00+00:00",
                 "status": "submitted",
                 "status_message": None,
                 "deleted": False,
+                "deleted_at": None,
                 "volume_id": None,
                 "provisioning_data": None,
+                "cost": 0.0,
                 "attachments": [],
                 "attachment_data": None,
             }
@@ -264,11 +279,14 @@ async def test_returns_volume(self, test_db, session: AsyncSession, client: Asyn
             "configuration": json.loads(volume.configuration),
             "external": False,
             "created_at": "2023-01-02T03:04:00+00:00",
+            "last_processed_at": "2023-01-02T03:04:00+00:00",
             "status": "submitted",
             "status_message": None,
             "deleted": False,
+            "deleted_at": None,
             "volume_id": None,
             "provisioning_data": None,
+            "cost": 0.0,
             "attachments": [],
             "attachment_data": None,
         }
@@ -326,11 +344,14 @@ async def test_creates_volume(self, test_db, session: AsyncSession, client: Asyn
             "user": user.name,
             "external": False,
             "created_at": "2023-01-02T03:04:00+00:00",
+            "last_processed_at": "2023-01-02T03:04:00+00:00",
             "status": "submitted",
             "status_message": None,
             "deleted": False,
+            "deleted_at": None,
             "volume_id": None,
             "provisioning_data": None,
+            "cost": 0.0,
             "attachments": [],
             "attachment_data": None,
         }

src/tests/_internal/server/services/test_volumes.py

@@ -0,0 +1,62 @@
+from datetime import datetime, timezone
+
+import pytest
+from freezegun import freeze_time
+
+from dstack._internal.core.models.volumes import VolumeStatus
+from dstack._internal.server.services.volumes import _get_volume_cost
+from dstack._internal.server.testing.common import get_volume, get_volume_provisioning_data
+
+
+class TestGetVolumeCost:
+    def test_returns_0_when_no_provisioning_data(self):
+        volume = get_volume(provisioning_data=None)
+        assert _get_volume_cost(volume) == 0.0
+
+    def test_returns_0_when_no_price(self):
+        volume = get_volume(
+            provisioning_data=get_volume_provisioning_data(price=None),
+        )
+        assert _get_volume_cost(volume) == 0.0
+
+    @freeze_time(datetime(2025, 1, 31, 0, 0, tzinfo=timezone.utc))
+    def test_calculates_active_volume_cost(self):
+        volume = get_volume(
+            status=VolumeStatus.ACTIVE,
+            deleted=False,
+            provisioning_data=get_volume_provisioning_data(price=30),
+            created_at=datetime(2025, 1, 1, 0, 0, tzinfo=timezone.utc),
+        )
+        assert _get_volume_cost(volume) == pytest.approx(30.0)
+
+    @freeze_time(datetime(2025, 1, 31, 0, 0, tzinfo=timezone.utc))
+    def test_calculates_finished_volume_cost(self):
+        volume = get_volume(
+            provisioning_data=get_volume_provisioning_data(price=30),
+            created_at=datetime(2025, 1, 1, 0, 0, tzinfo=timezone.utc),
+            deleted=True,
+            deleted_at=datetime(2025, 1, 16, 0, 0, tzinfo=timezone.utc),  # 15 days later
+        )
+        # Cost should be for 15 days out of a 30-day pricing period
+        assert _get_volume_cost(volume) == pytest.approx(15.0)
+
+    @freeze_time(datetime(2025, 1, 1, 0, 0, tzinfo=timezone.utc))
+    def test_calculates_zero_cost_for_zero_duration_active(self):
+        volume = get_volume(
+            status=VolumeStatus.ACTIVE,
+            deleted=False,
+            provisioning_data=get_volume_provisioning_data(price=30),
+            created_at=datetime(2025, 1, 1, 0, 0, tzinfo=timezone.utc),  # Same as frozen time
+        )
+        assert _get_volume_cost(volume) == 0.0
+
+    def test_calculates_zero_cost_for_zero_duration_finished(self):
+        finished_time = datetime(2025, 1, 1, 0, 0, tzinfo=timezone.utc)
+        volume = get_volume(
+            status=VolumeStatus.FAILED,
+            deleted=False,  # Can be failed without being deleted
+            provisioning_data=get_volume_provisioning_data(price=30),
+            created_at=finished_time,
+            last_processed_at=finished_time,
+        )
+        assert _get_volume_cost(volume) == 0.0