Issue #12882 has been updated by Martin Drst.

Assignee set to Yukihiro Matsumoto

----------------------------------------
Feature #12882: Add caller/file/line information to internal Kernel#warn calls
https://bugs.ruby-lang.org/issues/12882#change-62010

* Author: Jeremy Evans
* Status: Open
* Priority: Normal
* Assignee: Yukihiro Matsumoto
----------------------------------------
Most internal uses of Kernel#warn do not begin with caller/file/line information, making debugging such warnings more difficult, and hindering filtering/processing of warnings on a per-file/directory/gem basis when overriding Warning.warn (a new feature in ruby 2.4).

I think it would be better if internal calls to Kernel#warn in ruby code included caller information, so the warnings generated are similar to those generated by rb_warn in C code.

I'm attaching an initial attempt at this. There was a lot of internal inconsistency in existing warning messages that include caller information.  I choose to standardize on `caller(1,1).first`.  Specifying 1 as the length argument to caller provides a 5-10x speedup compared to the default of nil as the length argument, and since warning messages only use the first line, there's no need to generate additional lines. I also benchmarked using caller_locations, but that didn't seem to perform better, probably because the result is just converted to a string anyway.

Some existing warning messages that include caller information use #caller but attempt to strip out the method information via gsub.  I'm guessing it would be better to use #caller_locations. However, that's kind of cumbersome right now, if we want to do that, we should probably add a method to Thread::Backtrace::Location that returns just the absolute_path and lineno as a string, so we could standardize on `caller_locations(1,1).first.file_and_line` (or whatever the method is called).

There are a few questionable changes in the attached patch, such as the use of `caller(0,1)` in certain cases (when the changes were at top level), or including caller information in warning messages that were only output in DEBUG mode.

The attached patch does not include changes for rdoc and rubygems, as those are maintained in separate repositories. Assuming that this patch or a similar one is accepted, I can submit patches to both rdoc and rubygems for their warning messages.

---Files--------------------------------
0001-Prepend-warning-messages-with-caller-information.patch (30.6 KB)


-- 
https://bugs.ruby-lang.org/

Unsubscribe: <mailto:ruby-core-request / ruby-lang.org?subject=unsubscribe>
<http://lists.ruby-lang.org/cgi-bin/mailman/options/ruby-core>