This repository was archived by the owner on Aug 31, 2023. It is now read-only.
fix(rome_service): disallow large files from being parsed and analyzed #3339
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
✅ Deploy Preview for rometools canceled.
|
xunilrj
reviewed
Oct 5, 2022
xunilrj
approved these changes
Oct 5, 2022
9478178 to
568655d
Compare
ematipico
approved these changes
Oct 5, 2022
| ```block | ||
| ci.js lint ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ | ||
|
|
||
| × The file ci.js could not be parsed because it's too large (the file is 1.0 MiB long, but the size limit is 1.0 MiB) |
There was a problem hiding this comment.
Is it a coincidence that the input file is 1.0 Megabyte like the limit? If not, probably that's because we truncated some digits. I am not sure what to do... surely an inexperienced user might think that's a bug.
There was a problem hiding this comment.
It's a bit of both, in this case the test file is a few bytes larger than 1 MiB but that doesn't show since the values higher than 1 KiB are not printed at full precision. However the file size limit is checked using >= so even a file that's precisely 1 MiB in size would be rejected and print the error anyway.
568655d to
47e475e
Compare
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Summary
Fixes #3330
This PR adds a maximum size threshold to the Workspace after which files are no longer parsed, analyzed or formatted. At the moment I've hard-coded this limit to 1 MiB, but it should be trivial to expose this limit in the configuration file or the CLI if users really want to process very large files.
As part of the new message for this new error, I've added a new
Bytesutility torome_consolethat prints a quantity in bytes using the correct binary unit (B, KiB, MiB, GiB or TiB)Test Plan
I've added new test cases for the CLI that ensures files larger than the size threshold are not checked or formatted, and the correct diagnostic is emitted.