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

Dynamic Shovels: support old and new supervisor child ID formats on 3.11.x #10080

Merged
merged 7 commits into from
Dec 8, 2023
Merged

Dynamic Shovels: support old and new supervisor child ID formats on 3.11.x #10080

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
67e11c8
Dynamic Shovels: support old and new supervisor child ID formats
michaelklishin Nov 13, 2023
2a0322e
Dynamic Shovels: filter out old supervisor child IDs
michaelklishin Nov 13, 2023
525c79f
Adapt #9909 for 3.12.x, references #9894
michaelklishin Nov 14, 2023
fe92055
Don't create shovel if already exists with old sup id
gomoripeti Nov 17, 2023
2e82e79
Fix deleting and cleanup of shovels with old ids
gomoripeti Nov 17, 2023
334bb18
Fix dyn shovel child_exists check for old id format
gomoripeti Nov 17, 2023
b1d54fd
Update comment about which versions introduced new shovel child id fo…
gomoripeti Dec 8, 2023
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
60 changes: 48 additions & 12 deletions deps/rabbitmq_shovel/src/rabbit_shovel_dyn_worker_sup_sup.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,24 +41,31 @@ start_child({VHost, ShovelName} = Name, Def) ->
LockId = rabbit_shovel_locks:lock(Name),
cleanup_specs(),
rabbit_log_shovel:debug("Starting a mirrored supervisor named '~s' in virtual host '~s'", [ShovelName, VHost]),
Result = case mirrored_supervisor:start_child(
case child_exists(Name)
orelse mirrored_supervisor:start_child(
?SUPERVISOR,
{id(Name), {rabbit_shovel_dyn_worker_sup, start_link, [Name, obfuscated_uris_parameters(Def)]},
transient, ?WORKER_WAIT, worker, [rabbit_shovel_dyn_worker_sup]}) of
true -> ok;
{ok, _Pid} -> ok;
{error, {already_started, _Pid}} -> ok
end,
%% release the lock if we managed to acquire one
rabbit_shovel_locks:unlock(LockId),
Result.
ok.

obfuscated_uris_parameters(Def) when is_map(Def) ->
to_map(rabbit_shovel_parameters:obfuscate_uris_in_definition(to_list(Def)));
obfuscated_uris_parameters(Def) when is_list(Def) ->
rabbit_shovel_parameters:obfuscate_uris_in_definition(Def).

child_exists(Name) ->
lists:any(fun ({{_, N}, _, _, _}) -> N =:= Name end,
Id = id(Name),
%% older format, pre 3.13.0, 3.12.8 and 3.11.25. See rabbitmq/rabbitmq-server#9894.
OldId = old_id(Name),
lists:any(fun ({ChildId, _, _, _}) ->
ChildId =:= Id orelse ChildId =:= OldId
end,
mirrored_supervisor:which_children(?SUPERVISOR)).

stop_child({VHost, ShovelName} = Name) ->
Expand All @@ -67,8 +74,18 @@ stop_child({VHost, ShovelName} = Name) ->
case get({shovel_worker_autodelete, Name}) of
true -> ok; %% [1]
_ ->
ok = mirrored_supervisor:terminate_child(?SUPERVISOR, id(Name)),
ok = mirrored_supervisor:delete_child(?SUPERVISOR, id(Name)),
case mirrored_supervisor:terminate_child(?SUPERVISOR, id(Name)) of
ok ->
ok = mirrored_supervisor:delete_child(?SUPERVISOR, id(Name));
{error, not_found} ->
%% try older format, pre 3.13.0, 3.12.8 and 3.11.25. See rabbitmq/rabbitmq-server#9894.
case mirrored_supervisor:terminate_child(?SUPERVISOR, old_id(Name)) of
ok ->
ok = mirrored_supervisor:delete_child(?SUPERVISOR, old_id(Name));
{error, not_found} ->
ok
end
end,
rabbit_shovel_status:remove(Name)
end,
rabbit_shovel_locks:unlock(LockId),
Expand All @@ -83,19 +100,38 @@ stop_child({VHost, ShovelName} = Name) ->
%% See rabbit_shovel_worker:terminate/2

cleanup_specs() ->
SpecsSet = sets:from_list([element(2, element(1, S)) || S <- mirrored_supervisor:which_children(?SUPERVISOR)]),
ParamsSet = sets:from_list([ {proplists:get_value(vhost, S), proplists:get_value(name, S)}
|| S <- rabbit_runtime_parameters:list_component(<<"shovel">>) ]),
F = fun(Name, ok) ->
_ = mirrored_supervisor:delete_child(?SUPERVISOR, id(Name)),
Children = mirrored_supervisor:which_children(?SUPERVISOR),

ChildIdSet = sets:from_list([element(1, S) || S <- Children]),
ParamsSet = sets:from_list(
lists:flatmap(
fun(S) ->
Name = {proplists:get_value(vhost, S), proplists:get_value(name, S)},
%% Supervisor Id format was different pre 3.13.0, 3.12.8 and 3.11.25.
%% Try both formats to cover the transitionary mixed version cluster period.
[id(Name), old_id(Name)]
end,
rabbit_runtime_parameters:list_component(<<"shovel">>))),
F = fun(ChildId, ok) ->
try
_ = mirrored_supervisor:delete_child(?SUPERVISOR, ChildId)
catch _:_:_Stacktrace ->
ok
end,
ok
end,
ok = sets:fold(F, ok, sets:subtract(SpecsSet, ParamsSet)).
%% Delete any supervisor children that do not have their respective runtime parameters in the database.
SetToCleanUp = sets:subtract(ChildIdSet, ParamsSet),
ok = sets:fold(F, ok, SetToCleanUp).

%%----------------------------------------------------------------------------

init([]) ->
{ok, {{one_for_one, 3, 10}, []}}.

id({V, S} = Name) ->
{[V, S], Name}.
{[V, S], Name}.

%% older format, pre 3.13.0, 3.12.8 and 3.11.25. See rabbitmq/rabbitmq-server#9894
old_id({_V, _S} = Name) ->
Name.