chore(search-indexes): set up search indexes detection COMPASS-7196 (#4815)

Author: mabaasit

packages/collection-model/index.d.ts

@@ -46,6 +46,7 @@ interface Collection {
     isTimeSeries: boolean;
     isClustered: boolean;
     isFLE: boolean;
+    isSearchIndexesSupported: boolean;
     sourceName?: string;
     sourceReadonly?: boolean;
     sourceViewon?: string;

packages/collection-model/lib/model.js

@@ -257,6 +257,7 @@ const CollectionModel = AmpersandModel.extend(debounceActions(['fetch']), {
   /**
    * Fetches collection info and returns a special format of collection metadata
    * that events like open-in-new-tab, select-namespace, edit-view require
+   * @param {{ dataService: import('mongodb-data-service').DataService }} dataService
    */
   async fetchMetadata({ dataService }) {
     try {
@@ -268,12 +269,26 @@ const CollectionModel = AmpersandModel.extend(debounceActions(['fetch']), {
       // We don't care if it fails to get stats from server for any reason
     }
 
+    /**
+     * The support for search indexes is a feature of a server not a collection.
+     * As this check can only be performed currently by running $listSearchIndexes
+     * aggregation stage against a collection, so we run it from the collection model.
+     * With this setup, when a user opens the first collection, we set this property
+     * on the instance model and then from there its value is read avoiding call to server.
+     */
+    const isSearchIndexesSupported = await getParentByType(this, 'Instance')
+      .getIsSearchSupported({
+        dataService,
+        ns: this.ns,
+      });
+
     const collectionMetadata = {
       namespace: this.ns,
       isReadonly: this.readonly,
       isTimeSeries: this.isTimeSeries,
       isClustered: this.clustered,
       isFLE: this.fle2,
+      isSearchIndexesSupported,
     };
     if (this.sourceId) {
       try {

packages/compass-collection/src/modules/tabs.ts

@@ -89,6 +89,7 @@ export interface WorkspaceTabObject {
   sourceReadonly?: boolean;
   sourceViewOn?: string;
   localAppRegistry: AppRegistry;
+  isSearchIndexesSupported: boolean;
 }
 
 /**
@@ -148,6 +149,7 @@ const doSelectNamespace = (state: State, action: AnyAction) => {
         sourceReadonly: action.sourceReadonly,
         sourceViewOn: action.sourceViewOn,
         localAppRegistry: action.context.localAppRegistry,
+        isSearchIndexesSupported: action.isSearchIndexesSupported,
       });
     } else {
       newState.push({ ...tab });
@@ -197,6 +199,7 @@ const doCreateTab = (state: State, action: AnyAction) => {
     sourceReadonly: action.sourceReadonly,
     sourceViewOn: action.sourceViewOn,
     localAppRegistry: action.context.localAppRegistry,
+    isSearchIndexesSupported: action.isSearchIndexesSupported,
   });
   return newState;
 };
@@ -413,6 +416,7 @@ export const createTab = ({
   sourceViewOn,
   query,
   aggregation,
+  isSearchIndexesSupported,
 }: Pick<
   WorkspaceTabObject,
   | 'id'
@@ -425,6 +429,7 @@ export const createTab = ({
   | 'editViewName'
   | 'sourceReadonly'
   | 'sourceViewOn'
+  | 'isSearchIndexesSupported'
 > & {
   context: ContextProps;
   query?: any; // TODO(COMPASS-6162): type query.
@@ -444,6 +449,7 @@ export const createTab = ({
   sourceViewOn,
   query,
   aggregation,
+  isSearchIndexesSupported,
 });
 
 /**
@@ -475,6 +481,7 @@ export const selectNamespace = ({
   context,
   sourceReadonly,
   sourceViewOn,
+  isSearchIndexesSupported,
 }: Pick<
   WorkspaceTabObject,
   | 'id'
@@ -487,6 +494,7 @@ export const selectNamespace = ({
   | 'editViewName'
   | 'sourceReadonly'
   | 'sourceViewOn'
+  | 'isSearchIndexesSupported'
 > & {
   context: ContextProps;
 }): AnyAction => ({
@@ -502,6 +510,7 @@ export const selectNamespace = ({
   context,
   sourceReadonly,
   sourceViewOn,
+  isSearchIndexesSupported,
 });
 
 /**
@@ -662,6 +671,7 @@ export const selectOrCreateTab = ({
   sourceReadonly,
   sourceViewOn,
   sourcePipeline,
+  isSearchIndexesSupported,
 }: Pick<
   WorkspaceTabObject,
   | 'namespace'
@@ -673,6 +683,7 @@ export const selectOrCreateTab = ({
   | 'editViewName'
   | 'sourceReadonly'
   | 'sourceViewOn'
+  | 'isSearchIndexesSupported'
 > & {
   sourcePipeline: Document[];
 }): ThunkAction<void, RootState, void, AnyAction> => {
@@ -694,6 +705,7 @@ export const selectOrCreateTab = ({
           sourceReadonly,
           sourceViewOn,
           sourcePipeline,
+          isSearchIndexesSupported,
         })
       );
     } else {
@@ -716,6 +728,7 @@ export const selectOrCreateTab = ({
             sourceReadonly,
             sourceViewOn,
             sourcePipeline,
+            isSearchIndexesSupported,
           })
         );
         // Clear the stats of the closed tab's namespace if it's the last one in use.
@@ -751,6 +764,7 @@ export const createNewTab = ({
   sourcePipeline,
   query,
   aggregation,
+  isSearchIndexesSupported,
 }: Pick<
   WorkspaceTabObject,
   | 'namespace'
@@ -762,6 +776,7 @@ export const createNewTab = ({
   | 'editViewName'
   | 'sourceReadonly'
   | 'sourceViewOn'
+  | 'isSearchIndexesSupported'
 > & {
   sourcePipeline?: Document[];
   query?: any; // TODO(COMPASS-6162): type query.
@@ -782,6 +797,7 @@ export const createNewTab = ({
       sourcePipeline,
       query,
       aggregation,
+      isSearchIndexesSupported,
     });
     dispatch(
       createTab({
@@ -798,6 +814,7 @@ export const createNewTab = ({
         sourceViewOn,
         query,
         aggregation,
+        isSearchIndexesSupported,
       })
     );
     showCollectionSubmenu({ isReadOnly: isReadonly });
@@ -821,6 +838,7 @@ export const replaceTabContent = ({
   sourceReadonly,
   sourceViewOn,
   sourcePipeline,
+  isSearchIndexesSupported,
 }: Pick<
   WorkspaceTabObject,
   | 'namespace'
@@ -832,6 +850,7 @@ export const replaceTabContent = ({
   | 'editViewName'
   | 'sourceReadonly'
   | 'sourceViewOn'
+  | 'isSearchIndexesSupported'
 > & {
   sourcePipeline?: Document[];
 }): ThunkAction<void, RootState, void, AnyAction> => {
@@ -848,6 +867,7 @@ export const replaceTabContent = ({
       sourceName,
       editViewName,
       sourcePipeline,
+      isSearchIndexesSupported,
     });
     dispatch(
       selectNamespace({
@@ -862,6 +882,7 @@ export const replaceTabContent = ({
         context,
         sourceReadonly: !!sourceReadonly,
         sourceViewOn,
+        isSearchIndexesSupported,
       })
     );
     showCollectionSubmenu({ isReadOnly: isReadonly });

packages/compass-collection/src/stores/context.tsx

@@ -80,6 +80,7 @@ export type ContextProps = {
   isDataLake?: boolean;
   scopedModals?: any[];
   connectionString?: string;
+  isSearchIndexesSupported?: boolean;
 };
 
 type ContextWithAppRegistry = ContextProps & {
@@ -123,6 +124,7 @@ const setupStore = ({
   query,
   aggregation,
   connectionString,
+  isSearchIndexesSupported,
 }: ContextWithAppRegistry & { role: Role }) => {
   if (!role.storeName || !role.configureStore) {
     return;
@@ -149,6 +151,7 @@ const setupStore = ({
     query,
     aggregation,
     connectionString,
+    isSearchIndexesSupported,
   });
   localAppRegistry.registerStore(role.storeName, store);
 
@@ -359,6 +362,7 @@ const createContext = ({
   sourcePipeline,
   query,
   aggregation,
+  isSearchIndexesSupported,
 }: ContextProps): ContextProps => {
   const serverVersion = state.serverVersion;
   const localAppRegistry = new AppRegistry();
@@ -405,6 +409,7 @@ const createContext = ({
       sourcePipeline,
       query,
       aggregation,
+      isSearchIndexesSupported,
     });
 
     // Add the tab.

packages/compass-collection/src/stores/index.ts

@@ -224,6 +224,7 @@ store.onActivated = (appRegistry: AppRegistry) => {
         sourcePipeline: metadata.sourcePipeline,
         query: metadata.query,
         aggregation: metadata.aggregation,
+        isSearchIndexesSupported: metadata.isSearchIndexesSupported,
       })
     );
   });
@@ -268,6 +269,7 @@ store.onActivated = (appRegistry: AppRegistry) => {
         sourceReadonly: metadata.sourceReadonly,
         sourceViewOn: metadata.sourceViewOn,
         sourcePipeline: metadata.sourcePipeline,
+        isSearchIndexesSupported: metadata.isSearchIndexesSupported,
       })
     );
   });

packages/compass-indexes/src/components/indexes/indexes.spec.tsx

@@ -25,6 +25,7 @@ const renderIndexes = (
       dropFailedIndex={() => {}}
       onHideIndex={() => {}}
       onUnhideIndex={() => {}}
+      isAtlasSearchSupported={false}
       {...props}
     />
   );

packages/compass-indexes/src/components/indexes/indexes.tsx

@@ -21,6 +21,7 @@ import type { IndexView } from '../indexes-toolbar/indexes-toolbar';
 import { IndexesToolbar } from '../indexes-toolbar/indexes-toolbar';
 import { IndexesTable } from '../indexes-table/indexes-table';
 import type { RootState } from '../../modules';
+import { SearchIndexesStatuses } from '../../modules/search-indexes';
 
 const containerStyles = css({
   margin: spacing[3],
@@ -45,6 +46,7 @@ type IndexesProps = {
   onHideIndex: (name: string) => void;
   onUnhideIndex: (name: string) => void;
   readOnly?: boolean;
+  isAtlasSearchSupported: boolean;
 };
 
 // This constant is used as a trigger to show an insight whenever number of
@@ -66,6 +68,7 @@ export const Indexes: React.FunctionComponent<IndexesProps> = ({
   onHideIndex,
   onUnhideIndex,
   readOnly, // preferences readOnly.
+  isAtlasSearchSupported,
 }) => {
   const [currentIndexesView, setCurrentIndexesView] =
     useState<IndexView>('regular-indexes');
@@ -89,7 +92,7 @@ export const Indexes: React.FunctionComponent<IndexesProps> = ({
         isRefreshing={isRefreshing}
         writeStateDescription={description}
         hasTooManyIndexes={indexes.length > IDEAL_NUMBER_OF_MAX_INDEXES}
-        isAtlasSearchSupported={true}
+        isAtlasSearchSupported={isAtlasSearchSupported}
         onRefreshIndexes={refreshIndexes}
         onChangeIndexView={setCurrentIndexesView}
       />
@@ -121,6 +124,7 @@ const mapState = ({
   serverVersion,
   appRegistry,
   regularIndexes: { indexes, isRefreshing, error },
+  searchIndexes: { status },
 }: RootState) => ({
   indexes,
   isWritable,
@@ -130,6 +134,7 @@ const mapState = ({
   localAppRegistry: (appRegistry as any).localAppRegistry,
   isRefreshing,
   serverVersion,
+  isAtlasSearchSupported: status !== SearchIndexesStatuses.NOT_AVAILABLE,
 });
 
 const mapDispatch = {

packages/compass-indexes/src/modules/data-service.ts

@@ -1,15 +1,15 @@
-import type { DataService } from 'mongodb-data-service';
+import type { IndexesDataService } from '../stores/store';
 
 export enum ActionTypes {
   DataServiceConnected = 'indexes/data-service/DATA_SERVICE_CONNECTED',
 }
 
 type DataServiceConnectedAction = {
   type: ActionTypes.DataServiceConnected;
-  dataService: DataService;
+  dataService: IndexesDataService;
 };
 
-type State = DataService | null;
+type State = IndexesDataService | null;
 
 const INITIAL_STATE: State = null;
 
@@ -23,7 +23,7 @@ export default function reducer(
   return state;
 }
 
-export const dataServiceConnected = (dataService: DataService) => ({
+export const dataServiceConnected = (dataService: IndexesDataService) => ({
   type: ActionTypes.DataServiceConnected,
   dataService,
 });

packages/compass-indexes/src/modules/description.js

@@ -32,7 +32,7 @@ export default reducer;
  * Action creator for getDescription events.
  *
  * @param {String} description - The description.
- * @returns {Object} The getDescription action.
+ * @returns {import('redux').AnyAction} The getDescription action.
  */
 export const getDescription = (description) => ({
   type: GET_DESCRIPTION,