fix(insights): only load script if we write window.aa #5559
Conversation
This file contains 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
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 769588d:
|
Haroenv
requested review from
a team,
sarahdayan and
aymeric-giraudet
and removed request for
a team
Haroenv
commented
Apr 4, 2023
packages/instantsearch.js/src/middlewares/__tests__/createInsightsMiddleware.ts
Outdated
Show resolved
Hide resolved
…ghtsMiddleware.ts
Haroenv
commented
Apr 4, 2023
packages/instantsearch.js/src/middlewares/createInsightsMiddleware.ts
Outdated
Show resolved
Hide resolved
Haroenv
commented
Apr 4, 2023
| if (!insightsClient) { | ||
| if (!potentialInsightsClient) { |
There was a problem hiding this comment.
before this change, if window.AlgoliaAnalyticsObject wasn't a string, insightsClient still was noop, and thus not null
Comment on lines
+84
to
-87
| window[pointer].shouldAddScript = true; | ||
| } | ||
|
|
||
| insightsClient = window[pointer]; | ||
| insightsClient.shouldAddScript = true; |
There was a problem hiding this comment.
we should only add the script if we wrote window.aa, as otherwise nothing will happen with the script
aymeric-giraudet
approved these changes
Apr 4, 2023
Haroenv
added a commit
that referenced
this pull request
Apr 18, 2023
* fix(insights): only load script if we write window.aa * Update packages/instantsearch.js/src/middlewares/__tests__/createInsightsMiddleware.ts * Update packages/instantsearch.js/src/middlewares/createInsightsMiddleware.ts * fix lint
Haroenv
added a commit
that referenced
this pull request
Apr 24, 2023
* fix(insights): only load script if we write window.aa * Update packages/instantsearch.js/src/middlewares/__tests__/createInsightsMiddleware.ts * Update packages/instantsearch.js/src/middlewares/createInsightsMiddleware.ts * fix lint
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.
Summary
We were attempting to load search-insights, even if window.aa had potentially already been set up by something different.
Result
Only when window[window.AlgoliaAnalyticsObject] is set by InstantSearch it is safe to load search insights, otherwise it will not be used.