Skip to content

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

fix(plan): allow review submission after failed or canceled checks (#21525)

boojackc985123cef44
diff --git a/backend/component/review/submission.go b/backend/component/review/submission.go
index 458229c503..5d7396cf20 100644
--- a/backend/component/review/submission.go
+++ b/backend/component/review/submission.go
@@ -377,7 +377,10 @@ func validatePlanCheckRun(project *store.ProjectMessage, plan *store.PlanMessage
case store.PlanCheckRunStatusAvailable, store.PlanCheckRunStatusRunning:
return workflowError(ErrorFailedPrecondition, "Plan checks are still running")
case store.PlanCheckRunStatusCanceled, store.PlanCheckRunStatusFailed:
- return workflowError(ErrorFailedPrecondition, "Plan checks did not pass")
+ if project.Setting.GetEnforceSqlReview() {
+ return workflowError(ErrorFailedPrecondition, "Plan checks did not pass")
+ }
+ return nil
case store.PlanCheckRunStatusDone:
default:
return workflowError(ErrorFailedPrecondition, "Plan checks are not complete")
diff --git a/backend/component/review/submission_test.go b/backend/component/review/submission_test.go
index 261d811aba..e4aac7091e 100644
--- a/backend/component/review/submission_test.go
+++ b/backend/component/review/submission_test.go
@@ -136,6 +136,83 @@ func TestSubmitIssueAllowsPlanCheckErrorsRequiredOnlyForRollout(t *testing.T) {
require.False(t, result.Issue.Payload.GetDraft())
}
+func TestSubmitIssuePlanCheckRunStatus(t *testing.T) {
+ tests := []struct {
+ name string
+ status store.PlanCheckRunStatus
+ results []*storepb.PlanCheckRunResult_Result
+ enforceSQLReview bool
+ stale bool
+ wantAllowed bool
+ }{
+ {
+ name: "done advice error can be submitted without enforcement", status: store.PlanCheckRunStatusDone,
+ results: []*storepb.PlanCheckRunResult_Result{{Status: storepb.Advice_ERROR, Type: storepb.PlanCheckType_PLAN_CHECK_TYPE_STATEMENT_ADVISE}},
+ wantAllowed: true,
+ },
+ {
+ name: "done advice error is blocked with enforcement", status: store.PlanCheckRunStatusDone,
+ results: []*storepb.PlanCheckRunResult_Result{{Status: storepb.Advice_ERROR, Type: storepb.PlanCheckType_PLAN_CHECK_TYPE_STATEMENT_ADVISE}},
+ enforceSQLReview: true,
+ },
+ {
+ name: "failed timeout can be submitted without enforcement", status: store.PlanCheckRunStatusFailed,
+ results: []*storepb.PlanCheckRunResult_Result{{Status: storepb.Advice_ERROR, Title: "Plan check run timed out"}},
+ wantAllowed: true,
+ },
+ {
+ name: "failed timeout is blocked with enforcement", status: store.PlanCheckRunStatusFailed,
+ results: []*storepb.PlanCheckRunResult_Result{{Status: storepb.Advice_ERROR, Title: "Plan check run timed out"}},
+ enforceSQLReview: true,
+ },
+ {name: "failed executor can be submitted without enforcement", status: store.PlanCheckRunStatusFailed, wantAllowed: true},
+ {name: "failed executor is blocked with enforcement", status: store.PlanCheckRunStatusFailed, enforceSQLReview: true},
+ {name: "canceled run can be submitted without enforcement", status: store.PlanCheckRunStatusCanceled, wantAllowed: true},
+ {name: "canceled run is blocked with enforcement", status: store.PlanCheckRunStatusCanceled, enforceSQLReview: true},
+ {name: "stale failed run remains blocked", status: store.PlanCheckRunStatusFailed, stale: true},
+ }
+
+ for _, test := range tests {
+ t.Run(test.name, func(t *testing.T) {
+ ctx := context.Background()
+ stores := setupWorkflowStore(ctx, t)
+ if test.enforceSQLReview {
+ require.NoError(t, stores.UpdateProjects(ctx, &store.UpdateProjectMessage{
+ Workspace: "default", ResourceID: "project-a",
+ Setting: &storepb.Project{EnforceSqlReview: true},
+ }))
+ }
+ plan, issue := createReadyDraft(ctx, t, stores, false)
+ run, err := stores.GetPlanCheckRun(ctx, "project-a", plan.UID)
+ require.NoError(t, err)
+ version := plan.Config.GetApprovalInputVersion()
+ if test.stale {
+ version--
+ }
+ require.NoError(t, stores.UpdatePlanCheckRun(ctx, "project-a", test.status, &storepb.PlanCheckRunResult{
+ ApprovalInputVersion: version,
+ Results: test.results,
+ }, run.UID))
+
+ result, err := NewWorkflow(stores).SubmitIssue(ctx, SubmitIssueInput{
+ Workspace: "default", ProjectID: "project-a", IssueUID: issue.UID,
+ })
+ if test.wantAllowed {
+ require.NoError(t, err)
+ require.True(t, result.Submitted)
+ require.False(t, result.Issue.Payload.GetDraft())
+ } else {
+ var workflowErr *Error
+ require.True(t, errors.As(err, &workflowErr))
+ require.Equal(t, ErrorFailedPrecondition, workflowErr.Code)
+ got, getErr := stores.GetIssue(ctx, &store.FindIssueMessage{ProjectIDs: []string{"project-a"}, UID: &issue.UID})
+ require.NoError(t, getErr)
+ require.True(t, got.Payload.GetDraft())
+ }
+ })
+ }
+}
+
func TestConcurrentSubmitIssueEmitsEffectsOnce(t *testing.T) {
ctx := context.Background()
stores := setupWorkflowStore(ctx, t)
diff --git a/frontend/src/components/plan-check/PlanCheckSection.tsx b/frontend/src/components/plan-check/PlanCheckSection.tsx
index 08b87fbda4..c8a65bd1b1 100644
--- a/frontend/src/components/plan-check/PlanCheckSection.tsx
+++ b/frontend/src/components/plan-check/PlanCheckSection.tsx
@@ -59,8 +59,8 @@ interface PlanCheckSectionProps {
// Optional trailing element rendered after status counts (e.g. affected rows).
trailingSummary?: ReactNode;
renderTarget?: (target: string) => ReactNode;
- // If true, FAILED check runs without results render as a synthetic error
- // group. Used by plan-detail regular checks.
+ // If true, FAILED and CANCELED runs without error results render as a
+ // synthetic error group. Used by plan-detail regular checks.
includeRunFailure?: boolean;
// Section heading style; defaults to uppercase.
headingClassName?: string;
@@ -298,6 +298,8 @@ export function PlanCheckResultsDrawer({
getFilteredResultGroups({
includeRunFailure,
planCheckRuns,
+ runCanceledContent: t("common.canceled"),
+ runCanceledTitle: t("common.canceled"),
runFailureContent: t("common.failed"),
runFailureTitle: t("common.failed"),
selectedStatus,
diff --git a/frontend/src/lib/plan/check.test.ts b/frontend/src/lib/plan/check.test.ts
index ae4bb37dee..79ee2d39b8 100644
--- a/frontend/src/lib/plan/check.test.ts
+++ b/frontend/src/lib/plan/check.test.ts
@@ -8,7 +8,11 @@ import {
PlanCheckRunSchema,
} from "@/types/proto-es/v1/plan_service_pb";
import { Advice_Level } from "@/types/proto-es/v1/sql_service_pb";
-import { getFilteredResultGroups, getPlanCheckSummary } from "./check";
+import {
+ getFilteredResultGroups,
+ getPlanCheckSummary,
+ getPlanCheckSummaryWithFallback,
+} from "./check";
describe("plan check helpers", () => {
test("summarizes run-level and result-level statuses", () => {
@@ -33,14 +37,36 @@ describe("plan check helpers", () => {
]);
expect(summary).toEqual({
- error: 2,
+ error: 1,
running: 1,
success: 1,
- total: 5,
+ total: 4,
warning: 1,
});
});
+ test("counts incomplete runs once even when a timeout has an error result", () => {
+ for (const status of [
+ PlanCheckRun_Status.FAILED,
+ PlanCheckRun_Status.CANCELED,
+ ]) {
+ const run = create(PlanCheckRunSchema, {
+ status,
+ results: [
+ create(PlanCheckRun_ResultSchema, { status: Advice_Level.ERROR }),
+ ],
+ });
+ const statusName = PlanCheckRun_Status[status];
+ expect(getPlanCheckSummary([run]).error).toBe(1);
+ expect(
+ getPlanCheckSummaryWithFallback([], { [statusName]: 1, ERROR: 1 }).error
+ ).toBe(1);
+ expect(
+ getPlanCheckSummaryWithFallback([], { [statusName]: 1 }).error
+ ).toBe(1);
+ }
+ });
+
test("groups filtered results by type and target", () => {
const groups = getFilteredResultGroups({
planCheckRuns: [
@@ -74,4 +100,34 @@ describe("plan check helpers", () => {
]);
expect(groups[0]?.results).toHaveLength(1);
});
+
+ test("shows an incomplete run without duplicating its error result", () => {
+ const groups = getFilteredResultGroups({
+ includeRunFailure: true,
+ planCheckRuns: [
+ create(PlanCheckRunSchema, {
+ name: "failed-run",
+ status: PlanCheckRun_Status.FAILED,
+ results: [
+ create(PlanCheckRun_ResultSchema, {
+ status: Advice_Level.ERROR,
+ title: "Plan check run timed out",
+ }),
+ ],
+ }),
+ create(PlanCheckRunSchema, {
+ name: "canceled-run",
+ status: PlanCheckRun_Status.CANCELED,
+ error: "Canceled by user",
+ }),
+ ],
+ runCanceledTitle: "Canceled",
+ runFailureTitle: "Failed",
+ });
+
+ expect(groups).toHaveLength(2);
+ expect(groups[0]?.results[0]?.title).toBe("Plan check run timed out");
+ expect(groups[1]?.results[0]?.title).toBe("Canceled");
+ expect(groups[1]?.results[0]?.content).toBe("Canceled by user");
+ });
});
diff --git a/frontend/src/lib/plan/check.ts b/frontend/src/lib/plan/check.ts
index 0b07683366..01ba79ecd0 100644
--- a/frontend/src/lib/plan/check.ts
+++ b/frontend/src/lib/plan/check.ts
@@ -37,9 +37,12 @@ export const getPlanCheckSummaryWithFallback = (
const running = counts[PlanCheckRun_Status[PlanCheckRun_Status.RUNNING]] || 0;
const success = counts[Advice_Level[Advice_Level.SUCCESS]] || 0;
const warning = counts[Advice_Level[Advice_Level.WARNING]] || 0;
- const error =
- (counts[Advice_Level[Advice_Level.ERROR]] || 0) +
- (counts[PlanCheckRun_Status[PlanCheckRun_Status.FAILED]] || 0);
+ // A plan has one check run; its ERROR result already represents a failed run.
+ const error = Math.max(
+ counts[Advice_Level[Advice_Level.ERROR]] || 0,
+ counts[PlanCheckRun_Status[PlanCheckRun_Status.FAILED]] || 0,
+ counts[PlanCheckRun_Status[PlanCheckRun_Status.CANCELED]] || 0
+ );
return {
error,
running,
@@ -59,7 +62,13 @@ export const getPlanCheckSummary = (
for (const checkRun of planCheckRuns) {
if (checkRun.status === PlanCheckRun_Status.RUNNING) running++;
- if (checkRun.status === PlanCheckRun_Status.FAILED) error++;
+ if (
+ (checkRun.status === PlanCheckRun_Status.FAILED ||
+ checkRun.status === PlanCheckRun_Status.CANCELED) &&
+ !checkRun.results.some((result) => result.status === Advice_Level.ERROR)
+ ) {
+ error++;
+ }
for (const result of checkRun.results) {
if (result.status === Advice_Level.ERROR) error++;
else if (result.status === Advice_Level.WARNING) warning++;
@@ -108,7 +117,8 @@ export const planCheckRunListForSpec = (
}
if (
(run.status === PlanCheckRun_Status.RUNNING ||
- run.status === PlanCheckRun_Status.FAILED) &&
+ run.status === PlanCheckRun_Status.FAILED ||
+ run.status === PlanCheckRun_Status.CANCELED) &&
run.results.length === 0
) {
return [{ ...run, results: [] }];
@@ -131,12 +141,16 @@ export const expandSpecTargets = (
export const getFilteredResultGroups = ({
includeRunFailure = false,
planCheckRuns,
+ runCanceledContent,
+ runCanceledTitle,
runFailureContent,
runFailureTitle,
selectedStatus,
}: {
includeRunFailure?: boolean;
planCheckRuns: PlanCheckRun[];
+ runCanceledContent?: string;
+ runCanceledTitle?: string;
runFailureContent?: string;
runFailureTitle?: string;
selectedStatus?: Advice_Level;
@@ -147,18 +161,25 @@ export const getFilteredResultGroups = ({
for (const checkRun of planCheckRuns) {
if (
includeRunFailure &&
- checkRun.status === PlanCheckRun_Status.FAILED &&
+ (checkRun.status === PlanCheckRun_Status.FAILED ||
+ checkRun.status === PlanCheckRun_Status.CANCELED) &&
+ !checkRun.results.some(
+ (result) => result.status === Advice_Level.ERROR
+ ) &&
(selectedStatus === undefined || selectedStatus === Advice_Level.ERROR)
) {
+ const canceled = checkRun.status === PlanCheckRun_Status.CANCELED;
groups.push({
createTime: checkRun.createTime,
- key: `failed-${checkRun.name}`,
+ key: `${canceled ? "canceled" : "failed"}-${checkRun.name}`,
results: [
create(PlanCheckRun_ResultSchema, {
code: 0,
- content: checkRun.error || runFailureContent,
+ content:
+ checkRun.error ||
+ (canceled ? runCanceledContent : runFailureContent),
status: Advice_Level.ERROR,
- title: runFailureTitle,
+ title: canceled ? runCanceledTitle : runFailureTitle,
}),
],
target: "",
diff --git a/frontend/src/routes/project/plan-detail/components/lifecycle/advanceState.test.ts b/frontend/src/routes/project/plan-detail/components/lifecycle/advanceState.test.ts
index 5ffdfe6e4b..542956f00d 100644
--- a/frontend/src/routes/project/plan-detail/components/lifecycle/advanceState.test.ts
+++ b/frontend/src/routes/project/plan-detail/components/lifecycle/advanceState.test.ts
@@ -148,17 +148,19 @@ describe("getSubmitReviewAdvance", () => {
);
});
- test("treats a failed run the same as an errored one", () => {
- expect(
- ids(
- getSubmitReviewAdvance(
- submitArgs({
- plan: makePlan(["changeDatabaseConfig"], { FAILED: 1 }),
- project: project({ enforceSqlReview: true }),
- })
- ).blockers
- )
- ).toEqual(["checks-failed"]);
+ test("blocks failed and canceled runs when SQL review is enforced", () => {
+ for (const status of ["FAILED", "CANCELED"]) {
+ expect(
+ ids(
+ getSubmitReviewAdvance(
+ submitArgs({
+ plan: makePlan(["changeDatabaseConfig"], { [status]: 1 }),
+ project: project({ enforceSqlReview: true }),
+ })
+ ).blockers
+ )
+ ).toEqual(["checks-failed"]);
+ }
});
test("requires labels only where the project forces them", () => {
@@ -265,6 +267,16 @@ describe("getSubmitReviewAdvance override", () => {
});
});
+ test("offers the override when a run was canceled", () => {
+ expect(
+ decisionFor({ plan: makePlan(["changeDatabaseConfig"], { CANCELED: 1 }) })
+ ).toEqual({
+ body: "issue.checks-warning-hint",
+ headline: "plan.lifecycle.gate-checks-failed",
+ verb: "plan.submit-review-anyway",
+ });
+ });
+
test("withholds the override where SQL review is enforced, and blocks instead", () => {
const advance = getSubmitReviewAdvance(
submitArgs({
diff --git a/frontend/src/routes/project/plan-detail/utils/phaseSummary.test.ts b/frontend/src/routes/project/plan-detail/utils/phaseSummary.test.ts
index b00fc69dd0..fddc9051cf 100644
--- a/frontend/src/routes/project/plan-detail/utils/phaseSummary.test.ts
+++ b/frontend/src/routes/project/plan-detail/utils/phaseSummary.test.ts
@@ -71,7 +71,7 @@ describe("plan detail phase summaries", () => {
} as unknown as Plan;
expect(buildChangesSummary(plan, t)).toBe(
- "2 changes · 2 databases and 1 database groups · 2 passed, 1 warning, 2 error"
+ "2 changes · 2 databases and 1 database groups · 2 passed, 1 warning, 1 error"
);
});
diff --git a/frontend/src/routes/project/plan-detail/utils/phaseSummary.ts b/frontend/src/routes/project/plan-detail/utils/phaseSummary.ts
index 1c1571c39f..b9fdc432fb 100644
--- a/frontend/src/routes/project/plan-detail/utils/phaseSummary.ts
+++ b/frontend/src/routes/project/plan-detail/utils/phaseSummary.ts
@@ -1,3 +1,7 @@
+import {
+ getPlanCheckSummaryWithFallback,
+ type PlanCheckSummary,
+} from "@/lib/plan/check";
import {
ApprovalStatus,
IssueStatus,
@@ -5,24 +9,16 @@ import {
} from "@/types/proto-es/v1/common_pb";
import type { Issue } from "@/types/proto-es/v1/issue_service_pb";
import type { Plan } from "@/types/proto-es/v1/plan_service_pb";
-import { PlanCheckRun_Status } from "@/types/proto-es/v1/plan_service_pb";
import type { Rollout } from "@/types/proto-es/v1/rollout_service_pb";
import { Task_Status } from "@/types/proto-es/v1/rollout_service_pb";
-import { Advice_Level } from "@/types/proto-es/v1/sql_service_pb";
+
+export type { PlanCheckSummary } from "@/lib/plan/check";
type T = (key: string, options?: Record<string, unknown>) => string;
const isDatabaseGroupName = (name: string): boolean =>
name.includes("/databaseGroups/");
-export interface PlanCheckSummary {
- error: number;
- running: number;
- success: number;
- total: number;
- warning: number;
-}
-
// Mirrors the eligibility gates that can permanently prevent RolloutCreator
// from materializing a rollout. Transient approval and check gates are handled
// separately below.
@@ -31,25 +27,8 @@ const supportsAutomaticRollout = (plan: Plan): boolean =>
plan.specs.length > 0 &&
plan.specs.every((spec) => spec.config?.case === "changeDatabaseConfig");
-export const getPlanCheckSummary = (plan: Plan): PlanCheckSummary => {
- const statusCount = plan.planCheckRunStatusCount || {};
- const running =
- statusCount[PlanCheckRun_Status[PlanCheckRun_Status.RUNNING]] || 0;
- const success = statusCount[Advice_Level[Advice_Level.SUCCESS]] || 0;
- const warning = statusCount[Advice_Level[Advice_Level.WARNING]] || 0;
- const error = statusCount[Advice_Level[Advice_Level.ERROR]] || 0;
- const failed =
- statusCount[PlanCheckRun_Status[PlanCheckRun_Status.FAILED]] || 0;
- const totalError = error + failed;
-
- return {
- error: totalError,
- running,
- success,
- total: running + success + warning + totalError,
- warning,
- };
-};
+export const getPlanCheckSummary = (plan: Plan): PlanCheckSummary =>
+ getPlanCheckSummaryWithFallback([], plan.planCheckRunStatusCount);
export const isRolloutExpected = ({
issue,
@@ -78,8 +57,7 @@ export const isRolloutExpected = ({
return (
checks.running === 0 &&
checks.error === 0 &&
- (plan.planCheckRunStatusCount?.AVAILABLE ?? 0) === 0 &&
- (plan.planCheckRunStatusCount?.CANCELED ?? 0) === 0
+ (plan.planCheckRunStatusCount?.AVAILABLE ?? 0) === 0
);
};