fix(javascript): do not send user-agent for Predict #919
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
✅ Deploy Preview for api-clients-automation canceled.
|
✗ The generated branch has been deleted.If the PR has been merged, you can check the generated code on the |
shortcuts
commented
Aug 10, 2022
Comment on lines
+118
to
+121
| if (algoliaAgent.value) { | ||
| queryParameters['x-algolia-agent'] = algoliaAgent.value; | ||
| } | ||
|
|
There was a problem hiding this comment.
This is the only part that impacts the other client, which is something we are in control of as it's only reached by the factory of each clients.
damcou
approved these changes
Aug 11, 2022
their engineers are OOO so the issue should be tackled once they come back |
shortcuts
added a commit
that referenced
this pull request
Aug 25, 2022
This reverts commit dc43c2a.
shortcuts
added a commit
that referenced
this pull request
Aug 25, 2022
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.
🧭 What and Why
🎟 JIRA Ticket: https://algolia.atlassian.net/browse/APIC-621
See https://algolia.atlassian.net/browse/PRED-523 for context
Changes included:
The Predict API does not yet support user-agent query parameters, which makes every requests being rejected for unknown/non-parsable query parameter.
This is a not-really-pretty patch until it gets implemented, I've tried to minimize the footprint on the other clients but they all use the same requester. LMK if you have alternatives.
I've added the Jira ticket in a comment near the patches until it gets resolved, to avoid forgetting to remove it.
The fix is only applied for JavaScript, as it's the only client that is recommended from the Predict team.
🧪 Test
yarn docker playground javascript predictshould show an emptyalgoliaAgent, which gets removed if you do a real request (screenshot is with theechoRequester)