Skip to content

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

chore: code optimize (#18106)

ecmadao1dd99b2ef4a9
diff --git a/frontend/src/store/modules/v1/worksheet.ts b/frontend/src/store/modules/v1/worksheet.ts
index aed431812e..da89f5d121 100644
--- a/frontend/src/store/modules/v1/worksheet.ts
+++ b/frontend/src/store/modules/v1/worksheet.ts
@@ -19,6 +19,7 @@ import {
SearchWorksheetsRequestSchema,
UpdateWorksheetOrganizerRequestSchema,
UpdateWorksheetRequestSchema,
+ WorksheetOrganizerSchema,
} from "@/types/proto-es/v1/worksheet_service_pb";
import {
extractWorksheetUID,
@@ -237,14 +238,16 @@ export const useWorkSheetStore = defineStore("worksheet_v1", () => {
const batchUpsertWorksheetOrganizers = async (
requests: {
- organizer: Pick<WorksheetOrganizer, "worksheet" | "starred" | "folders">;
+ organizer: Partial<WorksheetOrganizer>;
updateMask: string[];
}[]
) => {
const request = create(BatchUpdateWorksheetOrganizerRequestSchema, {
requests: requests.map((request) =>
create(UpdateWorksheetOrganizerRequestSchema, {
- organizer: { ...request.organizer } as WorksheetOrganizer,
+ organizer: create(WorksheetOrganizerSchema, {
+ ...request.organizer,
+ } as WorksheetOrganizer),
updateMask: { paths: request.updateMask },
})
),
@@ -260,12 +263,13 @@ export const useWorkSheetStore = defineStore("worksheet_v1", () => {
};
const upsertWorksheetOrganizer = async (
- organizer: Pick<WorksheetOrganizer, "worksheet" | "starred" | "folders">,
+ organizer: Partial<WorksheetOrganizer>,
updateMask: string[]
) => {
- const fullOrganizer = { ...organizer } as WorksheetOrganizer;
const request = create(UpdateWorksheetOrganizerRequestSchema, {
- organizer: fullOrganizer,
+ organizer: create(WorksheetOrganizerSchema, {
+ ...organizer,
+ } as WorksheetOrganizer),
updateMask: { paths: updateMask },
});
const response =
diff --git a/frontend/src/views/sql-editor/AsidePanel/WorksheetPane/SheetList/FolderForm.vue b/frontend/src/views/sql-editor/AsidePanel/WorksheetPane/SheetList/FolderForm.vue
index 2cef58eb6f..edfe9a77f8 100644
--- a/frontend/src/views/sql-editor/AsidePanel/WorksheetPane/SheetList/FolderForm.vue
+++ b/frontend/src/views/sql-editor/AsidePanel/WorksheetPane/SheetList/FolderForm.vue
@@ -16,7 +16,7 @@
<template #trigger>
<NInput
ref="folderInputRef"
- :value="formattedFolderPath.split('/').join(' / ')"
+ :value="formattedFolderPath"
:placeholder="$t('sql-editor.choose-folder')"
@focus="onFocus"
@update:value="onInput"
@@ -74,7 +74,8 @@ watch(
(val) => emits("update:folder", val)
);
-const { folderTree, folderContext } = useSheetContextByView("my");
+const { folderTree, folderContext, getFoldersForWorksheet } =
+ useSheetContextByView("my");
const expandedKeys = ref<Set<string>>(new Set([]));
const expandedKeysArray = computed(() => Array.from(expandedKeys.value));
@@ -91,7 +92,7 @@ const formattedFolderPath = computed(() => {
if (val[0] === "/") {
val = val.slice(1);
}
- return val;
+ return val.split("/").join(" / ");
});
const onFocus = () => {
@@ -108,6 +109,9 @@ const onInput = (val: string) => {
if (val.endsWith(" /")) {
changedVal = val.slice(0, -2);
}
+ if (changedVal.endsWith(".")) {
+ changedVal = changedVal.slice(0, -1);
+ }
const rawPath = changedVal
.split("/")
.map((p) => p.trim())
@@ -128,12 +132,6 @@ const renderPrefix = ({ option }: { option: TreeOption }) => {
};
defineExpose({
- folderPath: formattedFolderPath,
- folders: computed(() =>
- formattedFolderPath.value
- .split("/")
- .map((p) => p.trim())
- .filter((p) => p)
- ),
+ folders: computed(() => getFoldersForWorksheet(folderPath.value)),
});
</script>
diff --git a/frontend/src/views/sql-editor/AsidePanel/WorksheetPane/SheetList/SheetTree.vue b/frontend/src/views/sql-editor/AsidePanel/WorksheetPane/SheetList/SheetTree.vue
index c1f76f8014..950852cc30 100644
--- a/frontend/src/views/sql-editor/AsidePanel/WorksheetPane/SheetList/SheetTree.vue
+++ b/frontend/src/views/sql-editor/AsidePanel/WorksheetPane/SheetList/SheetTree.vue
@@ -114,7 +114,6 @@ import { create } from "@bufbuild/protobuf";
import { useDebounceFn } from "@vueuse/core";
import { FolderInputIcon, TrashIcon, XIcon } from "lucide-vue-next";
import {
- type DialogReactive,
NButton,
NDropdown,
NInput,
@@ -252,7 +251,6 @@ const handleWorksheetToggleStar = useDebounceFn(
{
worksheet: worksheet,
starred,
- folders: [], // don't care about folders
},
["starred"]
);
@@ -383,8 +381,13 @@ const renderLabel = ({ option }: { option: TreeOption }) => {
if (!editingNode.value) {
return;
}
- if (val.includes("/")) {
- return;
+ if (!editingNode.value.node.worksheet) {
+ {
+ /* the folder name cannot contains "/" or "." */
+ }
+ if (val.includes("/") || val.includes(".")) {
+ return;
+ }
}
editingNode.value.node.label = val;
}}
@@ -481,8 +484,12 @@ const handleMultiDelete = async () => {
}
folders.push(node.key);
}
- await handleDeleteFolders(folders, [...checkedWorksheets.value]);
- checkable.value = false;
+ const removed = await handleDeleteFolders(folders, [
+ ...checkedWorksheets.value,
+ ]);
+ if (removed) {
+ checkable.value = false;
+ }
};
const handleDeleteFolders = (folders: string[], worksheets: string[]) => {
@@ -540,10 +547,6 @@ const handleDeleteFolders = (folders: string[], worksheets: string[]) => {
};
const handleDeleteSheet = (worksheetName: string) => {
- const cleanup = (dialogInstance: DialogReactive | undefined) => {
- dialogInstance?.destroy();
- };
-
const dialogInstance = $dialog.create({
title: t("sheet.hint-tips.confirm-to-delete-sheet-title"),
type: "error",
@@ -554,13 +557,13 @@ const handleDeleteSheet = (worksheetName: string) => {
async onPositiveClick() {
dialogInstance.loading = true;
await deleteWorksheets([worksheetName]);
- cleanup(dialogInstance);
+ dialogInstance.destroy();
},
onNegativeClick() {
- cleanup(dialogInstance);
+ dialogInstance.destroy();
},
onClose() {
- cleanup(dialogInstance);
+ dialogInstance.destroy();
},
negativeText: t("common.cancel"),
positiveText: t("common.delete"),
@@ -597,7 +600,6 @@ const handleDuplicateSheet = async (worksheetName: string) => {
{
worksheet: newWorksheet.name,
folders: worksheet.folders,
- starred: false,
},
["folders"]
);
@@ -732,15 +734,10 @@ const handleContextMenuSelect = async (key: DropdownOptionType) => {
visibility: Worksheet_Visibility.PRIVATE,
})
);
- const folders = contextMenuContext.node.key
- .replace(folderContext.rootPath.value, "")
- .split("/")
- .filter((p) => p);
await worksheetV1Store.upsertWorksheetOrganizer(
{
worksheet: newWorksheet.name,
- starred: false,
- folders,
+ folders: getFoldersForWorksheet(contextMenuContext.node.key),
},
["folders"]
);
diff --git a/frontend/src/views/sql-editor/Sheet/context.ts b/frontend/src/views/sql-editor/Sheet/context.ts
index 356747a8c1..839b83e422 100644
--- a/frontend/src/views/sql-editor/Sheet/context.ts
+++ b/frontend/src/views/sql-editor/Sheet/context.ts
@@ -147,6 +147,9 @@ const useSheetTreeByView = (
}
});
+ // getPathesForWorksheet returns all folder pathes for a worksheet.
+ // For example, if the worksheet folders is ["ed", "sample", "pro"],
+ // then all pathes should be: ["/{root}", "/{root}/ed", "/{root}/ed/sample", "/{root}/ed/sample/pro"]
const getPathesForWorksheet = (worksheet: {
folders: string[];
}): string[] => {
@@ -161,25 +164,33 @@ const useSheetTreeByView = (
return pathes;
};
+ // getPwdForWorksheet print working directory (pwd) for the worksheet.
+ // For example, if the worksheet folders is ["ed", "sample", "pro"],
+ // then the pwd is: /{root}/ed/sample/pro
const getPwdForWorksheet = (worksheet: { folders: string[] }): string => {
- return folderContext.ensureFolderPath(
- [folderContext.rootPath.value, ...worksheet.folders].join("/")
- );
+ return folderContext.ensureFolderPath(worksheet.folders.join("/"));
};
+ // getKeyForWorksheet returns the worksheet node key in the tree node.
+ // For example, if the worksheet worksheets/001 folders is ["ed", "sample", "pro"],
+ // then the path should be: /{root}/ed/sample/pro/bytebase-worksheet-001.sql
const getKeyForWorksheet = (worksheet: WorksheetLikeItem): string => {
return [
getPwdForWorksheet(worksheet),
- `bytebase-${worksheet.type}-${worksheet.name.split("/").slice(-1)[0]}`,
+ `bytebase-${worksheet.type}-${worksheet.name.split("/").slice(-1)[0]}.sql`,
].join("/");
};
+ // getFoldersForWorksheet returns the folders for a worksheet.
+ // The folders should NOT contains the root folder
+ // For example, the fullpath for a worksheet can be: /{root}/ed/sample/bytebase-worksheet-001.sql,
+ // then the folders should be ["ed", "sample"]
const getFoldersForWorksheet = (path: string): string[] => {
- return path
- .replace(folderContext.rootPath.value, "")
- .split("/")
- .slice(0, -1) // the last element should be the getKeyForWorksheet(worksheet)
- .filter((p) => p);
+ const pathes = path.replace(folderContext.rootPath.value, "").split("/");
+ if (pathes.slice(-1)[0].endsWith(".sql")) {
+ pathes.pop();
+ }
+ return pathes.map((p) => p.trim()).filter((p) => p);
};
const buildTree = (
@@ -295,15 +306,7 @@ const useSheetTreeByView = (
return;
}
- // const folderPathes = new Set<string>([]);
- // for (const worksheet of sheetLikeItemList.value) {
- // for (const path of getPathesForWorksheet(worksheet)) {
- // folderPathes.add(path);
- // }
- // }
- // folderContext.mergeFolders(folderPathes);
rebuildTree();
-
isInitialized.value = true;
} finally {
isLoading.value = false;
@@ -497,7 +500,6 @@ export const provideSheetContext = () => {
worksheets.map((worksheet) => ({
organizer: {
worksheet: worksheet.name,
- starred: false, // don't care about the starred
folders: worksheet.folders,
},
updateMask: ["folders"],
diff --git a/frontend/src/views/sql-editor/Sheet/folder.ts b/frontend/src/views/sql-editor/Sheet/folder.ts
index cab2baa2a6..5f3a72b09c 100644
--- a/frontend/src/views/sql-editor/Sheet/folder.ts
+++ b/frontend/src/views/sql-editor/Sheet/folder.ts
@@ -23,23 +23,24 @@ export const useFolderByView = (
const folders = computed(() => sortBy([...localCache.value]));
- // A valid folder path should be like "/xxx"
+ // A valid folder path should be like "/{root}/xx"
// It must not end with "/", for example, "xxx/" is not valid
- // It must starts with "/", like "/xxx"
+ // It must starts with "/{root}", like "/mine/xxx"
const ensureFolderPath = (path: string) => {
- let p = path;
- while (p.startsWith("/")) {
- p = p.slice(1);
- }
- while (p.endsWith("/")) {
- p = p.slice(0, -1);
- }
+ let p = path
+ .split("/")
+ .map((p) => p.trim())
+ .filter((p) => p)
+ .join("/");
if (!p) {
return rootPath.value;
}
if (!p.startsWith("/")) {
p = `/${p}`;
}
+ if (!p.startsWith(rootPath.value)) {
+ p = `${rootPath.value}${p}`;
+ }
return p;
};