chore: Compile rego once to save CPU cycles in testing #4169
Conversation
This file contains hidden or 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
Emyrk
reviewed
Sep 23, 2022
coderd/rbac/authz.go
Outdated
Comment on lines
77
to
101
| func init() { | ||
| var err error | ||
| query, err = rego.New( | ||
| // Bind the results to 2 variables for easy checking later. | ||
| rego.Query( | ||
| fmt.Sprintf("%s := data.authz.role_allow "+ | ||
| "%s := data.authz.scope_allow", | ||
| rolesOkCheck, scopeOkCheck), | ||
| ), | ||
| rego.Module("policy.rego", policy), | ||
| ).PrepareForEval(ctx) | ||
|
|
||
| ).PrepareForEval(context.Background()) | ||
| if err != nil { | ||
| return nil, xerrors.Errorf("prepare query: %w", err) | ||
| panic(err) | ||
| } | ||
| return &RegoAuthorizer{query: query}, nil | ||
| } | ||
|
|
||
| const ( | ||
| rolesOkCheck = "role_ok" | ||
| scopeOkCheck = "scope_ok" | ||
| ) | ||
|
|
||
| func NewAuthorizer() *RegoAuthorizer { | ||
| return &RegoAuthorizer{query: query} | ||
| } |
There was a problem hiding this comment.
Can we just do this with a sync.Once instead of a init()? I just don't like inits() in packages.
var authorizerOnce = sync.Once{}
// cachedQuery is cached to only be compiled once.
var cachedQuery *rego.PreparedEvalQuery
func NewAuthorizer() (*RegoAuthorizer, error) {
ctx := context.Background()
var query rego.PreparedEvalQuery
var err error
// Only compile the authorizer once and reuse it.
authorizerOnce.Do(func() {
query, err = rego.New(
// Bind the results to 2 variables for easy checking later.
rego.Query(
fmt.Sprintf("%s := data.authz.role_allow "+
"%s := data.authz.scope_allow",
rolesOkCheck, scopeOkCheck),
),
rego.Module("policy.rego", policy),
).PrepareForEval(ctx)
if err != nil {
err = xerrors.Errorf("prepare query: %w", err)
}
cachedQuery = &query
})
// Error from the first call
if err != nil {
return nil, err
}
if cachedQuery == nil {
return nil, xerrors.Errorf("cached query failed to compile")
}
return &RegoAuthorizer{query: *cachedQuery}, nil
}There was a problem hiding this comment.
I think erroring from the first call will result in more strange behavior... because you'd get an indirect error on the second execution. We panic'd before in coderd.go, so I tried to keep the same behavior.
There was a problem hiding this comment.
Yea, that is annoying. Could cache the error, but panicing is fine
Emyrk
approved these changes
Sep 23, 2022
coderd/rbac/authz.go
Outdated
| rego.Module("policy.rego", policy), | ||
| ).PrepareForEval(context.Background()) | ||
| if err != nil { | ||
| panic(err) |
There was a problem hiding this comment.
Wrap the error with some context?
Compiling rego isn't very fast, so this should speed up tests in CI!
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.
Compiling rego isn't very fast, so this should speed up tests in CI!