feat(chat): send events from hits in chat#6943
Merged
Conversation
More templates
algoliasearch-helper
instantsearch-ui-components
instantsearch.css
instantsearch.js
react-instantsearch
react-instantsearch-core
react-instantsearch-nextjs
react-instantsearch-router-nextjs
vue-instantsearch
commit: |
Haroenv
reviewed
Mar 27, 2026
Contributor
Haroenv
left a comment
Haroenv
left a comment
There was a problem hiding this comment.
can be two separate PRs, but we should also send the click event by default like on hits
There was a problem hiding this comment.
Pull request overview
This PR wires Algolia Insights event tracking into chat carousel tool results so clicks on rendered hits can emit sendEvent events with the metadata needed for Insights.
Changes:
- Pass
sendEventthrough the chat tool pipeline (connector → tool props → carousel). - Enrich chat tool hits with
__queryIDand__position(fallbacks) for Insights payload construction. - Update types and unit tests to account for the new
sendEventplumbing.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/react-instantsearch/src/widgets/chat/tools/tests/SearchIndexTool.test.tsx | Updates test renders to provide the new required sendEvent prop. |
| packages/react-instantsearch/src/widgets/chat/tools/SearchIndexTool.tsx | Enriches tool hits with __queryID/__position and forwards sendEvent into the carousel. |
| packages/instantsearch.js/src/widgets/chat/chat.tsx | Mirrors the hit enrichment and sendEvent forwarding for the InstantSearch.js chat widget template path. |
| packages/instantsearch.js/src/connectors/chat/connectChat.ts | Injects sendEvent into tool instances exposed to the UI layer. |
| packages/instantsearch.js/src/connectors/chat/tests/connectChat-test.ts | Extends connector expectations to include sendEvent. |
| packages/instantsearch-ui-components/src/components/chat/types.ts | Adds sendEvent typing to chat tool component props/tool definitions. |
| packages/instantsearch-ui-components/src/components/chat/ChatMessage.tsx | Ensures sendEvent is always provided to tool layout components (fallback to no-op). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
packages/react-instantsearch/src/widgets/chat/tools/SearchIndexTool.tsx
Outdated
Show resolved
Hide resolved
packages/react-instantsearch/src/widgets/chat/tools/__tests__/SearchIndexTool.test.tsx
Show resolved
Hide resolved
Haroenv
reviewed
Mar 30, 2026
| const items = output?.hits || []; | ||
| const items = (output?.hits || []).map((hit, index) => ({ | ||
| ...hit, | ||
| __queryID: hit.__queryID || output?.queryID, |
Contributor
There was a problem hiding this comment.
- how does hit already have __queryID? and if it sometimes has it, why do we fall back to the output's query id?
- why not using the addHitPosition / addQueryID function as hits does?
Contributor
Author
There was a problem hiding this comment.
Fixed!
- I think I initially thought queryID is in the hits but it's actually in the main request body after verifying it from several tool calls. Removed this old code now.
- Did not think to look in the connectors to see if a util already exists 😅, thanks!
Haroenv
reviewed
Mar 31, 2026
| const hitsWithAbsolutePosition = addAbsolutePosition( | ||
| output?.hits || [], | ||
| 0, // no page info in the tool input/output so assuming page 0 | ||
| input?.number_of_results ?? 5 // defaulting to 5 if number_of_results is not provided |
Contributor
There was a problem hiding this comment.
can we use the hits.length if not provided? seems better even though it's still wrong of course
Contributor
Author
There was a problem hiding this comment.
good idea, added it now. although since technically the output.hits can still be undefined, we need to have a fallback (still kept it as 5 for now)
packages/react-instantsearch/src/widgets/chat/tools/SearchIndexTool.tsx
Outdated
Show resolved
Hide resolved
Up to standards ✅🟢 Issues
|
| Metric | Results |
|---|---|
| Complexity | 25 |
| Duplication | 1 |
TIP This summary will be updated as you push new changes. Give us feedback
Haroenv
changed the title
Haroenv
changed the title
Haroenv
approved these changes
Mar 31, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
FX-3734
Added
sendEventto the Carousel in the Search index tool component.