Deprecate accessor methods #1449
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
f915bb0 to
347d315
Compare
Closed
erikvanoosten
added a commit
that referenced
this pull request
Feb 6, 2025
In preparation of removing the accessor method in zio-kafka 3.0.0, this change already removes them from the user documentation. File `writing-tests.md` is updated in a separate PR (#1449) as it involves code changes as well.
d2c4538 to
caf91eb
Compare
Accessor methods are deprecated by the ZIO community. Therefore, all accessor methods for `Consumer`, `Producer` and `TransactionalProducer` have been deprecated so that they can be removed in zio-kafka 3.0.0. Accessor methods were heavily used in the zio-kafka unit tests. Therefore, all tests and benchmarks have been rewritten to use services directly. `KafkaTestUtils` has been extended with several methods to make this easier. To nudge users of the zio-kafka-test-kit, anything that promotes accessor methods is also deprecated. The unit tests now have less layer trickery and are easier to understand.
caf91eb to
6dea2a1
Compare
erikvanoosten
added a commit
that referenced
this pull request
Feb 8, 2025
In preparation of removing the accessor method in zio-kafka 3.0.0, this change already removes them from the user documentation. File `writing-tests.md` is updated in a separate PR (#1449) as it involves code changes as well.
svroonland
approved these changes
Feb 8, 2025
erikvanoosten
added a commit
that referenced
this pull request
Feb 8, 2025
In preparation of removing the accessor method in zio-kafka 3.0.0, this change already removes them from the user documentation. File `writing-tests.md` is updated in a separate PR (#1449) as it involves code changes as well.
erikvanoosten
added a commit
that referenced
this pull request
Feb 8, 2025
In preparation of removing the accessor method in zio-kafka 3.0.0, this change already removes them from the user documentation. The diff looks a bit large because how to create a consumer was split to a different file. File `writing-tests.md` is updated in a separate PR (#1449) as it involves code changes as well.
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.
Accessor methods are deprecated by the ZIO community. Therefore, all accessor methods for
Consumer,ProducerandTransactionalProducerhave been deprecated so that they can be removed in zio-kafka 3.0.0.Accessor methods were heavily used in the zio-kafka unit tests. Therefore, all tests and benchmarks have been rewritten to use services directly.
KafkaTestUtilshas been extended with several methods to make this easier. To nudge users of the zio-kafka-test-kit, anything that promotes accessor methods is also deprecated.The unit tests now have less layer trickery and are easier to understand.
The documentation has been extended with a migration guide: https://github.com/zio/zio-kafka/blob/accessors/docs/migrating-to-2.11.md
Hint for the reviewer: enable "hide whitespace" for smaller diffs.