Prefer serializers in context to hide-secrets #70
Conversation
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
mattjstar
approved these changes
Jan 24, 2017
Contributor
mattjstar
left a comment
mattjstar
left a comment
There was a problem hiding this comment.
lgtm
Maybe it's worth adding a TODO to write a test to get top level context fields scrubbed too, like the changed test used to cover? ...Though that's not a big deal for now as it would be fairly dumb to explicitly pass in { credit_card: 'MY SECRET CARD' } directly into the context.
Contributor
Author
Noted. Will handle this + test in a follow up |
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.
If a log method is called with an object as its first argument, bunyan treats it specially as context. Values are passed through serializers, which are usually much more effective than traversing the entire object with
hide-secrets.This change makes it so that
scrubdoes not touch values of a context object when a serializer has been provided. This should help performance because we no longer need to traverse large, circularreqandresobjects.I'll be adding tests around this as a follow up.