File 3431-kernel-Make-dynamic-shell_history-provider... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 3431-kernel-Make-dynamic-shell_history-provider-more-robu.patch of Package erlang

From 3261a0a2ff4c848d7dd39c595c92dd138767e995 Mon Sep 17 00:00:00 2001
From: Lukas Larsson <lukas@erlang.org>
Date: Mon, 1 Mar 2021 16:54:55 +0100
Subject: [PATCH 01/11] kernel: Make dynamic shell_history provider more robust

We print error messages and disable it when it fails
just as if the disk_log backend would fail.
---
 lib/kernel/src/group_history.erl | 71 +++++++++++++++++++++++++-------
 1 file changed, 56 insertions(+), 15 deletions(-)

diff --git a/lib/kernel/src/group_history.erl b/lib/kernel/src/group_history.erl
index f50060cefa..6eddb30716 100644
--- a/lib/kernel/src/group_history.erl
+++ b/lib/kernel/src/group_history.erl
@@ -79,33 +79,55 @@ load() ->
         disabled ->
             [];
         Provider ->
-            Provider:load()
+            try Provider:load() of
+                History when is_list(History) ->
+                    History;
+                Error ->
+                    show_custom_provider_faulty_load_return(Provider, Error),
+                    disable_history(),
+                    []
+            catch E:R:ST ->
+                    show_custom_provider_crash(Provider, E, R, ST),
+                    disable_history(),
+                    []
+            end
     end.
 
 %% @doc adds a log line to the erlang history log, if configured to do so.
 -spec add(iodata()) -> ok.
-add(Line) -> add(Line, history_status()).
-
-add(Line, enabled) ->
+add(Line) ->
     case lists:member(Line, to_drop()) of
         false ->
-            case disk_log:log(?LOG_NAME, Line) of
-                ok ->
-                    ok;
-                {error, no_such_log} ->
-                    _ = open_log(), % a wild attempt we hope works!
-                    disk_log:log(?LOG_NAME, Line);
-                {error, _Other} ->
-                    % just ignore, we're too late
-                    ok
-            end;
+            add(Line, history_status());
         true ->
             ok
+    end.
+
+add(Line, enabled) ->
+    case disk_log:log(?LOG_NAME, Line) of
+        ok ->
+            ok;
+        {error, no_such_log} ->
+            _ = open_log(), % a wild attempt we hope works!
+            disk_log:log(?LOG_NAME, Line);
+        {error, _Other} ->
+                                                % just ignore, we're too late
+            ok
     end;
 add(_Line, disabled) ->
     ok;
 add(Line, Provider) ->
-    lists:member(Line, to_drop()) orelse Provider:add(Line).
+    try Provider:add(Line) of
+        ok ->
+            ok;
+        Error ->
+            show_custom_provider_faulty_add_return(Provider, Error),
+            ok
+    catch E:R:ST ->
+            show_custom_provider_crash(Provider, E, R, ST),
+            disable_history(),
+            ok
+    end.
 
 %%%%%%%%%%%%%%%
 %%% PRIVATE %%%
@@ -383,6 +405,28 @@ show_size_warning(_Current, _New) ->
          "The configured log history file size is different from "
          "the size of the log file on disk.~n", []).
 
+show_custom_provider_crash(Provider, Class, Reason, StackTrace) ->
+    show('$#erlang-history-custom-crash',
+         "The configured custom shell_history provider '~p' crashed. ~n"
+         "Did you mean to write 'enabled'?~n"
+         "~ts~n",
+         [Provider, erl_error:format_exception(1, Class, Reason, StackTrace,
+                                               fun(_, _, _) -> false end,
+                                               fun(Term, I) -> io_lib:print(Term, I, 80, 30) end,
+                                               unicode)]).
+
+show_custom_provider_faulty_load_return(Provider, Return) ->
+    show('$#erlang-history-custom-return',
+         "The configured custom shell_history provider ~p:load/0 did not return a list.~n"
+         "It returned ~p.~n",
+        [Provider, Return]).
+
+show_custom_provider_faulty_add_return(Provider, Return) ->
+    show('$#erlang-history-custom-return',
+         "The configured custom shell_history provider ~p:add/1 did not return ok.~n"
+         "It returned ~p.~n",
+        [Provider, Return]).
+
 show(Key, Format, Args) ->
     case get(Key) of
         undefined ->
-- 
2.26.2

Places

File 3431-kernel-Make-dynamic-shell_history-provider-more-robu.patch of Package erlang

Places