Merge pull request #7251 from terry-xiaoyu/add_restart_bridge_api

feat(bridge): add APIs for restart/stop bridges on one node
This commit is contained in:
Xinyu Liu 2022-03-10 13:34:44 +08:00 committed by GitHub
commit 67e39150d0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
27 changed files with 226 additions and 98 deletions

View File

@ -134,7 +134,7 @@ create(#{method := Method,
emqx_connector_http, emqx_connector_http,
Config#{base_url => maps:remove(query, URIMap), Config#{base_url => maps:remove(query, URIMap),
pool_type => random}, pool_type => random},
#{waiting_connect_complete => 5000}) of #{}) of
{ok, already_created} -> {ok, already_created} ->
{ok, State}; {ok, State};
{ok, _} -> {ok, _} ->

View File

@ -116,7 +116,7 @@ create(#{selector := Selector} = Config) ->
?RESOURCE_GROUP, ?RESOURCE_GROUP,
emqx_connector_mongo, emqx_connector_mongo,
Config, Config,
#{waiting_connect_complete => 5000}) of #{}) of
{ok, already_created} -> {ok, already_created} ->
{ok, NState}; {ok, NState};
{ok, _} -> {ok, _} ->

View File

@ -85,7 +85,7 @@ create(#{password_hash_algorithm := Algorithm,
?RESOURCE_GROUP, ?RESOURCE_GROUP,
emqx_connector_mysql, emqx_connector_mysql,
Config, Config,
#{waiting_connect_complete => 5000}) of #{}) of
{ok, already_created} -> {ok, already_created} ->
{ok, State}; {ok, State};
{ok, _} -> {ok, _} ->

View File

@ -81,7 +81,7 @@ create(#{query := Query0,
resource_id => ResourceId}, resource_id => ResourceId},
case emqx_resource:create_local(ResourceId, ?RESOURCE_GROUP, emqx_connector_pgsql, case emqx_resource:create_local(ResourceId, ?RESOURCE_GROUP, emqx_connector_pgsql,
Config#{named_queries => #{ResourceId => Query}}, Config#{named_queries => #{ResourceId => Query}},
#{waiting_connect_complete => 5000}) of #{}) of
{ok, already_created} -> {ok, already_created} ->
{ok, State}; {ok, State};
{ok, _} -> {ok, _} ->

View File

@ -93,7 +93,7 @@ create(#{cmd := Cmd,
resource_id => ResourceId}, resource_id => ResourceId},
case emqx_resource:create_local(ResourceId, ?RESOURCE_GROUP, case emqx_resource:create_local(ResourceId, ?RESOURCE_GROUP,
emqx_connector_redis, Config, emqx_connector_redis, Config,
#{waiting_connect_complete => 5000}) of #{}) of
{ok, already_created} -> {ok, already_created} ->
{ok, NState}; {ok, NState};
{ok, _} -> {ok, _} ->

View File

@ -63,7 +63,7 @@ init_per_suite(Config) ->
?RESOURCE_GROUP, ?RESOURCE_GROUP,
emqx_connector_mysql, emqx_connector_mysql,
mysql_config(), mysql_config(),
#{waiting_connect_complete => 5000}), #{}),
Config; Config;
false -> false ->
{skip, no_mysql} {skip, no_mysql}

View File

@ -64,7 +64,7 @@ init_per_suite(Config) ->
?RESOURCE_GROUP, ?RESOURCE_GROUP,
emqx_connector_pgsql, emqx_connector_pgsql,
pgsql_config(), pgsql_config(),
#{waiting_connect_complete => 5000}), #{}),
Config; Config;
false -> false ->
{skip, no_pgsql} {skip, no_pgsql}

View File

@ -63,7 +63,7 @@ init_per_suite(Config) ->
?RESOURCE_GROUP, ?RESOURCE_GROUP,
emqx_connector_redis, emqx_connector_redis,
redis_config(), redis_config(),
#{waiting_connect_complete => 5000}), #{}),
Config; Config;
false -> false ->
{skip, no_redis} {skip, no_redis}

View File

@ -56,7 +56,7 @@ init(#{query := SQL0} = Source) ->
?RESOURCE_GROUP, ?RESOURCE_GROUP,
emqx_connector_pgsql, emqx_connector_pgsql,
Source#{named_queries => #{ResourceID => SQL}}, Source#{named_queries => #{ResourceID => SQL}},
#{waiting_connect_complete => 5000}) of #{}) of
{ok, _} -> {ok, _} ->
Source#{annotations => Source#{annotations =>
#{id => ResourceID, #{id => ResourceID,

View File

@ -38,7 +38,7 @@ create_resource(Module, Config) ->
case emqx_resource:create_local(ResourceID, case emqx_resource:create_local(ResourceID,
?RESOURCE_GROUP, ?RESOURCE_GROUP,
Module, Config, Module, Config,
#{waiting_connect_complete => 5000}) of #{}) of
{ok, already_created} -> {ok, ResourceID}; {ok, already_created} -> {ok, ResourceID};
{ok, _} -> {ok, ResourceID}; {ok, _} -> {ok, ResourceID};
{error, Reason} -> {error, Reason} {error, Reason} -> {error, Reason}

View File

@ -45,7 +45,7 @@ init_per_suite(Config) ->
?RESOURCE_GROUP, ?RESOURCE_GROUP,
emqx_connector_mysql, emqx_connector_mysql,
mysql_config(), mysql_config(),
#{waiting_connect_complete => 5000}), #{}),
Config; Config;
false -> false ->
{skip, no_mysql} {skip, no_mysql}

View File

@ -45,7 +45,7 @@ init_per_suite(Config) ->
?RESOURCE_GROUP, ?RESOURCE_GROUP,
emqx_connector_pgsql, emqx_connector_pgsql,
pgsql_config(), pgsql_config(),
#{waiting_connect_complete => 5000}), #{}),
Config; Config;
false -> false ->
{skip, no_pgsql} {skip, no_pgsql}

View File

@ -46,7 +46,7 @@ init_per_suite(Config) ->
?RESOURCE_GROUP, ?RESOURCE_GROUP,
emqx_connector_redis, emqx_connector_redis,
redis_config(), redis_config(),
#{waiting_connect_complete => 5000}), #{}),
Config; Config;
false -> false ->
{skip, no_redis} {skip, no_redis}

View File

@ -50,7 +50,6 @@
, remove/2 , remove/2
, update/2 , update/2
, update/3 , update/3
, start/2
, stop/2 , stop/2
, restart/2 , restart/2
]). ]).
@ -208,12 +207,10 @@ lookup(Type, Name, RawConf) ->
raw_config => RawConf}} raw_config => RawConf}}
end. end.
start(Type, Name) ->
restart(Type, Name).
stop(Type, Name) -> stop(Type, Name) ->
emqx_resource:stop(resource_id(Type, Name)). emqx_resource:stop(resource_id(Type, Name)).
%% we don't provide 'start', as we want an already started bridge to be restarted.
restart(Type, Name) -> restart(Type, Name) ->
emqx_resource:restart(resource_id(Type, Name)). emqx_resource:restart(resource_id(Type, Name)).
@ -228,7 +225,7 @@ create(Type, Name, Conf) ->
<<"emqx_bridge">>, <<"emqx_bridge">>,
emqx_bridge:resource_type(Type), emqx_bridge:resource_type(Type),
parse_confs(Type, Name, Conf), parse_confs(Type, Name, Conf),
#{waiting_connect_complete => 5000}) of #{}) of
{ok, already_created} -> maybe_disable_bridge(Type, Name, Conf); {ok, already_created} -> maybe_disable_bridge(Type, Name, Conf);
{ok, _} -> maybe_disable_bridge(Type, Name, Conf); {ok, _} -> maybe_disable_bridge(Type, Name, Conf);
{error, Reason} -> {error, Reason} {error, Reason} -> {error, Reason}
@ -263,8 +260,8 @@ update(Type, Name, {OldConf, Conf}) ->
%% we don't need to recreate the bridge if this config change is only to %% we don't need to recreate the bridge if this config change is only to
%% toggole the config 'bridge.{type}.{name}.enable' %% toggole the config 'bridge.{type}.{name}.enable'
case maps:get(enable, Conf, true) of case maps:get(enable, Conf, true) of
false -> stop(Type, Name); true -> restart(Type, Name);
true -> start(Type, Name) false -> stop(Type, Name)
end end
end. end.
@ -275,7 +272,7 @@ recreate(Type, Name, Conf) ->
emqx_resource:recreate_local(resource_id(Type, Name), emqx_resource:recreate_local(resource_id(Type, Name),
emqx_bridge:resource_type(Type), emqx_bridge:resource_type(Type),
parse_confs(Type, Name, Conf), parse_confs(Type, Name, Conf),
#{waiting_connect_complete => 5000}). #{}).
create_dry_run(Type, Conf) -> create_dry_run(Type, Conf) ->
Conf0 = Conf#{<<"ingress">> => #{<<"remote_topic">> => <<"t">>}}, Conf0 = Conf#{<<"ingress">> => #{<<"remote_topic">> => <<"t">>}},

View File

@ -33,6 +33,7 @@
-export([ '/bridges'/2 -export([ '/bridges'/2
, '/bridges/:id'/2 , '/bridges/:id'/2
, '/bridges/:id/operation/:operation'/2 , '/bridges/:id/operation/:operation'/2
, '/nodes/:node/bridges/:id/operation/:operation'/2
]). ]).
-export([ lookup_from_local_node/2 -export([ lookup_from_local_node/2
@ -74,7 +75,8 @@ namespace() -> "bridge".
api_spec() -> api_spec() ->
emqx_dashboard_swagger:spec(?MODULE, #{check_schema => false}). emqx_dashboard_swagger:spec(?MODULE, #{check_schema => false}).
paths() -> ["/bridges", "/bridges/:id", "/bridges/:id/operation/:operation"]. paths() -> ["/bridges", "/bridges/:id", "/bridges/:id/operation/:operation",
"/nodes/:node/bridges/:id/operation/:operation"].
error_schema(Code, Message) when is_atom(Code) -> error_schema(Code, Message) when is_atom(Code) ->
error_schema([Code], Message); error_schema([Code], Message);
@ -87,11 +89,28 @@ get_response_body_schema() ->
emqx_dashboard_swagger:schema_with_examples(emqx_bridge_schema:get_response(), emqx_dashboard_swagger:schema_with_examples(emqx_bridge_schema:get_response(),
bridge_info_examples(get)). bridge_info_examples(get)).
param_path_operation() -> param_path_operation_cluster() ->
{operation, mk(enum([start, stop, restart]), {operation, mk(enum([enable, disable, stop, restart]),
#{ in => path #{ in => path
, required => true , required => true
, example => <<"start">> , example => <<"start">>
, desc => <<"Operations can be one of: enable, disable, start, stop, restart">>
})}.
param_path_operation_on_node() ->
{operation, mk(enum([stop, restart]),
#{ in => path
, required => true
, example => <<"start">>
, desc => <<"Operations can be one of: start, stop, restart">>
})}.
param_path_node() ->
{node, mk(binary(),
#{ in => path
, required => true
, example => <<"emqx@127.0.0.1">>
, desc => <<"The bridge Id. Must be of format {type}:{name}">>
})}. })}.
param_path_id() -> param_path_id() ->
@ -219,7 +238,7 @@ schema("/bridges") ->
bridge_info_examples(post)), bridge_info_examples(post)),
responses => #{ responses => #{
201 => get_response_body_schema(), 201 => get_response_body_schema(),
400 => error_schema('BAD_REQUEST', "Create bridge failed") 400 => error_schema('ALREADY_EXISTS', "Bridge already exists")
} }
} }
}; };
@ -267,11 +286,32 @@ schema("/bridges/:id/operation/:operation") ->
'operationId' => '/bridges/:id/operation/:operation', 'operationId' => '/bridges/:id/operation/:operation',
post => #{ post => #{
tags => [<<"bridges">>], tags => [<<"bridges">>],
summary => <<"Start/Stop/Restart Bridge">>, summary => <<"Enable/Disable/Stop/Restart Bridge">>,
description => <<"Start/Stop/Restart bridges on a specific node.">>, description => <<"Enable/Disable/Stop/Restart bridges on all nodes"
" in the cluster.">>,
parameters => [ parameters => [
param_path_id(), param_path_id(),
param_path_operation() param_path_operation_cluster()
],
responses => #{
500 => error_schema('INTERNAL_ERROR', "Operation Failed"),
200 => <<"Operation success">>
}
}
};
schema("/nodes/:node/bridges/:id/operation/:operation") ->
#{
'operationId' => '/nodes/:node/bridges/:id/operation/:operation',
post => #{
tags => [<<"bridges">>],
summary => <<"Stop/Restart Bridge">>,
description => <<"Stop/Restart bridges on a specific node.\n"
"NOTE: It's not allowed to disable/enable bridges on a single node.">>,
parameters => [
param_path_node(),
param_path_id(),
param_path_operation_on_node()
], ],
responses => #{ responses => #{
500 => error_schema('INTERNAL_ERROR', "Operation Failed"), 500 => error_schema('INTERNAL_ERROR', "Operation Failed"),
@ -341,23 +381,51 @@ lookup_from_local_node(BridgeType, BridgeName) ->
'/bridges/:id/operation/:operation'(post, #{bindings := '/bridges/:id/operation/:operation'(post, #{bindings :=
#{id := Id, operation := Op}}) -> #{id := Id, operation := Op}}) ->
?TRY_PARSE_ID(Id, case operation_to_conf_req(Op) of ?TRY_PARSE_ID(Id, case operation_func(Op) of
invalid -> {400, error_msg('BAD_REQUEST', <<"invalid operation">>)}; invalid -> {400, error_msg('BAD_REQUEST', <<"invalid operation">>)};
UpReq -> OperFunc when OperFunc == enable; OperFunc == disable ->
case emqx_conf:update(emqx_bridge:config_key_path() ++ [BridgeType, BridgeName], case emqx_conf:update(emqx_bridge:config_key_path() ++ [BridgeType, BridgeName],
{UpReq, BridgeType, BridgeName}, #{override_to => cluster}) of {OperFunc, BridgeType, BridgeName}, #{override_to => cluster}) of
{ok, _} -> {200}; {ok, _} -> {200};
{error, {pre_config_update, _, bridge_not_found}} -> {error, {pre_config_update, _, bridge_not_found}} ->
{404, error_msg('NOT_FOUND', <<"bridge not found">>)}; {404, error_msg('NOT_FOUND', <<"bridge not found">>)};
{error, Reason} -> {error, Reason} ->
{500, error_msg('INTERNAL_ERROR', Reason)} {500, error_msg('INTERNAL_ERROR', Reason)}
end;
OperFunc ->
Nodes = mria_mnesia:running_nodes(),
operation_to_all_nodes(Nodes, OperFunc, BridgeType, BridgeName)
end).
'/nodes/:node/bridges/:id/operation/:operation'(post, #{bindings :=
#{id := Id, operation := Op}}) ->
?TRY_PARSE_ID(Id, case operation_func(Op) of
invalid -> {400, error_msg('BAD_REQUEST', <<"invalid operation">>)};
OperFunc when OperFunc == restart; OperFunc == stop ->
case emqx_bridge:OperFunc(BridgeType, BridgeName) of
ok -> {200};
{error, Reason} ->
{500, error_msg('INTERNAL_ERROR', Reason)}
end end
end). end).
operation_to_conf_req(<<"start">>) -> start; operation_func(<<"stop">>) -> stop;
operation_to_conf_req(<<"stop">>) -> stop; operation_func(<<"restart">>) -> restart;
operation_to_conf_req(<<"restart">>) -> restart; operation_func(<<"enable">>) -> enable;
operation_to_conf_req(_) -> invalid. operation_func(<<"disable">>) -> disable;
operation_func(_) -> invalid.
operation_to_all_nodes(Nodes, OperFunc, BridgeType, BridgeName) ->
RpcFunc = case OperFunc of
restart -> restart_bridges_to_all_nodes;
stop -> stop_bridges_to_all_nodes
end,
case is_ok(emqx_bridge_proto_v1:RpcFunc(Nodes, BridgeType, BridgeName)) of
{ok, _} ->
{200};
{error, ErrL} ->
{500, error_msg('INTERNAL_ERROR', ErrL)}
end.
ensure_bridge_created(BridgeType, BridgeName, Conf) -> ensure_bridge_created(BridgeType, BridgeName, Conf) ->
case emqx_conf:update(emqx_bridge:config_key_path() ++ [BridgeType, BridgeName], case emqx_conf:update(emqx_bridge:config_key_path() ++ [BridgeType, BridgeName],
@ -437,7 +505,7 @@ format_metrics(#{
is_ok(ResL) -> is_ok(ResL) ->
case lists:filter(fun({ok, _}) -> false; (_) -> true end, ResL) of case lists:filter(fun({ok, _}) -> false; (ok) -> false; (_) -> true end, ResL) of
[] -> {ok, [Res || {ok, Res} <- ResL]}; [] -> {ok, [Res || {ok, Res} <- ResL]};
ErrL -> {error, ErrL} ErrL -> {error, ErrL}
end. end.

View File

@ -39,24 +39,16 @@ stop(_State) ->
ok = emqx_bridge:unload_hook(), ok = emqx_bridge:unload_hook(),
ok. ok.
-define(IS_OPER(O), when Oper == start; Oper == stop; Oper == restart). %% NOTE: We depends on the `emqx_bridge:pre_config_update/3` to restart/stop the
pre_config_update(_, {Oper, _, _}, undefined) ?IS_OPER(Oper) -> %% underlying resources.
pre_config_update(_, {_Oper, _, _}, undefined) ->
{error, bridge_not_found}; {error, bridge_not_found};
pre_config_update(_, {Oper, Type, Name}, OldConfig) ?IS_OPER(Oper) -> pre_config_update(_, {Oper, _Type, _Name}, OldConfig) ->
case perform_operation(Oper, Type, Name) of %% to save the 'enable' to the config files
ok -> {ok, OldConfig#{<<"enable">> => operation_to_enable(Oper)}};
%% we also need to save the 'enable' to the config files pre_config_update(_, Conf, _OldConfig) when is_map(Conf) ->
{ok, OldConfig#{<<"enable">> => operation_to_enable(Oper)}};
{error, _} = Err -> Err
end;
pre_config_update(_, Conf, _OldConfig) ->
{ok, Conf}. {ok, Conf}.
%% internal functions %% internal functions
operation_to_enable(start) -> true; operation_to_enable(disable) -> false;
operation_to_enable(stop) -> false; operation_to_enable(enable) -> true.
operation_to_enable(restart) -> true.
perform_operation(start, Type, Name) -> emqx_bridge:restart(Type, Name);
perform_operation(restart, Type, Name) -> emqx_bridge:restart(Type, Name);
perform_operation(stop, Type, Name) -> emqx_bridge:stop(Type, Name).

View File

@ -22,6 +22,8 @@
, list_bridges/1 , list_bridges/1
, lookup_from_all_nodes/3 , lookup_from_all_nodes/3
, restart_bridges_to_all_nodes/3
, stop_bridges_to_all_nodes/3
]). ]).
-include_lib("emqx/include/bpapi.hrl"). -include_lib("emqx/include/bpapi.hrl").
@ -37,7 +39,20 @@ list_bridges(Node) ->
-type key() :: atom() | binary() | [byte()]. -type key() :: atom() | binary() | [byte()].
-spec restart_bridges_to_all_nodes([node()], key(), key()) ->
emqx_rpc:erpc_multicall().
restart_bridges_to_all_nodes(Nodes, BridgeType, BridgeName) ->
erpc:multicall(Nodes, emqx_bridge, restart,
[BridgeType, BridgeName], ?TIMEOUT).
-spec stop_bridges_to_all_nodes([node()], key(), key()) ->
emqx_rpc:erpc_multicall().
stop_bridges_to_all_nodes(Nodes, BridgeType, BridgeName) ->
erpc:multicall(Nodes, emqx_bridge, stop,
[BridgeType, BridgeName], ?TIMEOUT).
-spec lookup_from_all_nodes([node()], key(), key()) -> -spec lookup_from_all_nodes([node()], key(), key()) ->
emqx_rpc:erpc_multicall(). emqx_rpc:erpc_multicall().
lookup_from_all_nodes(Nodes, BridgeType, BridgeName) -> lookup_from_all_nodes(Nodes, BridgeType, BridgeName) ->
erpc:multicall(Nodes, emqx_bridge_api, lookup_from_local_node, [BridgeType, BridgeName], ?TIMEOUT). erpc:multicall(Nodes, emqx_bridge_api, lookup_from_local_node,
[BridgeType, BridgeName], ?TIMEOUT).

View File

@ -79,8 +79,14 @@ init_per_testcase(_, Config) ->
{ok, _} = emqx_cluster_rpc:start_link(node(), emqx_cluster_rpc, 1000), {ok, _} = emqx_cluster_rpc:start_link(node(), emqx_cluster_rpc, 1000),
Config. Config.
end_per_testcase(_, _Config) -> end_per_testcase(_, _Config) ->
clear_resources(),
ok. ok.
clear_resources() ->
lists:foreach(fun(#{type := Type, name := Name}) ->
ok = emqx_bridge:remove(Type, Name)
end, emqx_bridge:list()).
%%------------------------------------------------------------------------------ %%------------------------------------------------------------------------------
%% HTTP server for testing %% HTTP server for testing
%%------------------------------------------------------------------------------ %%------------------------------------------------------------------------------
@ -239,6 +245,11 @@ t_http_crud_apis(_) ->
ok. ok.
t_start_stop_bridges(_) -> t_start_stop_bridges(_) ->
lists:foreach(fun(Type) ->
do_start_stop_bridges(Type)
end, [node, cluster]).
do_start_stop_bridges(Type) ->
%% assert we there's no bridges at first %% assert we there's no bridges at first
{ok, 200, <<"[]">>} = request(get, uri(["bridges"]), []), {ok, 200, <<"[]">>} = request(get, uri(["bridges"]), []),
@ -249,7 +260,7 @@ t_start_stop_bridges(_) ->
%ct:pal("the bridge ==== ~p", [Bridge]), %ct:pal("the bridge ==== ~p", [Bridge]),
#{ <<"type">> := ?BRIDGE_TYPE #{ <<"type">> := ?BRIDGE_TYPE
, <<"name">> := ?BRIDGE_NAME , <<"name">> := ?BRIDGE_NAME
, <<"status">> := _ , <<"status">> := <<"connected">>
, <<"node_status">> := [_|_] , <<"node_status">> := [_|_]
, <<"metrics">> := _ , <<"metrics">> := _
, <<"node_metrics">> := [_|_] , <<"node_metrics">> := [_|_]
@ -257,24 +268,68 @@ t_start_stop_bridges(_) ->
} = jsx:decode(Bridge), } = jsx:decode(Bridge),
BridgeID = emqx_bridge:bridge_id(?BRIDGE_TYPE, ?BRIDGE_NAME), BridgeID = emqx_bridge:bridge_id(?BRIDGE_TYPE, ?BRIDGE_NAME),
%% stop it %% stop it
{ok, 200, <<>>} = request(post, operation_path(stop, BridgeID), <<"">>), {ok, 200, <<>>} = request(post, operation_path(Type, stop, BridgeID), <<"">>),
{ok, 200, Bridge2} = request(get, uri(["bridges", BridgeID]), []), {ok, 200, Bridge2} = request(get, uri(["bridges", BridgeID]), []),
?assertMatch(#{ <<"status">> := <<"disconnected">> ?assertMatch(#{ <<"status">> := <<"disconnected">>
}, jsx:decode(Bridge2)), }, jsx:decode(Bridge2)),
%% start again %% start again
{ok, 200, <<>>} = request(post, operation_path(start, BridgeID), <<"">>), {ok, 200, <<>>} = request(post, operation_path(Type, restart, BridgeID), <<"">>),
{ok, 200, Bridge3} = request(get, uri(["bridges", BridgeID]), []), {ok, 200, Bridge3} = request(get, uri(["bridges", BridgeID]), []),
?assertMatch(#{ <<"status">> := <<"connected">> ?assertMatch(#{ <<"status">> := <<"connected">>
}, jsx:decode(Bridge3)), }, jsx:decode(Bridge3)),
%% restart an already started bridge %% restart an already started bridge
{ok, 200, <<>>} = request(post, operation_path(restart, BridgeID), <<"">>), {ok, 200, <<>>} = request(post, operation_path(Type, restart, BridgeID), <<"">>),
{ok, 200, Bridge3} = request(get, uri(["bridges", BridgeID]), []), {ok, 200, Bridge3} = request(get, uri(["bridges", BridgeID]), []),
?assertMatch(#{ <<"status">> := <<"connected">> ?assertMatch(#{ <<"status">> := <<"connected">>
}, jsx:decode(Bridge3)), }, jsx:decode(Bridge3)),
%% stop it again %% stop it again
{ok, 200, <<>>} = request(post, operation_path(stop, BridgeID), <<"">>), {ok, 200, <<>>} = request(post, operation_path(Type, stop, BridgeID), <<"">>),
%% restart a stopped bridge %% restart a stopped bridge
{ok, 200, <<>>} = request(post, operation_path(restart, BridgeID), <<"">>), {ok, 200, <<>>} = request(post, operation_path(Type, restart, BridgeID), <<"">>),
{ok, 200, Bridge4} = request(get, uri(["bridges", BridgeID]), []),
?assertMatch(#{ <<"status">> := <<"connected">>
}, jsx:decode(Bridge4)),
%% delete the bridge
{ok, 204, <<>>} = request(delete, uri(["bridges", BridgeID]), []),
{ok, 200, <<"[]">>} = request(get, uri(["bridges"]), []).
t_enable_disable_bridges(_) ->
%% assert we there's no bridges at first
{ok, 200, <<"[]">>} = request(get, uri(["bridges"]), []),
Port = start_http_server(fun handle_fun_200_ok/2),
URL1 = ?URL(Port, "abc"),
{ok, 201, Bridge} = request(post, uri(["bridges"]),
?HTTP_BRIDGE(URL1, ?BRIDGE_TYPE, ?BRIDGE_NAME)),
%ct:pal("the bridge ==== ~p", [Bridge]),
#{ <<"type">> := ?BRIDGE_TYPE
, <<"name">> := ?BRIDGE_NAME
, <<"status">> := <<"connected">>
, <<"node_status">> := [_|_]
, <<"metrics">> := _
, <<"node_metrics">> := [_|_]
, <<"url">> := URL1
} = jsx:decode(Bridge),
BridgeID = emqx_bridge:bridge_id(?BRIDGE_TYPE, ?BRIDGE_NAME),
%% disable it
{ok, 200, <<>>} = request(post, operation_path(cluster, disable, BridgeID), <<"">>),
{ok, 200, Bridge2} = request(get, uri(["bridges", BridgeID]), []),
?assertMatch(#{ <<"status">> := <<"disconnected">>
}, jsx:decode(Bridge2)),
%% enable again
{ok, 200, <<>>} = request(post, operation_path(cluster, enable, BridgeID), <<"">>),
{ok, 200, Bridge3} = request(get, uri(["bridges", BridgeID]), []),
?assertMatch(#{ <<"status">> := <<"connected">>
}, jsx:decode(Bridge3)),
%% enable an already started bridge
{ok, 200, <<>>} = request(post, operation_path(cluster, enable, BridgeID), <<"">>),
{ok, 200, Bridge3} = request(get, uri(["bridges", BridgeID]), []),
?assertMatch(#{ <<"status">> := <<"connected">>
}, jsx:decode(Bridge3)),
%% disable it again
{ok, 200, <<>>} = request(post, operation_path(cluster, disable, BridgeID), <<"">>),
%% enable a stopped bridge
{ok, 200, <<>>} = request(post, operation_path(cluster, enable, BridgeID), <<"">>),
{ok, 200, Bridge4} = request(get, uri(["bridges", BridgeID]), []), {ok, 200, Bridge4} = request(get, uri(["bridges", BridgeID]), []),
?assertMatch(#{ <<"status">> := <<"connected">> ?assertMatch(#{ <<"status">> := <<"connected">>
}, jsx:decode(Bridge4)), }, jsx:decode(Bridge4)),
@ -307,7 +362,7 @@ request(Method, Url, Body) ->
uri() -> uri([]). uri() -> uri([]).
uri(Parts) when is_list(Parts) -> uri(Parts) when is_list(Parts) ->
NParts = [E || E <- Parts], NParts = [E || E <- Parts],
?HOST ++ filename:join([?BASE_PATH, ?API_VERSION | NParts]). ?HOST ++ str(filename:join([?BASE_PATH, ?API_VERSION | NParts])).
auth_header_() -> auth_header_() ->
Username = <<"bridge_admin">>, Username = <<"bridge_admin">>,
@ -315,5 +370,10 @@ auth_header_() ->
{ok, Token} = emqx_dashboard_admin:sign_token(Username, Password), {ok, Token} = emqx_dashboard_admin:sign_token(Username, Password),
{"Authorization", "Bearer " ++ binary_to_list(Token)}. {"Authorization", "Bearer " ++ binary_to_list(Token)}.
operation_path(Oper, BridgeID) -> operation_path(node, Oper, BridgeID) ->
uri(["nodes", node(), "bridges", BridgeID, "operation", Oper]);
operation_path(cluster, Oper, BridgeID) ->
uri(["bridges", BridgeID, "operation", Oper]). uri(["bridges", BridgeID, "operation", Oper]).
str(S) when is_list(S) -> S;
str(S) when is_binary(S) -> binary_to_list(S).

View File

@ -21,9 +21,9 @@
, connector_id/2 , connector_id/2
]). ]).
-export([ list/0 -export([ list_raw/0
, lookup/1 , lookup_raw/1
, lookup/2 , lookup_raw/2
, create_dry_run/2 , create_dry_run/2
, update/2 , update/2
, update/3 , update/3
@ -68,18 +68,18 @@ parse_connector_id(ConnectorId) ->
_ -> error({invalid_connector_id, ConnectorId}) _ -> error({invalid_connector_id, ConnectorId})
end. end.
list() -> list_raw() ->
lists:foldl(fun({Type, NameAndConf}, Connectors) -> lists:foldl(fun({Type, NameAndConf}, Connectors) ->
lists:foldl(fun({Name, RawConf}, Acc) -> lists:foldl(fun({Name, RawConf}, Acc) ->
[RawConf#{<<"type">> => Type, <<"name">> => Name} | Acc] [RawConf#{<<"type">> => Type, <<"name">> => Name} | Acc]
end, Connectors, maps:to_list(NameAndConf)) end, Connectors, maps:to_list(NameAndConf))
end, [], maps:to_list(emqx:get_raw_config(config_key_path(), #{}))). end, [], maps:to_list(emqx:get_raw_config(config_key_path(), #{}))).
lookup(Id) when is_binary(Id) -> lookup_raw(Id) when is_binary(Id) ->
{Type, Name} = parse_connector_id(Id), {Type, Name} = parse_connector_id(Id),
lookup(Type, Name). lookup_raw(Type, Name).
lookup(Type, Name) -> lookup_raw(Type, Name) ->
case emqx:get_raw_config(config_key_path() ++ [Type, Name], not_found) of case emqx:get_raw_config(config_key_path() ++ [Type, Name], not_found) of
not_found -> {error, not_found}; not_found -> {error, not_found};
Conf -> {ok, Conf#{<<"type">> => Type, <<"name">> => Name}} Conf -> {ok, Conf#{<<"type">> => Type, <<"name">> => Name}}

View File

@ -205,10 +205,10 @@ schema("/connectors/:id") ->
end. end.
'/connectors'(get, _Request) -> '/connectors'(get, _Request) ->
{200, [format_resp(Conn) || Conn <- emqx_connector:list()]}; {200, [format_resp(Conn) || Conn <- emqx_connector:list_raw()]};
'/connectors'(post, #{body := #{<<"type">> := ConnType, <<"name">> := ConnName} = Params}) -> '/connectors'(post, #{body := #{<<"type">> := ConnType, <<"name">> := ConnName} = Params}) ->
case emqx_connector:lookup(ConnType, ConnName) of case emqx_connector:lookup_raw(ConnType, ConnName) of
{ok, _} -> {ok, _} ->
{400, error_msg('ALREADY_EXISTS', <<"connector already exists">>)}; {400, error_msg('ALREADY_EXISTS', <<"connector already exists">>)};
{error, not_found} -> {error, not_found} ->
@ -218,13 +218,13 @@ schema("/connectors/:id") ->
{201, format_resp(RawConf#{<<"type">> => ConnType, {201, format_resp(RawConf#{<<"type">> => ConnType,
<<"name">> => ConnName})}; <<"name">> => ConnName})};
{error, Error} -> {error, Error} ->
{400, error_msg('ALREADY_EXISTS', Error)} {400, error_msg('BAD_REQUEST', Error)}
end end
end. end.
'/connectors/:id'(get, #{bindings := #{id := Id}}) -> '/connectors/:id'(get, #{bindings := #{id := Id}}) ->
?TRY_PARSE_ID(Id, ?TRY_PARSE_ID(Id,
case emqx_connector:lookup(ConnType, ConnName) of case emqx_connector:lookup_raw(ConnType, ConnName) of
{ok, Conf} -> {ok, Conf} ->
{200, format_resp(Conf)}; {200, format_resp(Conf)};
{error, not_found} -> {error, not_found} ->
@ -234,7 +234,7 @@ schema("/connectors/:id") ->
'/connectors/:id'(put, #{bindings := #{id := Id}, body := Params0}) -> '/connectors/:id'(put, #{bindings := #{id := Id}, body := Params0}) ->
Params = filter_out_request_body(Params0), Params = filter_out_request_body(Params0),
?TRY_PARSE_ID(Id, ?TRY_PARSE_ID(Id,
case emqx_connector:lookup(ConnType, ConnName) of case emqx_connector:lookup_raw(ConnType, ConnName) of
{ok, _} -> {ok, _} ->
case emqx_connector:update(ConnType, ConnName, Params) of case emqx_connector:update(ConnType, ConnName, Params) of
{ok, #{raw_config := RawConf}} -> {ok, #{raw_config := RawConf}} ->
@ -249,7 +249,7 @@ schema("/connectors/:id") ->
'/connectors/:id'(delete, #{bindings := #{id := Id}}) -> '/connectors/:id'(delete, #{bindings := #{id := Id}}) ->
?TRY_PARSE_ID(Id, ?TRY_PARSE_ID(Id,
case emqx_connector:lookup(ConnType, ConnName) of case emqx_connector:lookup_raw(ConnType, ConnName) of
{ok, _} -> {ok, _} ->
case emqx_connector:delete(ConnType, ConnName) of case emqx_connector:delete(ConnType, ConnName) of
{ok, _} -> {ok, _} ->

View File

@ -114,15 +114,6 @@ set_special_configs(_) ->
init_per_testcase(_, Config) -> init_per_testcase(_, Config) ->
{ok, _} = emqx_cluster_rpc:start_link(node(), emqx_cluster_rpc, 1000), {ok, _} = emqx_cluster_rpc:start_link(node(), emqx_cluster_rpc, 1000),
%% assert we there's no connectors and no bridges at first
{ok, 200, Connectors} = request(get, uri(["connectors"]), []),
lists:foreach(fun(#{<<"id">> := ConnectorID}) ->
{ok, 200, <<>>} = request(delete, uri(["connectors", ConnectorID]), [])
end, jsx:decode(Connectors)),
{ok, 200, Bridges} = request(get, uri(["bridges"]), []),
lists:foreach(fun(#{<<"id">> := BridgeID}) ->
{ok, 204, <<>>} = request(delete, uri(["bridges", BridgeID]), [])
end, jsx:decode(Bridges)),
Config. Config.
end_per_testcase(_, _Config) -> end_per_testcase(_, _Config) ->
clear_resources(), clear_resources(),
@ -135,9 +126,9 @@ clear_resources() ->
lists:foreach(fun(#{type := Type, name := Name}) -> lists:foreach(fun(#{type := Type, name := Name}) ->
ok = emqx_bridge:remove(Type, Name) ok = emqx_bridge:remove(Type, Name)
end, emqx_bridge:list()), end, emqx_bridge:list()),
lists:foreach(fun(#{type := Type, name := Name}) -> lists:foreach(fun(#{<<"type">> := Type, <<"name">> := Name}) ->
ok = emqx_connector:delete(Type, Name) ok = emqx_connector:delete(Type, Name)
end, emqx_connector:list()). end, emqx_connector:list_raw()).
%%------------------------------------------------------------------------------ %%------------------------------------------------------------------------------
%% Testcases %% Testcases

View File

@ -71,7 +71,7 @@ perform_lifecycle_check(PoolName, InitialConfig) ->
?CONNECTOR_RESOURCE_GROUP, ?CONNECTOR_RESOURCE_GROUP,
?MYSQL_RESOURCE_MOD, ?MYSQL_RESOURCE_MOD,
CheckedConfig, CheckedConfig,
#{waiting_connect_complete => 5000} #{}
), ),
?assertEqual(InitialStatus, connected), ?assertEqual(InitialStatus, connected),
% Instance should match the state and status of the just started resource % Instance should match the state and status of the just started resource

View File

@ -72,7 +72,7 @@ perform_lifecycle_check(PoolName, InitialConfig) ->
?CONNECTOR_RESOURCE_GROUP, ?CONNECTOR_RESOURCE_GROUP,
?PGSQL_RESOURCE_MOD, ?PGSQL_RESOURCE_MOD,
CheckedConfig, CheckedConfig,
#{waiting_connect_complete => 5000} #{}
), ),
?assertEqual(InitialStatus, connected), ?assertEqual(InitialStatus, connected),
% Instance should match the state and status of the just started resource % Instance should match the state and status of the just started resource

View File

@ -86,7 +86,7 @@ perform_lifecycle_check(PoolName, InitialConfig, RedisCommand) ->
?CONNECTOR_RESOURCE_GROUP, ?CONNECTOR_RESOURCE_GROUP,
?REDIS_RESOURCE_MOD, ?REDIS_RESOURCE_MOD,
CheckedConfig, CheckedConfig,
#{waiting_connect_complete => 5000} #{}
), ),
?assertEqual(InitialStatus, connected), ?assertEqual(InitialStatus, connected),
% Instance should match the state and status of the just started resource % Instance should match the state and status of the just started resource

View File

@ -157,6 +157,8 @@ init(Name) ->
persistent_term:put(?CntrRef(Name), #{}), persistent_term:put(?CntrRef(Name), #{}),
{ok, #state{}}. {ok, #state{}}.
handle_call({get_rate, _Id}, _From, State = #state{rates = undefined}) ->
{reply, #{}, State};
handle_call({get_rate, Id}, _From, State = #state{rates = Rates}) -> handle_call({get_rate, Id}, _From, State = #state{rates = Rates}) ->
{reply, case maps:get(Id, Rates, undefined) of {reply, case maps:get(Id, Rates, undefined) of
undefined -> #{}; undefined -> #{};

View File

@ -178,14 +178,17 @@ do_recreate(InstId, ResourceType, NewConfig, Opts) ->
{error, not_found} {error, not_found}
end. end.
wait_for_resource_ready(InstId, 0) -> wait_for_resource_ready(InstId, WaitTime) ->
force_lookup(InstId); do_wait_for_resource_ready(InstId, WaitTime div 100).
wait_for_resource_ready(InstId, Retry) ->
do_wait_for_resource_ready(_InstId, 0) ->
timeout;
do_wait_for_resource_ready(InstId, Retry) ->
case force_lookup(InstId) of case force_lookup(InstId) of
#{status := connected} = Data -> Data; #{status := connected} -> ok;
_ -> _ ->
timer:sleep(100), timer:sleep(100),
wait_for_resource_ready(InstId, Retry-1) do_wait_for_resource_ready(InstId, Retry-1)
end. end.
do_create(InstId, Group, ResourceType, Config, Opts) -> do_create(InstId, Group, ResourceType, Config, Opts) ->
@ -197,8 +200,7 @@ do_create(InstId, Group, ResourceType, Config, Opts) ->
ok -> ok ->
ok = emqx_plugin_libs_metrics:create_metrics(resource_metrics, InstId, ok = emqx_plugin_libs_metrics:create_metrics(resource_metrics, InstId,
[matched, success, failed, exception], [matched]), [matched, success, failed, exception], [matched]),
WaitTime = maps:get(waiting_connect_complete , Opts, 0), {ok, force_lookup(InstId)};
{ok, wait_for_resource_ready(InstId, WaitTime div 100)};
Error -> Error ->
Error Error
end end
@ -252,6 +254,7 @@ do_start(InstId, Group, ResourceType, Config, Opts) when is_binary(InstId) ->
spawn(fun() -> spawn(fun() ->
start_and_check(InstId, Group, ResourceType, Config, Opts, InitData) start_and_check(InstId, Group, ResourceType, Config, Opts, InitData)
end), end),
_ = wait_for_resource_ready(InstId, maps:get(wait_for_resource_ready, Opts, 5000)),
ok. ok.
start_and_check(InstId, Group, ResourceType, Config, Opts, Data) -> start_and_check(InstId, Group, ResourceType, Config, Opts, Data) ->

View File

@ -361,7 +361,7 @@ create_resource(Context, #{type := DB} = Config) ->
<<"emqx_retainer">>, <<"emqx_retainer">>,
list_to_existing_atom(io_lib:format("~ts_~ts", [emqx_connector, DB])), list_to_existing_atom(io_lib:format("~ts_~ts", [emqx_connector, DB])),
Config, Config,
#{waiting_connect_complete => 5000}) of #{}) of
{ok, already_created} -> {ok, already_created} ->
Context#{resource_id => ResourceID}; Context#{resource_id => ResourceID};
{ok, _} -> {ok, _} ->