Feature fix encoding fatal error #3000
Merged
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
This test also demonstrates a bug "incompatible character encodings: UTF-8 and ASCII-8BIT". This bug only occurs when one of the scanned files contains a certain characters and the offense results are read from cache.
gerrywastaken
force-pushed
the
feature-fix-encoding-fatal-error
branch
2 times, most recently
from
caecb22 to
9ee213d
Compare
This tests makes sure that loading from the cache returns utf8 encoded strings. Currently the encoding is being changed to ASCII_8BIT and this can result in a fatal error for the end user. This also modifies :location to match the pre cache-load behaviour in lib/rubocop/processed_source.rb line 88.
If certain characters were encountered, RuboCop would crash during the syntax highlighting stage. This would only happen when the offense was read from cache. When offenses are read from cache they come back with an ASCII-8BIT encoding. Certain characters, such as curly quotes, cause an error when there is an attempt to convert the string back to UTF-8 for output to a HTML file. This fix changes the cache serialization so that it generates offenses in the same way as processed_source.rb, where the source is assigned instead of being read directly from a file by Parser.
gerrywastaken
force-pushed
the
feature-fix-encoding-fatal-error
branch
from
9ee213d to
d529b43
Compare
|
👍 Impressive work! I loved your attention to detail! |
|
Thanks mate and cheers for making RuboCop. :) |
|
Thanks for fixing this @gerrywastaken! I too was scratching my head trying to reproduce it to file #3099. Glad to see you were way ahead of me. |
|
@burnson Yeah I figured it must be affecting others. Glad this helped you. Good job tracking it down to cached results, that had me banging my head against a wall for quite some time. |
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.
This was a tricky one to track down. When I was running rubocop against some code it would keep crashing with an encoding error but it wasn't clear why this was happening and seemed inconsistent.
It turns out that it would only occur when the offenses were read from cache as they came back as ASCII-8BIT encoded strings instead of UTF-8 encoded when the cache isn't used. The attempt to convert inside the erb highlighting helper was triggering the crash.
I squashed the commits down into 3 logical changes, but didn't want to squash it into a single commit as it would have made things harder to understand for anybody looking at the changes. It also would have made cherry picking more difficult if it became necessary. If you still would prefer me to squash it further, then I can.
Before submitting a PR make sure the following are checked:
master(if not - rebase it)and description in grammatically correct, complete sentences.