Sanitize "api_key" from verbose log #3558
Merged
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
|
Thanks for your contribution! Depending on what you are working on, you may want to request a review from a Shopify team:
|
Coverage report
Show files with reduced coverage 🔻
Test suite run success1616 tests passing in 754 suites. Report generated by 🧪jest coverage report action from dfa068f |
|
We detected some changes at either packages/*/src or packages/cli-kit/assets/cli-ruby/** and there are no updates in the .changeset. |
|
@theodoretan I looked into analytics and it looks like the key is already santized to SHOPIFY_API_KEY there, so this should be good. |
MitchDickinson
approved these changes
Mar 15, 2024
isaacroldan
reviewed
Mar 21, 2024
isaacroldan
reviewed
Mar 21, 2024
| @@ -198,7 +198,7 @@ export async function publishMonorailEvent<TSchemaId extends keyof Schemas, TPay | |||
| const response = await fetch(url, {method: 'POST', body, headers}) | |||
|
|
|||
| if (response.status === 200) { | |||
| outputDebug(outputContent`Analytics event sent: ${outputToken.json(payload)}`) | |||
| outputDebug(outputContent`Analytics event sent: ${outputToken.json(sanitizePayload(payload))}`) | |||
There was a problem hiding this comment.
is this the only place where we were printing the api_key?
theodoretan
force-pushed
the
sanitize-api-key
branch
from
5556cc2
to
fd7f92a
Compare
isaacroldan
approved these changes
Apr 4, 2024
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.
WHY are these changes introduced?
Fixes #3518
The
api_keyis visible in the verbose log onshopify app config link. While this isn't critical as this is on the developers machine, these logs are required when opening a bug ticket.WHAT is this pull request doing?
Replaces the
api_keywith****for the logs output.How to test your changes?
Post-release steps
Measuring impact
How do we know this change was effective? Please choose one:
Checklist
devordeployhave been reflected in the internal flowchart.