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

DarshanaVenkatesh · 2025-08-08T23:41:58Z

Description

Change indexes tab to support views. Figma
COMPASS-9667

Views are supported on Compass for mongodb version 8.1+ and on Data Explorer for 8.0+.
We display banner to upgrade cluster and "no standard indexes" empty state for Compass <8.1 and Data Explorer <8.0
Banner's text changes slightly for Compass 8.0
We display banner linking to atlas indexes list and "no standard indexes" empty state for Data Explorer 8.0+
We display create search index and refresh buttons, indexes (disabled w/tooltip)/searchIndexes tabs and "no search indexes" empty state if Compass 8.1+ with no indexes
We display search index list if Compass 8.1+

compass_view_support_indexes.mov

Checklist

New tests and/or benchmarks are included
Documentation is changed or added
If this change updates the UI, screenshots/videos are added and a design review is requested
I have signed the MongoDB Contributor License Agreement (https://www.mongodb.com/legal/contributor-agreement)

Motivation and Context

Bugfix
New feature
Dependency update
Misc

Open Questions

Dependents

Types of changes

Backport Needed
Patch (non-breaking change which fixes an issue)
Minor (non-breaking change which adds functionality)
Major (fix or feature that would cause existing functionality to change)

Copilot

Pull Request Overview

This PR adds view support to the indexes tab for MongoDB versions 8.0+ and 8.1+, enabling search index management on views with version-specific functionality. The implementation includes new banners, empty states, and conditional rendering based on MongoDB version and environment (Compass vs Data Explorer).

Introduces version-specific banners and empty states for views with different MongoDB versions
Adds conditional fetching and rendering of search indexes for readonly views
Updates the indexes toolbar to support view-specific functionality and disable standard indexes tab for views

Reviewed Changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
`atlas-upgrade-cluster-link.ts`	New utility function to generate Atlas cluster upgrade links
`store.ts`	Updated search index fetching logic to support views on MongoDB 8.0+
`search-indexes.ts`	Modified fetchIndexes to allow search index fetching for views on MongoDB 8.1+
`view-version-incompatible-banners.tsx`	New component providing version-specific upgrade banners for views
`indexes.tsx`	Updated main component to handle view support with conditional rendering and banners
`indexes.spec.tsx`	Added test coverage for view support scenarios
`indexes-toolbar.tsx`	Enhanced toolbar with view-specific controls and automatic tab selection
`indexes-toolbar.spec.tsx`	Added tests for toolbar behavior with readonly views

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

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

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

...dexes/src/components/view-version-incompatible-banners/view-version-incompatible-banners.tsx

gribnoysup · 2025-08-13T07:18:57Z

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

+  const mongoDBMajorVersion = parseFloat(
+    serverVersion.split('.').slice(0, 2).join('.')
+  );


We use semver package for handling mongodb version comparison, you can't really rely fully on the version here being fully parseable as a number (because it's not). There are some examples in the code here that already use semver for similar checks (see serverSupportsSearchIndexManagement for example), please update your code to the similar pattern

Let me know if the way I changed this works! The majority of cases check 8.1+ but i had a few cases that differed so created a function that defaulted to 8.1+ but let me override which operator and comparison version.

gribnoysup · 2025-08-13T07:20:13Z

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

+  useEffect(() => {
+    // If the view is readonly, set the default tab to 'search-indexes'
+    if (isReadonlyView && indexView !== 'search-indexes') {
+      onIndexViewChanged('search-indexes'); // Update redux state
+    }
+  }, [indexView, isReadonlyView, onIndexViewChanged]);


Redux store owns this state and redux store reducer controls how exactly this state is set, this shouldn't be an effect in the view, please move this logic to the store

Added an initial state constant for views and modified the store initialization to have this when it's readOnly!

gribnoysup

General question: can you clarify why we are making a distinction in the verisons here for compass and for DE? They are ultimately connecting to the same clusters, so it doesn't look right to me that we are making a difference here between the two based on the server minor version

gribnoysup · 2025-08-14T07:35:24Z

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

  css,
-  spacing,
+  DropdownMenuButton,


Just a small note for the future, I'm not sure what's doing the re-ordering of the imports here, we don't have this style requirement in compass, but it makes reviewing this code way harder because it's not clear what exactly changed in the imports. If it's possible at all not to do, that would be very helpful 🙂

Yup, will keep this in mind. I think it's probably an intelllij setting I have set up that I can disable.

gribnoysup · 2025-08-14T07:46:03Z

packages/compass-indexes/src/modules/search-indexes.ts

+};*/
+
+const MIN_VERSION_FOR_VIEW_SEARCH_COMPATIBILITY_COMPASS = '8.1.0';
+export const compareVersionForViewSearchCompatibility = (


If (see my other comment) we need so many different comparison methods, I think we should still keep the pattern of having focused, clearly named, check methods instead of a very generic compare one, preferably explaining the reason why 🙂 Looking at current code, there is no way at all right now to say why exactly those arbitrary checks are used and this makes it very hard to maintain long term

Got it! I'll introduce individual comparison methods/try to limit the comparisons I make.

DarshanaVenkatesh · 2025-08-14T16:52:48Z

General question: can you clarify why we are making a distinction in the verisons here for compass and for DE? They are ultimately connecting to the same clusters, so it doesn't look right to me that we are making a difference here between the two based on the server minor version

Hi! So the reason is that in data explorer we are trying to provide cta for them to go to atlas search list and create indexes from there (The reason being is that we can create search indexes on atlas for 8.0+ while compass can only create indexes for 8.1+.)

gribnoysup

Overall looks neat! Left a few notes, most importantly let's replace the button onclick handler with passing a href property

...dexes/src/components/view-version-incompatible-banners/view-version-incompatible-banners.tsx

gribnoysup · 2025-08-18T15:58:05Z

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

@@ -162,8 +217,17 @@ export function Indexes({
        }
      >
        <div className={indexesContainersStyles}>
-          {!isReadonlyView && !enableAtlasSearchIndexes && (
-            <AtlasIndexesBanner
+          {isReadonlyView && (


Nit: doesn't need to addressed immediately, but I do think this code can be reworked a bit, at a glance it's now pretty tricky to read, there are overlapping states here that should never be rendered together, but the way the rendering part is written it's really hard to understand that without computing all the conditions in your head

Ah got it, i'll look into it again and see if I can make it more clear in a later pr.

gribnoysup · 2025-08-18T15:59:41Z

packages/compass-indexes/package.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",


There usually should be a corresponding package-lock update. If you added this one manually, you can run npm install on your machine to update the lockfile

ran npm install and pushed!

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

gribnoysup

Thanks for incorporating the requested changes, feel free to merge as soon as CI is green

gribnoysup · 2025-08-18T16:36:49Z

package-lock.json

@@ -43729,228 +43729,6 @@
        "mocha": "^10.2.0"
      }
    },
-    "packages/bson-transpilers/node_modules/@typescript-eslint/eslint-plugin": {


Just wanted to note, this looks kinda unrelated, but this is okay to keep here in changes and merge: seems like this got in by accident with one of the recently merged PRs that was hanging in open state for too long, this is a harmless clean-up for package-lock (and we do have a CI task that validates that) even though it's not really related to your changes

If someone gets to fixing this on main before you merge, this will probably cause a package-lock conflict, those are annoying to deal with, so the easiest thing to do is always to checkout package-lock from main and run install again instead of trying to resolve the conflict

Ah very good to know, ty!

DarshanaVenkatesh added 11 commits August 7, 2025 13:23

add banners to indexes tab

0b4ab54

update banner to include data explorer versions

0c96520

fetching search indexes for view

6bc7021

fix indexes-toolbar

8cc8504

update ui

aaf0f70

Merge branch 'main' into COMPASS-9667

cdbbfc8

update indexes-toolbar test

481bbd4

add tests to indexes.spec.tsx

b9be029

only fetch indexes for version 8.1+

6d9d8b8

fix conditionals

8f2ec15

Merge branch 'main' into COMPASS-9667

5b976d3

DarshanaVenkatesh marked this pull request as ready for review August 12, 2025 20:53

Copilot AI review requested due to automatic review settings August 12, 2025 20:53

DarshanaVenkatesh requested a review from a team as a code owner August 12, 2025 20:53

Copilot AI reviewed Aug 12, 2025

View reviewed changes

change or to and

fbbb21f

mongodb-js deleted a comment from Copilot AI Aug 12, 2025

add to useEffect conditional

50cee9a

DarshanaVenkatesh changed the title ~~COMPASS-9667: Add view support to indexes tab~~ feat(compass-indexes): Add view support to indexes tab COMPASS-9667 Aug 12, 2025

github-actions bot added the feat label Aug 12, 2025

DarshanaVenkatesh added the no release notes Fix or feature not for release notes label Aug 12, 2025

DarshanaVenkatesh requested a review from JimmyChoiMDB August 12, 2025 21:15

DarshanaVenkatesh added 2 commits August 12, 2025 14:54

remove fetch for version

aa59476

add verison check back but remove from store

26e428b

gribnoysup reviewed Aug 13, 2025

View reviewed changes

pr review changes

73b536b

DarshanaVenkatesh requested a review from gribnoysup August 13, 2025 18:14

DarshanaVenkatesh and others added 2 commits August 13, 2025 11:28

move function

6961789

Merge branch 'main' into COMPASS-9667

f6cee34

DarshanaVenkatesh added 2 commits August 13, 2025 11:44

fix indexes-toolbar.spec

cd9de5b

fix initial state import

6c47264

gribnoysup reviewed Aug 14, 2025

View reviewed changes

DarshanaVenkatesh and others added 6 commits August 14, 2025 09:57

Merge branch 'main' into COMPASS-9667

4dccafe

cleanup comparisons

dad9efd

Merge branch 'main' into COMPASS-9667

815f210

remove de errors

f88bf80

Merge branch 'main' into COMPASS-9667

f7983f1

add missing dep

7bc8bb7

DarshanaVenkatesh requested a review from gribnoysup August 18, 2025 15:57

gribnoysup approved these changes Aug 18, 2025

View reviewed changes

DarshanaVenkatesh and others added 4 commits August 18, 2025 09:05

installed for lockfile

e060334

replace button onClick with href

3d29b2c

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

Merge branch 'main' into COMPASS-9667

0de5a0e

ran prettier

2833412

gribnoysup approved these changes Aug 18, 2025

View reviewed changes

DarshanaVenkatesh merged commit 19993bf into main Aug 18, 2025
79 of 82 checks passed

DarshanaVenkatesh deleted the COMPASS-9667 branch August 18, 2025 21:51

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

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

Uh oh!

Conversation

DarshanaVenkatesh commented Aug 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Motivation and Context

Open Questions

Dependents

Types of changes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gribnoysup left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DarshanaVenkatesh commented Aug 14, 2025

Uh oh!

gribnoysup left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gribnoysup left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

DarshanaVenkatesh commented Aug 8, 2025 •

edited

Loading

gribnoysup left a comment •

edited

Loading