fix(sourcebundle): Skip non-UTF8 files #2109
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
loewenheim
requested review from
szokeasaurusrex and
Swatinem
and removed request for
szokeasaurusrex
src/utils/file_upload.rs
Outdated
| if let Err(e) = bundle.add_file(bundle_path, file.contents.as_slice(), info) { | ||
| if e.kind() == SourceBundleErrorKind::ReadFailed { | ||
| // This is a non-UTF8 file; it might be an asset which is not intended for inclusion in the | ||
| // sourcebundle. We silently skip it. |
There was a problem hiding this comment.
Let's add an info log to inform users that we are skipping the file
There was a problem hiding this comment.
Ideally with the file path, something like:
skipping file path/to/file because it is not UTF-8 encoded
Swatinem
approved these changes
Jul 23, 2024
loewenheim
changed the title
This was referenced Aug 3, 2024
This was referenced Sep 10, 2024
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.
Prompted by #2107 and #2108.
This matches on the error kind returned by
SourceBundleWriter::add_fileand silently skipsReadFailederrors, which happen on files that aren't valid UTF8. Errors like this are likely caused by asset files that weren't intended to be included in the bundle anyway. It might also make sense to log that we're skipping the file, though.