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

Deprecate channel based clients #894

Merged
merged 1 commit into from
Nov 23, 2022
Merged

Deprecate channel based clients #894

merged 1 commit into from
Nov 23, 2022

Conversation

milindl
Copy link
Contributor

@milindl milindl commented Nov 9, 2022

Adds Deprecated: to the godoc for ProduceChannel, and consumer's Event method.

Adds BUG: to the godoc for Flush and Len to emphasize they don't play well with ProduceChannel.

@milindl milindl requested a review from a team November 9, 2022 06:37
@milindl
Copy link
Contributor Author

milindl commented Nov 9, 2022

Does this need a changelog.md entry despite the fact that these were deprecated earlier?

@milindl milindl mentioned this pull request Nov 9, 2022
Closed
edenhill
edenhill suggested changes Nov 9, 2022
View reviewed changes
Copy link
Contributor

@edenhill edenhill left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please also add deprecation warnings to the examples README and the deprecated examples themselves, as needed

kafka/producer.go Outdated Show resolved Hide resolved
kafka/consumer.go Outdated Show resolved Hide resolved
kafka/producer.go Outdated Show resolved Hide resolved
kafka/producer.go Outdated Show resolved Hide resolved
kafka/producer.go Outdated Show resolved Hide resolved
@edenhill
Copy link
Contributor

edenhill commented Nov 9, 2022

Add a CHANGELOG entry to formally deprecate the channel based producer and consumer.
This will go well with our semver bump to 2.0

@milindl
Copy link
Contributor Author

milindl commented Nov 11, 2022

Emanuele has already moved the channel based examples into a legacy folder inside examples/ and made the required changes to legacy/README.md
The only example which needed a major change was go-kafkacat, which has been rewritten to not use channels.

Also - just to clarify this, Producer's Events() channel/deliveryChan in Produce() method is not being deprecated, right? Only ProduceChannel of the producer, and the Events() channel of the consumer is being deprecated?

@edenhill
Copy link
Contributor

Also - just to clarify this, Producer's Events() channel/deliveryChan in Produce() method is not being deprecated, right? Only ProduceChannel of the producer, and the Events() channel of the consumer is being deprecated?

Yep, that's correct

edenhill
edenhill suggested changes Nov 18, 2022
View reviewed changes
CHANGELOG.md Outdated Show resolved Hide resolved
@milindl milindl force-pushed the deprecate_produce_channel branch 2 times, most recently from a6c9066 to 4a16037 Compare November 23, 2022 04:54
edenhill
edenhill suggested changes Nov 23, 2022
View reviewed changes
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
@milindl
Deprecate channel based clients
5006f4d 
Adds Deprecated: to the godoc for ProduceChannel, and consumer's Event
method.

Adds BUG: to the godoc for Flush and Len to emphasize they don't play
well with ProduceChannel.

Change examples and changelog.
edenhill
edenhill approved these changes Nov 23, 2022
View reviewed changes
Copy link
Contributor

@edenhill edenhill left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@milindl milindl merged commit 87e0198 into confluentinc:master Nov 23, 2022
@milindl milindl deleted the deprecate_produce_channel branch November 23, 2022 08:45
@milindl milindl mentioned this pull request Nov 23, 2022
Closed
PrasanthV454 pushed a commit that referenced this pull request Mar 17, 2023
@milindl @PrasanthV454
Deprecate channel based clients (#894)
3885484 
Adds Deprecated: to the godoc for ProduceChannel, and consumer's Event
method.

Adds BUG: to the godoc for Flush and Len to emphasize they don't play
well with ProduceChannel.

Change examples and changelog.
@milindl milindl mentioned this pull request May 15, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@edenhill edenhill edenhill approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@milindl @edenhill