Hide handlers field in logger config map from the API

This field contains the index of all installed handlers. It is
internal and can not be altered by the user, and should therefore not
be visible.

5 files changed, 46 insertions, 61 deletions

diff --git a/lib/kernel/src/logger.erl b/lib/kernel/src/logger.erl
index 7ce4a80bbd..2c7466fdf6 100644
--- a/lib/kernel/src/logger.erl
+++ b/lib/kernel/src/logger.erl
@@ -364,7 +364,8 @@ set_handler_config(HandlerId,Config) ->
 -spec get_logger_config() -> {ok,Config} when
       Config :: config().
 get_logger_config() ->
-    logger_config:get(?LOGGER_TABLE,logger).
+    {ok,Config} = logger_config:get(?LOGGER_TABLE,logger),
+    {ok,maps:remove(handlers,Config)}.
 
 -spec get_handler_config(HandlerId) -> {ok,{Module,Config}} | {error,term()} when
       HandlerId :: handler_id(),
@@ -445,8 +446,9 @@ i() ->
 i(_Action = print) ->
     io:put_chars(i(string));
 i(_Action = string) ->
-    #{logger := #{level := Level, handlers := Handlers,
-                  filters := Filters, filter_default := FilterDefault},
+    #{logger := #{level := Level,
+                  filters := Filters,
+                  filter_default := FilterDefault},
       handlers := HandlerConfigs,
       module_levels := Modules} = i(term),
     [io_lib:format("Current logger configuration:~n", []),
@@ -455,16 +457,15 @@ i(_Action = string) ->
      io_lib:format("  Filters: ~n", []),
      print_filters(4, Filters),
      io_lib:format("  Handlers: ~n", []),
-     print_handlers([C || {Id, _, _} = C <- HandlerConfigs,
-                          lists:member(Id, Handlers)]),
+     print_handlers(HandlerConfigs),
      io_lib:format("  Level set per module: ~n", []),
      print_module_levels(Modules)
     ];
 i(_Action = term) ->
     {Logger, Handlers, Modules} = logger_config:get(tid()),
-    #{logger=>Logger,
-      handlers=>Handlers,
-      module_levels=>Modules}.
+    #{logger=>maps:remove(handlers,Logger),
+      handlers=>lists:keysort(1,Handlers),
+      module_levels=>lists:keysort(1,Modules)}.
 
 print_filters(Indent, {Id, {Fun, Config}}) ->
     io_lib:format("~sId: ~p~n"
diff --git a/lib/kernel/src/logger_server.erl b/lib/kernel/src/logger_server.erl
index f1b4a21c6a..bd0c325f2b 100644
--- a/lib/kernel/src/logger_server.erl
+++ b/lib/kernel/src/logger_server.erl
@@ -48,23 +48,18 @@ start_link() ->
     gen_server:start_link({local, ?SERVER}, ?MODULE, [], []).
 
 add_handler(Id,Module,Config0) ->
-    case sanity_check(logger,handlers,[Id]) of
-        ok ->
-            try check_mod(Module) of
+    try {check_id(Id),check_mod(Module)} of
+        {ok,ok} ->
+            case sanity_check(Id,Config0) of
                 ok ->
-                    case sanity_check(Id,Config0) of
-                        ok ->
-                            Default = default_config(Id),
-                            Config = maps:merge(Default,Config0),
-                            call({add_handler,Id,Module,Config});
-                        Error ->
-                            Error
-                    end
-            catch throw:Error ->
-                    {error,Error}
-            end;
-        Error ->
-            Error
+                    Default = default_config(Id),
+                    Config = maps:merge(Default,Config0),
+                    call({add_handler,Id,Module,Config});
+                Error ->
+                    Error
+            end
+    catch throw:Error ->
+            {error,Error}
     end.
 
 remove_handler(HandlerId) ->
@@ -197,7 +192,8 @@ handle_call({update_config,Id,NewConfig}, From, #state{tid=Tid}=State) ->
             {reply,Error,State}
     end;
 handle_call({set_config,logger,Config}, _From, #state{tid=Tid}=State) ->
-    Reply = do_set_config(Tid,logger,Config),
+    {ok,#{handlers:=Handlers}} = logger_config:get(Tid,logger),
+    Reply = do_set_config(Tid,logger,Config#{handlers=>Handlers}),
     {reply,Reply,State};
 handle_call({set_config,HandlerId,Config}, From, #state{tid=Tid}=State) ->
     case logger_config:get(Tid,HandlerId) of
@@ -322,8 +318,7 @@ do_set_config(Tid,Id,Config) ->
 default_config(logger) ->
     #{level=>info,
       filters=>[],
-      filter_default=>log,
-      handlers=>[]};
+      filter_default=>log};
 default_config(_) ->
     #{level=>info,
       filters=>[],
@@ -354,9 +349,6 @@ get_type(Id) ->
 check_config(Owner,[{level,Level}|Config]) ->
     check_level(Level),
     check_config(Owner,Config);
-check_config(logger,[{handlers,Handlers}|Config]) ->
-    check_handlers(Handlers),
-    check_config(logger,Config);
 check_config(Owner,[{filters,Filters}|Config]) ->
     check_filters(Filters),
     check_config(Owner,Config);
@@ -394,14 +386,6 @@ check_level(Level) ->
             throw({invalid_level,Level})
     end.
 
-check_handlers([Id|Handlers]) ->
-    check_id(Id),
-    check_handlers(Handlers);
-check_handlers([]) ->
-    ok;
-check_handlers(Handlers) ->
-    throw({invalid_handlers,Handlers}).
-
 check_filters([{Id,{Fun,_Args}}|Filters]) when is_atom(Id), is_function(Fun,2) ->
     check_filters(Filters);
 check_filters([Filter|_]) ->
diff --git a/lib/kernel/test/logger_SUITE.erl b/lib/kernel/test/logger_SUITE.erl
index 9fea92ee0d..1b75d8278e 100644
--- a/lib/kernel/test/logger_SUITE.erl
+++ b/lib/kernel/test/logger_SUITE.erl
@@ -105,12 +105,12 @@ start_stop(_Config) ->
 
 add_remove_handler(_Config) ->
     register(callback_receiver,self()),
-    {ok,#{handlers:=Hs0}} = logger:get_logger_config(),
+    #{handlers:=Hs0} = logger:i(),
     {error,{not_found,h1}} = logger:get_handler_config(h1),
     ok = logger:add_handler(h1,?MODULE,#{}),
     [add] = test_server:messages_get(),
-    {ok,#{handlers:=Hs}} = logger:get_logger_config(),
-    [h1|Hs0] = Hs,
+    #{handlers:=Hs} = logger:i(),
+    {value,_,Hs0} = lists:keytake(h1,1,Hs),
     {ok,{?MODULE,#{level:=info,filters:=[],filter_default:=log}}} = % defaults
         logger:get_handler_config(h1),
     ok = logger:set_handler_config(h1,filter_default,stop),
@@ -124,7 +124,7 @@ add_remove_handler(_Config) ->
     ok = check_logged(info,"hello",[],?MY_LOC(1)),
     ok = logger:remove_handler(h1),
     [remove] = test_server:messages_get(),
-    {ok,#{handlers:=Hs0}} = logger:get_logger_config(),
+    #{handlers:=Hs0} = logger:i(),
     {error,{not_found,h1}} = logger:get_handler_config(h1),
     {error,{not_found,h1}} = logger:remove_handler(h1),
     logger:info("hello",[]),
@@ -237,13 +237,18 @@ change_config(_Config) ->
     %% Overwrite logger config - check that defaults are added
     {ok,LConfig} = logger:get_logger_config(),
     ok = logger:set_logger_config(#{filter_default=>stop}),
-    {ok,#{level:=info,filters:=[],handlers:=[],filter_default:=stop}=LC1} =
+    {ok,#{level:=info,filters:=[],filter_default:=stop}=LC1} =
         logger:get_logger_config(),
-    4 = maps:size(LC1),
+    3 = maps:size(LC1),
+    %% Check that internal 'handlers' field has not been changed
+    #{handlers:=HCs} = logger:i(),
+    HIds1 = [Id || {Id,_,_} <- HCs],
+    {ok,#{handlers:=HIds2}} = logger_config:get(?LOGGER_TABLE,logger),
+    HIds1 = lists:sort(HIds2),
 
     %% Change one key only
-    ok = logger:set_logger_config(handlers,[h1]),
-    {ok,#{level:=info,filters:=[],handlers:=[h1],filter_default:=stop}} =
+    ok = logger:set_logger_config(level,warning),
+    {ok,#{level:=warning,filters:=[],filter_default:=stop}} =
         logger:get_logger_config(),
 
     %% Cleanup
@@ -441,9 +446,7 @@ handler_failed(_Config) ->
     {error,{invalid_handler,_}} = logger:add_handler(h1,nomodule,#{filter_default=>log}),
     logger:info(?map_rep),
     check_no_log(),
-    #{logger:=#{handlers:=Ids1},
-      handlers:=H1} = logger:i(),
-    false = lists:member(h1,Ids1),
+    #{handlers:=H1} = logger:i(),
     false = lists:keymember(h1,1,H1),
     {error,{not_found,h1}} = logger:remove_handler(h1),
 
@@ -453,10 +456,7 @@ handler_failed(_Config) ->
 
     logger:info(?map_rep),
     [remove] = test_server:messages_get(),
-
-    #{logger:=#{handlers:=Ids2},
-      handlers:=H2} = logger:i(),
-    false = lists:member(h2,Ids2),
+    #{handlers:=H2} = logger:i(),
     false = lists:keymember(h2,1,H2),
     {error,{not_found,h2}} = logger:remove_handler(h2),
 
@@ -511,10 +511,6 @@ config_sanity_check(_Config) ->
     {error,{invalid_filter_default,bad}} =
         logger:set_logger_config(filter_default,bad),
     {error,{invalid_level,bad}} = logger:set_logger_config(level,bad),
-    {error,{invalid_handlers,bad}} = logger:set_logger_config(handlers,bad),
-    {error,{invalid_id,{bad,bad}}} =
-        logger:set_logger_config(handlers,[{bad,bad}]),
-    {error,{invalid_id,"bad"}} = logger:set_logger_config(handlers,["bad"]),
     {error,{invalid_filters,bad}} = logger:set_logger_config(filters,bad),
     {error,{invalid_filter,bad}} = logger:set_logger_config(filters,[bad]),
     {error,{invalid_filter,{_,_}}} =
diff --git a/lib/kernel/test/logger_disk_log_h_SUITE.erl b/lib/kernel/test/logger_disk_log_h_SUITE.erl
index cdd1e68947..3aa1c3557b 100644
--- a/lib/kernel/test/logger_disk_log_h_SUITE.erl
+++ b/lib/kernel/test/logger_disk_log_h_SUITE.erl
@@ -328,7 +328,8 @@ formatter_fail(Config) ->
     logger:add_handler(Name, logger_disk_log_h, HConfig),
     Pid = whereis(Name),
     true = is_pid(Pid),
-    {ok,#{handlers:=H}} = logger:get_logger_config(),
+    #{handlers:=HC1} = logger:i(),
+    H = [Id || {Id,_,_} <- HC1],
     true = lists:member(Name,H),
 
     %% Formatter is added automatically
@@ -357,7 +358,8 @@ formatter_fail(Config) ->
 
     %% Check that handler is still alive and was never dead
     Pid = whereis(Name),
-    {ok,#{handlers:=H}} = logger:get_logger_config(),
+    #{handlers:=HC2} = logger:i(),
+    H = [Id || {Id,_,_} <- HC2],
     ok.
 
 formatter_fail(cleanup,_Config) ->
diff --git a/lib/kernel/test/logger_std_h_SUITE.erl b/lib/kernel/test/logger_std_h_SUITE.erl
index 83bc96620f..fc59d393e0 100644
--- a/lib/kernel/test/logger_std_h_SUITE.erl
+++ b/lib/kernel/test/logger_std_h_SUITE.erl
@@ -242,7 +242,8 @@ formatter_fail(Config) ->
                               filters=>?DEFAULT_HANDLER_FILTERS([?MODULE])}),
     Pid = whereis(?MODULE),
     true = is_pid(Pid),
-    {ok,#{handlers:=H}} = logger:get_logger_config(),
+    #{handlers:=HC1} = logger:i(),
+    H = [Id || {Id,_,_} <- HC1],
     true = lists:member(?MODULE,H),
 
     %% Formatter is added automatically
@@ -271,7 +272,8 @@ formatter_fail(Config) ->
 
     %% Check that handler is still alive and was never dead
     Pid = whereis(?MODULE),
-    {ok,#{handlers:=H}} = logger:get_logger_config(),
+    #{handlers:=HC2} = logger:i(),
+    H = [Id || {Id,_,_} <- HC2],
 
     ok.