Skip to content

Fix committed-offset bookkeeping advancing when commit fails #692

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

Open
wbarnha wants to merge 1 commit into
base: master
Choose a base branch
from
+20 −3
Open

Fix committed-offset bookkeeping advancing when commit fails #692

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions faust/transport/consumer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1053,8 +1053,8 @@ async def _commit_offsets(
on_timeout.info("+tables.on_commit")
self.app.tables.on_commit(committable_offsets)
on_timeout.info("-tables.on_commit")
self._committed_offset.update(committable_offsets)
self.app.monitor.on_tp_commit(committable_offsets)
self._committed_offset.update(committable_offsets)
self.app.monitor.on_tp_commit(committable_offsets)
return did_commit

def _filter_tps_with_pending_acks(
Expand Down
19 changes: 18 additions & 1 deletion tests/unit/transport/test_consumer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -946,9 +946,10 @@ async def test_handle_attached(self, *, consumer):

@pytest.mark.asyncio
async def test_commit_offsets(self, *, consumer):
consumer._commit = AsyncMock(name="_commit")
consumer._commit = AsyncMock(name="_commit", return_value=True)
consumer.current_assignment.update({TP1, TP2})
consumer.app.producer.flush = AsyncMock()
consumer.app.monitor.on_tp_commit = Mock(name="on_tp_commit")
await consumer._commit_offsets(
{
TP1: 3003,
Expand All @@ -961,6 +962,15 @@ async def test_commit_offsets(self, *, consumer):
TP2: 6006,
}
)
# On a successful commit, bookkeeping must advance.
consumer.app.monitor.on_tp_commit.assert_called_once_with(
{
TP1: 3003,
TP2: 6006,
}
)
assert consumer._committed_offset[TP1] == 3003
assert consumer._committed_offset[TP2] == 6006

@pytest.mark.asyncio
async def test_commit_offsets__did_not_commit(self, *, consumer):
Expand All @@ -969,6 +979,8 @@ async def test_commit_offsets__did_not_commit(self, *, consumer):
consumer.app.producer.flush = AsyncMock()
consumer.current_assignment.update({TP1, TP2})
consumer.app.tables = Mock(name="app.tables")
consumer.app.monitor.on_tp_commit = Mock(name="on_tp_commit")
committed_offset_before = dict(consumer._committed_offset)
await consumer._commit_offsets(
{
TP1: 3003,
Expand All @@ -977,6 +989,11 @@ async def test_commit_offsets__did_not_commit(self, *, consumer):
}
)
consumer.app.tables.on_commit.assert_not_called()
# Bookkeeping must not advance when the underlying commit failed
# (see faust-streaming/faust#316): a failed commit must not make
# Faust believe those offsets were actually committed.
consumer.app.monitor.on_tp_commit.assert_not_called()
assert consumer._committed_offset == committed_offset_before

@pytest.mark.asyncio
async def test_commit_offsets__in_transaction(self, *, consumer):
Expand Down
Loading