fix(compare): require configurationId by Haroenv · Pull Request #7306 · algolia/instantsearch

Haroenv · 2026-10-16T15:24:12Z

Summary

connectCompare throws The configurationId option is required. when it is created without a configurationId, and the option is typed as required. Every compare widget carries its own ID, so the shared-store ID and the click-time throw in compare() are removed.
compareBar (JS) and <CompareBar> (React) get the check from the connector, so they no longer have their own guards.
useCompare now takes required props. The React default-theme example passes the ID to its per-hit useCompare call.

Result

A missing configurationId fails when the widget is created or rendered, instead of inside the Compare button's click handler. Tests cover the connector usage error; the widget and React tests pass a configurationId.

🤖 Generated with Claude Code

codacy-production · 2026-10-16T15:25:42Z

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

🟢 Metrics 9 complexity

Metric Results

Complexity 9

View in Codacy

_{TIP This summary will be updated as you push new changes.}

pkg-pr-new · 2026-10-16T15:27:54Z

More templates

algoliasearch-helper

npm i https://pkg.pr.new/algolia/instantsearch/algoliasearch-helper@7306

instantsearch-ui-components

npm i https://pkg.pr.new/algolia/instantsearch/instantsearch-ui-components@7306

instantsearch.css

npm i https://pkg.pr.new/algolia/instantsearch/instantsearch.css@7306

instantsearch.js

npm i https://pkg.pr.new/algolia/instantsearch/instantsearch.js@7306

react-instantsearch

npm i https://pkg.pr.new/algolia/instantsearch/react-instantsearch@7306

react-instantsearch-core

npm i https://pkg.pr.new/algolia/instantsearch/react-instantsearch-core@7306

react-instantsearch-nextjs

npm i https://pkg.pr.new/algolia/instantsearch/react-instantsearch-nextjs@7306

react-instantsearch-router-nextjs

npm i https://pkg.pr.new/algolia/instantsearch/react-instantsearch-router-nextjs@7306

vue-instantsearch

npm i https://pkg.pr.new/algolia/instantsearch/vue-instantsearch@7306

commit: a910702

github-actions · 2026-10-16T15:30:00Z

Size Change: -154 B (-0.01%)

Total Size: 1.04 MB

📦 View Changed

Filename	Size	Change
`packages/instantsearch.js/dist/instantsearch.development.js`	335 kB	-41 B (-0.01%)
`packages/instantsearch.js/dist/instantsearch.production.min.js`	152 kB	-38 B (-0.02%)
`packages/react-instantsearch-core/dist/umd/ReactInstantSearchCore.min.js`	73.8 kB	-40 B (-0.05%)
`packages/react-instantsearch/dist/umd/ReactInstantSearch.min.js`	126 kB	-35 B (-0.03%)

ℹ️ View Unchanged

Filename	Size	Change
`packages/algoliasearch-helper/dist/algoliasearch.helper.js`	44.5 kB	0 B
`packages/algoliasearch-helper/dist/algoliasearch.helper.min.js`	14.1 kB	-2 B (-0.01%)
`packages/instantsearch.css/components/ai-mode-button.css`	1.76 kB	0 B
`packages/instantsearch.css/components/autocomplete-min.css`	4.33 kB	0 B
`packages/instantsearch.css/components/autocomplete.css`	4.68 kB	0 B
`packages/instantsearch.css/components/button.css`	1.98 kB	0 B
`packages/instantsearch.css/components/chat-min.css`	7.46 kB	0 B
`packages/instantsearch.css/components/chat.css`	7.97 kB	0 B
`packages/instantsearch.css/components/filter-suggestions.css`	1.89 kB	0 B
`packages/instantsearch.css/themes/algolia-min.css`	11.9 kB	0 B
`packages/instantsearch.css/themes/algolia.css`	12.7 kB	0 B
`packages/instantsearch.css/themes/nova-min.css`	12 kB	0 B
`packages/instantsearch.css/themes/nova.css`	12.8 kB	0 B
`packages/instantsearch.css/themes/reset-min.css`	1.3 kB	0 B
`packages/instantsearch.css/themes/reset.css`	1.38 kB	0 B
`packages/instantsearch.css/themes/satellite-min.css`	12.8 kB	0 B
`packages/instantsearch.css/themes/satellite.css`	13.8 kB	0 B
`packages/vue-instantsearch/vue2/cjs/index.js`	19.9 kB	0 B
`packages/vue-instantsearch/vue2/umd/index.js`	74.3 kB	-4 B (-0.01%)
`packages/vue-instantsearch/vue3/cjs/index.js`	20.6 kB	0 B
`packages/vue-instantsearch/vue3/umd/index.js`	74.7 kB	-6 B (-0.01%)

_{compressed-size-action}

Copilot

🟢 Approval recommended

The focused validation changes have targeted test coverage and no identified blocking issues; tests were not executed.

No open issues 🎉

What changed in this PR

Moves missing configurationId errors to JavaScript CompareBar creation and React rendering, rather than button clicks, while preserving the connector guard for toggles-only setups.

Changes:

Adds early validation in both widgets.
Adds validation tests.
Updates all-widget test helpers to supply a configuration ID.

File	Description
`packages/react-instantsearch/src/widgets/CompareBar.tsx`	Validates the ID before calling the hook.
`packages/react-instantsearch/src/widgets/__tests__/CompareBar.test.tsx`	Tests the missing-ID render error.
`packages/react-instantsearch/src/widgets/__tests__/__utils__/all-widgets.tsx`	Supplies an ID to CompareBar.
`packages/instantsearch.js/src/widgets/compare-bar/compare-bar.tsx`	Validates and forwards the ID.
`packages/instantsearch.js/src/widgets/compare-bar/__tests__/compare-bar-test.ts`	Tests required options and valid creation.
`packages/instantsearch.js/src/widgets/__tests__/index.test.ts`	Supplies an ID during widget initialization.

_{Review effort: Balanced}

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>

Copilot

🟡 Changes recommended

Changing configuration during an active search can leave React submitting comparisons with the previous configuration ID.

1 open issue

CompareBar retains stale configuration while search is loading · New

_{Review effort: Balanced}

shaejaz · 2026-10-20T09:34:37Z

+  // `CompareBar` is not part of `SingleWidget` (see `NON_COMPONENTS`), but
+  // `getAllInstantSearchWidgets` still renders it and it requires an ID.


what's the reason for it not being in the single widget list?

* fix(compareBar): require configurationId when the widget is created Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> * test(compareBar): pass configurationId in widgets index test Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> * fix(compare): require configurationId in the connector Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> * docs(examples): read the compare selection from render state Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Sonnet 5.5 <noreply@anthropic.com>

#7306 moved the check from `compare()` to widget creation; carry this PR's one-sentence wording over to the new location. The option's JSDoc and the docs link appended by `withUsage` already say where the ID comes from. Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(compare): clarify option validation messages Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> * fix(compare): shorten the `configurationId` usage message #7306 moved the check from `compare()` to widget creation; carry this PR's one-sentence wording over to the new location. The option's JSDoc and the docs link appended by `withUsage` already say where the ID comes from. Co-authored-by: Cursor <cursoragent@cursor.com> --------- Co-authored-by: Claude Sonnet 5.5 <noreply@anthropic.com> Co-authored-by: Andras F <andras.ferencz@algolia.com> Co-authored-by: Cursor <cursoragent@cursor.com>

Haroenv commented Oct 19, 2026

View reviewed changes

Comment thread packages/instantsearch.js/src/widgets/compare-bar/compare-bar.tsx Outdated

Haroenv requested a balanced review from Copilot October 19, 2026 12:07

Copilot started reviewing on behalf of Haroenv October 19, 2026 12:08

View session

Copilot AI reviewed Oct 19, 2026

View reviewed changes

Haroenv changed the title ~~fix(compareBar): require configurationId when the widget is created~~ fix(compare): require configurationId in the connector Oct 19, 2026

Haroenv requested review from a team, afrencalg and shaejaz and removed request for a team October 19, 2026 15:58

Haroenv marked this pull request as ready for review October 19, 2026 15:58

Haroenv and others added 2 commits October 19, 2026 17:58

fix(compareBar): require configurationId when the widget is created

838f2ba

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>

test(compareBar): pass configurationId in widgets index test

d6cb7b3

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>

Haroenv enabled auto-merge (squash) October 19, 2026 15:58

Haroenv and others added 2 commits October 19, 2026 17:59

fix(compare): require configurationId in the connector

4be7800

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>

docs(examples): read the compare selection from render state

1cd9c3b

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>

Haroenv force-pushed the fix/compare-bar-configuration-id branch from 27988ae to 1cd9c3b Compare October 19, 2026 16:00

Haroenv requested a balanced review from Copilot October 19, 2026 16:04

Copilot started reviewing on behalf of Haroenv October 19, 2026 16:05

View session

Copilot AI reviewed Oct 19, 2026

View reviewed changes

Comment thread packages/instantsearch.js/src/connectors/compare/connectCompare.ts

Haroenv commented Oct 19, 2026

View reviewed changes

Comment thread examples/react/default-theme/src/App.tsx Outdated

Apply suggestion from @Haroenv

a910702

Haroenv changed the title ~~fix(compare): require configurationId in the connector~~ fix(compare): require configurationId Oct 19, 2026

shaejaz approved these changes Oct 20, 2026

View reviewed changes

Haroenv merged commit a0c910e into master Oct 20, 2026
19 checks passed

Haroenv deleted the fix/compare-bar-configuration-id branch October 20, 2026 09:35

afrencalg mentioned this pull request Oct 20, 2026

fix(compare): clarify option validation messages #7300

Merged

Navigation Menu

Repository navigation

fix(compare): require configurationId - #7306

fix(compare): require configurationId#7306
Haroenv merged 5 commits into
masterfrom
fix/compare-bar-configuration-id

Haroenv commented Oct 16, 2026 •

edited

Loading

Uh oh!

codacy-production Bot commented Oct 16, 2026

Uh oh!

pkg-pr-new Bot commented Oct 16, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Oct 16, 2026 •

edited

Loading

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

shaejaz Oct 20, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		// `CompareBar` is not part of `SingleWidget` (see `NON_COMPONENTS`), but
		// `getAllInstantSearchWidgets` still renders it and it requires an ID.

Conversation

Haroenv commented Oct 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Result

Uh oh!

codacy-production Bot commented Oct 16, 2026

Up to standards ✅

Uh oh!

pkg-pr-new Bot commented Oct 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Oct 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟢 Approval recommended

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

Uh oh!

Uh oh!

shaejaz Oct 20, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Haroenv commented Oct 16, 2026 •

edited

Loading

pkg-pr-new Bot commented Oct 16, 2026 •

edited

Loading

github-actions Bot commented Oct 16, 2026 •

edited

Loading