Repository navigation
fix(gen): generate security handling for webhook server and client - #1771
Merged
Merged
Conversation
Webhook handlers and webhook client methods called s.security<Name>, but those methods were only generated for Server and Client, and WebhookServer/WebhookClient had no SecurityHandler/SecuritySource. Code generated for a webhook with security did not compile. When a webhook declares security, WebhookServer now takes a SecurityHandler and WebhookClient a SecuritySource, and both get the security methods. Fixes ogen-go#1560
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.
Fixes #1560
If a webhook declares
security, the generated webhook handlers and webhook client methods calls.security<Name>, but those methods only exist onServerandClient.WebhookServerandWebhookClienthave noSecurityHandler/SecuritySource, so the generated code does not compile.With this change, when some webhook requires security:
NewWebhookServertakes aSecurityHandlerandWebhookServergets thesecurity<Name>methodsNewWebhookClienttakes aSecuritySourceandWebhookClientgets the client-sidesecurity<Name>methodsSpecs where no webhook has security generate the same code as before (
make generate examplesonly adds the new test package). Webhook client +security-reentrantisn't wired up, so that combination now fails generation with an explicit error instead of producing broken code.Added
_testdata/positive/webhook_security.ymland an integration test that covers an API key and a custom security on webhooks: valid credentials, wrong credentials (401), and missing credentials (client error, and 401 from the server for a raw request).