fix(compass-database): update storage size stat value

Author: ivandevp

packages/data-service/src/data-service.ts

@@ -93,7 +93,7 @@ import {
   createClonedClient,
 } from './connect-mongo-client';
 import type { CollectionStats } from './types';
-import type { ConnectionStatusWithPrivileges } from './run-command';
+import type { ConnectionStatusWithPrivileges, DbStats } from './run-command';
 import { runCommand } from './run-command';
 import type { CSFLECollectionTracker } from './csfle-collection-tracker';
 import { CSFLECollectionTrackerImpl } from './csfle-collection-tracker';
@@ -2808,7 +2808,7 @@ class DataServiceImpl extends WithLogContext implements DataService {
     const db = this._database(name, 'META');
     const stats = await runCommand(
       db,
-      { dbStats: 1 },
+      { dbStats: 1, freeStorage: 1 },
       {
         enableUtf8Validation: false,
         ...maybeOverrideReadPreference(
@@ -2817,7 +2817,7 @@ class DataServiceImpl extends WithLogContext implements DataService {
         ),
       }
     );
-    const normalized = adaptDatabaseInfo(stats);
+    const normalized = adaptDatabaseInfo(stats as unknown as DbStats);
     return { name, ...normalized };
   }
 

packages/data-service/src/instance-detail-helper.ts

@@ -85,6 +85,7 @@ export type DatabaseDetails = {
   collection_count: number;
   document_count: number;
   storage_size: number;
+  free_storage_size: number;
   data_size: number;
   index_count: number;
   index_size: number;
@@ -373,6 +374,7 @@ export function adaptDatabaseInfo(
     storage_size: databaseStats.storageSize ?? 0,
     data_size: databaseStats.dataSize ?? 0,
     index_size: databaseStats.indexSize ?? 0,
+    free_storage_size: databaseStats.freeStorageSize ?? 0,
   };
 }
 

packages/data-service/src/run-command.ts

@@ -96,9 +96,13 @@ export type DbStats = {
   avgObjSize: number;
   dataSize: number;
   storageSize: number;
+  freeStorageSize?: number;
   numExtents: number;
   indexes: number;
   indexSize: number;
+  indexFreeStorageSize?: number;
+  totalSize?: number;
+  totalFreeStorageSize?: number;
   scaleFactor: number;
   fsUsedSize: number;
   fsTotalSize: number;

packages/database-model/index.d.ts

@@ -10,7 +10,9 @@ interface DatabaseProps {
   collectionsStatusError: string | null;
   collection_count: number | undefined;
   document_count: number | undefined;
+  calculated_storage_size: number | undefined;
   storage_size: number | undefined;
+  free_storage_size: number | undefined;
   data_size: number | undefined;
   index_count: number | undefined;
   index_size: number | undefined;

packages/database-model/lib/model.js

@@ -112,6 +112,7 @@ const DatabaseModel = AmpersandModel.extend(
       data_size: 'number',
       index_count: 'number',
       index_size: 'number',
+      free_storage_size: 'number',
     },
     derived: {
       // Either returns a collection count from database stats or from real
@@ -126,6 +127,18 @@ const DatabaseModel = AmpersandModel.extend(
             : this.collection_count ?? 0;
         },
       },
+      calculated_storage_size: {
+        deps: ['storage_size', 'free_storage_size'],
+        fn() {
+          if (
+            this.storage_size === undefined ||
+            this.free_storage_size === undefined
+          ) {
+            return undefined;
+          }
+          return this.storage_size - this.free_storage_size;
+        },
+      },
     },
     collections: {
       collections: MongoDbCollectionCollection,

packages/databases-collections-list/src/collections.tsx

@@ -133,7 +133,7 @@ const CollectionsList: React.FunctionComponent<{
                         : 'N/A',
                     hint:
                       coll.calculated_storage_size !== undefined &&
-                      'Storage Data: Sum of the disk space allocated to all collections in the database for document storage.',
+                      'Storage Data: Disk space allocated to this collection for document storage.',
                   },
                   {
                     label: 'Uncompressed data',
@@ -143,7 +143,7 @@ const CollectionsList: React.FunctionComponent<{
                         : 'N/A',
                     hint:
                       coll.document_size !== undefined &&
-                      'Uncompressed Data Size: Total size of the uncompressed data held in the database.',
+                      'Uncompressed Data Size: Total size of the uncompressed data held in this collection.',
                   },
                 ]
               : [
@@ -155,7 +155,7 @@ const CollectionsList: React.FunctionComponent<{
                         : 'N/A',
                     hint:
                       coll.calculated_storage_size !== undefined &&
-                      'Storage Data: Sum of the disk space allocated to all collections in the database for document storage.',
+                      'Storage Data: Disk space allocated to this collection for document storage.',
                   },
                   {
                     label: 'Uncompressed data',
@@ -165,7 +165,7 @@ const CollectionsList: React.FunctionComponent<{
                         : 'N/A',
                     hint:
                       coll.document_size !== undefined &&
-                      'Uncompressed Data Size: Total size of the uncompressed data held in the database.',
+                      'Uncompressed Data Size: Total size of the uncompressed data held in this collection.',
                   },
                   {
                     label: 'Documents',

packages/databases-collections-list/src/databases.tsx

@@ -76,12 +76,17 @@ const DatabasesList: React.FunctionComponent<{
               {
                 label: 'Storage',
                 value:
-                  enableDbAndCollStats && db.storage_size !== undefined
-                    ? compactBytes(db.storage_size)
+                  enableDbAndCollStats &&
+                  db.calculated_storage_size !== undefined
+                    ? compactBytes(db.calculated_storage_size)
                     : 'N/A',
                 hint:
                   enableDbAndCollStats &&
-                  'Storage Data: Sum of the disk space allocated to all collections in the database for document storage.',
+                  db.storage_size !== undefined &&
+                  db.free_storage_size !== undefined &&
+                  'Storage Data: Disk space allocated to all collections in the database for document storage.\n' +
+                    `Total storage: ${compactBytes(db.storage_size)}\n` +
+                    `Free storage: ${compactBytes(db.free_storage_size)}`,
               },
               {
                 label: 'Uncompressed data',

packages/databases-collections-list/src/index.spec.tsx

@@ -29,6 +29,8 @@ function createDatabase(name) {
     // dbStats
     document_count: 10,
     storage_size: 1500,
+    free_storage_size: 0,
+    calculated_storage_size: 1500,
     data_size: 1000,
     index_count: 25,
     index_size: 100,