feat(compass-indexes): Add view support to indexes tab COMPASS-9667 (#7182)

* add banners to indexes tab

* update banner to include data explorer versions

* fetching search indexes for view

* fix indexes-toolbar

* update ui

* update indexes-toolbar test

* add tests to indexes.spec.tsx

* only fetch indexes for version 8.1+

* fix conditionals

* change or to and

* add to useEffect conditional

* remove fetch for version

* add verison check back but remove from store

* pr review changes

* move function

* fix indexes-toolbar.spec

* fix initial state import

* cleanup comparisons

* remove de errors

* add missing dep

* installed for lockfile

* replace button onClick with href

Co-authored-by: Sergey Petushkov <[email protected]>

* ran prettier

---------

Co-authored-by: Sergey Petushkov <[email protected]>

Author: DarshanaVenkatesh

package-lock.json

@@ -78,6 +78,7 @@
     "@mongodb-js/compass-workspaces": "^0.51.0",
     "@mongodb-js/mongodb-constants": "^0.12.2",
     "@mongodb-js/shell-bson-parser": "^1.2.0",
+    "@mongodb-js/connection-info": "^0.17.1",
     "bson": "^6.10.4",
     "compass-preferences-model": "^2.50.0",
     "lodash": "^4.17.21",

packages/compass-indexes/package.json

@@ -113,27 +113,49 @@ describe('IndexesToolbar Component', function () {
         });
       });
     });
-
-    it('should not render a warning', function () {
-      expect(screen.queryByText('Readonly views may not contain indexes')).to
-        .not.exist;
-    });
   });
 
   describe('when it is a readonly view', function () {
-    beforeEach(function () {
-      renderIndexesToolbar({
-        isReadonlyView: true,
+    describe('and server version is < 8.1+', function () {
+      beforeEach(function () {
+        renderIndexesToolbar({
+          isReadonlyView: true,
+          indexView: 'search-indexes',
+        });
       });
-    });
 
-    it('should not render the create index button', function () {
-      expect(screen.queryByText('Create Index')).to.not.exist;
+      it('should not render the create index button', function () {
+        expect(screen.queryByText('Create Index')).to.not.exist;
+      });
+
+      it('should not render the create search index button', function () {
+        expect(screen.queryByText('Create Search Index')).to.not.exist;
+      });
+
+      it('should not render the refresh button', function () {
+        expect(screen.queryByText('Refresh')).to.not.exist;
+      });
     });
+    describe('and server version is > 8.1+', function () {
+      beforeEach(function () {
+        renderIndexesToolbar({
+          isReadonlyView: true,
+          serverVersion: '8.1.0',
+          indexView: 'search-indexes',
+        });
+      });
+
+      it('should not render the create index button', function () {
+        expect(screen.queryByText('Create Index')).to.not.exist;
+      });
 
-    it('should render a warning', function () {
-      expect(screen.getByText('Readonly views may not contain indexes.')).to.be
-        .visible;
+      it('should render the create search index button <8.1', function () {
+        expect(screen.getByText('Create Search Index')).to.be.visible;
+      });
+
+      it('should not render the refresh button', function () {
+        expect(screen.queryByText('Refresh')).to.be.visible;
+      });
     });
   });
 
@@ -332,5 +354,21 @@ describe('IndexesToolbar Component', function () {
       expect(segmentControl.closest('button')).to.have.attr('disabled');
       expect(onChangeViewCallback).to.not.have.been.calledOnce;
     });
+
+    describe('and readonly view >8.1', function () {
+      beforeEach(function () {
+        renderIndexesToolbar({
+          isReadonlyView: true,
+          serverVersion: '8.1.0',
+        });
+      });
+
+      it('it renders tabs with Indexes disabled', function () {
+        const indexesTab = screen.getByText('Indexes');
+        expect(indexesTab).to.be.visible;
+        expect(indexesTab.closest('button')).to.have.attr('disabled');
+        expect(screen.getByText('Search Indexes')).to.be.visible;
+      });
+    });
   });
 });

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

@@ -1,30 +1,32 @@
 import React, { useCallback } from 'react';
 import { connect } from 'react-redux';
 import {
-  withPreferences,
   usePreference,
+  withPreferences,
 } from 'compass-preferences-model/provider';
 import {
   Button,
-  ErrorSummary,
-  Tooltip,
-  WarningSummary,
-  Link,
   css,
-  spacing,
+  DropdownMenuButton,
+  ErrorSummary,
   Icon,
-  SpinLoader,
-  SignalPopover,
+  Link,
   PerformanceSignals,
-  DropdownMenuButton,
   SegmentedControl,
   SegmentedControlOption,
+  SignalPopover,
+  spacing,
+  SpinLoader,
+  Tooltip,
 } from '@mongodb-js/compass-components';
 import { useConnectionInfo } from '@mongodb-js/compass-connections/provider';
 import semver from 'semver';
 
 import type { RootState } from '../../modules';
-import { createSearchIndexOpened } from '../../modules/search-indexes';
+import {
+  isVersionSearchCompatibleForViews,
+  createSearchIndexOpened,
+} from '../../modules/search-indexes';
 import { getAtlasSearchIndexesLink } from '../../utils/atlas-search-indexes-link';
 import { createIndexOpened } from '../../modules/create-index';
 import type { IndexView } from '../../modules/index-view';
@@ -109,7 +111,10 @@ export const IndexesToolbar: React.FunctionComponent<IndexesToolbarProps> = ({
   const isSearchManagementActive = usePreference('enableAtlasSearchIndexes');
   const { atlasMetadata } = useConnectionInfo();
   const showInsights = usePreference('showInsights') && !errorMessage;
-  const showCreateIndexButton = !isReadonlyView && !readOnly && !errorMessage;
+  const showCreateIndexButton =
+    (!isReadonlyView || isVersionSearchCompatibleForViews(serverVersion)) &&
+    !readOnly &&
+    !errorMessage;
   const refreshButtonIcon = isRefreshing ? (
     <div className={spinnerStyles}>
       <SpinLoader title="Refreshing Indexes" />
@@ -123,7 +128,9 @@ export const IndexesToolbar: React.FunctionComponent<IndexesToolbarProps> = ({
       className={indexesToolbarContainerStyles}
       data-testid="indexes-toolbar-container"
     >
-      {!isReadonlyView && (
+      {(!isReadonlyView ||
+        (isVersionSearchCompatibleForViews(serverVersion) &&
+          isSearchManagementActive)) && (
         <div data-testid="indexes-toolbar">
           <div className={toolbarButtonsContainer}>
             {showCreateIndexButton && (
@@ -139,7 +146,9 @@ export const IndexesToolbar: React.FunctionComponent<IndexesToolbarProps> = ({
                       isWritable={isWritable}
                       onCreateRegularIndexClick={onCreateRegularIndexClick}
                       onCreateSearchIndexClick={onCreateSearchIndexClick}
-                    ></CreateIndexButton>
+                      isReadonlyView={isReadonlyView}
+                      indexView={indexView}
+                    />
                   </div>
                 }
               >
@@ -173,6 +182,7 @@ export const IndexesToolbar: React.FunctionComponent<IndexesToolbarProps> = ({
                 signals={PerformanceSignals.get('too-many-indexes')}
               />
             )}
+
             {isSearchManagementActive && (
               <SegmentedControl
                 size="xsmall"
@@ -182,13 +192,34 @@ export const IndexesToolbar: React.FunctionComponent<IndexesToolbarProps> = ({
                 value={indexView}
                 data-testid="indexes-segment-controls"
               >
-                <SegmentedControlOption
-                  data-testid="regular-indexes-tab"
-                  value="regular-indexes"
-                >
-                  Indexes
-                </SegmentedControlOption>
-                {!isSearchIndexesSupported && (
+                {isReadonlyView && (
+                  <Tooltip
+                    align="top"
+                    justify="end"
+                    enabled={true}
+                    renderMode="portal"
+                    trigger={
+                      <SegmentedControlOption
+                        data-testid="regular-indexes-tab"
+                        value="regular-indexes"
+                        disabled={isReadonlyView}
+                      >
+                        Indexes
+                      </SegmentedControlOption>
+                    }
+                  >
+                    Readonly views may not contain standard indexes.
+                  </Tooltip>
+                )}
+                {!isReadonlyView && (
+                  <SegmentedControlOption
+                    data-testid="regular-indexes-tab"
+                    value="regular-indexes"
+                  >
+                    Indexes
+                  </SegmentedControlOption>
+                )}
+                {!isSearchIndexesSupported && !isReadonlyView && (
                   <Tooltip
                     align="top"
                     justify="end"
@@ -227,7 +258,7 @@ export const IndexesToolbar: React.FunctionComponent<IndexesToolbarProps> = ({
                     )}
                   </Tooltip>
                 )}
-                {isSearchIndexesSupported && (
+                {(isSearchIndexesSupported || isReadonlyView) && (
                   <SegmentedControlOption
                     data-testid="search-indexes-tab"
                     value="search-indexes"
@@ -240,14 +271,8 @@ export const IndexesToolbar: React.FunctionComponent<IndexesToolbarProps> = ({
           </div>
         </div>
       )}
-      {isReadonlyView ? (
-        <WarningSummary
-          warnings={['Readonly views may not contain indexes.']}
-        />
-      ) : (
-        !!errorMessage && (
-          <ErrorSummary data-testid="indexes-error" errors={[errorMessage]} />
-        )
+      {!!errorMessage && isSearchManagementActive && (
+        <ErrorSummary data-testid="indexes-error" errors={[errorMessage]} />
       )}
     </div>
   );
@@ -259,6 +284,8 @@ type CreateIndexButtonProps = {
   isWritable: boolean;
   onCreateRegularIndexClick: () => void;
   onCreateSearchIndexClick: () => void;
+  isReadonlyView: boolean;
+  indexView: IndexView;
 };
 
 type CreateIndexActions = 'createRegularIndex' | 'createSearchIndex';
@@ -271,6 +298,8 @@ export const CreateIndexButton: React.FunctionComponent<
   isWritable,
   onCreateRegularIndexClick,
   onCreateSearchIndexClick,
+  isReadonlyView,
+  indexView,
 }) => {
   const onActionDispatch = useCallback(
     (action: CreateIndexActions) => {
@@ -284,7 +313,23 @@ export const CreateIndexButton: React.FunctionComponent<
     [onCreateRegularIndexClick, onCreateSearchIndexClick]
   );
 
-  if (isSearchIndexesSupported && isSearchManagementActive) {
+  if (isReadonlyView && isSearchManagementActive) {
+    if (indexView === 'search-indexes') {
+      return (
+        <Button
+          disabled={!isWritable}
+          onClick={onCreateSearchIndexClick}
+          variant="primary"
+          size="small"
+        >
+          Create Search Index
+        </Button>
+      );
+    }
+
+    return null;
+  }
+  if (!isReadonlyView && isSearchIndexesSupported && isSearchManagementActive) {
     return (
       <DropdownMenuButton
         data-testid="multiple-index-types-creation-dropdown"

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

@@ -45,20 +45,8 @@ const renderIndexes = async (
 
   if (props) {
     const state = store.getState();
-
-    const allProps: Partial<RootState> = {
-      indexView: props.indexView ?? 'regular-indexes',
-      regularIndexes: {
-        ...state.regularIndexes,
-        ...props.regularIndexes,
-      },
-      searchIndexes: {
-        ...state.searchIndexes,
-        ...props.searchIndexes,
-      },
-    };
-
-    Object.assign(store.getState(), allProps);
+    const newState = { ...state, ...props };
+    Object.assign(store.getState(), newState);
   }
 
   render(
@@ -332,5 +320,76 @@ describe('Indexes Component', function () {
 
       expect(getSearchIndexesStub.callCount).to.equal(2);
     });
+
+    it('renders search indexes list if isReadonlyView 8.1+ and has indexes', async function () {
+      const getSearchIndexesStub = sinon.stub().resolves(searchIndexes);
+      const dataProvider = {
+        getSearchIndexes: getSearchIndexesStub,
+      };
+      await renderIndexes(undefined, dataProvider, {
+        indexView: 'search-indexes',
+        isReadonlyView: true,
+        serverVersion: '8.1.0',
+      });
+
+      await waitFor(() => {
+        expect(screen.getByTestId('search-indexes-list')).to.exist;
+      });
+    });
+
+    it('renders correct empty state if isReadonlyView 8.1+ and has no indexes', async function () {
+      const getSearchIndexesStub = sinon.stub().resolves([]);
+      const dataProvider = {
+        getSearchIndexes: getSearchIndexesStub,
+      };
+      await renderIndexes(undefined, dataProvider, {
+        indexView: 'search-indexes',
+        isReadonlyView: true,
+        serverVersion: '8.1.0',
+      });
+
+      expect(screen.getByText('No search indexes yet')).to.be.visible;
+      expect(screen.getByText('Create Atlas Search Index')).to.be.visible;
+    });
+
+    it('renders correct empty state if isReadonlyView 8.0 and has no indexes', async function () {
+      const getSearchIndexesStub = sinon.stub().resolves([]);
+      const dataProvider = {
+        getSearchIndexes: getSearchIndexesStub,
+      };
+      await renderIndexes(undefined, dataProvider, {
+        indexView: 'search-indexes',
+        isReadonlyView: true,
+        serverVersion: '8.0.0',
+      });
+
+      expect(
+        screen.queryByText(
+          /Upgrade your cluster or manage search indexes on views in the Atlas UI./i
+        )
+      ).to.exist;
+      expect(screen.queryByText('No standard indexes')).to.exist;
+      expect(screen.queryByText('Create Atlas Search Index')).to.not.exist;
+    });
+
+    it('renders correct empty state if isReadonlyView <8.0 and has no indexes', async function () {
+      const getSearchIndexesStub = sinon.stub().resolves([]);
+      const dataProvider = {
+        getSearchIndexes: getSearchIndexesStub,
+      };
+      await renderIndexes(undefined, dataProvider, {
+        indexView: 'search-indexes',
+        isReadonlyView: true,
+        serverVersion: '7.0.0',
+      });
+
+      expect(
+        screen.queryByText(
+          /Upgrade your cluster to create search indexes on views./i
+        )
+      ).to.exist;
+      expect(screen.queryByText('No standard indexes')).to.exist;
+      expect(screen.queryByText('Create Atlas Search Index')).to.not.exist;
+    });
   });
 });