RI-7942: vector search onboarding - create index by dantovska · Pull Request #5618 · redis/RedisInsight

dantovska · 2026-03-10T14:23:41Z

What

Adds a guided onboarding tour for the "Create Index from Existing Data" flow on the Vector Search page. The tour walks users through 6 steps: defining the index schema, index prefix, field name, sample value, indexing type & options, and the create index command view.
Key changes:

Onboarding context and provider to manage step navigation (next, back, skip) with localStorage persistence
Popover component that anchors to each relevant UI element and displays step-specific content
Step constants with content for each onboarding step, including an inline indexing type reference
Integration into the create index page header, toolbar, and index detail columns

Additional:

Fix for select key onboarding popover whitespace rendering

Testing

Navigate to Vector Search Page
Create index from existing data
Select a key
Onboarding flow triggers

Few Screenshots:

First step

Light	Dark

Middle step

Light	Dark

Final step

Light	Dark

Note

Medium Risk
Moderate UI behavior change: introduces new onboarding state machine with localStorage persistence and forces tab switching to Command view during the final step, which could affect navigation/state if edge cases were missed.

Overview
Adds a new Create Index onboarding tour for Vector Search (existing-data flow), implemented as a step-based context/provider persisted via BrowserStorageItem.vectorSearchCreateIndexOnboarding.

Introduces CreateIndexOnboardingPopover and step content/constants, and wires popovers onto key UI touchpoints (header, index prefix control, table column headers, and view toggle). The tour auto-starts once fields are detected, auto-switches to Command view on the final step, and reuses the new IndexingTypeContent for both onboarding and the existing indexing-type tooltip.

Also makes AnchorPosition publicly exportable from RiPopover types, tweaks spacing in SelectKeyOnboardingPopover, adds auto-dismiss when a key is selected, and removes an unused apiHelper fixture from an e2e test.

^{Written by Cursor Bugbot for commit e4a3c56. This will update automatically on new commits. Configure here.}

jit-ci · 2026-03-10T14:25:44Z

🛡️ Jit Security Scan Results

✅ No security findings were detected in this PR

^{Security scan by Jit}

...ui/src/pages/vector-search/context/create-index-onboarding/CreateIndexOnboardingProvider.tsx

valkirilov · 2026-03-10T14:31:48Z

...rc/pages/vector-search/components/create-index-onboarding/CreateIndexOnboarding.constants.ts

+    title: 'Index prefix',
+    body: [
+      'Controls which keys are included in the index. All keys starting with this prefix will be indexed.',
+      React.createElement(


nit: Maybe create the file to be tsx and make this more readable?

Also, the text is matching 1:1 with the tooltip for the same column, so I wonder whether we can reuse it, instead of duplicating it 🤔

redisinsight/ui/src/pages/vector-search/components/index-details/components/FieldTypeCell/FieldTypeTooltip.tsx

valkirilov · 2026-03-10T14:36:22Z

.../src/pages/vector-search/components/create-index-onboarding/CreateIndexOnboardingPopover.tsx

+              content.body.map((item, index) =>
+                typeof item === 'string' ? (
+                  <Text
+                    // eslint-disable-next-line react/no-array-index-key


nit: It's minor, but we can get red of it, by adding some prefix to the key, like bla-bla-${index}

github-actions · 2026-03-10T14:38:25Z

Code Coverage - Frontend unit tests

St.^❔	Category	Percentage	Covered / Total
🟢	Statements	82.17%	22978/27963
🟡	Branches	67.43%	9667/14337
🟡	Functions	77.19%	6228/8068
🟢	Lines	82.61%	22491/27224

Test suite run success

6370 tests passing in 761 suites.

Report generated by 🧪jest coverage report action from e4a3c56

Adds context, provider, and tests for the create index onboarding flow on the vector search page. References: #RI-7942 Made-with: Cursor

Defines onboarding steps, step content, and types for the create index onboarding flow. References: #RI-7942 Made-with: Cursor

References: #RI-7942 Made-with: Cursor

Adds the onboarding popover with step navigation (next, back, skip, close), step content rendering, indexing type content, styles, barrel file, and tests. References: #RI-7942 Made-with: Cursor

Export AnchorPosition from RiPopover types for use by onboarding popover. Add vectorSearchCreateIndexOnboarding storage key. References: #RI-7942 Made-with: Cursor

Wrap create index page with onboarding provider, add popover anchors to header, toolbar, and index detail columns. References: #RI-7942 Made-with: Cursor

… test Split Text component for proper paragraph break and add test for auto-dismiss when a key is selected. References: #RI-7942 Made-with: Cursor

Move body rendering into constants as ready-to-render JSX, removing conditional type checks from the popover component. References: #RI-7942 Made-with: Cursor

Move duplicated field type list and descriptions into a shared IndexingTypeContent component used by both FieldTypeTooltip and the create index onboarding popover. References: #RI-7942 Made-with: Cursor

…g provider The nextStep callback had markOnboardingSeen() and setIsActive(false) inside the setCurrentStep updater function, which must be pure. Moved completion side effects to a useEffect that reacts to the state transition instead. References: #RI-7942 Made-with: Cursor

Automatically switches to command view when the onboarding reaches the CommandView step, and restores the previous tab when leaving that step. References: #RI-7942 Made-with: Cursor

.../src/pages/vector-search/pages/VectorSearchCreateIndexPage/components/CreateIndexToolbar.tsx

Combine early return with condition check into a single guard clause. References: #RI-7942 Made-with: Cursor

…search-onboarding-create-index

cursor

Cursor Bugbot has reviewed your changes and found 1 potential issue.

^{Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.}

cursor · 2026-03-11T16:34:33Z

.../src/pages/vector-search/pages/VectorSearchCreateIndexPage/components/CreateIndexToolbar.tsx

+      setActiveTab(tabBeforeOnboardingRef.current)
+      tabBeforeOnboardingRef.current = null
+    }
+  }, [currentStep, isActive])


Tab restore ref lost on toolbar unmount/remount

Low Severity

tabBeforeOnboardingRef is a local useRef that stores the user's tab before auto-switching to Command view. If the toolbar unmounts while onboarding is on the CommandView step (e.g., because the user selects a different key, causing fields to become empty), the ref is destroyed. When the toolbar remounts, a new ref is initialized to null, and the effect re-runs, saving the already-switched Command tab as the "original." Subsequent tab restoration incorrectly restores to Command instead of the user's actual prior tab (typically Table).

dantovska self-assigned this Mar 10, 2026

dantovska requested review from ArtemHoruzhenko, DimoHG, KrumTy, pawelangelow, pd-redis and valkirilov as code owners March 10, 2026 14:23

dantovska changed the title ~~Fe/feature/ri 7942/vector search onboarding create index~~ RI-7942: vector search onboarding - create index Mar 10, 2026

cursor bot reviewed Mar 10, 2026

View reviewed changes

...ui/src/pages/vector-search/context/create-index-onboarding/CreateIndexOnboardingProvider.tsx Show resolved Hide resolved

valkirilov reviewed Mar 10, 2026

View reviewed changes

dantovska added 12 commits March 11, 2026 13:19

feat(ui): add create index onboarding context and provider

0bfd894

Adds context, provider, and tests for the create index onboarding flow on the vector search page. References: #RI-7942 Made-with: Cursor

feat(ui): add create index onboarding step constants

a6c79ce

Defines onboarding steps, step content, and types for the create index onboarding flow. References: #RI-7942 Made-with: Cursor

refactor(ui): update onboarding context imports to new constants path

3073988

References: #RI-7942 Made-with: Cursor

add children null since it is necessary

3bdd35b

feat(ui): add create index onboarding popover component

ec41a92

Adds the onboarding popover with step navigation (next, back, skip, close), step content rendering, indexing type content, styles, barrel file, and tests. References: #RI-7942 Made-with: Cursor

feat(ui): export AnchorPosition type and add onboarding storage key

0f9b079

Export AnchorPosition from RiPopover types for use by onboarding popover. Add vectorSearchCreateIndexOnboarding storage key. References: #RI-7942 Made-with: Cursor

feat(ui): integrate create index onboarding into page components

4462ac6

Wrap create index page with onboarding provider, add popover anchors to header, toolbar, and index detail columns. References: #RI-7942 Made-with: Cursor

fix(ui): fix select key onboarding popover whitespace and add dismiss…

01d5723

… test Split Text component for proper paragraph break and add test for auto-dismiss when a key is selected. References: #RI-7942 Made-with: Cursor

refactor(ui): convert onboarding constants to tsx and simplify popover

bc6a82e

Move body rendering into constants as ready-to-render JSX, removing conditional type checks from the popover component. References: #RI-7942 Made-with: Cursor

refactor(ui): extract shared IndexingTypeContent component

e12e4e5

Move duplicated field type list and descriptions into a shared IndexingTypeContent component used by both FieldTypeTooltip and the create index onboarding popover. References: #RI-7942 Made-with: Cursor

feat(ui): auto-switch to command view during onboarding step

afa257f

Automatically switches to command view when the onboarding reaches the CommandView step, and restores the previous tab when leaving that step. References: #RI-7942 Made-with: Cursor

dantovska force-pushed the fe/feature/RI-7942/vector-search-onboarding-create-index branch from c28bca2 to afa257f Compare March 11, 2026 11:46

cursor bot reviewed Mar 11, 2026

View reviewed changes

.../src/pages/vector-search/pages/VectorSearchCreateIndexPage/components/CreateIndexToolbar.tsx Show resolved Hide resolved

.../src/pages/vector-search/pages/VectorSearchCreateIndexPage/components/CreateIndexToolbar.tsx Show resolved Hide resolved

dantovska added 2 commits March 11, 2026 18:16

refactor(ui): simplify onboarding tab-switch guard in CreateIndexToolbar

aeadad2

Combine early return with condition check into a single guard clause. References: #RI-7942 Made-with: Cursor

Merge remote-tracking branch 'origin' into fe/feature/RI-7942/vector-…

e4a3c56

…search-onboarding-create-index

cursor bot reviewed Mar 11, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

RI-7942: vector search onboarding - create index#5618

RI-7942: vector search onboarding - create index#5618
dantovska wants to merge 14 commits intomainfrom
fe/feature/RI-7942/vector-search-onboarding-create-index

dantovska commented Mar 10, 2026 •

edited by cursor bot

Loading

Uh oh!

jit-ci bot commented Mar 10, 2026 •

edited

Loading

Uh oh!

Uh oh!

valkirilov Mar 10, 2026

Uh oh!

valkirilov Mar 10, 2026

Uh oh!

valkirilov Mar 10, 2026

Uh oh!

github-actions bot commented Mar 10, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

cursor bot left a comment

Uh oh!

cursor bot Mar 11, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

dantovska commented Mar 10, 2026 • edited by cursor bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What

Testing

Uh oh!

jit-ci bot commented Mar 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🛡️ Jit Security Scan Results

Uh oh!

Uh oh!

valkirilov Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

valkirilov Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

valkirilov Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Mar 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Coverage - Frontend unit tests

Test suite run success

Uh oh!

Uh oh!

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Uh oh!

cursor bot Mar 11, 2026

Choose a reason for hiding this comment

Tab restore ref lost on toolbar unmount/remount

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

dantovska commented Mar 10, 2026 •

edited by cursor bot

Loading

jit-ci bot commented Mar 10, 2026 •

edited

Loading

github-actions bot commented Mar 10, 2026 •

edited

Loading