feat(get-app-authentication): improve error message when privateKey is incomplete #312
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
|
@gr2m Not sure if we should test this in a pre-release first. What do you think? |
gr2m
reviewed
Aug 1, 2021
test/index.test.ts
Outdated
|
|
||
| await expect(auth({ type: "app" })).rejects.toEqual( | ||
| new Error( | ||
| "Private key is incomplete. Make sure it is a single line String and newlines have been replaced by '\n'" |
There was a problem hiding this comment.
Looks good! I suggest we slightly change the error message to
Suggested change
| "Private key is incomplete. Make sure it is a single line String and newlines have been replaced by '\n'" | |
| "The 'privateKey` option contains only the first line '-----BEGIN RSA PRIVATE KEY-----'. If you are setting it using a `.env` file, make sure it is set on a single line with newlines replaced by '\n'" |
what do you think?
no pre-release necessary can you check what's up with the node 10 tests? |
checking Node 10 issue |
gr2m
approved these changes
Aug 1, 2021
|
Thanks Oscar! |
|
🎉 This PR is included in version 3.6.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
📝 Summary
privateKeyprovided by a user is incomplete (with only-----BEGIN RSA PRIVATE KEY-----)⛱ Motivation and Context
Fix #311