Skip to content

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

refactor: simplify review context and remove unnecessary abstractions (#17649)

Danny Xud08684e92255
diff --git a/frontend/src/components/IssueV1/components/CurrentApproverV1.vue b/frontend/src/components/IssueV1/components/CurrentApproverV1.vue
index c03d040f6d..4234f8ff5f 100644
--- a/frontend/src/components/IssueV1/components/CurrentApproverV1.vue
+++ b/frontend/src/components/IssueV1/components/CurrentApproverV1.vue
@@ -7,8 +7,10 @@
>
<span>-</span>
</template>
- <template v-else-if="currentStep?.status === 'REJECTED'">
- <NTooltip :disabled="!currentStep.approver">
+ <template
+ v-else-if="issue.approvalStatus === Issue_ApprovalStatus.REJECTED"
+ >
+ <NTooltip :disabled="!rejectedApprover">
<template #trigger>
<div class="flex flex-row items-center gap-x-2">
<div
@@ -25,7 +27,7 @@
<i18n-t
keypath="custom-approval.approval-flow.issue-review.review-sent-back-by"
>
- <template #user>{{ approverInCurrentStep?.title }}</template>
+ <template #user>{{ rejectedApprover?.title }}</template>
</i18n-t>
</template>
</NTooltip>
@@ -46,31 +48,29 @@
import { computedAsync } from "@vueuse/core";
import { NTooltip } from "naive-ui";
import { computed } from "vue";
-import { toRef } from "vue";
import { BBAvatar } from "@/bbkit";
import {
- extractReviewContext,
- useWrappedReviewStepsV1,
-} from "@/components/IssueV1";
-import { useCurrentUserV1, useUserStore } from "@/store";
-import { userNamePrefix } from "@/store/modules/v1/common";
+ candidatesOfApprovalStepV1,
+ useCurrentUserV1,
+ userNamePrefix,
+ useUserStore,
+} from "@/store";
import { type ComposedIssue } from "@/types";
import {
IssueStatus,
Issue_ApprovalStatus,
+ Issue_Approver_Status,
} from "@/types/proto-es/v1/issue_service_pb";
const props = defineProps<{
issue: ComposedIssue;
}>();
-const context = extractReviewContext(toRef(props, "issue"));
const me = useCurrentUserV1();
const userStore = useUserStore();
const approvalFlowReady = computed(() => {
- const approvalStatus = props.issue.approvalStatus;
- return approvalStatus !== Issue_ApprovalStatus.CHECKING;
+ return props.issue.approvalStatus !== Issue_ApprovalStatus.CHECKING;
});
const rolloutReady = computed(() => {
@@ -81,29 +81,38 @@ const rolloutReady = computed(() => {
);
});
-const wrappedSteps = useWrappedReviewStepsV1(toRef(props, "issue"), context);
-
-const currentStep = computed(() => {
- return wrappedSteps.value.find(
- (step) => step.status === "CURRENT" || step.status === "REJECTED"
+const rejectedApprover = computedAsync(() => {
+ if (props.issue.approvalStatus !== Issue_ApprovalStatus.REJECTED) {
+ return undefined;
+ }
+ const rejectedApproval = props.issue.approvers.find(
+ (ap) => ap.status === Issue_Approver_Status.REJECTED
);
+ if (!rejectedApproval?.principal) return undefined;
+ return userStore.getOrFetchUserByIdentifier(rejectedApproval.principal);
});
-const approverInCurrentStep = computedAsync(() => {
- if (!currentStep.value?.approver) {
- return;
+const currentApprover = computedAsync(() => {
+ if (props.issue.approvalStatus !== Issue_ApprovalStatus.PENDING) {
+ return undefined;
}
- return userStore.getOrFetchUserByIdentifier(currentStep.value.approver);
-});
-const currentApprover = computedAsync(() => {
- if (!currentStep.value) return undefined;
- const includeMyself = currentStep.value.candidates.includes(
- `${userNamePrefix}${me.value.email}`
- );
- // Show currentUser if currentUser is one of the validate approver candidates.
- if (includeMyself) return me.value;
+ const { approvalTemplates, approvers } = props.issue;
+ if (approvalTemplates.length === 0) return undefined;
+
+ const currentStepIndex = approvers.length;
+ const steps = approvalTemplates[0].flow?.steps || [];
+ const step = steps[currentStepIndex];
+ if (!step) return undefined;
+
+ const candidates = candidatesOfApprovalStepV1(props.issue, step);
+ const currentUserName = `${userNamePrefix}${me.value.email}`;
+
+ // Show currentUser if currentUser is one of the valid approver candidates.
+ if (candidates.includes(currentUserName)) return me.value;
+
// Show the first approver candidate otherwise.
- return userStore.getOrFetchUserByIdentifier(currentStep.value.candidates[0]);
+ if (candidates.length === 0) return undefined;
+ return userStore.getOrFetchUserByIdentifier(candidates[0]);
});
</script>
diff --git a/frontend/src/components/IssueV1/components/HeaderSection/Actions/review/ReviewActionButton.vue b/frontend/src/components/IssueV1/components/HeaderSection/Actions/review/ReviewActionButton.vue
index 4d0c3a0aa3..8cb334781a 100644
--- a/frontend/src/components/IssueV1/components/HeaderSection/Actions/review/ReviewActionButton.vue
+++ b/frontend/src/components/IssueV1/components/HeaderSection/Actions/review/ReviewActionButton.vue
@@ -31,6 +31,7 @@ import {
} from "@/components/IssueV1/logic";
import type { ErrorItem } from "@/components/misc/ErrorList.vue";
import ErrorList from "@/components/misc/ErrorList.vue";
+import { Issue_Approver_Status } from "@/types/proto-es/v1/issue_service_pb";
const props = defineProps<{
action: IssueReviewAction;
@@ -41,30 +42,40 @@ defineEmits<{
}>();
const { t } = useI18n();
-const { issue, reviewContext } = useIssueContext();
+const { issue } = useIssueContext();
const errors = computed(() => {
- const errors: ErrorItem[] = [];
+ if (allowUserToApplyReviewAction(issue.value, props.action)) {
+ return [];
+ }
+
+ const errors: ErrorItem[] = [
+ t("issue.error.you-are-not-allowed-to-perform-this-action"),
+ ];
+
+ const { approvalTemplates, approvers } = issue.value;
+ if (approvalTemplates.length === 0) return errors;
- if (!allowUserToApplyReviewAction(issue.value, reviewContext, props.action)) {
- errors.push(t("issue.error.you-are-not-allowed-to-perform-this-action"));
- const flow = reviewContext.flow.value;
- const index = flow.currentStepIndex;
- const steps = flow.template.flow?.steps ?? [];
- const step = steps[index];
- if (step) {
- for (let i = 0; i < step.nodes.length; i++) {
- const node = step.nodes[i];
- const roleTitle = displayReviewRoleTitle(node);
- if (node) {
- errors.push({
- error: roleTitle,
- indent: 1,
- });
- }
- }
+ const rejectedIndex = approvers.findIndex(
+ (ap) => ap.status === Issue_Approver_Status.REJECTED
+ );
+ const currentStepIndex =
+ rejectedIndex >= 0 ? rejectedIndex : approvers.length;
+
+ const steps = approvalTemplates[0].flow?.steps ?? [];
+ const step = steps[currentStepIndex];
+ if (!step) return errors;
+
+ for (const node of step.nodes) {
+ const roleTitle = displayReviewRoleTitle(node);
+ if (roleTitle) {
+ errors.push({
+ error: roleTitle,
+ indent: 1,
+ });
}
}
+
return errors;
});
</script>
diff --git a/frontend/src/components/IssueV1/logic/action/review.ts b/frontend/src/components/IssueV1/logic/action/review.ts
index 508898abb2..fba71fe281 100644
--- a/frontend/src/components/IssueV1/logic/action/review.ts
+++ b/frontend/src/components/IssueV1/logic/action/review.ts
@@ -12,7 +12,6 @@ import {
Issue_ApprovalStatus,
} from "@/types/proto-es/v1/issue_service_pb";
import { isUserIncludedInList } from "@/utils";
-import type { ReviewContext } from "../context";
export type IssueReviewAction = "APPROVE" | "SEND_BACK" | "RE_REQUEST";
@@ -61,10 +60,8 @@ export const issueReviewActionButtonProps = (
export const allowUserToApplyReviewAction = (
issue: ComposedIssue,
- context: ReviewContext,
action: IssueReviewAction
) => {
- const { flow } = context;
const approvalFlowReady =
issue.approvalStatus !== Issue_ApprovalStatus.CHECKING;
const rolloutReady =
@@ -84,9 +81,17 @@ export const allowUserToApplyReviewAction = (
const me = useCurrentUserV1();
if (action === "APPROVE" || action === "SEND_BACK") {
- const index = flow.value.currentStepIndex;
- const steps = flow.value.template.flow?.steps ?? [];
- const step = steps[index];
+ const { approvalTemplates, approvers } = issue;
+ if (approvalTemplates.length === 0) return false;
+
+ const rejectedIndex = approvers.findIndex(
+ (ap) => ap.status === Issue_Approver_Status.REJECTED
+ );
+ const currentStepIndex =
+ rejectedIndex >= 0 ? rejectedIndex : approvers.length;
+
+ const steps = approvalTemplates[0].flow?.steps ?? [];
+ const step = steps[currentStepIndex];
if (!step) return false;
const candidates = candidatesOfApprovalStepV1(issue, step);
return isUserIncludedInList(me.value.email, candidates);
diff --git a/frontend/src/components/IssueV1/logic/base.ts b/frontend/src/components/IssueV1/logic/base.ts
index ff34c60416..24c9566bd6 100644
--- a/frontend/src/components/IssueV1/logic/base.ts
+++ b/frontend/src/components/IssueV1/logic/base.ts
@@ -23,7 +23,6 @@ import {
import type { IssueContext, IssueEvents, IssuePhase } from "./context";
import { planCheckRunListForTask } from "./plan-check";
import { releaserCandidatesForIssue } from "./releaser";
-import { extractReviewContext } from "./review";
import { stageForTask } from "./utils";
const state = {
@@ -130,7 +129,6 @@ export const useBaseIssueContext = (
const releaserCandidates = computed(() => {
return releaserCandidatesForIssue(issue.value);
});
- const reviewContext = extractReviewContext(issue);
const phase = computed((): IssuePhase => {
if (isCreating.value) return "CREATE";
@@ -174,7 +172,6 @@ export const useBaseIssueContext = (
phase,
events,
releaserCandidates,
- reviewContext,
selectedStage,
selectedTask,
formatOnSave,
diff --git a/frontend/src/components/IssueV1/logic/context.ts b/frontend/src/components/IssueV1/logic/context.ts
index b054020959..7bbd6a29a1 100644
--- a/frontend/src/components/IssueV1/logic/context.ts
+++ b/frontend/src/components/IssueV1/logic/context.ts
@@ -3,7 +3,7 @@ import type { useDialog } from "naive-ui";
import { v4 as uuidv4 } from "uuid";
import type { InjectionKey, Ref, ComputedRef } from "vue";
import { inject, provide } from "vue";
-import type { ComposedIssue, ReviewFlow } from "@/types";
+import type { ComposedIssue } from "@/types";
import type { PlanCheckRun } from "@/types/proto-es/v1/plan_service_pb";
import type { Stage, Task } from "@/types/proto-es/v1/rollout_service_pb";
import type {
@@ -22,12 +22,6 @@ export type IssueEvents = Emittery<{
"perform-task-rollout-action": { action: TaskRolloutAction; tasks: Task[] };
}>;
-export type ReviewContext = {
- // The review flow.
- // Now we have only one flow in an issue
- flow: Ref<ReviewFlow>;
-};
-
export type IssueContext = {
// Basic fields
isCreating: Ref<boolean>;
@@ -36,8 +30,6 @@ export type IssueContext = {
phase: Ref<IssuePhase>;
allowChange: ComputedRef<boolean>;
- // review status
- reviewContext: ReviewContext;
// The release candidates of the issue.
// Format: users/{email}
releaserCandidates: Ref<string[]>;
diff --git a/frontend/src/components/IssueV1/logic/review.ts b/frontend/src/components/IssueV1/logic/review.ts
index 44c986a256..2d513f31fc 100644
--- a/frontend/src/components/IssueV1/logic/review.ts
+++ b/frontend/src/components/IssueV1/logic/review.ts
@@ -1,138 +1,6 @@
-import { computed, unref, watchEffect } from "vue";
-import {
- candidatesOfApprovalStepV1,
- useCurrentUserV1,
- userNamePrefix,
- useUserStore,
-} from "@/store";
-import type {
- ReviewFlow,
- MaybeRef,
- ComposedIssue,
- WrappedReviewStep,
-} from "@/types";
-import { emptyFlow } from "@/types";
-import type {
- ApprovalNode,
- ApprovalStep,
- Issue,
-} from "@/types/proto-es/v1/issue_service_pb";
-import {
- ApprovalNode_Type,
- Issue_Approver_Status,
- Issue_ApprovalStatus,
-} from "@/types/proto-es/v1/issue_service_pb";
+import type { ApprovalNode } from "@/types/proto-es/v1/issue_service_pb";
+import { ApprovalNode_Type } from "@/types/proto-es/v1/issue_service_pb";
import { displayRoleTitle } from "@/utils";
-import { isUserIncludedInList } from "@/utils";
-import type { ReviewContext } from "./context";
-
-export const extractReviewContext = (issue: MaybeRef<Issue>): ReviewContext => {
- const flow = computed((): ReviewFlow => {
- const issueValue = unref(issue);
- const approvalStatus = issueValue.approvalStatus;
- if (
- approvalStatus === Issue_ApprovalStatus.CHECKING ||
- approvalStatus === Issue_ApprovalStatus.APPROVAL_STATUS_UNSPECIFIED
- ) {
- return emptyFlow();
- }
-
- const { approvalTemplates, approvers } = issueValue;
- if (approvalTemplates.length === 0) return emptyFlow();
-
- const rejectedIndex = approvers.findIndex(
- (ap) => ap.status === Issue_Approver_Status.REJECTED
- );
- const currentStepIndex =
- rejectedIndex >= 0 ? rejectedIndex : approvers.length;
-
- return {
- template: approvalTemplates[0],
- approvers,
- currentStepIndex,
- };
- });
-
- return {
- flow,
- };
-};
-
-export const useWrappedReviewStepsV1 = (
- issue: MaybeRef<ComposedIssue>,
- context: ReviewContext
-) => {
- const userStore = useUserStore();
- const currentUser = useCurrentUserV1();
- // Format: users/{email}
- const currentUserName = computed(
- () => `${userNamePrefix}${currentUser.value.email}`
- );
-
- watchEffect(async () => {
- const { flow } = context;
- const approvers = flow.value.approvers;
- const steps = flow.value.template.flow?.steps;
- const distinctUsers = steps?.map((_, i) => approvers[i]?.principal) ?? [];
- await userStore.batchGetUsers(distinctUsers);
- });
-
- return computed(() => {
- const { flow } = context;
- const steps = flow.value.template.flow?.steps || [];
- const approvers = flow.value.approvers;
- const currentStepIndex = flow.value.currentStepIndex ?? -1;
- const issueValue = unref(issue);
- const rolloutReady =
- issueValue.approvalStatus === Issue_ApprovalStatus.APPROVED ||
- issueValue.approvalStatus === Issue_ApprovalStatus.SKIPPED;
-
- const statusOfStep = (index: number) => {
- if (rolloutReady) {
- return "APPROVED";
- }
- if (index >= (steps?.length ?? 0)) {
- // Out of index
- return "PENDING";
- }
- const approval = approvers[index];
- if (approval && approval.status === Issue_Approver_Status.REJECTED) {
- return "REJECTED";
- }
- if (index < currentStepIndex) {
- return "APPROVED";
- }
- if (index === currentStepIndex) {
- return "CURRENT";
- }
- return "PENDING";
- };
-
- const approverOfStep = (index: number) => {
- return approvers[index]?.principal;
- };
-
- const candidatesOfStep = (step: ApprovalStep) => {
- const users = candidatesOfApprovalStepV1(unref(issue), step);
- if (isUserIncludedInList(currentUserName.value, users)) {
- const idx = users.indexOf(currentUserName.value);
- if (idx >= 0) {
- users.splice(idx, 1);
- }
- users.unshift(currentUserName.value);
- }
- return users;
- };
-
- return steps.map<WrappedReviewStep>((step, index) => ({
- index,
- step,
- status: statusOfStep(index),
- approver: approverOfStep(index),
- candidates: candidatesOfStep(step),
- }));
- });
-};
export const displayReviewRoleTitle = (node: ApprovalNode) => {
const { type, role } = node;
diff --git a/frontend/src/types/review.ts b/frontend/src/types/review.ts
index 8ff994a785..f797bbc2b5 100644
--- a/frontend/src/types/review.ts
+++ b/frontend/src/types/review.ts
@@ -1,6 +1,5 @@
import { create as createProto } from "@bufbuild/protobuf";
import type {
- ApprovalStep,
Issue_Approver,
ApprovalTemplate,
} from "./proto-es/v1/issue_service_pb";
@@ -12,14 +11,6 @@ export type ReviewFlow = {
currentStepIndex: number; // -1 if finished
};
-export type WrappedReviewStep = {
- index: number;
- step: ApprovalStep;
- status: "APPROVED" | "REJECTED" | "CURRENT" | "PENDING";
- approver: string | undefined;
- candidates: string[];
-};
-
export const emptyFlow = (): ReviewFlow => {
return {
template: createProto(ApprovalTemplateSchema, {}),
diff --git a/frontend/src/utils/v1/advanced-search/issue/ui-filter.ts b/frontend/src/utils/v1/advanced-search/issue/ui-filter.ts
index ba46537d8e..8bc3643111 100644
--- a/frontend/src/utils/v1/advanced-search/issue/ui-filter.ts
+++ b/frontend/src/utils/v1/advanced-search/issue/ui-filter.ts
@@ -1,9 +1,5 @@
-import {
- releaserCandidatesForIssue,
- useWrappedReviewStepsV1,
- extractReviewContext,
-} from "@/components/IssueV1/logic";
-import { userNamePrefix } from "@/store";
+import { releaserCandidatesForIssue } from "@/components/IssueV1/logic";
+import { candidatesOfApprovalStepV1, userNamePrefix } from "@/store";
import type { ComposedIssue } from "@/types";
import { Issue_ApprovalStatus } from "@/types/proto-es/v1/issue_service_pb";
import { isUserIncludedInList } from "@/utils";
@@ -31,16 +27,26 @@ export const filterIssueByApprover = (
) => {
if (!approver) return true;
- const reviewContext = extractReviewContext(issue);
- const steps = useWrappedReviewStepsV1(issue, reviewContext);
+ // Only show issues that are pending approval
+ if (issue.approvalStatus !== Issue_ApprovalStatus.PENDING) {
+ return false;
+ }
+
+ const { approvalTemplates, approvers } = issue;
+ if (approvalTemplates.length === 0) return false;
+
+ const currentStepIndex = approvers.length;
+ const steps = approvalTemplates[0].flow?.steps || [];
+ const step = steps[currentStepIndex];
+ if (!step) return false;
+
+ const candidates = candidatesOfApprovalStepV1(issue, step);
- const currentStep = steps.value.find((step) => step.status === "CURRENT");
- if (!currentStep) return false;
// We support "approver:{email}" by now
// Planning to support "approver:[{email_1}, {email_2}, ...]" and
// "approver:roles/{role}" in the future
if (approver.startsWith(userNamePrefix)) {
- return currentStep.candidates.includes(approver);
+ return candidates.includes(approver);
}
console.error(