perf: opa fmt 3x faster formatting
#7341
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
We have a Regal rule checking that a file is formatted, making the performance of the formatter more important than it normally might be. Since I did some work on this in Regal recently, I was curious to see if this could be improved. Turned out to be a few bottlenecks that we could remove with great results. The Regal policies are possibly not representative for all kinds of Rego, and one thing that stands out is thay they have a *lot* of metadata annotations. Turned out that comment processing was the main bottleneck, so improving this meant a huge boost for formatting a typical Regal policy. The improvements here should make formatting of any file faster though. **BenchmarkFormatLargePolicy-10 main** ``` 382 3064960 ns/op 4573131 B/op 26266 allocs/op ``` **BenchmarkFormatLargePolicy-10 opa-fmt-perf** ``` 1396 812859 ns/op 362651 B/op 8811 allocs/op ``` Signed-off-by: Anders Eknert <[email protected]>
charlieegan3
approved these changes
Feb 6, 2025
|
Might be woth pointing out to the casual observer — this makes the formatting part of |
anderseknert
commented
Feb 6, 2025
| @@ -281,7 +281,7 @@ func init() { | |||
| addRegoV0V1FlagWithDescription(formatCommand.Flags(), &fmtParams.regoV1, false, "format module(s) to be compatible with both Rego v0 and v1") | |||
| addV0CompatibleFlag(formatCommand.Flags(), &fmtParams.v0Compatible, false) | |||
| addV1CompatibleFlag(formatCommand.Flags(), &fmtParams.v1Compatible, false) | |||
| formatCommand.Flags().BoolVar(&fmtParams.checkResult, "check-result", true, "assert that the formatted code is valid and can be successfully parsed (default true)") | |||
| formatCommand.Flags().BoolVar(&fmtParams.checkResult, "check-result", true, "assert that the formatted code is valid and can be successfully parsed") | |||
There was a problem hiding this comment.
This was printed twice
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.
We have a Regal rule checking that a file is formatted, making the performance of the formatter more important than it normally might be.
Since I did some work on this in Regal recently, I was curious to see if this could be improved. Turned out to be a few bottlenecks that we could remove with great results. The Regal policies are possibly not representative for all kinds of Rego, and one thing that stands out is thay they have a lot of metadata annotations. Turned out that comment processing was the main bottleneck, so improving this meant a huge boost for formatting a typical Regal policy. The improvements here should make formatting of any file faster though.
BenchmarkFormatLargePolicy-10 main
BenchmarkFormatLargePolicy-10 opa-fmt-perf