Delete zds-client usage #89
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
get_catalogi and get_informatieobjecttypen appear to not be used in any of our projects. Users who do make use of this are advised to copy the code from 0.31.0 to their own projects or libraries.
Downstream projects/libraries should implement this functionality themselves, as it turns out it is not as common as initially anticipated.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #89 +/- ##
==========================================
+ Coverage 74.22% 76.07% +1.85%
==========================================
Files 40 40
Lines 1575 1513 -62
Branches 223 218 -5
==========================================
- Hits 1169 1151 -18
+ Misses 337 296 -41
+ Partials 69 66 -3 ☔ View full report in Codecov by Sentry. |
We're dropping the zds_client dependency, which removes our requirement to handle OpenAPI specifications, thus we can/should also remove our cache handling for schemas.
Removed because it's unused in our own projects. If you do make use of this, you can instead use the equivalent code: ```py client = Service.get_client(some_resource_url) ```
Better typing support and still emits the runtime warning.
Added a check for the legacy module that zds-client is installed, since the dependency is now moved into an optional group. TODO: vendor the ClientAuth in zgw-consumers directly instead of relying on zds-client.
These are tightly coupled to zds-client. Rather than changing their signature, we opt to deprecate them and provide the alternatives to use.
This allows us to drop the dependency on zds-client entirely
sergei-maertens
force-pushed
the
refactor/remove-zds-client-usage
branch
from
dad0227 to
16a4011
Compare
…model Environments/projects that don't use zds-client anymore already do not need to be burdened with these fields. This approach makes it safe to not break on run-time and allows opt-in for project that know what they're doing.
sergei-maertens
force-pushed
the
refactor/remove-zds-client-usage
branch
from
1352e9b to
50429dd
Compare
Viicos
approved these changes
Mar 26, 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.
Closes #88
This removes the library code that uses
zds_clientlibrary in some form. Lots of breaking changes here!Tested against Open Forms via open-formulieren/open-forms#4059 and the test suite as good as passes (failures need to be addressed internally).
I wanted to test this against the following projects too, but they either depend on notifications-api-common (which uses gemma-zds-client) or need to address the breaking changes :/