Skip to content

Database governance built for humans and agents — controlling changes and access across every major database.

fix(review): let a rule run complete while review is off

rebeliceebbd4d0d18a3
diff --git a/backend/api/v1/issue_service_review_run.go b/backend/api/v1/issue_service_review_run.go
index f12aafa8ab..29497e5025 100644
--- a/backend/api/v1/issue_service_review_run.go
+++ b/backend/api/v1/issue_service_review_run.go
@@ -82,15 +82,6 @@ func (s *IssueService) RunReview(ctx context.Context, req *connect.Request[v1pb.
if len(targets) == 0 {
return nil, connect.NewError(connect.CodeFailedPrecondition, errors.Errorf("the plan has no reviewable SQL"))
}
- if reviewType == store.ReviewRunTypeRule {
- policy, err := s.store.GetEffectiveReviewRulePolicy(ctx, project.Workspace, projectID)
- if err != nil {
- return nil, connect.NewError(connect.CodeInternal, errors.Wrapf(err, "failed to get review rule policy"))
- }
- if len(policy.GetRules()) == 0 {
- return nil, connect.NewError(connect.CodeFailedPrecondition, errors.Errorf("rule review requires the SYNTAX rule to be on"))
- }
- }
if reviewType == store.ReviewRunTypeAI {
aiSetting, err := s.store.GetAISetting(ctx, common.GetWorkspaceIDFromContext(ctx))
if err != nil {
diff --git a/backend/api/v1/issue_service_review_run_test.go b/backend/api/v1/issue_service_review_run_test.go
index 4e38c80d50..5aeaab496f 100644
--- a/backend/api/v1/issue_service_review_run_test.go
+++ b/backend/api/v1/issue_service_review_run_test.go
@@ -14,44 +14,33 @@ import (
"github.com/bytebase/bytebase/backend/store"
)
-func TestRunReviewRefusesRuleReviewWithoutSyntax(t *testing.T) {
+// TestRunReviewCreatesRuleRunWithReviewOff pins that switching every rule off
+// does not refuse a rule run: the run completes with no findings, which
+// resolves the findings of earlier runs.
+func TestRunReviewCreatesRuleRunWithReviewOff(t *testing.T) {
t.Parallel()
ctx := issueServiceTestContext()
stores := setupIssueServiceTestStore(ctx, t)
_, issue := createIssueServiceApprovalIssue(ctx, t, stores)
service := newIssueServiceForTest(t, stores)
- setProjectRules := func(rules ...storepb.ReviewRuleType) {
- t.Helper()
- payload, err := protojson.Marshal(&storepb.ReviewRulePolicy{Rules: rules})
- require.NoError(t, err)
- _, err = stores.CreatePolicy(ctx, &store.PolicyMessage{
- Workspace: "default",
- ResourceType: storepb.Policy_PROJECT,
- Resource: common.FormatProject("project-a"),
- Type: storepb.Policy_REVIEW_RULE,
- Payload: string(payload),
- Enforce: true,
- })
- require.NoError(t, err)
- }
- runRuleReview := func() (*v1pb.ReviewRun, error) {
- resp, err := service.RunReview(ctx, connect.NewRequest(&v1pb.RunReviewRequest{
- Name: fmt.Sprintf("projects/project-a/issues/%d/reviewRuns/rule", issue.UID),
- }))
- if err != nil {
- return nil, err
- }
- return resp.Msg, nil
- }
-
- setProjectRules(storepb.ReviewRuleType_REQUIRE_WHERE)
- _, err := runRuleReview()
- require.Equal(t, connect.CodeFailedPrecondition, connect.CodeOf(err))
+ // REQUIRE_WHERE without SYNTAX is review switched off.
+ payload, err := protojson.Marshal(&storepb.ReviewRulePolicy{Rules: []storepb.ReviewRuleType{storepb.ReviewRuleType_REQUIRE_WHERE}})
+ require.NoError(t, err)
+ _, err = stores.CreatePolicy(ctx, &store.PolicyMessage{
+ Workspace: "default",
+ ResourceType: storepb.Policy_PROJECT,
+ Resource: common.FormatProject("project-a"),
+ Type: storepb.Policy_REVIEW_RULE,
+ Payload: string(payload),
+ Enforce: true,
+ })
+ require.NoError(t, err)
- setProjectRules(storepb.ReviewRuleType_SYNTAX, storepb.ReviewRuleType_REQUIRE_WHERE)
- run, err := runRuleReview()
+ resp, err := service.RunReview(ctx, connect.NewRequest(&v1pb.RunReviewRequest{
+ Name: fmt.Sprintf("projects/project-a/issues/%d/reviewRuns/rule", issue.UID),
+ }))
require.NoError(t, err)
- require.Equal(t, v1pb.ReviewRun_RULE, run.Type)
- require.Equal(t, v1pb.ReviewRun_AVAILABLE, run.Status)
+ require.Equal(t, v1pb.ReviewRun_RULE, resp.Msg.Type)
+ require.Equal(t, v1pb.ReviewRun_AVAILABLE, resp.Msg.Status)
}
diff --git a/backend/runner/reviewrun/rule_executor.go b/backend/runner/reviewrun/rule_executor.go
index 8b1f9e03ab..926545965c 100644
--- a/backend/runner/reviewrun/rule_executor.go
+++ b/backend/runner/reviewrun/rule_executor.go
@@ -66,8 +66,9 @@ func (e *RuleExecutor) RunOnce(ctx context.Context, projectID string, issueUID i
if err != nil {
return nil, errors.Wrapf(err, "failed to get review rule policy")
}
- // An empty policy is review switched off. omni evaluates SYNTAX whether or
- // not it is listed, so it is not asked at all.
+ // An empty policy is review switched off: the run completes with no
+ // findings, which resolves those of earlier runs. omni evaluates SYNTAX
+ // whether or not it is listed, so it is not asked at all.
if len(policy.GetRules()) == 0 {
return nil, nil
}