feat: hide secrets in yarn config commands#1228
Merged
Merged
Conversation
arcanis
reviewed
Apr 21, 2020
Member
arcanis
left a comment
arcanis
left a comment
There was a problem hiding this comment.
Looks good! Can you also add a test?
arcanis
reviewed
Apr 22, 2020
| }); | ||
|
|
||
| const firstToken = configuration.getForDisplay(`npmAuthToken`); | ||
| const secondToken = configuration.getForDisplay(`npmScopes`).get(`myScope`).get(`npmAuthToken`); |
Member
There was a problem hiding this comment.
While keeping a unit test here is fine, I tend to prefer integration tests.
The reason for that is that because they are typically wider in scope, they also test behaviours closer from what real-life users will experience. For example, while you did test that getForDisplay works, you didn't test that it actually gets used by yarn config get. As a result, it's quite possible for someone to make an accidental regression during a refactoring.
Food for thought 🙂
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
2 participants
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's the problem this PR addresses?
yarn configcommand (e. g.npmScopes.scope.npmAuthToken) by the existing implementation.yarn config setcommand.How did you fix it?
I created a new
hideSecretsfunction that recursively hides secrets and a newgetSecretmethod on theConfigurationclass that returns a configuration value with all secrets hidden.I replaced the existing implementation with the new
configuration.getSecretmethod.