feat: visually identify FLE2 collections MONGOSH-1204 (#1270)

Author: alenakhineika

packages/browser-repl/package-lock.json

@@ -25,7 +25,7 @@ export class ShowCollectionsOutput extends Component<ShowCollectionsOutputProps>
     let maxCollectionNameLength = 0;
     value.forEach(coll => {
       maxCollectionNameLength = Math.max(maxCollectionNameLength, coll.name.length);
-      if (coll.name.startsWith('system.')) {
+      if (coll.name.startsWith('system.') || coll.name.startsWith('enxcol_.')) {
         systemCollections.push(coll);
       } else {
         otherCollections.push(coll);

packages/browser-repl/src/components/types/show-collections-output.tsx

@@ -128,7 +128,7 @@ function formatCollections(output: CollectionNamesWithTypes[], options: FormatOp
   const otherCollections: CollectionNamesWithTypes[] = [];
 
   output.forEach(coll => {
-    if (coll.name.startsWith('system.')) {
+    if (coll.name.startsWith('system.') || coll.name.startsWith('enxcol_.')) {
       systemCollections.push(coll);
     } else {
       otherCollections.push(coll);

packages/cli-repl/src/format-output.ts

@@ -164,14 +164,26 @@ describe('Database', () => {
           { name: 'coll3', type: 'view' },
           { name: 'coll1', type: 'collection' },
           { name: 'coll2', type: 'newtype' },
+          { name: 'coll4', type: 'collection' },
+          { name: 'enxcol_.coll4.esc', type: 'collection' },
+          { name: 'enxcol_.coll4.ecc', type: 'collection' },
+          { name: 'enxcol_.coll4.ecoc', type: 'collection' },
+          { name: 'enxcol_.coll5.esc', type: 'collection' },
+          { name: 'coll6', type: 'timeseries' }
         ];
 
         serviceProvider.listCollections.resolves(result);
 
         expect(await database._getCollectionNamesWithTypes()).to.deep.equal([
           { name: 'coll1', badge: '' },
           { name: 'coll2', badge: '' },
-          { name: 'coll3', badge: '[view]' }
+          { name: 'coll3', badge: '[view]' },
+          { name: 'coll4', badge: '[queryable-encryption]' },
+          { name: 'coll6', badge: '[time-series]' },
+          { name: 'enxcol_.coll4.ecc', badge: '' },
+          { name: 'enxcol_.coll4.ecoc', badge: '' },
+          { name: 'enxcol_.coll4.esc', badge: '' },
+          { name: 'enxcol_.coll5.esc', badge: '' }
         ]);
 
         expect(serviceProvider.listCollections).to.have.been.calledOnceWith(

packages/shell-api/src/database.spec.ts

@@ -23,7 +23,8 @@ import {
   isValidCollectionName,
   getConfigDB,
   shouldRunAggregationImmediately,
-  adjustRunCommand
+  adjustRunCommand,
+  getBadge
 } from './helpers';
 
 import type {
@@ -169,16 +170,11 @@ export default class Database extends ShellApiWithMongoClass {
     let collections = await this._listCollections({}, { ...options, nameOnly: true });
     collections = collections.sort((c1, c2) => (c1.name).localeCompare(c2.name));
 
-    const typesToBages: any = {
-      timeseries: '[time-series]',
-      view: '[view]'
-    };
+    this._cachedCollectionNames = collections.map((collection: Document) => collection.name);
 
-    this._cachedCollectionNames = collections.map((collection: any) => collection.name);
-
-    return collections.map((collection: any) => ({
+    return collections.map((collection: Document, index: number) => ({
       name: collection.name,
-      badge: typesToBages[collection.type] ?? ''
+      badge: getBadge(collections, index)
     }));
   }
 

packages/shell-api/src/database.ts

@@ -769,3 +769,28 @@ export function adjustRunCommand(cmd: Document, shellBson: ShellBson): Document
   }
   return cmd;
 }
+
+const isFLE2Collection = (collections: Document[], index: number): boolean => {
+  return (
+    !collections[index].name.startsWith('enxcol_.') &&
+    collections.some(coll => coll.name === `enxcol_.${collections[index].name}.esc`) &&
+    collections.some(coll => coll.name === `enxcol_.${collections[index].name}.ecc`) &&
+    collections.some(coll => coll.name === `enxcol_.${collections[index].name}.ecoc`)
+  );
+};
+
+export function getBadge(collections: Document[], index: number): string {
+  if (collections[index].type === 'timeseries') {
+    return '[time-series]';
+  }
+
+  if (collections[index].type === 'view') {
+    return '[view]';
+  }
+
+  if (isFLE2Collection(collections, index)) {
+    return '[queryable-encryption]';
+  }
+
+  return '';
+}