yuanbiao
/
emqx
1
0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix: `?SLOG` with msg field

This commit is contained in:
JimMoen 2024-06-19 18:38:10 +08:00
parent a6fa3e82d9
commit ff742d926a
No known key found for this signature in database
4 changed files with 53 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
apps/emqx_management/src/emqx_mgmt_api_plugins.erl
View File

@ -410,7 +410,7 @@ upload_install(post, #{body := #{<<"plugin">> := Plugin}}) when is_map(Plugin) -
%% File bin is too large, we use rpc:multicall instead of cluster_rpc:multicall %% File bin is too large, we use rpc:multicall instead of cluster_rpc:multicall
NameVsn = string:trim(FileName, trailing, ".tar.gz"), NameVsn = string:trim(FileName, trailing, ".tar.gz"),
case emqx_plugins:describe(NameVsn) of case emqx_plugins:describe(NameVsn) of
{error, #{error_msg := "bad_info_file", reason := {enoent, _}}} -> {error, #{msg := "bad_info_file", reason := {enoent, _Path}}} ->
case emqx_plugins:parse_name_vsn(FileName) of case emqx_plugins:parse_name_vsn(FileName) of
{ok, AppName, _Vsn} -> {ok, AppName, _Vsn} ->
AppDir = filename:join(emqx_plugins:install_dir(), AppName), AppDir = filename:join(emqx_plugins:install_dir(), AppName),
@ -466,12 +466,12 @@ do_install_package(FileName, Bin) ->
), ),
Reason = Reason =
case hd(Filtered) of case hd(Filtered) of
{error, #{error_msg := Reason0}} -> Reason0; {error, #{msg := Reason0}} -> Reason0;
{error, #{reason := Reason0}} -> Reason0 {error, #{reason := Reason0}} -> Reason0
end, end,
{400, #{ {400, #{
code => 'BAD_PLUGIN_INFO', code => 'BAD_PLUGIN_INFO',
message => iolist_to_binary([Reason, ": ", FileName]) message => iolist_to_binary([bin(Reason), ": ", FileName])
}} }}
end. end.
@ -627,10 +627,9 @@ do_update_plugin_config(NameVsn, AvroJsonMap, AvroValue) ->
return(Code, ok) -> return(Code, ok) ->
{Code}; {Code};
return(_, {error, #{error_msg := "bad_info_file", reason := {enoent, _} = Reason}}) -> return(_, {error, #{msg := Msg, reason := {enoent, Path} = Reason}}) ->
{404, #{code => 'NOT_FOUND', message => readable_error_msg(Reason)}}; ?SLOG(error, #{msg => Msg, reason => Reason}),
return(_, {error, #{error_msg := "bad_avro_config_file", reason := {enoent, _} = Reason}}) -> {404, #{code => 'NOT_FOUND', message => iolist_to_binary([Path, " does not exist"])}};
{404, #{code => 'NOT_FOUND', message => readable_error_msg(Reason)}};
return(_, {error, Reason}) -> return(_, {error, Reason}) ->
{400, #{code => 'PARAM_ERROR', message => readable_error_msg(Reason)}}. {400, #{code => 'PARAM_ERROR', message => readable_error_msg(Reason)}}.
@ -730,6 +729,10 @@ format_plugin_avsc_and_i18n(_NameVsn) ->
#{avsc => null, i18n => null}. #{avsc => null, i18n => null}.
-endif. -endif.
bin(A) when is_atom(A) -> atom_to_binary(A, utf8);
bin(L) when is_list(L) -> list_to_binary(L);
bin(B) when is_binary(B) -> B.
% running_status: running loaded, stopped % running_status: running loaded, stopped
%% config_status: not_configured disable enable %% config_status: not_configured disable enable
plugin_status(#{running_status := running}) -> running; plugin_status(#{running_status := running}) -> running;

68
apps/emqx_plugins/src/emqx_plugins.erl
View File

@ -198,12 +198,12 @@ ensure_uninstalled(NameVsn) ->
case read_plugin_info(NameVsn, #{}) of case read_plugin_info(NameVsn, #{}) of
{ok, #{running_status := RunningSt}} when RunningSt =/= stopped -> {ok, #{running_status := RunningSt}} when RunningSt =/= stopped ->
{error, #{ {error, #{
error_msg => "bad_plugin_running_status", msg => "bad_plugin_running_status",
hint => "stop_the_plugin_first" hint => "stop_the_plugin_first"
}}; }};
{ok, #{config_status := enabled}} -> {ok, #{config_status := enabled}} ->
{error, #{ {error, #{
error_msg => "bad_plugin_config_status", msg => "bad_plugin_config_status",
hint => "disable_the_plugin_first" hint => "disable_the_plugin_first"
}}; }};
_ -> _ ->
@ -289,7 +289,7 @@ ensure_started(NameVsn) ->
ok -> ok ->
ok; ok;
{error, ReasonMap} -> {error, ReasonMap} ->
?SLOG(alert, ReasonMap#{msg => "failed_to_start_plugin"}), ?SLOG(error, ReasonMap#{msg => "failed_to_start_plugin"}),
{error, ReasonMap} {error, ReasonMap}
end. end.
@ -383,7 +383,7 @@ list() ->
{ok, Info} -> {ok, Info} ->
{true, Info}; {true, Info};
{error, Reason} -> {error, Reason} ->
?SLOG(warning, Reason), ?SLOG(warning, Reason#{msg => "failed_to_read_plugin_info"}),
false false
end end
end, end,
@ -411,7 +411,10 @@ decode_plugin_config_map(NameVsn, AvroJsonMap) ->
do_decode_plugin_config_map(NameVsn, AvroJsonMap) do_decode_plugin_config_map(NameVsn, AvroJsonMap)
end; end;
false -> false ->
?SLOG(debug, #{name_vsn => NameVsn, plugin_with_avro_schema => false}), ?SLOG(debug, #{
msg => "plugin_without_config_schema",
name_vsn => NameVsn
}),
{ok, ?plugin_without_config_schema} {ok, ?plugin_without_config_schema}
end. end.
@ -546,13 +549,13 @@ do_ensure_installed(NameVsn) ->
end; end;
{error, {_, enoent}} -> {error, {_, enoent}} ->
{error, #{ {error, #{
error_msg => "failed_to_extract_plugin_package", msg => "failed_to_extract_plugin_package",
path => TarGz, path => TarGz,
reason => not_found reason => plugin_tarball_not_found
}}; }};
{error, Reason} -> {error, Reason} ->
{error, #{ {error, #{
error_msg => "bad_plugin_package", msg => "bad_plugin_package",
path => TarGz, path => TarGz,
reason => Reason reason => Reason
}} }}
@ -609,7 +612,7 @@ add_new_configured(Configured, {Action, NameVsn}, Item) ->
{Front, Rear} = lists:splitwith(SplitFun, Configured), {Front, Rear} = lists:splitwith(SplitFun, Configured),
Rear =:= [] andalso Rear =:= [] andalso
throw(#{ throw(#{
error_msg => "position_anchor_plugin_not_configured", msg => "position_anchor_plugin_not_configured",
hint => "maybe_install_and_configure", hint => "maybe_install_and_configure",
name_vsn => NameVsn name_vsn => NameVsn
}), }),
@ -675,8 +678,9 @@ do_ensure_started(NameVsn) ->
ok = load_code_start_apps(NameVsn, Plugin); ok = load_code_start_apps(NameVsn, Plugin);
{error, #{reason := Reason} = ReasonMap} -> {error, #{reason := Reason} = ReasonMap} ->
?SLOG(error, #{ ?SLOG(error, #{
error_msg => string_reason(Reason), msg => "failed_to_start_plugin",
name_vsn => NameVsn name_vsn => NameVsn,
reason => Reason
}), }),
{error, ReasonMap} {error, ReasonMap}
end end
@ -691,10 +695,12 @@ tryit(WhichOp, F) ->
try try
F() F()
catch catch
throw:ReasonMap -> throw:ReasonMap when is_map(ReasonMap) ->
%% thrown exceptions are known errors %% thrown exceptions are known errors
%% translate to a return value without stacktrace %% translate to a return value without stacktrace
{error, ReasonMap}; {error, ReasonMap};
throw:Reason ->
{error, #{reason => Reason}};
error:Reason:Stacktrace -> error:Reason:Stacktrace ->
%% unexpected errors, log stacktrace %% unexpected errors, log stacktrace
?SLOG(warning, #{ ?SLOG(warning, #{
@ -778,7 +784,7 @@ do_get_from_cluster(NameVsn) ->
ok = do_ensure_installed(NameVsn); ok = do_ensure_installed(NameVsn);
{error, NodeErrors} when Nodes =/= [] -> {error, NodeErrors} when Nodes =/= [] ->
ErrMeta = #{ ErrMeta = #{
error_msg => "failed_to_copy_plugin_from_other_nodes", msg => "failed_to_copy_plugin_from_other_nodes",
name_vsn => NameVsn, name_vsn => NameVsn,
node_errors => NodeErrors, node_errors => NodeErrors,
reason => plugin_not_found reason => plugin_not_found
@ -787,7 +793,7 @@ do_get_from_cluster(NameVsn) ->
{error, ErrMeta}; {error, ErrMeta};
{error, _} -> {error, _} ->
ErrMeta = #{ ErrMeta = #{
error_msg => "no_nodes_to_copy_plugin_from", msg => "no_nodes_to_copy_plugin_from",
name_vsn => NameVsn, name_vsn => NameVsn,
reason => plugin_not_found reason => plugin_not_found
}, },
@ -889,7 +895,7 @@ check_plugin(
catch catch
_:_ -> _:_ ->
throw(#{ throw(#{
error_msg => "bad_rel_apps", msg => "bad_rel_apps",
rel_apps => Apps, rel_apps => Apps,
hint => "A non-empty string list of app_name-app_vsn format" hint => "A non-empty string list of app_name-app_vsn format"
}) })
@ -897,7 +903,7 @@ check_plugin(
Info; Info;
false -> false ->
throw(#{ throw(#{
error_msg => "name_vsn_mismatch", msg => "name_vsn_mismatch",
name_vsn => NameVsn, name_vsn => NameVsn,
path => FilePath, path => FilePath,
name => Name, name => Name,
@ -906,7 +912,7 @@ check_plugin(
end; end;
check_plugin(_What, NameVsn, File) -> check_plugin(_What, NameVsn, File) ->
throw(#{ throw(#{
error_msg => "bad_info_file_content", msg => "bad_info_file_content",
mandatory_fields => [rel_vsn, name, rel_apps, description], mandatory_fields => [rel_vsn, name, rel_apps, description],
name_vsn => NameVsn, name_vsn => NameVsn,
path => File path => File
@ -962,7 +968,7 @@ do_load_plugin_app(AppName, Ebin) ->
ok; ok;
{error, Reason} -> {error, Reason} ->
throw(#{ throw(#{
error_msg => "failed_to_load_plugin_beam", msg => "failed_to_load_plugin_beam",
path => BeamFile, path => BeamFile,
reason => Reason reason => Reason
}) })
@ -977,7 +983,7 @@ do_load_plugin_app(AppName, Ebin) ->
ok; ok;
{error, Reason} -> {error, Reason} ->
throw(#{ throw(#{
error_msg => "failed_to_load_plugin_app", msg => "failed_to_load_plugin_app",
name => AppName, name => AppName,
reason => Reason reason => Reason
}) })
@ -994,7 +1000,7 @@ start_app(App) ->
ok; ok;
{error, {ErrApp, Reason}} -> {error, {ErrApp, Reason}} ->
throw(#{ throw(#{
error_msg => "failed_to_start_plugin_app", msg => "failed_to_start_plugin_app",
app => App, app => App,
err_app => ErrApp, err_app => ErrApp,
reason => Reason reason => Reason
@ -1076,7 +1082,7 @@ stop_app(App) ->
?SLOG(debug, #{msg => "plugin_not_started", app => App}), ?SLOG(debug, #{msg => "plugin_not_started", app => App}),
ok = unload_moudle_and_app(App); ok = unload_moudle_and_app(App);
{error, Reason} -> {error, Reason} ->
throw(#{error_msg => "failed_to_stop_app", app => App, reason => Reason}) throw(#{msg => "failed_to_stop_app", app => App, reason => Reason})
end. end.
unload_moudle_and_app(App) -> unload_moudle_and_app(App) ->
@ -1171,7 +1177,7 @@ for_plugins(ActionFun) ->
for_plugins_action_error_occurred, for_plugins_action_error_occurred,
ErrMeta ErrMeta
), ),
?SLOG(error, ErrMeta), ?SLOG(error, ErrMeta#{msg => "for_plugins_action_error_occurred"}),
ok ok
end. end.
@ -1314,6 +1320,11 @@ ensure_config_map(NameVsn) ->
true -> true ->
do_ensure_config_map(NameVsn, ConfigJsonMap); do_ensure_config_map(NameVsn, ConfigJsonMap);
false -> false ->
?SLOG(debug, #{
msg => "put_plugin_config_directly",
hint => "plugin_without_config_schema",
name_vsn => NameVsn
}),
put_config(NameVsn, ConfigJsonMap, ?plugin_without_config_schema) put_config(NameVsn, ConfigJsonMap, ?plugin_without_config_schema)
end; end;
_ -> _ ->
@ -1398,23 +1409,23 @@ prune_backup_files(Path) ->
Deletes Deletes
). ).
read_file_fun(Path, ErrMsg, #{read_mode := ?RAW_BIN}) -> read_file_fun(Path, Msg, #{read_mode := ?RAW_BIN}) ->
fun() -> fun() ->
case file:read_file(Path) of case file:read_file(Path) of
{ok, Bin} -> {ok, Bin} ->
{ok, Bin}; {ok, Bin};
{error, Reason} -> {error, Reason} ->
ErrMeta = #{error_msg => ErrMsg, reason => Reason}, ErrMeta = #{msg => Msg, reason => Reason},
throw(ErrMeta) throw(ErrMeta)
end end
end; end;
read_file_fun(Path, ErrMsg, #{read_mode := ?JSON_MAP}) -> read_file_fun(Path, Msg, #{read_mode := ?JSON_MAP}) ->
fun() -> fun() ->
case hocon:load(Path, #{format => richmap}) of case hocon:load(Path, #{format => richmap}) of
{ok, RichMap} -> {ok, RichMap} ->
{ok, hocon_maps:ensure_plain(RichMap)}; {ok, hocon_maps:ensure_plain(RichMap)};
{error, Reason} -> {error, Reason} ->
ErrMeta = #{error_msg => ErrMsg, reason => Reason}, ErrMeta = #{msg => Msg, reason => Reason},
throw(ErrMeta) throw(ErrMeta)
end end
end. end.
@ -1512,8 +1523,3 @@ bin(B) when is_binary(B) -> B.
wrap_to_list(Path) -> wrap_to_list(Path) ->
binary_to_list(iolist_to_binary(Path)). binary_to_list(iolist_to_binary(Path)).
string_reason(plugin_not_found) ->
"plugin_not_found";
string_reason(_) ->
"unexpected_error".

10
apps/emqx_plugins/test/emqx_plugins_SUITE.erl
View File

@ -353,7 +353,7 @@ t_enable_disable(Config) ->
?assertEqual([#{name_vsn => NameVsn, enable => true}], emqx_plugins:configured()), ?assertEqual([#{name_vsn => NameVsn, enable => true}], emqx_plugins:configured()),
?assertMatch( ?assertMatch(
{error, #{ {error, #{
error_msg := "bad_plugin_config_status", msg := "bad_plugin_config_status",
hint := "disable_the_plugin_first" hint := "disable_the_plugin_first"
}}, }},
emqx_plugins:ensure_uninstalled(NameVsn) emqx_plugins:ensure_uninstalled(NameVsn)
@ -381,7 +381,7 @@ t_bad_tar_gz(Config) ->
ok = file:write_file(FakeTarTz, "a\n"), ok = file:write_file(FakeTarTz, "a\n"),
?assertMatch( ?assertMatch(
{error, #{ {error, #{
error_msg := "bad_plugin_package", msg := "bad_plugin_package",
reason := eof reason := eof
}}, }},
emqx_plugins:ensure_installed("fake-vsn") emqx_plugins:ensure_installed("fake-vsn")
@ -389,7 +389,7 @@ t_bad_tar_gz(Config) ->
%% the plugin tarball can not be found on any nodes %% the plugin tarball can not be found on any nodes
?assertMatch( ?assertMatch(
{error, #{ {error, #{
error_msg := "no_nodes_to_copy_plugin_from", msg := "no_nodes_to_copy_plugin_from",
reason := plugin_not_found reason := plugin_not_found
}}, }},
emqx_plugins:ensure_installed("nonexisting") emqx_plugins:ensure_installed("nonexisting")
@ -463,7 +463,7 @@ t_bad_info_json(Config) ->
ok = write_info_file(Config, NameVsn, "bad-syntax"), ok = write_info_file(Config, NameVsn, "bad-syntax"),
?assertMatch( ?assertMatch(
{error, #{ {error, #{
error_msg := "bad_info_file", msg := "bad_info_file",
reason := {parse_error, _} reason := {parse_error, _}
}}, }},
emqx_plugins:describe(NameVsn) emqx_plugins:describe(NameVsn)
@ -471,7 +471,7 @@ t_bad_info_json(Config) ->
ok = write_info_file(Config, NameVsn, "{\"bad\": \"obj\"}"), ok = write_info_file(Config, NameVsn, "{\"bad\": \"obj\"}"),
?assertMatch( ?assertMatch(
{error, #{ {error, #{
error_msg := "bad_info_file_content", msg := "bad_info_file_content",
mandatory_fields := _ mandatory_fields := _
}}, }},
emqx_plugins:describe(NameVsn) emqx_plugins:describe(NameVsn)

2
apps/emqx_plugins/test/emqx_plugins_tests.erl
View File

@ -57,7 +57,7 @@ read_plugin_test() ->
try try
ok = write_file(InfoFile, FakeInfo), ok = write_file(InfoFile, FakeInfo),
?assertMatch( ?assertMatch(
{error, #{error_msg := "bad_rel_apps"}}, {error, #{msg := "bad_rel_apps"}},
emqx_plugins:read_plugin_info(NameVsn, #{}) emqx_plugins:read_plugin_info(NameVsn, #{})
) )
after after