Add more configurability to the library #6
Merged
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
The versions of the tests that used the correct scope were redundant because the correct scope is used in all the other tests. The point of these tests is to check what happens when an incorrect scope is used and that's what the tests now do.
There was a lot of repetition in the tests for the preparation for doing the query request.
akikoskinen
force-pushed
the
configurability
branch
from
c939036
to
a05c6dd
Compare
There was a lot of repetition in the tests for the preparation for doing the delete request.
The GDPR model instance was searched by its primary key field. This is still the default behaviour, but now the field lookup can also be changed with a `GDPR_API_MODEL_LOOKUP` setting.
In addition to being a Django field lookup value, the `GDPR_API_MODEL_LOOKUP` setting can now also point to a function that provides the GDPR model instance. That way the user of this library has full control over how that instance gets found.
It's required that a User model can be obtained from the model instance specified by the `GDPR_API_MODEL` setting. By default the model instance's `user` attribute is tried. If that won't work, it's now possible to configure a function with the `GDPR_API_USER_PROVIDER` setting. That function can do anything that is needed to obtain the user.
This was existing functionality, but missing any tests.
Raising a Django REST Framework `APIException` gets handled by the DRF's exception handler. The default handler produces some JSON content into the response. The exception handler can also be overridden by the user in which case this library would have no control over what the response contains. Better not use exceptions at all and just return a Response instance.
The default data deletion behaviour, deleting the GDPR API model instance, might not be the correct procedure in every case. Some application might for example want to anonymise the data instead of deletion. It's now possible to provide a function that gets called instead of the default behaviour.
The function may return an `ErrorResponse` instance. If it does, the database transaction gets rolled back and the returned instance is serialized into the HTTP response, providing a correctly structured response contents.
The URL pattern string can be given with the `GDPR_API_URL_PATTERN` setting. The setting affects the Djano URLConf, which is cached after the first load. There's a trick in conftest.py that reloads the URLConfs every time this setting changes. That trick isn't needed during runtime of the app because settings shouldn't change during runtime.
akikoskinen
force-pushed
the
configurability
branch
from
a05c6dd
to
858deb1
Compare
Codecov Report
@@ Coverage Diff @@
## main #6 +/- ##
==========================================
+ Coverage 92.23% 94.59% +2.36%
==========================================
Files 4 5 +1
Lines 103 148 +45
Branches 14 24 +10
==========================================
+ Hits 95 140 +45
+ Misses 5 4 -1
- Partials 3 4 +1
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
mikkokeskinen
approved these changes
Apr 18, 2023
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.
The first version of this library was very opinionated and assumed quite a lot from the project that would use it. It has since come obvious that those assumptions don't hold for many projects. Projects still using this library has had to circumvent the limitations in various ways. This PR offers configurability to the library so that projects wouldn't need to hack it so much.
There's another PR City-of-Helsinki/example-backend-profile#15 using these new features.