Add ExcludeLocationFile JSON marshalling option #6398
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
|
The difference in Regal linting the Kics repo: main 1700 files linted. 14233 violations found in 1696 files.
regal lint --enable-all kics/assets 191.61s user 7.18s system 610% cpu 32.553 totalwithout file 1700 files linted. 14233 violations found in 1696 files.
wegal lint --enable-all kics/assets 169.34s user 5.96s system 610% cpu 28.737 total22 seconds less spent in the processor, and 4 seconds less of wallclock time. Quite an improvement! |
johanfylling
approved these changes
Nov 10, 2023
| @@ -96,15 +96,32 @@ func (loc *Location) Compare(other *Location) int { | |||
|
|
|||
| func (loc *Location) MarshalJSON() ([]byte, error) { | |||
| // structs are used here to preserve the field ordering of the original Location struct | |||
| if loc.JSONOptions.MarshalOptions.ExcludeLocationFile { | |||
There was a problem hiding this comment.
Doing something like
data := struct {
File string `json:"file,omitempty"`
Row int `json:"row"`
Col int `json:"col"`
Text []byte `json:"text,omitempty"`
}{
Row: loc.Row,
Col: loc.Col,
}
if !loc.JSONOptions.MarshalOptions.ExcludeLocationFile {
data.File = loc.File
}would eliminate some redundancy here without changing the behavior, right?
There was a problem hiding this comment.
I tried that, and I could swear I had empty "" show up still, but now that I try again, it seems to work. If CI is happy too, then let's have this merged :)
There was a problem hiding this comment.
I had edited code in the wrong location 😬 It doesn't work as I'm still seeing tests fail with "file": "". Not sure why omitempty doesn't bite.
anderseknert
force-pushed
the
location-skip-file
branch
from
6457e56
to
4858924
Compare
Repeating the name of the file in each location is often redundant, and large AST trees carry thousands of these attributes. Providing an option to have them removed at least for serialization (as anything more would be a breaking change) seems like a good compromise. For reference, see StyraInc/regal#408 Signed-off-by: Anders Eknert <anders@styra.com>
anderseknert
force-pushed
the
location-skip-file
branch
from
4858924
to
239cf6d
Compare
The AST is always parsed from a single file. I guess you could add elements to that programmatically, but then it'd be your responsibility to ensure they follow the same conventions for JSON marshalling. |
anderseknert
added a commit
to StyraInc/regal
that referenced
this pull request
Nov 10, 2023
As we now can exclude that: open-policy-agent/opa#6398 About a 10% reduction in eval time linting the Kics repo 🚀 We will still add a "file" attribute to locations reported in violations, but we'll source that from `input.regal.file.name` instead, and won't have to worry about `walk` traversing thousands of redundant nodes. Signed-off-by: Anders Eknert <anders@styra.com>
anderseknert
added a commit
to StyraInc/regal
that referenced
this pull request
Nov 10, 2023
As we now can exclude that: open-policy-agent/opa#6398 About a 10% reduction in eval time linting the Kics repo 🚀 We will still add a "file" attribute to locations reported in violations, but we'll source that from `input.regal.file.name` instead, and won't have to worry about `walk` traversing thousands of redundant nodes. Signed-off-by: Anders Eknert <anders@styra.com>
anderseknert
added a commit
to StyraInc/regal
that referenced
this pull request
Nov 10, 2023
As we now can exclude that: open-policy-agent/opa#6398 About a 10% reduction in eval time linting the Kics repo 🚀 We will still add a "file" attribute to locations reported in violations, but we'll source that from `input.regal.file.name` instead, and won't have to worry about `walk` traversing thousands of redundant nodes. Signed-off-by: Anders Eknert <anders@styra.com>
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.
Repeating the name of the file in each location is often redundant, and large AST trees carry thousands of these attributes. Providing an option to have them removed at least for serialization (as anything more would be a breaking change) seems like a good compromise.
For reference, see StyraInc/regal#408