Refactor payments module to apply plugin mechanism consistently #4921
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
…ently All other modules operate on the idea that the generic code populates the plugin options from the generic information and the specified options serializer, which allows plugins to be generically typed and not needing to perform additional input validation or conversion from the raw JSON data for the options to the Python/Django objects that are easier to work with. This does change the public API of the registry/plugins to take an extra argument, but enables us to apply static type checking (which already reveals some problems) and simpler plugin code.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #4921 +/- ##
=======================================
Coverage 96.58% 96.59%
=======================================
Files 757 758 +1
Lines 25783 25798 +15
Branches 3390 3390
=======================================
+ Hits 24902 24919 +17
+ Misses 616 613 -3
- Partials 265 266 +1 ☔ View full report in Codecov by Sentry. |
Rather than just type-checking some files, we are close enough to type check most of the package and instead skip some files/subpackages with known (but not critical) type checking issues. Here and there we need to suppress some errors because the Django ORM magic is too much for Pyright.
sergei-maertens
force-pushed
the
feature/3457-refactor-payment-plugins
branch
from
dbdba94 to
e9aa4d7
Compare
sergei-maertens
commented
Dec 16, 2024
| @@ -127,7 +126,6 @@ def expected_parameters(self): | |||
| class FormAdmin( | |||
| FormioConfigMixin, | |||
| RegistrationBackendFieldMixin, | |||
| PaymentBackendChoiceFieldMixin, | |||
There was a problem hiding this comment.
irrelevant/unused because we only support the React-based change form page.
sergei-maertens
commented
Dec 16, 2024
| return_method = "GET" | ||
| webhook_method = "POST" | ||
| configuration_options = EmptyOptions | ||
| configuration_options: type[serializers.Serializer] = EmptyOptions | ||
|
|
||
| # override | ||
|
|
||
| def start_payment( | ||
| self, | ||
| request: HttpRequest, |
There was a problem hiding this comment.
this stays HttpRequest because it's called outside of DRF views too
sergei-maertens
commented
Dec 16, 2024
| ) -> PaymentInfo: | ||
| raise NotImplementedError() | ||
|
|
||
| def handle_return( | ||
| self, request: HttpRequest, payment: "SubmissionPayment" | ||
| self, | ||
| request: Request, |
There was a problem hiding this comment.
changed to DRF request because plugin code is accessing DRF-specific properties that don't exist on HttpRequest
stevenbal
approved these changes
Dec 16, 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.
Part of #3457 - doing the refactor before making the required changes
All other modules operate on the idea that the generic code populates the plugin options from the generic information and the specified options serializer, which allows plugins to be generically typed and not needing to perform additional input validation or conversion from the raw JSON data for the options to the Python/Django objects that are easier to work with.
This does change the public API of the registry/plugins to take an extra argument, but enables us to apply static type checking (which already reveals some problems) and simpler plugin code.
Checklist
Check off the items that are completed or not relevant.
Impact on features
Release management
I have updated the translations assets (you do NOT need to provide translations)
./bin/makemessages_js.sh./bin/compilemessages_js.shDockerfile/scripts
./binfolderCommit hygiene