refactor: make captcha a real service #15137
Merged
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
In preparation for a conversion to a proper service, move the recaptcha code to a package named `captcha`. Next refactoring will include mass rename of variables. Signed-off-by: Mike Fiedler <[email protected]>
In anticipation of adding another recaptcha service, wrap the existing implementation with an Interface that conforms to the existing behavior. Signed-off-by: Mike Fiedler <[email protected]>
As a way to make the service interface more generic, rename applicable variables, parameters, strings. Signed-off-by: Mike Fiedler <[email protected]>
By making the specific bits for a given service part of the service instance, we avoid leaking the implementation details to the code referencing it, allowing us to swap the implementation. Signed-off-by: Mike Fiedler <[email protected]>
We don't have any other backends (yet), but now we can configure one if we wanted to. Signed-off-by: Mike Fiedler <[email protected]>
Signed-off-by: Mike Fiedler <[email protected]>
miketheman
commented
Jan 3, 2024
| @@ -70,3 +70,6 @@ OIDC_AUDIENCE=pypi | |||
| # Default to the reCAPTCHA testing keys from https://developers.google.com/recaptcha/docs/faq | |||
| RECAPTCHA_SITE_KEY=6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI | |||
| RECAPTCHA_SECRET_KEY=6LeIxAcTAAAAAGG-vFI1TnRWxMZNFuojJ4WifJWe | |||
|
|
|||
| # Example of Captcha backend configuration | |||
| # CAPTCHA_BACKEND=warehouse.captcha.recaptcha.Service | |||
There was a problem hiding this comment.
A value isn't needed for deployment, since the default is currently recaptcha.Service
|
Looks great, my only concern was CSP but it appears we are ahead of that! |
ewdurbin
approved these changes
Jan 3, 2024
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.
Best reviewed commit by commit, since there's some that are not too interesting (example: mass rename).
Paves the way for a future captcha service via interface.