Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove zds-client usage #88

Closed
sergei-maertens opened this issue Mar 25, 2024 · 1 comment · Fixed by #89
Closed

Remove zds-client usage #88

sergei-maertens opened this issue Mar 25, 2024 · 1 comment · Fixed by #89
Assignees
@sergei-maertens

Comments

@sergei-maertens
Copy link
Member

There are some internal bits and pieces that use zds-client under the hood which need to be removed or updated before we can drop support for zds-client alltogether (we have alternative bindings for ape-pie already).

Most notably, this will impact some of the admin and ZGW API's integrations. Currently I'm leaning towards removing this functionality, as we barely use it ourselves anymore and we want to move zgw-consumers more in the direction of a "service configuration" library rather than having tight integration with the ZGW APIs (a rename will happen at some point to hammer this point home).

Possibly we will split of some integration code into another library, but this is not a guarantee.
@sergei-maertens sergei-maertens self-assigned this Mar 25, 2024
@sergei-maertens
Copy link
Member Author

@damm89 - you're the only party I know making use of zgw-consumers and this will very likely cause some breaking changes for you. I intend to document the breakage in the changelog and include some pointers to what the implementation used to be, so you can move over the code to your own project(s)/libraries. Does that work for you?

sergei-maertens added a commit that referenced this issue Mar 25, 2024
@sergei-maertens
💥 [#88] Delete most of the zgw_consumers.service code
9a3d9e9 
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.
sergei-maertens added a commit that referenced this issue Mar 25, 2024
@sergei-maertens
💥 [#88] Delete admin zaaktype mixin
0d572b5 
Downstream projects/libraries should implement this functionality
themselves, as it turns out it is not as common as initially
anticipated.
@sergei-maertens sergei-maertens mentioned this issue Mar 25, 2024
Merged
sergei-maertens added a commit that referenced this issue Mar 25, 2024
@sergei-maertens
🗑️ [#88] Deprecate custom zds_client schema fetcher cache
bb3be8e 
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.
sergei-maertens added a commit that referenced this issue Mar 25, 2024
@sergei-maertens
💥 [#88] Remove Service.objects.get_client_for manager method
7d089e0 
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)
```
sergei-maertens added a commit that referenced this issue Mar 25, 2024
@sergei-maertens
🎨 [#88] Move deprecation warning to decorator
f6d61a4 
Better typing support and still emits the runtime warning.
sergei-maertens added a commit that referenced this issue Mar 25, 2024
@sergei-maertens
🗑️ [#88] Deprecate zds-client usage
f7cb334 
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.
sergei-maertens added a commit that referenced this issue Mar 25, 2024
@sergei-maertens
🗑️ [#88] Deprecate a number of legacy service class methods
e07f8c7 
These are tightly coupled to zds-client. Rather than changing their
signature, we opt to deprecate them and provide the alternatives
to use.
sergei-maertens added a commit that referenced this issue Mar 25, 2024
@sergei-maertens
♻️ [#88] Implement ZGW JWT mechanism directly
dad0227 
This allows us to drop the dependency on zds-client entirely
sergei-maertens added a commit that referenced this issue Mar 25, 2024
@sergei-maertens
♻️ [#88] Implement ZGW JWT mechanism directly
16a4011 
This allows us to drop the dependency on zds-client entirely
sergei-maertens added a commit that referenced this issue Mar 25, 2024
@sergei-maertens
✨ [#88] Opt-in to hide/ignore the oas/oas_file fields on the service …
67b916a 
…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 added a commit that referenced this issue Mar 25, 2024
@sergei-maertens
📝 [#88] Add release notes
1352e9b
sergei-maertens added a commit that referenced this issue Mar 25, 2024
@sergei-maertens
✨ [#88] Opt-in to hide/ignore the oas/oas_file fields on the service …
5014183 
…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 added a commit that referenced this issue Mar 25, 2024
@sergei-maertens
📝 [#88] Add release notes
50429dd
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sergei-maertens sergei-maertens

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Delete zds-client usage maykinmedia/zgw-consumers
1 participant
@sergei-maertens