setup data for the feature

Author: mabaasit

packages/collection-model/index.d.ts

@@ -78,9 +78,11 @@ interface CollectionProps {
   index_size: number;
   isTimeSeries: boolean;
   isView: boolean;
+  /** Only relevant for a view and identifies collection/view from which this view was created. */
   sourceName: string | null;
   source: Collection;
   properties: { id: string; options?: unknown }[];
+  ns_source: 'provisioned' | 'privileges';
 }
 
 type CollectionDataService = Pick<DataService, 'collectionStats' | 'collectionInfo' | 'listCollections' | 'isListSearchIndexesSupported'>;

packages/collection-model/lib/model.js

@@ -102,8 +102,9 @@ function pickCollectionInfo({
   validation,
   clustered,
   fle2,
+  ns_source,
 }) {
-  return { type, readonly, view_on, collation, pipeline, validation, clustered, fle2 };
+  return { type, readonly, view_on, collation, pipeline, validation, clustered, fle2, ns_source };
 }
 
 /**
@@ -124,6 +125,7 @@ const CollectionModel = AmpersandModel.extend(debounceActions(['fetch']), {
     statusError: { type: 'string', default: null },
 
     // Normalized values from collectionInfo command
+    ns_source: 'string',
     readonly: 'boolean',
     clustered: 'boolean',
     fle2: 'boolean',

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

@@ -58,7 +58,11 @@ import type {
   ConnectionFleOptions,
   ConnectionOptions,
 } from './connection-options';
-import type { InstanceDetails } from './instance-detail-helper';
+import type {
+  CollectionDetails,
+  DatabaseDetails,
+  InstanceDetails,
+} from './instance-detail-helper';
 import {
   isNotAuthorized,
   isNotSupportedPipelineStage,
@@ -312,7 +316,7 @@ export interface DataService {
         | ConnectionStatusWithPrivileges['authInfo']['authenticatedUserPrivileges']
         | null;
     }
-  ): Promise<ReturnType<typeof adaptCollectionInfo>[]>;
+  ): Promise<CollectionDetails[]>;
 
   /**
    * Returns normalized collection info provided by listCollection command for a
@@ -419,7 +423,7 @@ export interface DataService {
     roles?:
       | ConnectionStatusWithPrivileges['authInfo']['authenticatedUserRoles']
       | null;
-  }): Promise<{ _id: string; name: string }[]>;
+  }): Promise<Omit<DatabaseDetails, 'collections'>[]>;
 
   /**
    * Get the stats for a database.
@@ -1291,7 +1295,16 @@ class DataServiceImpl extends WithLogContext implements DataService {
         | ConnectionStatusWithPrivileges['authInfo']['authenticatedUserPrivileges']
         | null;
     } = {}
-  ): Promise<ReturnType<typeof adaptCollectionInfo>[]> {
+  ): Promise<CollectionDetails[]> {
+    const listCollections = async () => {
+      const colls = await this._listCollections(databaseName, filter, {
+        nameOnly,
+      });
+      return colls.map((coll) => ({
+        ns_source: 'provisioned' as const,
+        ...coll,
+      }));
+    };
     const getCollectionsFromPrivileges = async () => {
       const databases = getPrivilegesByDatabaseAndCollection(
         await this._getPrivilegesOrFallback(privileges),
@@ -1307,11 +1320,11 @@ class DataServiceImpl extends WithLogContext implements DataService {
           // those registered as "real" collection names
           Boolean
         )
-        .map((name) => ({ name }));
+        .map((name) => ({ name, ns_source: 'privileges' as const }));
     };
 
     const [listedCollections, collectionsFromPrivileges] = await Promise.all([
-      this._listCollections(databaseName, filter, { nameOnly }),
+      listCollections(),
       // If the filter is not empty, we can't meaningfully derive collections
       // from privileges and filter them as the criteria might include any key
       // from the listCollections result object and there is no such info in
@@ -1325,7 +1338,10 @@ class DataServiceImpl extends WithLogContext implements DataService {
       // if they were fetched successfully
       [...collectionsFromPrivileges, ...listedCollections],
       'name'
-    ).map((coll) => adaptCollectionInfo({ db: databaseName, ...coll }));
+    ).map((coll) => ({
+      ns_source: coll.ns_source,
+      ...adaptCollectionInfo({ db: databaseName, ...coll }),
+    }));
 
     return collections;
   }
@@ -1348,7 +1364,7 @@ class DataServiceImpl extends WithLogContext implements DataService {
     roles?:
       | ConnectionStatusWithPrivileges['authInfo']['authenticatedUserRoles']
       | null;
-  } = {}): Promise<{ _id: string; name: string }[]> {
+  } = {}): Promise<Omit<DatabaseDetails, 'collections'>[]> {
     const adminDb = this._database('admin', 'CRUD');
 
     const listDatabases = async () => {
@@ -1363,7 +1379,10 @@ class DataServiceImpl extends WithLogContext implements DataService {
           },
           { enableUtf8Validation: false }
         );
-        return databases;
+        return databases.map((x) => ({
+          ...x,
+          ns_source: 'provisioned' as const,
+        }));
       } catch (err) {
         // Currently Compass should not fail if listDatabase failed for any
         // possible reason to preserve current behavior. We probably want this
@@ -1395,7 +1414,7 @@ class DataServiceImpl extends WithLogContext implements DataService {
           // out
           Boolean
         )
-        .map((name) => ({ name }));
+        .map((name) => ({ name, ns_source: 'privileges' as const }));
     };
 
     const getDatabasesFromRoles = async () => {
@@ -1410,7 +1429,7 @@ class DataServiceImpl extends WithLogContext implements DataService {
         // have custom privileges that we can't currently fetch.
         ['read', 'readWrite', 'dbAdmin', 'dbOwner']
       );
-      return databases.map((name) => ({ name }));
+      return databases.map((name) => ({ name, ns_source: 'roles' as const }));
     };
 
     const [listedDatabases, databasesFromPrivileges, databasesFromRoles] =
@@ -1426,7 +1445,12 @@ class DataServiceImpl extends WithLogContext implements DataService {
       [...databasesFromRoles, ...databasesFromPrivileges, ...listedDatabases],
       'name'
     ).map((db) => {
-      return { _id: db.name, name: db.name, ...adaptDatabaseInfo(db) };
+      return {
+        _id: db.name,
+        name: db.name,
+        ns_source: db.ns_source,
+        ...adaptDatabaseInfo(db),
+      };
     });
 
     return databases;

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

@@ -54,7 +54,7 @@ type DataLakeDetails = {
   version: string | null;
 };
 
-type CollectionDetails = {
+export type CollectionDetails = {
   _id: string;
   name: string;
   database: string;
@@ -76,9 +76,10 @@ type CollectionDetails = {
     validationAction: string;
     validationLevel: string;
   } | null;
+  ns_source: 'provisioned' | 'privileges';
 };
 
-type DatabaseDetails = {
+export type DatabaseDetails = {
   _id: string;
   name: string;
   collection_count: number;
@@ -88,6 +89,7 @@ type DatabaseDetails = {
   index_count: number;
   index_size: number;
   collections: CollectionDetails[];
+  ns_source: 'provisioned' | 'privileges' | 'roles';
 };
 
 export type InstanceDetails = {
@@ -358,7 +360,7 @@ function adaptBuildInfo(rawBuildInfo: Partial<BuildInfo>) {
 
 export function adaptDatabaseInfo(
   databaseStats: Partial<DbStats> & Partial<DatabaseInfo>
-): Omit<DatabaseDetails, '_id' | 'collections' | 'name'> {
+): Omit<DatabaseDetails, '_id' | 'collections' | 'name' | 'ns_source'> {
   return {
     collection_count: databaseStats.collections ?? 0,
     document_count: databaseStats.objects ?? 0,
@@ -375,8 +377,10 @@ export function adaptCollectionInfo({
   info,
   options,
   type,
-}: CollectionInfoNameOnly &
-  Partial<CollectionInfo> & { db: string }): CollectionDetails {
+}: CollectionInfoNameOnly & Partial<CollectionInfo> & { db: string }): Omit<
+  CollectionDetails,
+  'ns_source'
+> {
   const ns = toNS(`${db}.${name}`);
   const {
     collection,

packages/database-model/index.d.ts

@@ -16,6 +16,7 @@ interface DatabaseProps {
   index_size: number;
   collectionsLength: number;
   collections: CollectionCollection;
+  ns_source: 'provisioned' | 'privileges' | 'roles';
 }
 
 interface Database extends DatabaseProps {

packages/database-model/lib/model.js

@@ -105,7 +105,7 @@ const DatabaseModel = AmpersandModel.extend(
       statusError: { type: 'string', default: null },
       collectionsStatus: { type: 'string', default: 'initial' },
       collectionsStatusError: { type: 'string', default: null },
-
+      ns_source: 'string',
       collection_count: 'number',
       document_count: 'number',
       storage_size: 'number',
@@ -236,7 +236,7 @@ const DatabaseCollection = AmpersandCollection.extend(
         roles: instanceModel.auth.roles
       });
 
-      this.set(dbs.map(({ _id, name }) => ({ _id, name })));
+      this.set(dbs.map(({ _id, name, ns_source }) => ({ _id, name, ns_source })));
     },
 
     toJSON(opts = { derived: true }) {