Add non-verified methods to managed handlers - #2813
Draft
xavdid wants to merge 1 commit into
Draft
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
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.
Why?
On the back of my work in DEVSDK-3085, we're adding support for non-verified webhook handing to the managed handlers. There were two key design stipulations:
handlemethods and if/when we call the signature verification methods.To that end, the main entrypoint for the non-verified handler is a new method on the client and a static method on the with-verification handler. The class definition and/or constructor for the non-verified handler is as private as possible.
Design wise, the exact implementation varied between languages:
handlemethods and the amount of duplicated code is minimalhandlemethod after embedding the with-verification handler inside the non-verification handler. It would have worked the other way too, but this was the least code changehandlemethods and it's impossible for a caller to see the "wrong" one. If we had used inheritance, then the child would have the parent'shandlesignature exposed, which is confusing (even if we overrode it to always error)signatureargument tohandle. Instead, I took the same "sibling" approach described above so a caller only ever has the correcthandleWhat?
StripeEventNotificationHandlerWithoutVerificationclass and associated constructorsSee Also