Database governance built for humans and agents — controlling changes and access across every major database.
Go cicddata-governancedata-maskingdata-securitydatabase-accessdatabase-governancedevopsdevsecopsflywaygitopsliquibasemongodbmysqloraclepostgresqlschema-migrationssecuritysql-clientsqlservertidb
chore: extract useRouteChangeGuard (#17894)
ecmadao05c94539f53e
diff --git a/frontend/src/components/EnvironmentForm/EnvironmentForm.vue b/frontend/src/components/EnvironmentForm/EnvironmentForm.vueindex 93c7012412..379d3183a1 100644--- a/frontend/src/components/EnvironmentForm/EnvironmentForm.vue+++ b/frontend/src/components/EnvironmentForm/EnvironmentForm.vue@@ -9,10 +9,7 @@</template><script lang="ts" setup>-import { useEventListener } from "@vueuse/core";import { toRef, computed } from "vue";-import { useI18n } from "vue-i18n";-import { onBeforeRouteLeave } from "vue-router";import { useEmitteryEventListener } from "@/composables/useEmitteryEventListener";import { hasFeature } from "@/store";import type { Policy } from "@/types/proto-es/v1/org_policy_service_pb";@@ -54,7 +51,6 @@ const emit = defineEmits<{(event: "cancel"): void;}>();-const { t } = useI18n();const context = provideEnvironmentFormContext({create: toRef(props, "create"),environment: toRef(props, "environment"),@@ -66,23 +62,6 @@ const isEditing = computed(() => {return !props.create && valueChanged();});-useEventListener("beforeunload", (e) => {- if (!isEditing.value) {- return;- }- e.returnValue = t("common.leave-without-saving");- return e.returnValue;-});--onBeforeRouteLeave((to, from, next) => {- if (isEditing.value) {- if (!window.confirm(t("common.leave-without-saving"))) {- return;- }- }- next();-});-useEmitteryEventListener(events, "create", (params) => {const { environment } = params;if (environment.tags?.protected === "protected") {diff --git a/frontend/src/components/InstanceForm/InstanceForm.vue b/frontend/src/components/InstanceForm/InstanceForm.vueindex 4d97c5ec2e..7dca9d0f28 100644--- a/frontend/src/components/InstanceForm/InstanceForm.vue+++ b/frontend/src/components/InstanceForm/InstanceForm.vue@@ -11,10 +11,7 @@</template><script lang="ts" setup>-import { useEventListener } from "@vueuse/core";-import { watch, onMounted, toRef } from "vue";-import { useI18n } from "vue-i18n";-import { onBeforeRouteLeave } from "vue-router";+import { watch, onMounted, toRef, computed } from "vue";import { useEmitteryEventListener } from "@/composables/useEmitteryEventListener";import { useActuatorV1Store, useSettingV1Store } from "@/store";import { Engine } from "@/types/proto-es/v1/common_pb";@@ -34,7 +31,6 @@ const emit = defineEmits<{const settingV1Store = useSettingV1Store();const actuatorStore = useActuatorV1Store();-const { t } = useI18n();const instance = toRef(props, "instance");const hideAdvancedFeatures = toRef(props, "hideAdvancedFeatures");@@ -48,23 +44,6 @@ const {missingFeature,} = context;-useEventListener("beforeunload", (e) => {- if (isCreating.value || !valueChanged.value) {- return;- }- e.returnValue = t("common.leave-without-saving");- return e.returnValue;-});--onBeforeRouteLeave((to, from, next) => {- if (!isCreating.value && valueChanged.value) {- if (!window.confirm(t("common.leave-without-saving"))) {- return;- }- }- next();-});-onMounted(async () => {if (isCreating.value) {adminDataSource.value.host = actuatorStore.isDocker@@ -103,4 +82,8 @@ watch(useEmitteryEventListener(events, "dismiss", () => {emit("dismiss");});++defineExpose({+ isEditing: computed(() => !isCreating.value && valueChanged.value),+});</script>diff --git a/frontend/src/components/IssueV1/components/StatementSection/StatementSection.vue b/frontend/src/components/IssueV1/components/StatementSection/StatementSection.vueindex cf35d91d47..7b8c391bbe 100644--- a/frontend/src/components/IssueV1/components/StatementSection/StatementSection.vue+++ b/frontend/src/components/IssueV1/components/StatementSection/StatementSection.vue@@ -9,11 +9,10 @@</template><script setup lang="ts">-import { useEventListener } from "@vueuse/core";import { computed, nextTick, ref } from "vue";-import { useI18n } from "vue-i18n";-import { onBeforeRouteLeave, useRouter } from "vue-router";+import { useRouter } from "vue-router";import { usePlanSQLCheckContext } from "@/components/Plan/components/SQLCheckSection/context";+import { useRouteChangeGuard } from "@/composables/useRouteChangeGuard";import { useCurrentProjectV1 } from "@/store";import { TaskTypeListWithStatement } from "@/types";import { databaseForTask } from "@/utils";@@ -21,7 +20,6 @@ import { isValidTaskName } from "@/utils";import { useIssueContext } from "../../logic";import EditorView from "./EditorView";-const { t } = useI18n();const router = useRouter();const { isCreating, selectedTask } = useIssueContext();const { project } = useCurrentProjectV1();@@ -64,27 +62,7 @@ const scrollToLineByHash = (hash: string) => {});};-const beforeUnloadHandler = (e: BeforeUnloadEvent) => {- // For created issues and not editing, no need to prompt.- if (!isCreating.value && !editorViewRef.value?.isEditing) {- return;- }-- // For creating issues or editing task statement, prompt to confirm leaving.- e.preventDefault();- // Included for legacy support, e.g. Chrome/Edge < 119- e.returnValue = t("common.leave-without-saving");- return e.returnValue;-};--useEventListener("beforeunload", beforeUnloadHandler);--onBeforeRouteLeave((to, from, next) => {- if (isCreating.value || editorViewRef.value?.isEditing) {- if (!window.confirm(t("common.leave-without-saving"))) {- return;- }- }- next();-});+useRouteChangeGuard(+ computed(() => isCreating.value || (editorViewRef.value?.isEditing ?? false))+);</script>diff --git a/frontend/src/components/ProjectSettingPanel.vue b/frontend/src/components/ProjectSettingPanel.vueindex 9ce8a889f7..b49fe86c50 100644--- a/frontend/src/components/ProjectSettingPanel.vue+++ b/frontend/src/components/ProjectSettingPanel.vue@@ -70,11 +70,10 @@</template><script lang="ts" setup>-import { useEventListener } from "@vueuse/core";import { NButton } from "naive-ui";import { ref, computed } from "vue";import { useI18n } from "vue-i18n";-import { onBeforeRouteLeave } from "vue-router";+import { useRouteChangeGuard } from "@/composables/useRouteChangeGuard";import { pushNotification } from "@/store";import type { Project } from "@/types/proto-es/v1/project_service_pb";import ProjectArchiveRestoreButton from "./Project/ProjectArchiveRestoreButton.vue";@@ -110,22 +109,7 @@ const isDirty = computed(() => {return settingRefList.value.some((settingRef) => settingRef.value?.isDirty);});-useEventListener("beforeunload", (e) => {- if (!isDirty.value) {- return;- }- e.returnValue = t("common.leave-without-saving");- return e.returnValue;-});--onBeforeRouteLeave((to, from, next) => {- if (isDirty.value) {- if (!window.confirm(t("common.leave-without-saving"))) {- return;- }- }- next();-});+useRouteChangeGuard(isDirty);const onUpdate = async () => {for (const settingRef of settingRefList.value) {diff --git a/frontend/src/components/SQLReview/components/SQLReviewTemplateSelector.vue b/frontend/src/components/SQLReview/components/SQLReviewTemplateSelector.vueindex 45d6df5ca9..4b69714a13 100644--- a/frontend/src/components/SQLReview/components/SQLReviewTemplateSelector.vue+++ b/frontend/src/components/SQLReview/components/SQLReviewTemplateSelector.vue@@ -6,7 +6,7 @@</p><div- class="flex flex-col sm:flex-row sm:flex-wrap justify-start items-stretch gap-x-10 gap-y-4"+ class="flex flex-col sm:flex-row sm:flex-wrap justify-start items-stretch gap-x-4 gap-y-4"><divv-for="template in reviewPolicyTemplateList"@@ -44,10 +44,10 @@</div></div>- <NDivider />+ <NDivider v-if="reviewPolicyTemplateList.length > 0" /><div- class="flex flex-col sm:flex-row sm:flex-wrap justify-start items-stretch gap-x-10 gap-y-4"+ class="flex flex-col sm:flex-row sm:flex-wrap justify-start items-stretch gap-x-4 gap-y-4"><divv-for="template in builtInTemplateList"diff --git a/frontend/src/components/SyncDatabaseSchemaV1/DatabaseSchemaSelector.vue b/frontend/src/components/SyncDatabaseSchemaV1/DatabaseSchemaSelector.vueindex 9b5440e125..76259a4a82 100644--- a/frontend/src/components/SyncDatabaseSchemaV1/DatabaseSchemaSelector.vue+++ b/frontend/src/components/SyncDatabaseSchemaV1/DatabaseSchemaSelector.vue@@ -9,13 +9,12 @@{{ $t("common.database") }}</span><EnvironmentSelect- class="!w-60 mr-3 shrink-0"+ class="mr-3"name="environment":environment-name="state.environmentName"@update:environment-name="handleEnvironmentSelect"/><DatabaseSelect- class="!w-128 max-w-full":project-name="project.name":database-name="state.databaseName":environment-name="state.environmentName"@@ -30,9 +29,7 @@<span class="flex w-40 items-center shrink-0 text-sm">{{ $t("database.sync-schema.schema-version.self") }}</span>- <div- class="w-192 max-w-full flex flex-row justify-start items-center relative"- >+ <div class="w-full flex flex-row justify-start items-center relative"><NSelect:loading="isPreparingSchemaVersionOptions":value="state.changelogName"diff --git a/frontend/src/components/SyncDatabaseSchemaV1/index.vue b/frontend/src/components/SyncDatabaseSchemaV1/index.vueindex 61427719f6..092ac8e5d5 100644--- a/frontend/src/components/SyncDatabaseSchemaV1/index.vue+++ b/frontend/src/components/SyncDatabaseSchemaV1/index.vue@@ -82,6 +82,7 @@ import { useI18n } from "vue-i18n";import { useRoute, useRouter, type LocationQueryRaw } from "vue-router";import { BBSpin } from "@/bbkit";import { StepTab } from "@/components/v2";+import { useRouteChangeGuard } from "@/composables/useRouteChangeGuard";import { PROJECT_V1_ROUTE_ISSUE_DETAIL } from "@/router/dashboard/projectV1";import { WORKSPACE_ROOT_MODULE } from "@/router/dashboard/workspaceRoutes";import {@@ -142,6 +143,14 @@ const rawSQLState = reactive<RawSQLState>({const targetDatabaseViewRef =ref<InstanceType<typeof SelectTargetDatabasesView>>();+useRouteChangeGuard(+ computed(+ () =>+ state.sourceSchemaType === SourceSchemaType.RAW_SQL &&+ rawSQLState.statement !== ""+ )+);+const sourceSchemaString = asyncComputed(async () => {if (state.sourceSchemaType === SourceSchemaType.SCHEMA_HISTORY_VERSION) {if (isValidChangelogName(changelogSourceSchemaState.changelogName)) {diff --git a/frontend/src/composables/useRouteChangeGuard.ts b/frontend/src/composables/useRouteChangeGuard.tsnew file mode 100644index 0000000000..2ff493c686--- /dev/null+++ b/frontend/src/composables/useRouteChangeGuard.ts@@ -0,0 +1,23 @@+import { useEventListener } from "@vueuse/core";+import { type Ref } from "vue";+import { onBeforeRouteLeave } from "vue-router";+import { t } from "@/plugins/i18n";++export const useRouteChangeGuard = (isEditing: Ref<boolean>) => {+ useEventListener("beforeunload", (e) => {+ if (!isEditing.value) {+ return;+ }+ e.returnValue = t("common.leave-without-saving");+ return e.returnValue;+ });++ onBeforeRouteLeave((to, from, next) => {+ if (isEditing.value) {+ if (!window.confirm(t("common.leave-without-saving"))) {+ return;+ }+ }+ next();+ });+};diff --git a/frontend/src/views/DashboardLanding.vue b/frontend/src/views/DashboardLanding.vueindex de6151c3fd..b4a80815eb 100644--- a/frontend/src/views/DashboardLanding.vue+++ b/frontend/src/views/DashboardLanding.vue@@ -92,7 +92,7 @@<Draggable v-model="quickLinkList" item-key="id" animation="300"><template #item="{ element }: { element: QuickLink }"><div- class="group flex items-center justify-between p-2 hover:bg-gray-100 rounded-sm cursor-grab"+ class="flex items-center justify-between p-2 hover:bg-gray-100 rounded-sm cursor-grab"><div :key="element.id" class="flex items-center gap-x-2"><NCheckbox@@ -103,9 +103,7 @@<component :is="element.icon" class="w-5 h-5 text-gray-500" />{{ element.title }}</div>- <GripVerticalIcon- class="w-5 h-5 text-gray-500 hidden group-hover:block"- />+ <GripVerticalIcon class="w-5 h-5 text-gray-500" /></div></template></Draggable>diff --git a/frontend/src/views/EnvironmentDashboard.vue b/frontend/src/views/EnvironmentDashboard.vueindex 991b85a068..17aa1f88f5 100644--- a/frontend/src/views/EnvironmentDashboard.vue+++ b/frontend/src/views/EnvironmentDashboard.vue@@ -127,6 +127,7 @@ import {} from "@/components/EnvironmentForm";import { Drawer, DrawerContent } from "@/components/v2";import { EnvironmentV1Name } from "@/components/v2";+import { useRouteChangeGuard } from "@/composables/useRouteChangeGuard";import {useUIStateStore,useEnvironmentV1Store,@@ -183,6 +184,10 @@ const selectEnvironment = (index: number) => {onTabChange(id);};+useRouteChangeGuard(+ computed(() => environmentDetailRefs.value[0]?.isEditing ?? false)+);+const onTabChange = (id: string) => {// The NTabPane only render the selected environment,// so we only need to check the 1st environmentDetailRefsdiff --git a/frontend/src/views/InstanceDetail.vue b/frontend/src/views/InstanceDetail.vueindex 23339c8f18..2a1f6c6cad 100644--- a/frontend/src/views/InstanceDetail.vue+++ b/frontend/src/views/InstanceDetail.vue@@ -16,7 +16,7 @@</div></div>- <NTabs v-model:value="state.selectedTab">+ <NTabs :value="state.selectedTab" @update:value="onTabChange"><template #suffix><div class="flex items-center space-x-2"><InstanceSyncButton@@ -36,7 +36,7 @@</div></template><NTabPane name="overview" :tab="$t('common.overview')">- <InstanceForm class="-mt-2" :instance="instance">+ <InstanceForm ref="instanceFormRef" class="-mt-2" :instance="instance"><InstanceFormBody :hide-archive-restore="hideArchiveRestore" /><InstanceFormButtons class="sticky bottom-0 z-10" /></InstanceForm>@@ -115,6 +115,7 @@ import {PagedDatabaseTable,DatabaseOperations,} from "@/components/v2/Model/DatabaseV1Table";+import { useRouteChangeGuard } from "@/composables/useRouteChangeGuard";import { useBodyLayoutContext } from "@/layouts/common";import {pushNotification,@@ -173,6 +174,18 @@ const router = useRouter();const instanceV1Store = useInstanceV1Store();const databaseStore = useDatabaseV1Store();const pagedDatabaseTableRef = ref<InstanceType<typeof PagedDatabaseTable>>();+const instanceFormRef = ref<InstanceType<typeof InstanceForm>>();++const onTabChange = (tab: InstanceHash) => {+ if (instanceFormRef.value?.isEditing) {+ if (!window.confirm(t("common.leave-without-saving"))) {+ return;+ }+ }+ state.selectedTab = tab;+};++useRouteChangeGuard(computed(() => instanceFormRef.value?.isEditing ?? false));const readonlyScopes = computed((): SearchScope[] => [{ id: "instance", value: props.instanceId, readonly: true },diff --git a/frontend/src/views/ProfileDashboard.vue b/frontend/src/views/ProfileDashboard.vueindex 758e9cfb9b..c4e9c5a8de 100644--- a/frontend/src/views/ProfileDashboard.vue+++ b/frontend/src/views/ProfileDashboard.vue@@ -223,14 +223,12 @@ import { create } from "@bufbuild/protobuf";import { FieldMaskSchema } from "@bufbuild/protobuf/wkt";import type { ConnectError } from "@connectrpc/connect";import { computedAsync, useTitle } from "@vueuse/core";-import { useEventListener } from "@vueuse/core";import { cloneDeep, isEqual } from "lodash-es";import type { DropdownOption } from "naive-ui";import { NButton, NDropdown, NInput, NTag } from "naive-ui";import { computed, nextTick, onMounted, onUnmounted, reactive, ref } from "vue";import { useI18n } from "vue-i18n";import { useRouter } from "vue-router";-import { onBeforeRouteLeave } from "vue-router";import EmailInput from "@/components/EmailInput.vue";import { FeatureModal } from "@/components/FeatureGuard";import FeatureBadge from "@/components/FeatureGuard/FeatureBadge.vue";@@ -241,6 +239,7 @@ import UserPassword from "@/components/User/Settings/UserPassword.vue";import UserAvatar from "@/components/User/UserAvatar.vue";import NoPermissionPlaceholder from "@/components/misc/NoPermissionPlaceholder.vue";import ServiceAccountTag from "@/components/misc/ServiceAccountTag.vue";+import { useRouteChangeGuard } from "@/composables/useRouteChangeGuard";import { WORKSPACE_ROUTE_USER_PROFILE } from "@/router/dashboard/workspaceRoutes";import {SETTING_ROUTE_PROFILE_TWO_FACTOR,@@ -376,22 +375,7 @@ const allowSaveEdit = computed(() => {);});-useEventListener("beforeunload", (e) => {- if (!state.editing || !allowSaveEdit.value) {- return;- }- e.returnValue = t("common.leave-without-saving");- return e.returnValue;-});--onBeforeRouteLeave((to, from, next) => {- if (state.editing && allowSaveEdit.value) {- if (!window.confirm(t("common.leave-without-saving"))) {- return;- }- }- next();-});+useRouteChangeGuard(computed(() => state.editing && allowSaveEdit.value));const updateUser = <K extends keyof User>(field: K, value: User[K]) => {if (!state.editingUser) return;diff --git a/frontend/src/views/SettingWorkspaceGeneral.vue b/frontend/src/views/SettingWorkspaceGeneral.vueindex e15a1a48dc..169e57da6c 100644--- a/frontend/src/views/SettingWorkspaceGeneral.vue+++ b/frontend/src/views/SettingWorkspaceGeneral.vue@@ -51,11 +51,10 @@</template><script lang="ts" setup>-import { useEventListener } from "@vueuse/core";import { NButton } from "naive-ui";import { onMounted, ref, computed } from "vue";import { useI18n } from "vue-i18n";-import { useRoute, onBeforeRouteLeave } from "vue-router";+import { useRoute } from "vue-router";import {BrandingSetting,SecuritySetting,@@ -65,6 +64,7 @@ import {GeneralSetting,ProductImprovementSetting,} from "@/components/GeneralSetting";+import { useRouteChangeGuard } from "@/composables/useRouteChangeGuard";import { pushNotification } from "@/store";import { useSettingV1Store } from "@/store/modules/v1/setting";@@ -148,20 +148,5 @@ const onUpdate = async () => {}};-useEventListener("beforeunload", (e) => {- if (!isDirty.value) {- return;- }- e.returnValue = t("common.leave-without-saving");- return e.returnValue;-});--onBeforeRouteLeave((to, from, next) => {- if (isDirty.value) {- if (!window.confirm(t("common.leave-without-saving"))) {- return;- }- }- next();-});+useRouteChangeGuard(isDirty);</script>diff --git a/frontend/src/views/SettingWorkspaceMembers.vue b/frontend/src/views/SettingWorkspaceMembers.vueindex dad93aa843..9957b0b66c 100644--- a/frontend/src/views/SettingWorkspaceMembers.vue+++ b/frontend/src/views/SettingWorkspaceMembers.vue@@ -43,12 +43,12 @@</NTabPane><template #suffix>- <div class="flex items-center space-x-3">+ <div class="flex items-center gap-x-2"><SearchBoxv-model:value="state.searchText":placeholder="$t('settings.members.search-member')"/>- <div v-if="allowEdit" class="flex justify-end gap-x-3">+ <div v-if="allowEdit" class="flex justify-end gap-x-2"><NButtonv-if="state.selectedTab === 'MEMBERS'":disabled="state.selectedMembers.length === 0"diff --git a/frontend/src/views/SettingWorkspaceUsers.vue b/frontend/src/views/SettingWorkspaceUsers.vueindex c1dc042456..31a9701480 100644--- a/frontend/src/views/SettingWorkspaceUsers.vue+++ b/frontend/src/views/SettingWorkspaceUsers.vue@@ -63,7 +63,7 @@</NTabPane><template #suffix>- <div class="flex items-center space-x-3">+ <div class="flex items-center gap-x-2"><SearchBox v-model:value="state.activeUserFilterText" /><NButtondiff --git a/frontend/src/views/auth/Signin.vue b/frontend/src/views/auth/Signin.vueindex 4208ce3bbe..0a2efb48a7 100644--- a/frontend/src/views/auth/Signin.vue+++ b/frontend/src/views/auth/Signin.vue@@ -3,8 +3,8 @@<div class="mx-auto w-full max-w-sm"><BytebaseLogo class="mx-auto" />- <div class="mt-8">- <NCard v-if="showSignInForm">+ <div v-if="showSignInForm" class="mt-8">+ <NCard><NTabsclass="card-tabs":default-value="defaultTabValue"