fix: throw helpful error on auth({ type: "installation" }) if installationId option is not set
#135
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
An installationId is required in either `createAuthApp` or `auth` when using the installation auth type. This adds an error message to warn users when an installationId is missing.
gr2m
reviewed
Aug 2, 2020
| @@ -55,7 +55,7 @@ const { createAppAuth } = require("@octokit/auth-app"); | |||
| </td></tr> | |||
| <tr><td colspan=2> | |||
|
|
|||
| ⚠️ For usage in browsers: The private keys provide by GitHub are in `PKCS#1` format, but the WebCrypto API only supports `PKCS#8`. You need to convert it first: | |||
| ⚠️ For usage in browsers: The private keys provided by GitHub are in `PKCS#1` format, but the WebCrypto API only supports `PKCS#8`. You need to convert it first: | |||
| @@ -16,6 +16,12 @@ export async function getInstallationAuthentication( | |||
| const installationId = (options.installationId || | |||
| state.installationId) as number; | |||
|
|
|||
| if (typeof installationId !== "number") { | |||
| throw new Error( | |||
| "installationId is required for installation authtentication." | |||
There was a problem hiding this comment.
typo in "authtentication" :)
I like to prefix error messages with the package names. And maybe clarify that installationId is an option? How about this
Suggested change
| "installationId is required for installation authtentication." | |
| "[@octokit/auth-app] installationId option is required for installation authentication." |
There was a problem hiding this comment.
Oops haha, fix a typo/leave a typo I guess! That looks pretty good to me, I'll update that and the test for it as well.
gr2m
changed the title
auth({ type: "installation" }) if installationId option is not set
|
🎉 This PR is included in version 2.4.11 🎉 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.
An installationId is required in either
createAuthApporauthwhen using the installation auth type. This adds an error message to warn users when an installationId is missing.Closes #64