[GR-18163] Fix "circular causes" error at raising exception

PullRequest: truffleruby/4547

Author: andrykonchin

spec/ruby/core/exception/full_message_spec.rb

@@ -211,4 +211,16 @@ class << e
     e.full_message(highlight: false).lines.first.should =~ /RuntimeError/
     e.full_message(highlight: true).lines.first.should =~ /#{Regexp.escape("\e[1;4mRuntimeError\e[m")}/
   end
+
+  it "allows cause with empty backtrace" do
+    begin
+      raise RuntimeError.new("Some runtime error"), cause: RuntimeError.new("Some other runtime error")
+    rescue => e
+    end
+
+    full_message = e.full_message
+    full_message.should include "RuntimeError"
+    full_message.should include "Some runtime error"
+    full_message.should include "Some other runtime error"
+  end
 end

spec/ruby/core/kernel/raise_spec.rb

@@ -203,6 +203,65 @@
       e.cause.should == e1
     end
   end
+
+  it "re-raises a previously rescued exception that doesn't have a cause and isn't a cause of any other exception with setting a cause implicitly" do
+    begin
+      begin
+        raise "Error 1"
+      rescue => e1
+        begin
+          raise "Error 2"
+        rescue => e2
+          raise "Error 3"
+        end
+      end
+    rescue => e
+      e.message.should == "Error 3"
+      e.cause.should == e2
+    end
+  end
+
+  it "re-raises a previously rescued exception that doesn't have a cause and is a cause of other exception without setting a cause implicitly" do
+    begin
+      begin
+        raise "Error 1"
+      rescue => e1
+        begin
+          raise "Error 2"
+        rescue => e2
+          e1.cause.should == nil
+          e2.cause.should == e1
+          raise e1
+        end
+      end
+    rescue => e
+      e.should == e1
+      e.cause.should == nil
+    end
+  end
+
+  it "re-raises a previously rescued exception that has a cause but isn't a cause of any other exception without setting a cause implicitly" do
+    begin
+      begin
+        raise "Error 1"
+      rescue => e1
+        begin
+          raise "Error 2"
+        rescue => e2
+          begin
+            raise "Error 3", cause: RuntimeError.new("Error 4")
+          rescue => e3
+            e2.cause.should == e1
+            e3.cause.should_not == e2
+            raise e2
+          end
+        end
+      end
+    rescue => e
+      e.should == e2
+      e.cause.should == e1
+    end
+  end
 end
 
 describe "Kernel#raise" do

spec/ruby/shared/kernel/raise.rb

@@ -88,6 +88,10 @@ def initialize
     -> { @object.raise(nil) }.should raise_error(TypeError, "exception class/object expected")
   end
 
+  it "raises a TypeError when passed a message and an extra argument" do
+    -> { @object.raise("message", {cause: RuntimeError.new()}) }.should raise_error(TypeError, "exception class/object expected")
+  end
+
   it "raises TypeError when passed a non-Exception object but it responds to #exception method that doesn't return an instance of Exception class" do
     e = Object.new
     def e.exception

src/main/java/org/truffleruby/core/exception/ExceptionNodes.java

@@ -9,6 +9,7 @@
  */
 package org.truffleruby.core.exception;
 
+import com.oracle.truffle.api.dsl.Fallback;
 import com.oracle.truffle.api.interop.InteropLibrary;
 import com.oracle.truffle.api.library.CachedLibrary;
 import com.oracle.truffle.api.object.Shape;
@@ -368,4 +369,35 @@ Object getRaiseException(RubyException exception) {
 
     }
 
+    @Primitive(name = "exception_used_as_a_cause?")
+    public abstract static class IsUsedAsACauseNode extends PrimitiveArrayArgumentsNode {
+
+        @Specialization
+        boolean isUsedAsACause(RubyException exception) {
+            return exception.usedAsACause;
+        }
+
+        @Fallback
+        boolean isUsedAsACauseForeignException(Object exception) {
+            return false;
+        }
+
+    }
+
+    @Primitive(name = "exception_used_as_a_cause!")
+    public abstract static class UsedAsACauseNode extends PrimitiveArrayArgumentsNode {
+
+        @Specialization
+        Object usedAsACause(RubyException exception) {
+            exception.usedAsACause = true;
+            return nil;
+        }
+
+        @Fallback
+        Object usedAsACauseForeignException(Object exception) {
+            return nil;
+        }
+
+    }
+
 }

src/main/java/org/truffleruby/core/exception/RubyException.java

@@ -50,6 +50,7 @@ public class RubyException extends RubyDynamicObject implements ObjectGraphNode
     public Object backtraceLocations = null;
     /** null (not set), RubyArray of Strings, or nil (empty) */
     public Object customBacktrace = null;
+    public boolean usedAsACause = false;
 
     public RubyException(RubyClass rubyClass, Shape shape, Object message, Backtrace backtrace, Object cause) {
         super(rubyClass, shape);

src/main/ruby/truffleruby/core/kernel.rb

@@ -698,25 +698,29 @@ def raise(exc = undefined, msg = undefined, ctx = nil, cause: undefined, **kwarg
         msg = kwargs
       end
 
+      exc = Truffle::ExceptionOperations.build_exception_for_raise(exc, msg)
+      exc.set_backtrace(ctx) if ctx
+      Primitive.exception_capture_backtrace(exc, 1) unless Truffle::ExceptionOperations.backtrace?(exc)
+
       if cause_given
         unless Primitive.is_a?(cause, ::Exception) || Primitive.nil?(cause)
           Truffle::ExceptionOperations.exception_object_expected!
         end
       else
-        cause = $!
+        if Primitive.nil?(exc.cause) && !Primitive.exception_used_as_a_cause?(exc)
+          cause = $!
+        else
+          cause = nil
+        end
       end
 
-      exc = Truffle::ExceptionOperations.build_exception_for_raise(exc, msg)
-
-      exc.set_backtrace(ctx) if ctx
-      Primitive.exception_capture_backtrace(exc, 1) unless Truffle::ExceptionOperations.backtrace?(exc)
-
       if !Primitive.nil?(cause) && (cause_given || Primitive.nil?(exc.cause)) && !Primitive.equal?(cause, exc)
         if Truffle::ExceptionOperations.circular_cause?(cause, exc)
           raise ArgumentError, 'circular causes'
         end
 
         Primitive.exception_set_cause exc, cause
+        Primitive.exception_used_as_a_cause!(cause)
       end
     end
 

src/main/ruby/truffleruby/core/truffle/exception_operations.rb

@@ -22,7 +22,7 @@ def self.build_exception_for_raise(exc, msg)
 
         exception_object_expected! unless Primitive.is_a?(exc, ::Exception)
         exc
-      elsif Primitive.is_a?(exc, ::String)
+      elsif Primitive.is_a?(exc, ::String) && Primitive.undefined?(msg)
         ::RuntimeError.exception exc
       else
         exception_class_object_expected!
@@ -297,14 +297,14 @@ def self.append_causes(str, err, causes, reverse, highlight, options)
           append_causes(str, cause, causes, reverse, highlight, options)
           backtrace_message = backtrace_message(highlight, reverse, cause.backtrace, cause, options)
           if backtrace_message.empty?
-            str << detailed_message_or_fallback(exception, options)
+            str << detailed_message_or_fallback(cause, options)
           else
             str << backtrace_message
           end
         else
           backtrace_message = backtrace_message(highlight, reverse, cause.backtrace, cause, options)
           if backtrace_message.empty?
-            str << detailed_message_or_fallback(exception, options)
+            str << detailed_message_or_fallback(cause, options)
           else
             str << backtrace_message
           end

test/mri/excludes/TestException.rb

@@ -3,7 +3,6 @@
 exclude :test_cause_raised_in_rescue, "cause should not be overwritten by reraise."
 exclude :test_cause_thread_with_cause, "NoMethodError: undefined method `message' for nil:NilClass"
 exclude :test_circular_cause, "Expected #<RuntimeError: error 2> to be nil."
-exclude :test_circular_cause_handle, "Exception(ArgumentError) with message matches to /circular cause/."
 exclude :test_errinfo_encoding_in_debug, "Expected \"\" to include \"#<Module:0x608>::Cエラー\"."
 exclude :test_errinfo_in_debug, "needs investigation"
 exclude :test_exception_in_ensure_with_next, "NameError: uninitialized constant TestException::RubyVM"
@@ -13,7 +12,6 @@
 exclude :test_marshal_circular_cause, "\"\\x04\\bo:\\x11RuntimeError\\b:\\tmesgI\\\"\\berr\\x06:\\x06ET:\\abt[\\x00:\\ncauseo:\\x0EException\\a;\\x060;\\b0\"."
 exclude :test_non_exception_cause, "Exception(TypeError) with message matches to /exception/."
 exclude :test_output_string_encoding, "<1> expected but was <0>."
-exclude :test_raise_with_cause, "[TypeError] exception expected, not #<RuntimeError: [Feature #8257]>."
 exclude :test_stackoverflow, "<no message> (java.lang.IndexOutOfBoundsException) from com.oracle.svm.core.jni.functions.JNIFunctions$NewObjectWithObjectArrayArgFunctionPointer.invoke(JNIFunctions.java:-1)"
 exclude :test_too_many_args_in_eval, "[SystemStackError] exception expected, not #<ArgumentError: wrong number of arguments (given 140000, expected 0..3)>."
 exclude :test_undef_Warning_warn, "[NoMethodError] exception expected, not #<NameError: undefined method `warn' for class `Module'>."