[GR-34365] Exception#full_message should default the order to :top since Ruby 3

PullRequest: truffleruby/3294

Author: eregon

CHANGELOG.md

@@ -12,6 +12,7 @@ Bug fixes:
 Compatibility:
 
 * Fix `Marshal.dump` to raise an error when an object has singleton methods (@bjfish).
+* `Exception#full_message` now defaults the order to `:top` like CRuby 3+ (@eregon).
 
 Performance:
 

spec/mspec/lib/mspec/matchers/output.rb

@@ -42,12 +42,12 @@ def failure_message
     expected_out = "\n"
     actual_out = "\n"
     unless @out.nil?
-      expected_out += "  $stdout: #{@out.inspect}\n"
-      actual_out += "  $stdout: #{@stdout.inspect}\n"
+      expected_out += "  $stdout: #{MSpec.format(@out)}\n"
+      actual_out += "  $stdout: #{MSpec.format(@stdout.to_s)}\n"
     end
     unless @err.nil?
-      expected_out += "  $stderr: #{@err.inspect}\n"
-      actual_out += "  $stderr: #{@stderr.inspect}\n"
+      expected_out += "  $stderr: #{MSpec.format(@err)}\n"
+      actual_out += "  $stderr: #{MSpec.format(@stderr.to_s)}\n"
     end
     ["Expected:#{expected_out}", "     got:#{actual_out}"]
   end

spec/ruby/core/thread/report_on_exception_spec.rb

@@ -61,6 +61,36 @@
       }.should raise_error(RuntimeError, "Thread#report_on_exception specs")
     end
 
+    ruby_version_is "3.0" do
+      it "prints a backtrace on $stderr in the regular backtrace order" do
+        line_raise = __LINE__ + 2
+        def foo
+          raise RuntimeError, "Thread#report_on_exception specs backtrace order"
+        end
+
+        line_call_foo = __LINE__ + 5
+        go = false
+        t = Thread.new {
+          Thread.current.report_on_exception = true
+          Thread.pass until go
+          foo
+        }
+
+        -> {
+          go = true
+          Thread.pass while t.alive?
+        }.should output("", <<ERR)
+#{t.inspect} terminated with exception (report_on_exception is true):
+#{__FILE__}:#{line_raise}:in `foo': Thread#report_on_exception specs backtrace order (RuntimeError)
+\tfrom #{__FILE__}:#{line_call_foo}:in `block (5 levels) in <top (required)>'
+ERR
+
+        -> {
+          t.join
+        }.should raise_error(RuntimeError, "Thread#report_on_exception specs backtrace order")
+      end
+    end
+
     it "prints the backtrace even if the thread was killed just after Thread#raise" do
       t = nil
       ready = false

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

@@ -87,7 +87,7 @@ def inspect
     end
   end
 
-  def full_message(highlight: nil, order: undefined)
+  def full_message(highlight: nil, order: :top)
     Truffle::ExceptionOperations.full_message(self, highlight, order)
   end
 

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

@@ -127,12 +127,9 @@ def self.full_message(exception, highlight, order)
                     raise ArgumentError, "expected true of false as highlight: #{highlight}" unless highlight.equal?(true) || highlight.equal?(false)
                     !highlight.equal?(false)
                   end
-      reverse = if Primitive.undefined?(order)
-                  Exception.to_tty?
-                else
-                  raise ArgumentError, "expected :top or :bottom as order: #{order}" unless order.equal?(:top) || order.equal?(:bottom)
-                  !order.equal?(:top)
-                end
+
+      raise ArgumentError, "expected :top or :bottom as order: #{order}" unless order.equal?(:top) || order.equal?(:bottom)
+      reverse = !order.equal?(:top)
 
       result = ''.b
       bt = exception.backtrace || caller(2)

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

@@ -161,7 +161,7 @@ def self.detect_outermost_recursion(obj, &block)
   end
 
   def self.report_exception(thread, exception)
-    message = "#{thread.inspect} terminated with exception:\n#{exception.full_message}"
+    message = "#{thread.inspect} terminated with exception (report_on_exception is true):\n#{exception.full_message}"
     $stderr.write message
   end