feat(compass-indexes): add index build progress COMPASS-9495 #7200

nbbeeken · 2025-08-15T04:15:25Z

Description

Add a percentage to the index build row in the table if it is in progress.

https://jira.mongodb.org/browse/COMPASS-9495

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 - parity with legacy DE
Dependency update
Misc

Open Questions

For reviewers:

Did I make good use of hooks by writing useIndexProgress?
- No 😅
The getInProgressIndexInfo used to just list stub indexes because even in progress ones would be listed as "ready" while they continued to build on the server. We now will list "real" indexes via this function. Is that the right approach?

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)

Screen.Recording.2025-08-15.at.2.29.25.PM.mov

index_finish.mov

Copilot

Pull Request Overview

This PR adds index build progress tracking to the MongoDB Compass indexes table, showing a percentage indicator when indexes are being built. The implementation introduces a new hook for polling index progress via currentOp command and updates the UI to display build progress and a spinner for in-progress indexes.

Adds useIndexProgress hook for tracking index build progress via polling
Updates Redux state to track progress percentage for in-progress indexes
Modifies UI components to display progress indicators and spinners for building indexes

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
`test/setup-store.ts`	Adds mock `currentOp` method to test data service
`src/stores/store.ts`	Extends data service type to include `currentOp` for progress tracking
`src/modules/regular-indexes.ts`	Adds progress tracking logic, new actions, and `getIndexesProgress` thunk
`src/modules/regular-indexes.spec.ts`	Adds tests for index progress tracking functionality
`src/hooks/use-index-progress.ts`	New custom hook for managing index build progress polling
`src/components/regular-indexes-table/regular-indexes-table.tsx`	Integrates progress hook and updates index filtering logic
`src/components/regular-indexes-table/regular-indexes-table.spec.tsx`	Updates tests to mock the progress hook
`src/components/regular-indexes-table/regular-index-actions.tsx`	Adds progress display UI with spinner and percentage

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

packages/compass-indexes/src/hooks/use-index-progress.ts

packages/compass-indexes/src/components/regular-indexes-table/regular-index-actions.tsx

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

packages/compass-indexes/src/hooks/use-index-progress.ts

packages/compass-indexes/src/components/regular-indexes-table/regular-index-actions.tsx

gribnoysup · 2025-08-22T07:24:02Z

packages/compass-indexes/src/components/regular-indexes-table/in-progress-index-actions.tsx

 };

+const styles = css({


Super nit: it's a good practice to give this a more descriptive name, something like indexActionsContainerStyles

gribnoysup · 2025-08-22T07:24:32Z

packages/compass-indexes/src/components/regular-indexes-table/in-progress-index-actions.tsx

+    <div className={styles}>
+      {isBuilding && (
+        <>
+          <Body>Building... {progress | 0}%</Body>


Nit

Suggested change

<Body>Building... {progress | 0}%</Body>

<Body>Building… {progress | 0}%</Body>

gribnoysup · 2025-08-22T07:25:45Z

packages/compass-indexes/src/components/regular-indexes-table/regular-index-actions.tsx

+  display: 'flex',
+  alignItems: 'center',
+  justifyContent: 'flex-end',
+  gap: '8px',


For spacing we always try to use the spacing export from compass-components / leafygreen if value is available

Suggested change

gap: '8px',

gap: spacing[200],

gribnoysup · 2025-08-22T07:26:20Z

packages/compass-indexes/src/components/regular-indexes-table/in-progress-index-actions.tsx

+  display: 'flex',
+  alignItems: 'center',
+  justifyContent: 'flex-end',
+  gap: '8px',


Ditto spacing

gribnoysup · 2025-08-22T07:26:27Z

packages/compass-indexes/src/components/regular-indexes-table/in-progress-index-actions.tsx

+        <>
+          <Body>Building... {progress | 0}%</Body>
+          <SpinLoader
+            size={16}


Ditto spacing

gribnoysup · 2025-08-22T07:42:48Z

packages/data-service/src/data-service.ts

+            _id: '$command.indexes.name',
+            progress: { $first: '$progress' },
+          },
+        }, // group on index name


I guess you can just add something like { $project: { progress: { $floor: { $divide: ['$progress.done', '$progress.total'] } } } } here and leave all the work of calculating the values the server 🙂

Well I depend on the value not being floored but otherwise SGTM!

gribnoysup · 2025-08-22T07:43:40Z

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

-      // only be possible in cases of "index with the same name already exists")
+      // Keep in-progress indexes that are still actively building, but remove:
+      // 1. Failed indexes (status: 'failed')
+      // 2. Completed indexes (real index exists and progress >= 100%)


I don't see this filtering on progress value happening, seems like we're keeping them as regular ones at the moment, is this comment outdated?

Yea let's just use the comments inside the filtering to reduce confusion

gribnoysup · 2025-08-22T07:47:08Z

packages/compass-indexes/src/components/regular-indexes-table/in-progress-index-actions.tsx

@@ -43,12 +56,27 @@ const IndexActions: React.FunctionComponent<IndexActionsProps> = ({
    [onDeleteFailedIndexClick, index]
  );

+  const progress = index.buildProgress * 100;
+  const isBuilding = progress > 0 && progress < 100;


I'm not sure I follow this logic, we either have these in "in-progress" bucket or in "regular", how are we expecting this UI to show up for both?

Perhaps I've over engineered a bit, and I can confirm this again. IIUC the inprogress state is a "fake" one to make the UI show the user's index in the table right away after they create it. It changes to "ready" as soon as we see the index in a listIndexes response. I think the progress logic is left over here from when I would show users 0% when we had a true 0 value. I think I can remove this.

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

nbbeeken force-pushed the COMPASS-9495 branch from 002fefc to 3dc8abd Compare August 15, 2025 18:31

nbbeeken added the release notes label Aug 15, 2025

nbbeeken added 4 commits August 15, 2025 15:18

feat(compass-indexes): add index build progress COMPASS-9495

48dd989

fix: tests

500b292

fix: switch back to 10s intervals and round the number at the component

e88e0d0

chore: dont need math

0a570dd

nbbeeken force-pushed the COMPASS-9495 branch from 0d117da to 0a570dd Compare August 15, 2025 19:18

nbbeeken marked this pull request as ready for review August 15, 2025 19:18

Copilot AI review requested due to automatic review settings August 15, 2025 19:18

nbbeeken requested a review from a team as a code owner August 15, 2025 19:18

Copilot AI reviewed Aug 15, 2025

View reviewed changes

chore: copilot

09d3ede

gribnoysup reviewed Aug 18, 2025

View reviewed changes

packages/compass-indexes/src/hooks/use-index-progress.ts Outdated Show resolved Hide resolved

nbbeeken added 3 commits August 18, 2025 16:11

fix: move index progress to data-service

c24c74c

fix hook deps

af849dd

fix: styles and types

7498e14

gribnoysup reviewed Aug 19, 2025

View reviewed changes

packages/compass-indexes/src/components/regular-indexes-table/regular-index-actions.tsx Outdated Show resolved Hide resolved

nbbeeken added 2 commits August 19, 2025 10:50

test: buildProgress display

70beee2

fix: styles

7a21889

gribnoysup reviewed Aug 22, 2025

View reviewed changes

nbbeeken added 6 commits August 22, 2025 14:08

fix: rename indexActionsContainerStyles

e84a25e

fix: use …

14d3c33

fix: spacing

417a28c

docs: comments on filter

1847d51

feat: make the agg run the division

7f51791

fix: remove progress from "in-progress"

180dfaf

nbbeeken requested a review from gribnoysup August 22, 2025 19:09

	<Body>Building... {progress \| 0}%</Body>
	<Body>Building… {progress \| 0}%</Body>

feat(compass-indexes): add index build progress COMPASS-9495 #7200

Are you sure you want to change the base?

feat(compass-indexes): add index build progress COMPASS-9495 #7200

Uh oh!

Conversation

nbbeeken commented Aug 15, 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!

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!

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!

gribnoysup Aug 22, 2025 • 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!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

nbbeeken commented Aug 15, 2025 •

edited

Loading

gribnoysup Aug 22, 2025 •

edited

Loading