File 1021-Improve-handling-of-exceptions-from-parse-... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 1021-Improve-handling-of-exceptions-from-parse-transforms.patch of Package erlang (Revision 3e233b2d0ea21cbf4e721681a5e11bfd)

Currently displaying revision 3e233b2d0ea21cbf4e721681a5e11bfd , Show latest

From 0cc266f5ba5a229b148f5ec75f43160085237291 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn=20Gustavsson?= <bjorn@erlang.org>
Date: Thu, 20 May 2021 06:55:44 +0200
Subject: [PATCH] Improve handling of exceptions from parse transforms

746fb27c38c7e1 (#4528) refactored handling of internal compiler
errors. An unintended consequence was that `exit` and `throw` exceptions
raised by parse transforms or core transforms would be reported as
internal compiler errors. As well as being confusing, the return value
from `compile:file/2` would be the atom `error` even when the `return_errors`
option was given. (The `return_errors` and `return_warnings` options are
intentionally ignored when the compiler has crashed in an unexpected way.)

Change the error handling so that exceptions in parse and core
transforms are reported as an error in the given transform. While at
it, also improve the formatting of the exception reasons and
stacktraces for transforms.
---
 lib/compiler/src/compile.erl                  | 18 +++++-----
 lib/compiler/test/compile_SUITE.erl           | 20 ++++++++---
 .../test/compile_SUITE_data/generic_pt.erl    |  6 +++-
 lib/compiler/test/error_SUITE.erl             | 35 +++++++++++++------
 4 files changed, 55 insertions(+), 24 deletions(-)

diff --git a/lib/compiler/src/compile.erl b/lib/compiler/src/compile.erl
index 0d5fc5f400..7a36c6333a 100644
--- a/lib/compiler/src/compile.erl
+++ b/lib/compiler/src/compile.erl
@@ -324,12 +324,14 @@ format_error({write_error, Error}) ->
 format_error({rename,From,To,Error}) ->
     io_lib:format("failed to rename ~ts to ~ts: ~ts",
 		  [From,To,file:format_error(Error)]);
-format_error({parse_transform,M,R}) ->
-    io_lib:format("error in parse transform '~ts': ~tp", [M, R]);
+format_error({parse_transform,M,{C,R,Stk}}) ->
+    E = format_error_reason(C, R, Stk),
+    io_lib:format("error in parse transform '~ts':\n~ts", [M, E]);
 format_error({undef_parse_transform,M}) ->
     io_lib:format("undefined parse transform '~ts'", [M]);
-format_error({core_transform,M,R}) ->
-    io_lib:format("error in core transform '~s': ~tp", [M, R]);
+format_error({core_transform,M,{C,R,Stk}}) ->
+    E = format_error_reason(C, R, Stk),
+    io_lib:format("error in core transform '~s':\n~ts", [M, E]);
 format_error({crash,Pass,Reason,Stk}) ->
     io_lib:format("internal error in pass ~p:\n~ts", [Pass,format_error_reason({Reason, Stk})]);
 format_error({bad_return,Pass,Reason}) ->
@@ -1152,9 +1154,9 @@ foldl_transform([T|Ts], Code0, St) ->
                 Forms ->
                     foldl_transform(Ts, Forms, St)
             catch
-                error:Reason:Stk ->
+                Class:Reason:Stk ->
                     Es = [{St#compile.ifile,[{none,compile,
-                                              {parse_transform,T,{Reason,Stk}}}]}],
+                                              {parse_transform,T,{Class,Reason,Stk}}}]}],
                     {error,St#compile{errors=St#compile.errors ++ Es}}
             end;
         false ->
@@ -1215,9 +1217,9 @@ foldl_core_transforms([T|Ts], Code0, St) ->
 	Forms ->
 	    foldl_core_transforms(Ts, Forms, St)
     catch
-        error:Reason:Stk ->
+        Class:Reason:Stk ->
             Es = [{St#compile.ifile,[{none,compile,
-                                      {core_transform,T,{Reason,Stk}}}]}],
+                                      {core_transform,T,{Class,Reason,Stk}}}]}],
             {error,St#compile{errors=St#compile.errors ++ Es}}
     end;
 foldl_core_transforms([], Code, St) -> {ok,Code,St}.
diff --git a/lib/compiler/test/compile_SUITE.erl b/lib/compiler/test/compile_SUITE.erl
index 7c47d8a289..c9495c3755 100644
--- a/lib/compiler/test/compile_SUITE.erl
+++ b/lib/compiler/test/compile_SUITE.erl
@@ -1768,14 +1768,26 @@ do_transforms(Config) ->
                                     {core_transform,generic_pt},
                                     {parse_transform,generic_pt}]),
 
-    %% Test crashing in a core transform.
+    %% Test exceptions from a core transform.
     Simple = filename:join(DataDir, simple),
     error = compile:file(Simple, [report, {core_transform,generic_pt}, {action, crash}]),
-    {error,_,_} = compile:file(Simple, [return, {core_transform,generic_pt}, {action, crash}]),
+    {error,_,[]} = compile:file(Simple, [return, {core_transform,generic_pt}, {action, crash}]),
 
-    %% Test crashing in a parse transform.
+    error = compile:file(Simple, [report, {core_transform,generic_pt}, {action, throw}]),
+    {error,_,[]} = compile:file(Simple, [return, {core_transform,generic_pt}, {action, throw}]),
+
+    error = compile:file(Simple, [report, {core_transform,generic_pt}, {action, exit}]),
+    {error,_,[]} = compile:file(Simple, [return, {core_transform,generic_pt}, {action, exit}]),
+
+    %% Test exceptions from a parse transform.
     error = compile:file(Simple, [report, {parse_transform,generic_pt}, {action, crash}]),
-    {error,_,_} = compile:file(Simple, [return, {parse_transform,generic_pt}, {action, crash}]),
+    {error,_,[]} = compile:file(Simple, [return, {parse_transform,generic_pt}, {action, crash}]),
+
+    error = compile:file(Simple, [report, {parse_transform,generic_pt}, {action, throw}]),
+    {error,_,[]} = compile:file(Simple, [return, {parse_transform,generic_pt}, {action, throw}]),
+
+    error = compile:file(Simple, [report, {parse_transform,generic_pt}, {action, exit}]),
+    {error,_,[]} = compile:file(Simple, [return, {parse_transform,generic_pt}, {action, exit}]),
 
     %% Test generating errors and warnings in a parse_transform.
     {ok,simple} = compile:file(Simple, [report, {parse_transform,generic_pt}, {action, warning}]),
diff --git a/lib/compiler/test/compile_SUITE_data/generic_pt.erl b/lib/compiler/test/compile_SUITE_data/generic_pt.erl
index 55015e589b..ed4d32f2e9 100644
--- a/lib/compiler/test/compile_SUITE_data/generic_pt.erl
+++ b/lib/compiler/test/compile_SUITE_data/generic_pt.erl
@@ -40,7 +40,11 @@ actions(Source, Forms, Options) ->
         error ->
             {error, Es, Ws};
         undefined_error ->
-            {error, [{Source, [{{1,1}, ?MODULE, unknown_error}]}], []}
+            {error, [{Source, [{{1,1}, ?MODULE, unknown_error}]}], []};
+        throw ->
+            throw(thrown);
+        exit ->
+            exit(exited)
     end.
 
 format_error(bad_moon_phase) ->
diff --git a/lib/compiler/test/error_SUITE.erl b/lib/compiler/test/error_SUITE.erl
index 769dc6e651..0fd5fedcc4 100644
--- a/lib/compiler/test/error_SUITE.erl
+++ b/lib/compiler/test/error_SUITE.erl
@@ -230,25 +230,38 @@ transforms(Config) ->
 	    [return],
 	    {error,[{none,compile,{undef_parse_transform,non_existing}}],[]}}],
     [] = run(Config, Ts1),
+
     Ts2 = <<"
               -compile({parse_transform,",?MODULE_STRING,"}).
              ">>,
-    {error,[{none,compile,{parse_transform,?MODULE,{too_bad,_}}}],[]} =
-	run_test(Ts2, test_filename(Config), [], dont_write_beam),
-    Ts3 = <<"
-              -compile({parse_transform,",?MODULE_STRING,"}).
-             ">>,
-    {error,[{none,compile,{parse_transform,?MODULE,{undef,_}}}],[]} =
-        run_test(Ts3, test_filename(Config), [call_undef], dont_write_beam),
+
+    {error,[{none,compile,{parse_transform,?MODULE,{error,too_bad,_}}}],[]} =
+	run_test(Ts2, test_filename(Config), [{pt_error,error}], dont_write_beam),
+
+    {error,[{none,compile,{parse_transform,?MODULE,{error,undef,_}}}],[]} =
+        run_test(Ts2, test_filename(Config), [{pt_error,call_undef}], dont_write_beam),
+
+    {error,[{none,compile,{parse_transform,?MODULE,{exit,exited,_}}}],[]} =
+        run_test(Ts2, test_filename(Config), [{pt_error,exit}], dont_write_beam),
+
+    {error,[{none,compile,{parse_transform,?MODULE,{throw,thrown,[_|_]}}}],[]} =
+        run_test(Ts2, test_filename(Config), [{pt_error,throw}], dont_write_beam),
+
     ok.
 
 parse_transform(_, Opts) ->
-    case lists:member(call_undef, Opts) of
-        false -> error(too_bad);
-        true -> camembert:délicieux()
+    {_,Error} = lists:keyfind(pt_error, 1, Opts),
+    case Error of
+        call_undef ->
+            camembert:délicieux();
+        throw ->
+            throw(thrown);
+        exit ->
+            exit(exited);
+        error ->
+            error(too_bad)
     end.
 
-
 maps_warnings(Config) when is_list(Config) ->
     Ts1 = [{map_ok_use_of_pattern,
 	   <<"
-- 
2.26.2

Places

File 1021-Improve-handling-of-exceptions-from-parse-transforms.patch of Package erlang (Revision 3e233b2d0ea21cbf4e721681a5e11bfd)

Places