fix(insightsMiddleware): throw an error when credentials can't be extracted #4901
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
…racted When api or appId is missing, an error gets thrown by search insights, but that doesn't explain *why* that error gets thrown. Ideally this would also clarify what the next step is (usually making sure to spread the previous search client, or leaving all properties in place, but i'm not too sure how to word that. This doesn't add a new error where there wasn't already one, as the search-insights library threw an error in this case already.
Haroenv
commented
Sep 8, 2021
|
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 f812b80:
|
Haroenv
requested review from
a team and
francoischalifour
and removed request for
a team
eunjae-lee
reviewed
Sep 9, 2021
| insightsClient, | ||
| })({ instantSearchInstance }) | ||
| ).toThrowErrorMatchingInlineSnapshot( | ||
| `"[insights middleware]: could not extract Algolia credentials from searchClient"` |
There was a problem hiding this comment.
Seems reasonable, but I'm curious in which case searchClient didn't include the credentials? In that case, InstantSearch.js itself won't be functioning, no?
There was a problem hiding this comment.
if you do the following:
const client = algoliasearch()
const searchClient = {
search: client.search // or intercept
}
In that case only the "required" methods are present, as well as with a "backend search" without an algolia client the insights-thrown error is confusing
There was a problem hiding this comment.
Ah okay, that makes sense.
eunjae-lee
approved these changes
Sep 10, 2021
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
When api or appId is missing, an error gets thrown by search insights, but that doesn't explain why that error gets thrown.
Ideally this would also clarify what the next step is (usually making sure to spread the previous search client, or leaving all properties in place, but i'm not too sure how to word that.
This doesn't add a new error where there wasn't already one, as the search-insights library threw an error in this case already.
Result
An error that explains when the search client doesn't match insights' expectation