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

fix(bridge_v2_api): avoid calling nodes that do not support minimum bpapi #12472

Merged
merged 1 commit into from Feb 5, 2024
Merged

fix(bridge_v2_api): avoid calling nodes that do not support minimum bpapi #12472

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 13 additions & 3 deletions apps/emqx_bridge/src/emqx_bridge_v2_api.erl
View file
Open in desktop
Expand Up @@ -747,7 +747,7 @@ schema("/source_types") ->
%%------------------------------------------------------------------------------

handle_list(ConfRootKey) ->
Nodes = emqx:running_nodes(),
Nodes = nodes_supporting_bpapi_version(6),
NodeReplies = emqx_bridge_proto_v6:v2_list_bridges_on_nodes_v6(Nodes, ConfRootKey),
case is_ok(NodeReplies) of
{ok, NodeBridges} ->
Expand Down Expand Up @@ -942,7 +942,7 @@ is_ok(ResL) ->
%% bridge helpers
-spec lookup_from_all_nodes(emqx_bridge_v2:root_cfg_key(), _, _, _) -> _.
lookup_from_all_nodes(ConfRootKey, BridgeType, BridgeName, SuccCode) ->
Nodes = emqx:running_nodes(),
Nodes = nodes_supporting_bpapi_version(6),
case
is_ok(
emqx_bridge_proto_v6:v2_lookup_from_all_nodes_v6(
Expand All @@ -959,7 +959,7 @@ lookup_from_all_nodes(ConfRootKey, BridgeType, BridgeName, SuccCode) ->
end.

get_metrics_from_all_nodes(ConfRootKey, Type, Name) ->
Nodes = emqx:running_nodes(),
Nodes = nodes_supporting_bpapi_version(6),
Result = maybe_unwrap(
emqx_bridge_proto_v6:v2_get_metrics_from_all_nodes_v6(Nodes, ConfRootKey, Type, Name)
),
Expand Down Expand Up @@ -1058,6 +1058,16 @@ supported_versions(_Call) -> bpapi_version_range(6, 6).
bpapi_version_range(From, To) ->
lists:seq(From, To).

nodes_supporting_bpapi_version(Vsn) ->
[
N
|| N <- emqx:running_nodes(),
case emqx_bpapi:supported_version(N, ?BPAPI_NAME) of
undefined -> false;
NVsn when is_number(NVsn) -> NVsn >= Vsn
end
].

maybe_unwrap({error, not_implemented}) ->
{error, not_implemented};
maybe_unwrap(RpcMulticallResult) ->
Expand Down
47 changes: 45 additions & 2 deletions apps/emqx_bridge/test/emqx_bridge_v2_api_SUITE.erl
View file
Open in desktop
Expand Up @@ -106,7 +106,6 @@
-define(KAFKA_BRIDGE_UPDATE(Name, Connector),
maps:without([<<"name">>, <<"type">>], ?KAFKA_BRIDGE(Name, Connector))
).
-define(KAFKA_BRIDGE_UPDATE(Name), ?KAFKA_BRIDGE_UPDATE(Name, ?ACTION_CONNECTOR_NAME)).

-define(SOURCE_TYPE_STR, "mqtt").
-define(SOURCE_TYPE, <<?SOURCE_TYPE_STR>>).
Expand Down Expand Up @@ -1477,7 +1476,7 @@ t_cluster_later_join_metrics(Config) ->
?assertMatch(
{ok, 200, #{
<<"metrics">> := #{<<"success">> := _},
<<"node_metrics">> := [#{<<"metrics">> := #{}}, #{<<"metrics">> := #{}} | _]
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Returns a single node result now, because BPAPI might not be ready / not have announced the new node's APIs yet, and thus is rejected when choosing the nodes.

<<"node_metrics">> := [#{<<"metrics">> := #{}} | _]
}},
request_json(get, uri([?ACTIONS_ROOT, ActionID, "metrics"]), Config)
),
Expand Down Expand Up @@ -1512,3 +1511,47 @@ t_raw_config_response_defaults(Config) ->
)
),
ok.

t_older_version_nodes_in_cluster(matrix) ->
[
[cluster, actions],
[cluster, sources]
];
t_older_version_nodes_in_cluster(Config) ->
Copy link
Member

Choose a reason for hiding this comment

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

Is this testcase going to be relevant in the future releases? If not, perhaps a manual one-off test is enough?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think this still might be relevant for any rolling upgrade scenario.

[_, Kind | _] = group_path(Config),
PrimaryNode = ?config(node, Config),
OtherNode = maybe_get_other_node(Config),
?assertNotEqual(OtherNode, PrimaryNode),
Name = atom_to_binary(?FUNCTION_NAME),
?check_trace(
begin
#{api_root_key := APIRootKey} = get_common_values(Kind, Name),
erpc:call(PrimaryNode, fun() ->
meck:new(emqx_bpapi, [no_history, passthrough, no_link]),
meck:expect(emqx_bpapi, supported_version, fun(N, Api) ->
case N =:= OtherNode of
true -> 1;
false -> meck:passthrough([N, Api])
end
end)
end),
erpc:call(OtherNode, fun() ->
meck:new(emqx_bridge_v2, [no_history, passthrough, no_link]),
meck:expect(emqx_bridge_v2, list, fun(_ConfRootKey) ->
error(should_not_be_called)
end)
end),
?assertMatch(
{ok, 200, _},
request_json(
get,
uri([APIRootKey]),
Config
)
),
ok
end,
[]
),

ok.
1 change: 1 addition & 0 deletions changes/ce/fix-12472.en.md
View file
Open in desktop
@@ -0,0 +1 @@
Fixed an issue that could lead to some read operations on `/api/v5/actions/` and `/api/v5/sources/` to return 500 while rolling upgrades are underway.