tolerance, receivedAt, timestamp are now optional in Webhook.ts#2670
Draft
prathmesh-stripe wants to merge 1 commit intomasterfrom
Draft
tolerance, receivedAt, timestamp are now optional in Webhook.ts#2670prathmesh-stripe wants to merge 1 commit intomasterfrom
prathmesh-stripe wants to merge 1 commit intomasterfrom
Conversation
prathmesh-stripe
force-pushed
the
prathmesh/fix-webhook-signature
branch
from
df30437 to
4b1ef97
Compare
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
1 participant
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?
In v22, several webhook method parameters that were previously optional in manually maintained became required due to a type consolidation.
generateTestHeaderStringonly truly requirespayloadandsecret(all other fields have defaults).verifyHeader/constructEventwork without explicittoleranceandcryptoProviderarguments. Users upgrading to v22 now get TypeScript errors when calling these methods with the same arguments that worked in v21.What?
timestamp,scheme,signature, andcryptoProvideroptional inWebhookTestHeaderOptionstoleranceandcryptoProvideroptional inverifyHeader/verifyHeaderAsyncsignaturesschemeoptional inparseHeaderprepareOptionsreturn type to reflect that defaulted fields are resolved to non-optionalSee Also
generateTestHeaderString#2666Changelog