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.

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

fix: Clarify comment in backup consumer logic #781

Merged
merged 3 commits into from
Jun 13, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion karapace/backup/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,13 @@ def _consume_records(
if start_offset >= end_offset:
raise EmptyPartition

end_offset -= 1 # high watermark to actual end offset
# kafka-python returns end offset + 1, i.e. the value that will be assigned
aiven-anton marked this conversation as resolved.
Show resolved Hide resolved
# to the next record to be produced. To get the highest offset already
# produced we need to subtract 1. Note that this has little to do with high
# watermark, which takes into account the highest record offset to be fully
# in sync across ISRs, and therefore can be an arbitrary number less than
# or equal to the LEO.
Copy link
Contributor

Choose a reason for hiding this comment

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

great, thanks for the explaination! This save a lot of time to the reader of the code. Can we mention also what happens if the topic its empty?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That would be good, I'll leave that as a room for further future improvement though.

end_offset -= 1

while True:
records: Collection[ConsumerRecord] = consumer.poll(poll_timeout.milliseconds).get(topic_partition, [])
Expand Down