Merge pull request #7236 from zhongwencool/config-api

feat(config): Filter unnecessary HTTP APIs

.github/workflows/release.yaml

@@ -76,4 +76,3 @@ jobs:
                 -d "{\"ref\":\"v1.0.4\",\"inputs\":{\"version\": \"${{ github.ref_name }}\"}}" \
                 "https://api.github.com/repos/emqx/emqx-ci-helper/actions/workflows/update_emqx_homebrew.yaml/dispatches"
           fi
-   

apps/emqx/include/emqx.hrl

@@ -53,6 +53,7 @@
 %%--------------------------------------------------------------------
 -define(ACTIVATED_ALARM, emqx_activated_alarm).
 -define(DEACTIVATED_ALARM, emqx_deactivated_alarm).
+-define(TRIE, emqx_trie).
 
 %%--------------------------------------------------------------------
 %% Message and Delivery

apps/emqx/src/emqx_alarm.erl

@@ -164,7 +164,7 @@ to_rfc3339(Timestamp) ->
 %%--------------------------------------------------------------------
 
 init([]) ->
-    ok = mria:wait_for_tables([?ACTIVATED_ALARM, ?DEACTIVATED_ALARM]),
+    ok = mria:wait_for_tables([?ACTIVATED_ALARM, ?DEACTIVATED_ALARM, ?TRIE]),
     deactivate_all_alarms(),
     {ok, #{}, get_validity_period()}.
 

apps/emqx/src/emqx_trie.erl

@@ -47,7 +47,6 @@
 -compile(nowarn_export_all).
 -endif.
 
--define(TRIE, emqx_trie).
 -define(SESSION_DISC_TRIE, emqx_session_trie_disc).
 -define(SESSION_RAM_TRIE, emqx_session_trie_ram).
 -define(PREFIX(Prefix), {Prefix, 0}).

apps/emqx/test/emqx_trie_SUITE.erl

@@ -22,8 +22,6 @@
 -include_lib("emqx/include/emqx.hrl").
 -include_lib("eunit/include/eunit.hrl").
 
--define(TRIE, emqx_trie).
-
 all() ->
     [{group, compact},
      {group, not_compact}

apps/emqx_management/src/emqx_mgmt_api_configs.erl

@@ -24,24 +24,33 @@
 
 -export([config/3, config_reset/3, configs/3, get_full_config/0]).
 
--export([get_conf_schema/2, gen_schema/1]).
+-export([gen_schema/1]).
 
 -define(PREFIX, "/configs/").
 -define(PREFIX_RESET, "/configs_reset/").
 -define(ERR_MSG(MSG), list_to_binary(io_lib:format("~p", [MSG]))).
 -define(EXCLUDES, [
-    exhook,
+    <<"exhook">>,
-    gateway,
+    <<"gateway">>,
-    plugins,
+    <<"plugins">>,
-    bridges,
+    <<"bridges">>,
-    "rule_engine",
+    <<"rule_engine">>,
-    "authorization",
+    <<"authorization">>,
-    "authentication",
+    <<"authentication">>,
-    "rpc",
+    <<"rpc">>,
-    "db",
+    <<"db">>,
-    "connectors",
+    <<"connectors">>,
-    "slow_subs",
+    <<"slow_subs">>,
-    "psk_authentication"
+    <<"psk_authentication">>,
+    <<"topic_metrics">>,
+    <<"rewrite">>,
+    <<"auto_subscribe">>,
+    <<"retainer">>,
+    <<"statsd">>,
+    <<"delayed">>,
+    <<"event_message">>,
+    <<"prometheus">>,
+    <<"telemetry">>
 ]).
 
 api_spec() ->
@@ -51,7 +60,7 @@ namespace() -> "configuration".
 
 paths() ->
     ["/configs", "/configs_reset/:rootname"] ++
-    lists:map(fun({Name, _Type}) -> ?PREFIX ++ to_list(Name) end, config_list(?EXCLUDES)).
+    lists:map(fun({Name, _Type}) -> ?PREFIX ++ binary_to_list(Name) end, config_list()).
 
 schema("/configs") ->
     #{
@@ -66,15 +75,12 @@ schema("/configs") ->
                         desc =>
  <<"Node's name: If you do not fill in the fields, this node will be used by default.">>})}],
             responses => #{
-                200 => config_list(?EXCLUDES)
+                200 => lists:map(fun({_, Schema}) -> Schema end, config_list())
             }
         }
     };
 schema("/configs_reset/:rootname") ->
-    Paths = lists:map(
+    Paths = lists:map(fun({Path, _}) -> binary_to_atom(Path) end, config_list()),
-        fun({Path, _})when is_atom(Path) -> Path;
-           ({Path, _}) when is_list(Path) -> list_to_atom(Path)
-        end, config_list(?EXCLUDES)),
     #{
         'operationId' => config_reset,
         post => #{
@@ -88,9 +94,9 @@ schema("/configs_reset/:rootname") ->
             %% `conf_path`, it cannot be defined here.
             parameters => [
                 {rootname, hoconsc:mk( hoconsc:enum(Paths)
-                                     , #{in => path, example => <<"authorization">>})},
+                                     , #{in => path, example => <<"sysmon">>})},
                 {conf_path, hoconsc:mk(typerefl:binary(),
-                    #{in => query, required => false, example => <<"cache.enable">>,
+                    #{in => query, required => false, example => <<"os.sysmem_high_watermark">>,
                         desc => <<"The config path separated by '.' character">>})}],
             responses => #{
                 200 => <<"Rest config successfully">>,
@@ -99,13 +105,13 @@ schema("/configs_reset/:rootname") ->
         }
     };
 schema(Path) ->
-    {Root, Schema} = find_schema(Path),
+    {RootKey, {_Root, Schema}} = find_schema(Path),
     #{
         'operationId' => config,
         get => #{
             tags => [conf],
             description => iolist_to_binary([ <<"Get the sub-configurations under *">>
-                                            , Root
+                                            , RootKey
                                             , <<"*">>]),
             responses => #{
                 200 => Schema,
@@ -115,7 +121,7 @@ schema(Path) ->
         put => #{
             tags => [conf],
             description => iolist_to_binary([ <<"Update the sub-configurations under *">>
-                                            , Root
+                                            , RootKey
                                             , <<"*">>]),
             'requestBody' => Schema,
             responses => #{
@@ -127,13 +133,8 @@ schema(Path) ->
 
 find_schema(Path) ->
     [_, _Prefix, Root | _] = string:split(Path, "/", all),
-    Configs = config_list(?EXCLUDES),
+    Configs = config_list(),
-    case lists:keyfind(Root, 1, Configs) of
+    lists:keyfind(list_to_binary(Root), 1, Configs).
-        {Root, Schema} -> {Root, Schema};
-        false ->
-            RootAtom = list_to_existing_atom(Root),
-            {Root, element(2, lists:keyfind(RootAtom, 1, Configs))}
-    end.
 
 %% we load all configs from emqx_conf_schema, some of them are defined as local ref
 %% we need redirect to emqx_conf_schema.
@@ -148,7 +149,8 @@ config(get, _Params, Req) ->
         {ok, Conf} ->
             {200, Conf};
         {not_found, _, _} ->
-            {404, #{code => 'NOT_FOUND', message => <<"Config cannot found">>}}
+            {404, #{code => 'NOT_FOUND',
+                message => <<(list_to_binary(Path))/binary, " not found">>}}
     end;
 
 config(put, #{body := Body}, Req) ->
@@ -201,33 +203,14 @@ conf_path_from_querystr(Req) ->
         Path -> string:lexemes(Path, ". ")
     end.
 
-config_list(Exclude) ->
+config_list() ->
-    Roots = emqx_conf_schema:roots(),
+    Roots = hocon_schema:roots(emqx_conf_schema),
-    lists:foldl(fun(Key, Acc) -> lists:keydelete(Key, 1, Acc) end, Roots, Exclude).
+    lists:foldl(fun(Key, Acc) -> lists:keydelete(Key, 1, Acc) end, Roots, ?EXCLUDES).
-
-to_list(L) when is_list(L) -> L;
-to_list(Atom) when is_atom(Atom) -> atom_to_list(Atom).
 
 conf_path(Req) ->
     <<"/api/v5", ?PREFIX, Path/binary>> = cowboy_req:path(Req),
     string:lexemes(Path, "/ ").
 
-get_conf_schema(Conf, MaxDepth) ->
-    get_conf_schema([], maps:to_list(Conf), [], MaxDepth).
-
-get_conf_schema(_BasePath, [], Result, _MaxDepth) ->
-    Result;
-get_conf_schema(BasePath, [{Key, Conf} | Confs], Result, MaxDepth) ->
-    Path = BasePath ++ [Key],
-    Depth = length(Path),
-    Result1 = case is_map(Conf) of
-                  true when Depth < MaxDepth ->
-                      get_conf_schema(Path, maps:to_list(Conf), Result, MaxDepth);
-                  true when Depth >= MaxDepth -> Result;
-                  false -> Result
-              end,
-    get_conf_schema(BasePath, Confs, [{Path, gen_schema(Conf)} | Result1], MaxDepth).
-
 %% TODO: generate from hocon schema
 gen_schema(Conf) when is_boolean(Conf) ->
     with_default_value(#{type => boolean}, Conf);

apps/emqx_modules/src/emqx_rewrite_api.erl

@@ -27,12 +27,6 @@
 
 -define(EXCEED_LIMIT, 'EXCEED_LIMIT').
 
--import(emqx_mgmt_util, [ object_array_schema/1
-                        , object_array_schema/2
-                        , error_schema/2
-                        , properties/1
-                        ]).
-
 api_spec() ->
     emqx_dashboard_swagger:spec(?MODULE).
 
@@ -41,7 +35,7 @@ paths() ->
 
 schema("/mqtt/topic_rewrite") ->
     #{
-        operationId => topic_rewrite,
+        'operationId' => topic_rewrite,
         get => #{
             tags => ?API_TAG_MQTT,
             description => <<"List rewrite topic.">>,
@@ -53,11 +47,13 @@ schema("/mqtt/topic_rewrite") ->
         put => #{
             description => <<"Update rewrite topic">>,
             tags => ?API_TAG_MQTT,
-            requestBody => hoconsc:mk(hoconsc:array(hoconsc:ref(emqx_modules_schema, "rewrite")),#{}),
+            'requestBody' => hoconsc:mk(hoconsc:array(
+                hoconsc:ref(emqx_modules_schema, "rewrite")),#{}),
             responses => #{
                 200 => hoconsc:mk(hoconsc:array(hoconsc:ref(emqx_modules_schema, "rewrite")),
                     #{desc => <<"Update rewrite topic success.">>}),
-                413 => emqx_dashboard_swagger:error_codes([?EXCEED_LIMIT], <<"Rules count exceed max limit">>)
+                413 => emqx_dashboard_swagger:error_codes([?EXCEED_LIMIT],
+                    <<"Rules count exceed max limit">>)
             }
         }
     }.
@@ -71,6 +67,7 @@ topic_rewrite(put, #{body := Body}) ->
             ok = emqx_rewrite:update(Body),
             {200, emqx_rewrite:list()};
         _ ->
-            Message = iolist_to_binary(io_lib:format("Max rewrite rules count is ~p", [?MAX_RULES_LIMIT])),
+            Message = iolist_to_binary(
+                io_lib:format("Max rewrite rules count is ~p", [?MAX_RULES_LIMIT])),
             {413, #{code => ?EXCEED_LIMIT, message => Message}}
     end.

scripts/check-nl-at-eof.sh

@@ -25,6 +25,7 @@ nl_at_eof() {
 n=0
 while read -r file; do
     if ! nl_at_eof "$file"; then
+        echo "nl_at_eof: $file"
         n=$(( n + 1 ))
     fi
 done < <(git ls-files)