-
Notifications
You must be signed in to change notification settings - Fork 197
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Receive pending acks after assignments_revoked is invoked (#351)
We are building a multi-process data processing pipeline with Brod and we are using the assignments_revoked callback to flush all messages being processed. However, if any message is acknowledged during the assignments_revoked step, those acks won't be committed, they will just sit in the group coordinator inbox and eventually be processed too late. This commit makes it so we retrieve any pending ack from the inbox before we commit them.
- Loading branch information
Showing
3 changed files
with
176 additions
and
24 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,138 @@ | ||
| %%% | ||
| %%% Copyright (c) 2015-2019 Klarna Bank AB (publ) | ||
| %%% | ||
| %%% Licensed under the Apache License, Version 2.0 (the "License"); | ||
| %%% you may not use this file except in compliance with the License. | ||
| %%% You may obtain a copy of the License at | ||
| %%% | ||
| %%% http://www.apache.org/licenses/LICENSE-2.0 | ||
| %%% | ||
| %%% Unless required by applicable law or agreed to in writing, software | ||
| %%% distributed under the License is distributed on an "AS IS" BASIS, | ||
| %%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| %%% See the License for the specific language governing permissions and | ||
| %%% limitations under the License. | ||
| %%% | ||
|
|
||
| %% @private | ||
| -module(brod_group_coordinator_SUITE). | ||
| -define(CLIENT_ID, ?MODULE). | ||
| -define(OTHER_CLIENT_ID, other_coordinator_id). | ||
| -define(TOPIC, <<"brod-group-coordinator">>). | ||
| -define(GROUP, <<"brod-group-coordinator">>). | ||
| -define(PARTITION, 0). | ||
|
|
||
| %% Test framework | ||
| -export([ init_per_suite/1 | ||
| , end_per_suite/1 | ||
| , common_init_per_testcase/2 | ||
| , common_end_per_testcase/2 | ||
| , suite/0 | ||
| ]). | ||
|
|
||
| %% brod coordinator callbacks | ||
| -export([ assignments_revoked/1 | ||
| , assignments_received/4 | ||
| ]). | ||
|
|
||
| %% Test cases | ||
| -export([ t_acks_during_revoke/1 ]). | ||
|
|
||
| -define(assert_receive(Pattern, Return), | ||
| receive | ||
| Pattern -> Return | ||
| after | ||
| 30000 -> ct:fail(erlang:process_info(self(), messages)) | ||
| end). | ||
|
|
||
| -include_lib("snabbkaffe/include/ct_boilerplate.hrl"). | ||
| -include("brod.hrl"). | ||
|
|
||
| %%%_* ct callbacks ============================================================= | ||
|
|
||
| suite() -> [{timetrap, {seconds, 60}}]. | ||
|
|
||
| init_per_suite(Config) -> Config. | ||
| end_per_suite(_Config) -> ok. | ||
|
|
||
| common_init_per_testcase(_Case, Config) -> | ||
| {ok, _} = application:ensure_all_started(brod), | ||
| BootstrapHosts = [{"localhost", 9092}], | ||
| ClientConfig = client_config(), | ||
| ok = brod:start_client(BootstrapHosts, ?CLIENT_ID, ClientConfig), | ||
| ok = brod:start_client(BootstrapHosts, ?OTHER_CLIENT_ID, ClientConfig), | ||
| ok = brod:start_producer(?CLIENT_ID, ?TOPIC, _ProducerConfig = []), | ||
| Config. | ||
|
|
||
| common_end_per_testcase(_Case, Config) when is_list(Config) -> | ||
| ok = brod:stop_client(?CLIENT_ID), | ||
| ok = brod:stop_client(?OTHER_CLIENT_ID), | ||
| ok = application:stop(brod). | ||
|
|
||
| client_config() -> | ||
| case os:getenv("KAFKA_VERSION") of | ||
| "0.9" ++ _ -> [{query_api_versions, false}]; | ||
| _ -> [] | ||
| end. | ||
|
|
||
| %%%_* Group coordinator callbacks ============================================== | ||
|
|
||
| assignments_revoked({Pid, Count}) -> | ||
| Pid ! {assignments_revoked, Count}, | ||
| receive continue -> ok end, | ||
| ok. | ||
|
|
||
| assignments_received({Pid, Count}, _MemberId, GenerationId, TopicAssignments) -> | ||
| Pid ! {assignments_received, Count, GenerationId, TopicAssignments}, | ||
| ok. | ||
|
|
||
| %%%_* Test functions =========================================================== | ||
|
|
||
| t_acks_during_revoke(Config) when is_list(Config) -> | ||
| {ok, GroupCoordinator1Pid} = | ||
| brod_group_coordinator:start_link(?CLIENT_ID, ?GROUP, [?TOPIC], | ||
| _Config = [], ?MODULE, {self(), 1}), | ||
|
|
||
| ?assert_receive({assignments_revoked, 1}, ok), | ||
| GroupCoordinator1Pid ! continue, | ||
| GenerationId = ?assert_receive({assignments_received, 1, GId, _}, GId), | ||
|
|
||
| {ok, Offset} = | ||
| brod:produce_sync_offset(?CLIENT_ID, ?TOPIC, ?PARTITION, <<>>, <<1, 2, 3>>), | ||
|
|
||
| {ok, {_, [_]}} = brod:fetch(?CLIENT_ID, ?TOPIC, ?PARTITION, Offset), | ||
|
|
||
| {ok, GroupCoordinator2Pid} = | ||
| brod_group_coordinator:start_link(?OTHER_CLIENT_ID, ?GROUP, [?TOPIC], | ||
| _Config = [], ?MODULE, {self(), 2}), | ||
|
|
||
| %% Allow new partition to be started | ||
| ?assert_receive({assignments_revoked, 2}, ok), | ||
| GroupCoordinator2Pid ! continue, | ||
|
|
||
| %% We only ack when we are inside assignments_revoked | ||
| ?assert_receive({assignments_revoked, 1}, ok), | ||
| brod_group_coordinator:ack(GroupCoordinator1Pid, GenerationId, | ||
| ?TOPIC, ?PARTITION, Offset), | ||
| GroupCoordinator1Pid ! continue, | ||
|
|
||
| TopicAssignments1 = ?assert_receive({assignments_received, 1, _, TA1}, TA1), | ||
| TopicAssignments2 = ?assert_receive({assignments_received, 2, _, TA2}, TA2), | ||
| Assignments = TopicAssignments1 ++ TopicAssignments2, | ||
|
|
||
| %% The assigment needs to start at the chosen offset. | ||
| ?assertMatch( [ok] | ||
| , [ok || #brod_received_assignment{ | ||
| partition=?PARTITION, | ||
| begin_offset=BeginOffset | ||
| } <- Assignments, | ||
| BeginOffset == Offset + 1] | ||
| ), | ||
|
|
||
| ok. | ||
|
|
||
| %%%_* Emacs ==================================================================== | ||
| %%% Local Variables: | ||
| %%% allout-layout: t | ||
| %%% erlang-indent-level: 2 | ||
| %%% End: |