Allow Gem paths to be stripped from file names in stacktraces when they contain a Regexp special character #764
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
imjoehaines
changed the title
e.g. the 3.2 RC contains a '+' in the gem path (at least locally and on CI): `/../.gem/ruby/3.2.0+3` This needs escaping or it won't match any paths because it is expecting 1 or more '0' characters, rather than the literal characters '0+'
imjoehaines
force-pushed
the
regexp-escape-gem-path
branch
from
523d466
to
e94216a
Compare
imjoehaines
changed the title
imjoehaines
requested review from
Cawllec and
twometresteve
and removed request for
Cawllec
twometresteve
approved these changes
Dec 20, 2022
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Goal
We strip the Gem paths from file names in stack traces, but this doesn't work if there's a regexp special character
For example, the Ruby 3.2 RC contains a '+' in the gem path (at least locally and on CI):
/.../.gem/ruby/3.2.0+3This won't match any paths when used in a Regexp, because it is expecting one or more
0characters, rather than the literal characters0+. I've changed this matching logic to use a string instead of a Regexp to sidestep this problem and save having to escape the pathI spent a bit of time looking at adding unit tests for this but decided not to in the end because it involves reaching into
Geminternals and, with the wide range of Ruby versions we support, that didn't seem like a good idea. We already have tests for this stripping that use the real Gem path to prove this doesn't break anythingTesting
This caused a test to fail on the Ruby 3.2 RC, which now passes with this change