Workaround Bundler's friendly errors swallowing error reports #634
Conversation
We avoid reporting SystemExit exceptions as they aren't (usually) errors. However, Bundler's friendly errors will wrap an exception in a SystemExit — in this case we need to unwrap to the original exception
This proves that we don't unwrap exceptions too much when unwrapping Bundler's friendly errors. In this case, the backtrace will look something like this: 1. Bundler friendly errors 2. Our exit 3. The exception we raised We want to drop 1. because it may be hiding a real exception, however we don't want to drop 2. because it's a deliberate exit This test proves that we don't go too far and end up with an exception that we would notify about
|
Hi! I'm fixing this in rubygems/rubygems#4063. Just letting you know in case you want to give the fix a try and see if it works for you, and also so that you are aware and can remove the workarounds you had to add. Regards! EDIT: I linked to the original issue, not to the PR, updated now :) |
Thanks for the heads up! I've done some testing today with Bundler 2.2.4 and your fix does make this workaround unnecessary We'll keep it around for a while so people have a chance to update Bundler, but thanks for fixing the root issue 🙂 |
Goal
When running a script with
bundle exec <file>orbundle exec ruby <file>, Bundler will wrap any uncaught exceptions in aSystemExit— see rubygems/rubygems#3368 andfriendly_errors.rbThis means that the uncaught exceptions are ignored by default, as we don't report
SystemExitexceptions, which can lead to real errors not being reportedThis PR attempts to workaround this behaviour by trying to "unwrap" the original exception from the
SystemExit. This is made more complicated by it being possible to have two levels ofSystemExitexceptions, if an executable script is run directly withbundle exec <file>. In this case we unwrap the "friendly errors"SystemExitand then unwrap the original exceptionIt's also important that we don't unwrap other
SystemExitexceptions, because then we will report any time an exit is used in arescueblock, e.g.Design
I'm not a huge fan of inspecting the backtrace for specific files, but they have stayed consistent for years so it should be fairly safe. I wasn't able to find another way to do this that didn't also result in reporting legitimate exits
Changeset
unwrap_bundler_exceptionwhich is used in theat_exithookTesting
The maze runner tests run the same files with the same results using both
bundle execandbundle exec ruby, which proves we can unwrap 1 or 2 levels of exceptions as neededThe new
exit_after_exceptiontest ensures we don't report exits outside of Bundler