feat(compass-indexes): Refactor read/writability of search and regular indexes COMPASS-10310 #7778

JimmyChoiMDB · 2026-02-09T20:33:36Z

Description

Add indexes-read-write-access.ts file in utils directory that exposes helper functions and hooks to determine whether the user can read or write search or regular indexes
Add is-view-search-compatible.ts file that exposes helper functions and hooks to determine whether view version is search compatible and view pipeline is search queryable
Moved banner and empty state components to separate files for easy reuse
No functional changes

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
If this change could impact the load on the MongoDB cluster, please describe the expected and worst case impact
I have signed the MongoDB Contributor License Agreement (https://www.mongodb.com/legal/contributor-agreement)

Motivation and Context

Bugfix
New feature
Dependency update
Misc

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

Refactors how Compass Indexes determines read/write access and view compatibility for regular vs search indexes, and extracts reusable UI pieces for view-incompatible states.

Changes:

Added shared utilities/hooks for index read/write access and view search compatibility.
Updated regular/search index fetching + UI rendering to use the new access/compat logic.
Extracted view-incompatibility banners/empty states into reusable components and updated tests accordingly.

Reviewed changes

Copilot reviewed 14 out of 15 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
packages/compass-indexes/test/setup-store.ts	Updates test preference defaults to include Atlas Search indexes enabled.
packages/compass-indexes/src/utils/is-view-search-compatible.ts	Adds hook + helpers for view version/pipeline search compatibility.
packages/compass-indexes/src/utils/indexes-read-write-access.ts	Adds hook + helpers for regular/search index read/write gating.
packages/compass-indexes/src/modules/search-indexes.ts	Refactors fetch gating for search indexes using new helpers + injected services.
packages/compass-indexes/src/modules/regular-indexes.ts	Refactors fetch gating for regular indexes using new helpers.
packages/compass-indexes/src/components/view-version-incompatible-banners/view-version-incompatible-banners.tsx	Removes inlined banner component (moved elsewhere).
packages/compass-indexes/src/components/view-incompatible-components/view-version-incompatible-banner.tsx	Adds extracted banner component for view version incompatibility.
packages/compass-indexes/src/components/view-incompatible-components/view-standard-indexes-incompatible-empty-state.tsx	Adds extracted empty state for standard views/regular index incompatibility messaging.
packages/compass-indexes/src/components/view-incompatible-components/view-pipeline-incompatible-banner.tsx	Adds extracted banner for view pipeline incompatibility.
packages/compass-indexes/src/components/search-indexes-table/search-indexes-table.tsx	Switches to new access/compat hooks; updates zero state + action gating.
packages/compass-indexes/src/components/search-indexes-table/search-indexes-table.spec.tsx	Updates tests to render with Redux Provider + store setup.
packages/compass-indexes/src/components/indexes/indexes.tsx	Replaces inline view-incompat components with extracted versions and new hooks.
packages/compass-indexes/src/components/indexes/indexes.spec.tsx	Updates a test description/expectation for new messaging behavior.
packages/compass-indexes/package.json	Removes @mongodb-js/connection-info dependency.

Copilot · 2026-02-10T00:51:56Z

packages/compass-indexes/src/utils/is-view-search-compatible.ts

+export function getIsViewVersionSearchCompatible(
+  serverVersion: string,
+  isAtlas: boolean
+): boolean {
+  return isAtlas
+    ? VIEW_PIPELINE_UTILS.isVersionSearchCompatibleForViewsDataExplorer(
+        serverVersion
+      )
+    : VIEW_PIPELINE_UTILS.isVersionSearchCompatibleForViewsCompass(
+        serverVersion
+      );
+}


getIsViewVersionSearchCompatible only keys off isAtlas, but prior behavior distinguished between managing search indexes in Compass (8.1+) vs deferring to Atlas UI/Data Explorer (8.0+). As written, Atlas connections will treat 8.0 as compatible even when Atlas Search indexes are enabled in Compass, which can incorrectly allow UI/actions/fetching on unsupported versions. Consider including the enableAtlasSearchIndexes (or an explicit 'manageInCompass' flag) in the compatibility calculation and using Compass compatibility when in-Compass management is enabled.

Copilot · 2026-02-10T00:51:57Z

...c/components/view-incompatible-components/view-standard-indexes-incompatible-empty-state.tsx

+      subTitle="Standard views use the indexes of the underlying collection. As a result, you
+           cannot create, drop or re-build indexes on a standard view directly, nor get a list of indexes on the view."


This JSX prop value appears to be a multi-line string literal wrapped in double quotes; in TS/JS, string literals can't contain raw newlines and this will fail to parse/compile. Use a template literal (backticks), string concatenation, or a single-line string (or JSX text via {...}) to avoid introducing a syntax error.

Suggested change

subTitle="Standard views use the indexes of the underlying collection. As a result, you

cannot create, drop or re-build indexes on a standard view directly, nor get a list of indexes on the view."

subTitle="Standard views use the indexes of the underlying collection. As a result, you cannot create, drop or re-build indexes on a standard view directly, nor get a list of indexes on the view."

Copilot · 2026-02-10T00:51:57Z

packages/compass-indexes/src/utils/indexes-read-write-access.ts

+  const { isWritable, isReadonlyView, isSearchIndexesSupported } = useSelector(
+    (state: RootState) => ({
+      serverVersion: state.serverVersion,
+      isWritable: state.isWritable,
+      isReadonlyView: state.isReadonlyView,
+      isSearchIndexesSupported: state.isSearchIndexesSupported,
+      collectionStats: state.collectionStats,
+    })
+  );


This useSelector returns a new object every time the store updates, which will force a rerender even when none of the selected values changed. Prefer selecting fields individually (multiple useSelector calls) or pass shallowEqual as the equality function, and avoid including fields in the selection object that aren't needed for this hook.

Suggested change

const { isWritable, isReadonlyView, isSearchIndexesSupported } = useSelector(

(state: RootState) => ({

serverVersion: state.serverVersion,

isWritable: state.isWritable,

isReadonlyView: state.isReadonlyView,

isSearchIndexesSupported: state.isSearchIndexesSupported,

collectionStats: state.collectionStats,

})

);

const isWritable = useSelector((state: RootState) => state.isWritable);

const isReadonlyView = useSelector(

(state: RootState) => state.isReadonlyView

);

const isSearchIndexesSupported = useSelector(

(state: RootState) => state.isSearchIndexesSupported

);

Copilot · 2026-02-10T00:51:57Z

packages/compass-indexes/src/utils/is-view-search-compatible.ts

+  const { serverVersion, collectionStats } = useSelector(
+    (state: RootState) => ({
+      serverVersion: state.serverVersion,
+      collectionStats: state.collectionStats,
+    })
+  );


Same pattern here: selecting into a freshly created object will trigger rerenders on any store update. Consider selecting serverVersion and collectionStats via separate selectors or using shallowEqual to prevent unnecessary rerenders.

Suggested change

const { serverVersion, collectionStats } = useSelector(

(state: RootState) => ({

serverVersion: state.serverVersion,

collectionStats: state.collectionStats,

})

);

const serverVersion = useSelector(

(state: RootState) => state.serverVersion

);

const collectionStats = useSelector(

(state: RootState) => state.collectionStats

);

Copilot · 2026-02-10T00:51:58Z

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

+  });
+
+  if (state) {
+    const newState = { ...store.getState(), ...state };
+    Object.assign(store.getState(), newState);
+  }
+


Mutating the object returned by store.getState() is not reliable in Redux tests (it bypasses reducers and may not notify subscribers). Prefer creating the store with a preloaded state (if supported by setupStore/activateIndexesPlugin), or dispatch actions to reach the desired state shape for the scenario under test.

Suggested change

});

if (state) {

const newState = { ...store.getState(), ...state };

Object.assign(store.getState(), newState);

}

...(state ?? {}),

});

Copilot · 2026-02-10T00:51:58Z

...ass-indexes/src/components/view-incompatible-components/view-version-incompatible-banner.tsx

+      <div className={viewContentStyles}>
+        <span>
+          Your MongoDB version is {serverVersion}. Creating and managing search
+          indexes on views {!isAtlas && 'in Compass'} is supported on MongoDB


Grammar: 'indexes ... is supported' should be 'indexes ... are supported' (plural subject).

Suggested change

indexes on views {!isAtlas && 'in Compass'} is supported on MongoDB

indexes on views {!isAtlas && 'in Compass'} are supported on MongoDB

Copilot · 2026-02-10T00:51:58Z

packages/compass-indexes/src/utils/indexes-read-write-access.ts

+export function getIsSearchIndexesReadable(
+  enableAtlasSearchIndexes: boolean,
+  isReadonlyView: boolean,
+  isViewVersionSearchCompatible: boolean,
+  isSearchIndexesSupported: boolean
+): boolean {
+  return (
+    enableAtlasSearchIndexes &&
+    (isReadonlyView ? isViewVersionSearchCompatible : isSearchIndexesSupported)
+  );
+}


New access/compat logic is central to the refactor and has multiple branching cases (readonly view vs collection, Atlas vs non-Atlas, version compatibility, pipeline queryability, preferences). Please add focused unit tests covering at least: (1) Atlas + enableAtlasSearchIndexes=true + serverVersion 8.0 (should be treated as incompatible for in-Compass management if that’s the intended rule), (2) Atlas + enableAtlasSearchIndexes=false + serverVersion 8.0, and (3) non-Atlas + serverVersion 8.0/8.1 boundaries, so regressions are caught.

add utils files and refactor read/writability of indexes

0bad5f2

github-actions bot added the feat label Feb 9, 2026

JimmyChoiMDB added feature flagged PRs labeled with this label will not be included in the release notes of the next release and removed feat labels Feb 9, 2026

github-actions bot added the feat label Feb 9, 2026

Jimmy Choi added 5 commits February 9, 2026 12:45

add offline-mode isWritable condition

aad5e60

check

5fe8ce2

Merge branch 'main' into COMPASS-10310-v2

6cdeefc

check

cdb52f2

fix test

1c64283

JimmyChoiMDB requested a review from mabaasit February 10, 2026 00:49

JimmyChoiMDB marked this pull request as ready for review February 10, 2026 00:49

JimmyChoiMDB requested a review from a team as a code owner February 10, 2026 00:49

Copilot AI review requested due to automatic review settings February 10, 2026 00:49

Copilot AI reviewed Feb 10, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(compass-indexes): Refactor read/writability of search and regular indexes COMPASS-10310 #7778

feat(compass-indexes): Refactor read/writability of search and regular indexes COMPASS-10310 #7778

Uh oh!

JimmyChoiMDB commented Feb 9, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 10, 2026

Uh oh!

Copilot AI Feb 10, 2026

Uh oh!

Copilot AI Feb 10, 2026

Uh oh!

Copilot AI Feb 10, 2026

Uh oh!

Copilot AI Feb 10, 2026

Uh oh!

Copilot AI Feb 10, 2026

Uh oh!

Copilot AI Feb 10, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

		subTitle="Standard views use the indexes of the underlying collection. As a result, you
		cannot create, drop or re-build indexes on a standard view directly, nor get a list of indexes on the view."

	indexes on views {!isAtlas && 'in Compass'} is supported on MongoDB
	indexes on views {!isAtlas && 'in Compass'} are supported on MongoDB

feat(compass-indexes): Refactor read/writability of search and regular indexes COMPASS-10310 #7778

Are you sure you want to change the base?

feat(compass-indexes): Refactor read/writability of search and regular indexes COMPASS-10310 #7778

Uh oh!

Conversation

JimmyChoiMDB commented Feb 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Motivation and Context

Types of changes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

JimmyChoiMDB commented Feb 9, 2026 •

edited

Loading