feat(compass-indexes): Refactor read/writability of search and regular indexes COMPASS-10310 by JimmyChoiMDB · Pull Request #7778 · mongodb-js/compass

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.

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

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

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

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

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

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

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

gribnoysup · 2026-02-10T08:12:32Z

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

+  isSearchIndexesReadable: boolean;
+  isSearchIndexesWritable: boolean;
+} {
+  const { isWritable, isReadonlyView, isSearchIndexesSupported } = useSelector(


Please read the compass development guide section on redux, we are avoiding use of redux hooks for components and use connect instead (the reasoning is explained in the doc). If you want to encapsulate this logic, please make it into a selector function, not a hook

got it, converted the hook into a selector function

gribnoysup · 2026-02-10T08:14:46Z

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

+      getIsRegularIndexesReadable(isReadonlyView);
+    if (
+      !isRegularIndexesReadable ||
+      !isWritable // offline-mode, cannot fetch


This is a misleading comment, isWritable can be just connection to a node in a cluster where topology doesn't allow writes

fixed the comment to be less misleading.

also i only added this because there was a test checking for this in search-indexes.spec.ts

isWritable itself seems like a bit of a misnomer, this is describing a non-fetchable or non-refreshable condition

mabaasit · 2026-02-10T14:08:11Z

...ss-indexes/src/components/view-incompatible-components/view-pipeline-incompatible-banner.tsx

+};
+
+const mapState = ({ searchIndexes }: RootState) => ({
+  searchIndexes: searchIndexes.indexes,


Suggested change

searchIndexes: searchIndexes.indexes,

hasNoSearchIndexes: searchIndexes.indexes.length === 0,

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

mabaasit · 2026-02-11T09:28:55Z

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

+    })(getState());
+
+    if (
+      !isRegularIndexesReadable ||


With isWritable gaurd, i am wondering now if we should clear this out. If user already had a list of indexes fetched and somehow the topology is not writable anymore, should we clear it? Same for search indexes 🤔

i do think adding || !isWritable here either incorrect or at least misleading. i think it depends on how you expect offline-mode to behave - do you want to show the indexes we've fetched before and show stale data, or not show anything at all. that might be a question for product.

Currently we are not hiding any data for this state (!isWritable) at most of the places, but are introducing it here. I think we should align how we are handling things currently and we can create a follow up for this.

sounds good, created https://jira.mongodb.org/browse/COMPASS-10357 and added a TODO

mabaasit · 2026-02-11T13:07:59Z

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

+    const { atlasMetadata } = connectionInfoRef.current;
+    const { isRegularIndexesReadable } = selectReadWriteAccess({
+      isAtlas: !!atlasMetadata,
+      ...preferences.getPreferences(),


Do we need to pass all of them here?

technically isRegularIndexesReadable is just !isReadonlyView, so we dont need them. but the selector function requires all inputs as parameters

I meant with ...preferences.getPreferences(), you are literally passing all the preferences to the selectReadWriteAccess method. We can be explicit in passing only values this function needs.

yeah makes sense. fixed

mabaasit · 2026-02-13T08:00:44Z

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

              variant="primary"
              size="small"
-              disabled={!isViewPipelineSearchQueryable}
+              // TODO: COMPASS-10353 disable for other non-writable cases as well


Suggested change

// TODO: COMPASS-10353 disable for other non-writable cases as well

// TODO(COMPASS-10353): disable for other non-writable cases as well

This is how we are adding todos in the codebase.

ah got it, thanks

mabaasit · 2026-02-13T08:15:55Z

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

+    const { atlasMetadata } = connectionInfoRef.current;
+    const { isRegularIndexesReadable } = selectReadWriteAccess({
+      isAtlas: !!atlasMetadata,
+      ...preferences.getPreferences(),


I meant with ...preferences.getPreferences(), you are literally passing all the preferences to the selectReadWriteAccess method. We can be explicit in passing only values this function needs.

mabaasit · 2026-02-13T08:19:35Z

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

+    })(getState());
+
+    if (
+      !isRegularIndexesReadable ||


Currently we are not hiding any data for this state (!isWritable) at most of the places, but are introducing it here. I think we should align how we are handling things currently and we can create a follow up for this.

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

gribnoysup reviewed Feb 10, 2026

View reviewed changes

Jimmy Choi and others added 4 commits February 10, 2026 13:58

change from hook to selector fn and tests

b68acee

change from hook to selector fn and tests

5368b6e

regular-indexes-table

a3d4c82

regular-indexes-table imports

dbb42f0

mabaasit reviewed Feb 11, 2026

View reviewed changes

JimmyChoiMDB added 3 commits February 11, 2026 12:11

fixes

feb6017

fixes

7af961d

Merge branch 'main' into COMPASS-10310-v2

6f87c7b

JimmyChoiMDB requested review from gribnoysup and mabaasit and removed request for mabaasit February 12, 2026 18:15

mabaasit reviewed Feb 13, 2026

View reviewed changes

JimmyChoiMDB added 2 commits February 13, 2026 00:46

Merge branch 'main' into COMPASS-10310-v2

e7152f1

fixes

404abcd

JimmyChoiMDB requested a review from mabaasit February 13, 2026 08:49

	searchIndexes: searchIndexes.indexes,
	hasNoSearchIndexes: searchIndexes.indexes.length === 0,

	// TODO: COMPASS-10353 disable for other non-writable cases as well
	// TODO(COMPASS-10353): disable for other non-writable cases as well

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!

Uh oh!

Uh oh!

Uh oh!

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!

JimmyChoiMDB Feb 10, 2026 • 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!

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!

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!

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

JimmyChoiMDB commented Feb 9, 2026 •

edited

Loading

JimmyChoiMDB Feb 10, 2026 •

edited

Loading