[GR-22031] Always show core source sections, with format <internal:core> core/file.rb:line.

PullRequest: truffleruby/1752

Author: eregon

CHANGELOG.md

@@ -10,6 +10,7 @@ New features:
 * `foreign_object.class` now calls `getMetaObject()` (except for Java classes, same as before).
 * Add basic support for Linux ARM64.
 * `foreign_object.name = value` will now call `Interoplibrary#writeMember("name", value)` instead of `invokeMember("name=", value)`.
+* Always show the Ruby core library files in backtraces (#1414).
 
 Bug fixes:
 

doc/contributor/debugging.md

@@ -0,0 +1,28 @@
+# Debugging TruffleRuby
+
+## Printing Exceptions
+
+There are two ways to print exceptions, which can be useful to find the source of an error:
+
+* the standard Ruby `-d` flag which print the `file:line` where each exception was raised.
+* `--backtraces-raise` which show the full backtrace on each exception raised.
+
+Both print all exceptions even if the exceptions are later rescued.
+
+Java exceptions can be printed with `exceptions-print-uncaught-java` or
+`--exceptions-print-java`.
+
+See other `--backtraces-*` and `--exceptions-*` options for more possibilities.
+
+## More Information in Backtraces
+
+We try to match MRI's backtrace format as closely as possible. This sometimes means
+that we don't display extra information that we actually do have available.
+When debugging you may want to see this information.
+
+An option to show more information is `--backtraces-interleave-java=true`
+which shows you the Java methods involved in executing each Ruby method.
+
+When you are interoperating with other languages, including C extensions,
+backtraces for Java exceptions may be missing information, as the Java frames
+are gone by the time Ruby has a chance to format them into a backtrace.

doc/user/debugging.md

@@ -43,7 +43,7 @@
       # This regexp is deliberately imprecise to account for the need to abstract out
       # the paths of the included mspec files and the desire to avoid specifying in any
       # detail what the in `...' portion looks like.
-      line.should =~ /^[^ ]+\:\d+(:in `[^`]+')?$/
+      line.should =~ /^.+:\d+:in `[^`]+'$/
     end
   end
 

spec/ruby/core/exception/backtrace_spec.rb

@@ -10,4 +10,14 @@
   it 'returns the absolute path of the call frame' do
     @frame.lineno.should == @line
   end
+
+  it 'should be the same line number as in #to_s, including for core methods' do
+    # Get the caller_locations from a call made into a core library method
+    locations = [:non_empty].map { caller_locations }[0]
+
+    locations.each do |location|
+      line_number = location.to_s[/:(\d+):/, 1]
+      location.lineno.should == Integer(line_number)
+    end
+  end
 end

spec/ruby/core/thread/backtrace/location/lineno_spec.rb

@@ -87,6 +87,18 @@
     end
   end
 
+  it 'should be the same path as in #to_s, including for core methods' do
+    # Get the caller_locations from a call made into a core library method
+    locations = [:non_empty].map { caller_locations }[0]
+
+    locations.each do |location|
+      filename = location.to_s[/^(.+):\d+:/, 1]
+      path = location.path
+
+      path.should == filename
+    end
+  end
+
   context "canonicalization" do
     platform_is_not :windows do
       before :each do

spec/ruby/core/thread/backtrace/location/path_spec.rb

@@ -10,17 +10,20 @@
 
 describe 'Thread::Backtrace::Location#absolute_path' do
 
-  it 'should be the same absolute path as in the formatted description for core methods' do
+  it 'returns an existing and canonical path for core methods' do
     # Get the caller_locations from a call made into a core method.
     locations = [:non_empty].map { caller_locations }.flatten
 
     locations.each do |location|
-      filename, _line_number, _in_method = location.to_s.split(':')
       path = location.absolute_path
+      path.should_not.include?('(core)')
 
-      path.should_not == '(core)'
-      path.start_with?('resource:/').should be_false
-      location.absolute_path.should == File.expand_path(filename)
+      if path.include?('resource:')
+        skip
+      else
+        File.should.exist?(location.absolute_path)
+        File.realpath(location.absolute_path).should == location.absolute_path
+      end
     end
   end
 

spec/truffle/thread/backtrace/location/absolute_path_spec.rb

@@ -189,7 +189,8 @@ protected Object backtraceLocations(DynamicObject exception,
                 Object backtraceLocations = Layouts.EXCEPTION.getBacktraceLocations(exception);
                 if (hasLocationsProfile.profile(backtraceLocations == null)) {
                     Backtrace backtrace = Layouts.EXCEPTION.getBacktrace(exception);
-                    backtraceLocations = backtrace.getBacktraceLocations(GetBacktraceException.UNLIMITED, null);
+                    backtraceLocations = backtrace
+                            .getBacktraceLocations(getContext(), GetBacktraceException.UNLIMITED, null);
                     Layouts.EXCEPTION.setBacktraceLocations(exception, backtraceLocations);
                 }
                 return backtraceLocations;