[GR-18163] The exit code should be 1 if there is an internal error while running at_exit hooks

PullRequest: truffleruby/3892

Author: eregon

spec/tags/truffle/java_exception_tags.txt

@@ -1,3 +1,4 @@
 slow:Internal errors reaching the top level show both the Java stacktrace and Ruby backtrace
 slow:Internal errors reaching the top level show the cause
 slow:Internal errors reaching the top level AssertionError in another Thread is rethrown on the main Ruby Thread
+slow:Internal errors reaching the top level are also reported if they happen in at_exit

spec/truffle/fixtures/throw_java_exception_at_exit.rb

@@ -0,0 +1,15 @@
+# Copyright (c) 2023 Oracle and/or its affiliates. All rights reserved. This
+# code is released under a tri EPL/GPL/LGPL license. You can use it,
+# redistribute it and/or modify it under the terms of the:
+#
+# Eclipse Public License version 2.0, or
+# GNU General Public License version 2, or
+# GNU Lesser General Public License version 2.1.
+
+def foo
+  Truffle::Debug.throw_java_exception 'custom message'
+end
+
+at_exit do
+  foo
+end

spec/truffle/java_exception_spec.rb

@@ -33,6 +33,30 @@
     EOS
   end
 
+  it "are also reported if they happen in at_exit" do
+    file = fixture(__FILE__, 'throw_java_exception_at_exit.rb')
+    out = ruby_exe(file, args: "2>&1", exit_status: 1)
+    out = out.gsub(/\.java:\d+/, '.java:LINE')
+    out.should == <<-EOS
+
+truffleruby: unexpected internal exception in at_exit,
+please report it to https://github.com/oracle/truffleruby/issues.
+
+```
+custom message (java.lang.RuntimeException)
+	from org.truffleruby.debug.TruffleDebugNodes$ThrowJavaExceptionNode.throwingMethod(TruffleDebugNodes.java:LINE)
+	from org.truffleruby.debug.TruffleDebugNodes$ThrowJavaExceptionNode.callingMethod(TruffleDebugNodes.java:LINE)
+	from org.truffleruby.debug.TruffleDebugNodes$ThrowJavaExceptionNode.throwJavaException(TruffleDebugNodes.java:LINE)
+	from org.truffleruby.debug.TruffleDebugNodesFactory$ThrowJavaExceptionNodeFactory$ThrowJavaExceptionNodeGen.executeAndSpecialize(TruffleDebugNodesFactory.java:LINE)
+	from org.truffleruby.debug.TruffleDebugNodesFactory$ThrowJavaExceptionNodeFactory$ThrowJavaExceptionNodeGen.execute(TruffleDebugNodesFactory.java:LINE)
+	from org.truffleruby.language.RubyCoreMethodRootNode.execute(RubyCoreMethodRootNode.java:LINE)
+#{file}:10:in `throw_java_exception'
+	from #{file}:10:in `foo'
+	from #{file}:14:in `block in <main>'
+```
+    EOS
+  end
+
   it "show the cause" do
     file = fixture(__FILE__, 'throw_java_exception_with_cause.rb')
     out = ruby_exe(file, args: "2>&1", exit_status: 1)

src/main/java/org/truffleruby/core/kernel/AtExitManager.java

@@ -48,15 +48,21 @@ public void add(RubyProc block, boolean always) {
     }
 
     public AbstractTruffleException runAtExitHooks() {
-        return runExitHooks(atExitHooks, "at_exit");
+        return runExitHooks(atExitHooks);
     }
 
     public void runSystemExitHooks() {
-        runExitHooks(systemExitHooks, "system at_exit");
+        try {
+            runExitHooks(systemExitHooks);
+        } catch (ExitException | ThreadDeath e) {
+            throw e;
+        } catch (RuntimeException | Error e) {
+            BacktraceFormatter.printInternalError(context, e, "unexpected internal exception in system at_exit");
+        }
     }
 
     @TruffleBoundary
-    private AbstractTruffleException runExitHooks(Deque<RubyProc> stack, String name) {
+    private AbstractTruffleException runExitHooks(Deque<RubyProc> stack) {
         AbstractTruffleException lastException = null;
 
         while (true) {
@@ -67,13 +73,9 @@ private AbstractTruffleException runExitHooks(Deque<RubyProc> stack, String name
 
             try {
                 ProcOperations.rootCall(block, EmptyArgumentsDescriptor.INSTANCE, RubyBaseNode.EMPTY_ARGUMENTS);
-            } catch (ExitException | ThreadDeath e) {
-                throw e;
             } catch (AbstractTruffleException e) {
                 handleAtExitException(context, e);
                 lastException = e;
-            } catch (RuntimeException | Error e) {
-                BacktraceFormatter.printInternalError(context, e, "Unexpected internal exception in " + name);
             }
         }
     }

src/main/java/org/truffleruby/language/exceptions/TopLevelRaiseHandler.java

@@ -56,20 +56,21 @@ public int execute(Runnable body) {
             // No FiberShutdownException, it's only for Fibers
             assert !(e instanceof FiberShutdownException) : e;
 
-            BacktraceFormatter.printInternalError(
-                    getContext(),
-                    e,
+            BacktraceFormatter.printInternalError(getContext(), e,
                     "an internal exception escaped out of the interpreter");
             return 1;
         }
 
         // Execute at_exit hooks (except if hard #exit!)
+        String step = "unexpected internal exception in at_exit";
         try {
             AbstractTruffleException atExitException = getContext().getAtExitManager().runAtExitHooks();
+
             if (atExitException != null) {
                 exitCode = statusFromException(atExitException);
             }
 
+            step = "an internal exception escaped out of the interpreter";
             if (caughtException != null) {
                 // print the main script exception now
                 if (!AtExitManager.isSilentException(getContext(), caughtException)) {
@@ -84,10 +85,7 @@ public int execute(Runnable body) {
         } catch (ThreadDeath e) { // Context#close(true)
             throw e;
         } catch (RuntimeException | Error e) { // Internal error
-            BacktraceFormatter.printInternalError(
-                    getContext(),
-                    e,
-                    "an internal exception escaped out of the interpreter");
+            BacktraceFormatter.printInternalError(getContext(), e, step);
             return 1;
         }