Repository navigation
fix(javascript): mask API key in ApiError stack trace - #7182
Merged
Merged
Conversation
Contributor
No code generatedIf you believe code should've been generated, please, report the issue. π Benchmark resultsBenchmarks performed on the method using a mock server, the results might not reflect the real-world performance.
|
Fluf22
approved these changes
Oct 23, 2026
algolia-api-clients-automation-bot Bot
added a commit
to algolia/algoliasearch-client-javascript
that referenced
this pull request
Oct 23, 2026
algolia/api-clients-automation#7182 Co-authored-by: Brennan Blair <36816721+bblair31@users.noreply.github.com>
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.
π§ What and Why
Non-retryable 4xx errors (
ApiError/DetailedApiError) kept the rawx-algolia-api-keyheader inerror.stackTrace. Logging or serializing the error put the key into the logs.Which, best I can tell, server-side is usually a write or admin key.
RetryErrorand retry logging already mask it. It looks like v4 masked this path too (and the other language clients don't keep request headers on errors), so I think this is a v5 regression specific to JS.Changes included:
deserializeFailure(createTransporter.ts).correlationId.test.ts).π§ͺ Test
yarninclients/algoliasearch-client-javascript.packages/client-common, runyarn test. All tests pass.