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: fix and optimize the worksheet tree (#18094)
ecmadao97ac2ee87c47
diff --git a/frontend/src/views/sql-editor/AsidePanel/AsidePanel.vue b/frontend/src/views/sql-editor/AsidePanel/AsidePanel.vueindex 97b2fb8dc4..d8090faf44 100644--- a/frontend/src/views/sql-editor/AsidePanel/AsidePanel.vue+++ b/frontend/src/views/sql-editor/AsidePanel/AsidePanel.vue@@ -21,6 +21,7 @@:menu-props="{ class: 'project-select-menu' }":project-name="project":include-all="false"+ :clearable="false":include-default-project="allowAccessDefaultProject":loading="!projectContextReady"@update:project-name="handleSwitchProject"diff --git a/frontend/src/views/sql-editor/AsidePanel/WorksheetPane/SheetList/DraftTree.vue b/frontend/src/views/sql-editor/AsidePanel/WorksheetPane/SheetList/DraftTree.vuedeleted file mode 100644index 2f69f404ab..0000000000--- a/frontend/src/views/sql-editor/AsidePanel/WorksheetPane/SheetList/DraftTree.vue+++ /dev/null@@ -1,222 +0,0 @@-<template>- <div class="flex flex-col items-stretch gap-y-1 relative worksheet-tree">- <NTree- block-line- :keyboard="false"- :data="[treeNode]"- :multiple="false"- :show-irrelevant-nodes="false"- :filter="filterNode(rootPath)"- :pattern="keyword"- :render-prefix="renderPrefix"- :render-suffix="renderSuffix"- :render-label="renderLabel"- :node-props="nodeProps"- :selected-keys="selectedKeys"- :expanded-keys="expandedKeysArray"- :override-default-node-click-behavior="overrideNodeClickBehavior"- @update:expanded-keys="(keys: string[]) => expandedKeys = new Set(keys)"- />- </div>-</template>--<script lang="tsx" setup>-import {- FilePenIcon,- FolderOpenIcon,- FolderPenIcon,- XIcon,-} from "lucide-vue-next";-import {- NTree,- type TreeOption,- type TreeOverrideNodeClickBehavior,-} from "naive-ui";-import { computed, ref, watch } from "vue";-import { HighlightLabelText } from "@/components/v2";-import { t } from "@/plugins/i18n";-import {- useCurrentUserV1,- useSQLEditorTabStore,- useTabViewStateStore,-} from "@/store";-import { isDescendantOf, useDynamicLocalStorage } from "@/utils";-import { filterNode } from "./common";--// TODO(ed): can we deprecate the DraftTree and use the SheetTree & useSheetTreeByView instead?-interface DraftWorsheetNode extends TreeOption {- key: string;- label: string;- draftId?: string;- children?: DraftWorsheetNode[];-}--const props = defineProps<{- keyword: string;-}>();--const rootPath = computed(() => "/draft");-const tabStore = useSQLEditorTabStore();-const me = useCurrentUserV1();-const { removeViewState } = useTabViewStateStore();-const selectedKeys = ref<string[]>([]);-const expandedKeys = useDynamicLocalStorage<Set<string>>(- computed(- () => `bb.sql-editor.worksheet-tree-expand-keys.draft.${me.value.name}`- ),- new Set([rootPath.value])-);--// Convert Set to Array once per render cycle instead of spreading in template-const expandedKeysArray = computed(() => Array.from(expandedKeys.value));--const overrideNodeClickBehavior: TreeOverrideNodeClickBehavior = ({- option,-}) => {- if (option.children) {- return "toggleExpand";- }- return "default";-};--const keyForDraft = (tab: { id: string }) => {- return `bb-worksheet-list-draft-${tab.id}`;-};--// Extract only tree-relevant properties to avoid rebuilding on unrelated changes-// (e.g., statement, status, connection changes should NOT trigger rebuild)-const draftTreeData = computed(() => {- return tabStore.tabList- .filter((tab) => !tab.worksheet)- .map((tab) => ({- id: tab.id,- title: tab.title,- worksheet: tab.worksheet, // Track to detect when draft becomes saved- }));-});--const treeNode = computed((): DraftWorsheetNode => {- return {- isLeaf: false,- key: rootPath.value,- label: t("common.draft"),- children: draftTreeData.value.map((draftData) => {- return {- isLeaf: true,- key: keyForDraft({ id: draftData.id }),- label: draftData.title,- draftId: draftData.id,- };- }),- };-});--const renderPrefix = ({ option }: { option: TreeOption }) => {- const node = option as DraftWorsheetNode;- if (node.draftId) {- // the node is file- return <FilePenIcon class="w-4 h-auto text-gray-600" />;- }- if (expandedKeys.value.has(node.key)) {- // is opened folder- return <FolderOpenIcon class="w-4 h-auto text-gray-600" />;- }- return <FolderPenIcon class="w-4 h-auto text-gray-600" />;-};--const renderSuffix = ({ option }: { option: TreeOption }) => {- const node = option as DraftWorsheetNode;- if (!node.draftId) {- return null;- }-- return (- <XIcon- class="w-4 h-auto text-gray-600"- onClick={() => {- if (node.draftId) {- const draft = tabStore.tabList.find((t) => t.id === node.draftId);- if (draft) {- tabStore.removeTab(draft);- }- removeViewState(node.draftId);- }- }}- />- );-};--const renderLabel = ({ option }: { option: TreeOption }) => {- const node = option as DraftWorsheetNode;- return <HighlightLabelText text={node.label} keyword={props.keyword} />;-};--const nodeProps = ({ option }: { option: TreeOption }) => {- const node = option as DraftWorsheetNode;- return {- "data-item-key": node.key,- onClick(e: MouseEvent) {- if (- !isDescendantOf(e.target as Element, ".n-tree-node-content__text") &&- !isDescendantOf(e.target as Element, ".n-tree-node-content__prefix")- ) {- return;- }- if (node.draftId) {- tabStore.setCurrentTabId(node.draftId);- }- },- };-};--watch(- () => ({- id: tabStore.currentTab?.id,- worksheet: tabStore.currentTab?.worksheet,- }),- ({ id, worksheet }) => {- selectedKeys.value = [];- if (!id) {- return;- }- if (worksheet) {- return;- }- const key = keyForDraft({ id });- selectedKeys.value = [key];- expandedKeys.value.add(rootPath.value);- },- { immediate: true }-);-</script>--<style lang="postcss" scoped>-.worksheet-tree :deep(.n-tree .v-vl) {- --n-node-content-height: 21px !important;-}-.worksheet-tree :deep(.n-tree-node-content) {- padding-left: 0 !important;- padding-right: 1rem !important;- font-size: 0.875rem;- line-height: 1.25rem;- flex: 1;-}-.worksheet-tree :deep(.n-tree-node-wrapper) {- padding: 0;-}-.worksheet-tree :deep(.n-tree-node-switcher--hide) {- width: 0.5rem !important;-}-.worksheet-tree :deep(.n-tree-node-content__prefix) {- flex-shrink: 0;-}-.worksheet-tree :deep(.n-tree-node-content__suffix) {- flex-shrink: 0;-}-.worksheet-tree :deep(.n-tree-node-content__text) {- overflow: hidden;- flex: 1;- text-overflow: ellipsis;- white-space: nowrap;-}-</style>diff --git a/frontend/src/views/sql-editor/AsidePanel/WorksheetPane/SheetList/SheetTree.vue b/frontend/src/views/sql-editor/AsidePanel/WorksheetPane/SheetList/SheetTree.vueindex 71841d2691..93207b135a 100644--- a/frontend/src/views/sql-editor/AsidePanel/WorksheetPane/SheetList/SheetTree.vue+++ b/frontend/src/views/sql-editor/AsidePanel/WorksheetPane/SheetList/SheetTree.vue@@ -50,7 +50,7 @@@clickoutside="handleContextMenuClickOutside"><SharePopover- :worksheet="contextMenuContext.node?.worksheet"+ :worksheet="worksheetEntity"@on-updated="handleContextMenuClickOutside"/></NPopover>@@ -85,7 +85,6 @@ import {} from "@/store";import { DEBOUNCE_SEARCH_DELAY } from "@/types";import {- type Worksheet,Worksheet_Visibility,WorksheetSchema,} from "@/types/proto-es/v1/worksheet_service_pb";@@ -102,7 +101,8 @@ import {} from "@/views/sql-editor/Sheet";import { filterNode } from "./common";import { type DropdownOptionType, useDropdown } from "./dropdown";-import { TreeNodePrefix, TreeNodeSuffix } from "./TreeNodeRenders";+import TreeNodePrefix from "./TreeNodePrefix.vue";+import TreeNodeSuffix from "./TreeNodeSuffix.vue";const props = defineProps<{view: SheetViewMode;@@ -135,18 +135,19 @@ const tabStore = useSQLEditorTabStore();const {context: contextMenuContext,options: contextMenuOptions,+ worksheetEntity,handleSharePanelShow,handleMenuShow,handleClickOutside: handleContextMenuClickOutside,-} = useDropdown();+} = useDropdown(props.view);const expandedKeysArray = computed(() => Array.from(expandedKeys.value));watch(isInitialized,async () => {- if (!isInitialized.value) {- await fetchSheetList(project.value);+ if (!isInitialized.value && project.value) {+ await fetchSheetList();}},{ immediate: true }@@ -160,17 +161,15 @@ watch();const handleWorksheetToggleStar = useDebounceFn(- async (worksheet: Worksheet) => {- const starred = !worksheet.starred;+ async ({ worksheet, starred }: { worksheet: string; starred: boolean }) => {await worksheetV1Store.upsertWorksheetOrganizer({- worksheet: worksheet.name,+ worksheet: worksheet,starred,- folders: worksheet.folders,+ folders: [], // don't care about folders},["starred"]);- worksheet.starred = starred;},DEBOUNCE_SEARCH_DELAY);@@ -192,7 +191,7 @@ const renderSuffix = ({ option }: { option: TreeOption }) => {return (<TreeNodeSuffixnode={node}- isWorksheetCreator={isWorksheetCreator}+ view={props.view}onSharePanelShow={handleSharePanelShow}onContextMenuShow={handleMenuShow}onToggleStar={handleWorksheetToggleStar}@@ -220,15 +219,23 @@ const handleRenameNode = useDebounceFn(async () => {newTitle,].join("/");if (newKey === editingNode.value.node.key) {- editingNode.value = undefined;- return;+ return cleanup();}if (editingNode.value.node.worksheet) {- editingNode.value.node.worksheet.title = newTitle;- await worksheetV1Store.patchWorksheet(editingNode.value.node.worksheet, [- "title",- ]);+ const worksheet = worksheetV1Store.getWorksheetByName(+ editingNode.value.node.worksheet.name+ );+ if (!worksheet) {+ return cleanup();+ }+ await worksheetV1Store.patchWorksheet(+ {+ ...worksheet,+ title: newTitle,+ },+ ["title"]+ );// update tab titleconst tab = tabStore.tabList.find(@@ -323,12 +330,15 @@ const nodeProps = ({ option }: { option: TreeOption }) => {return;}if (node.worksheet) {- selectedKeys.value = [node.key];- openWorksheetByName(- node.worksheet.name,- editorContext,- e.metaKey || e.ctrlKey- );+ if (node.worksheet.type === "worksheet") {+ openWorksheetByName(+ node.worksheet.name,+ editorContext,+ e.metaKey || e.ctrlKey+ );+ } else {+ tabStore.setCurrentTabId(node.worksheet.name);+ }} else {if (expandedKeys.value.has(node.key)) {expandedKeys.value.delete(node.key);@@ -340,16 +350,14 @@ const nodeProps = ({ option }: { option: TreeOption }) => {};};-const deleteWorksheets = async (worksheets: Worksheet[]) => {+const deleteWorksheets = async (worksheets: string[]) => {await Promise.all(worksheets.map((worksheet) =>- worksheetV1Store.deleteWorksheetByName(worksheet.name)+ worksheetV1Store.deleteWorksheetByName(worksheet)));for (const worksheet of worksheets) {- const tab = tabStore.tabList.find(- (tab) => tab.worksheet === worksheet.name- );+ const tab = tabStore.tabList.find((tab) => tab.worksheet === worksheet);if (tab) {tabStore.removeTab(tab);removeViewState(tab.id);@@ -358,7 +366,7 @@ const deleteWorksheets = async (worksheets: Worksheet[]) => {};const handleDeleteFolder = (node: WorsheetFolderNode) => {- const worksheets = revealWorksheets(node, (node) => node.worksheet);+ const worksheets = revealWorksheets(node, (node) => node.worksheet?.name);if (worksheets.length === 0) {folderContext.removeFolder(node.key);} else {@@ -385,7 +393,7 @@ const handleDeleteFolder = (node: WorsheetFolderNode) => {dialogInstance.loading = true;await batchUpdateWorksheetFolders(worksheets.map((worksheet) => ({- ...worksheet,+ name: worksheet,folders: [],})));@@ -400,7 +408,7 @@ const handleDeleteFolder = (node: WorsheetFolderNode) => {}};-const handleDeleteSheet = (worksheet: Worksheet) => {+const handleDeleteSheet = (worksheetName: string) => {const cleanup = (dialogInstance: DialogReactive | undefined) => {dialogInstance?.destroy();};@@ -414,7 +422,7 @@ const handleDeleteSheet = (worksheet: Worksheet) => {closeOnEsc: true,async onPositiveClick() {dialogInstance.loading = true;- await deleteWorksheets([worksheet]);+ await deleteWorksheets([worksheetName]);cleanup(dialogInstance);},onNegativeClick() {@@ -429,7 +437,11 @@ const handleDeleteSheet = (worksheet: Worksheet) => {});};-const handleDuplicateSheet = async (worksheet: Worksheet) => {+const handleDuplicateSheet = async (worksheetName: string) => {+ const worksheet = worksheetV1Store.getWorksheetByName(worksheetName);+ if (!worksheet) {+ return;+ }const dialogInstance = $dialog.create({title: t("sheet.hint-tips.confirm-to-duplicate-sheet"),type: "info",@@ -551,14 +563,14 @@ const handleContextMenuSelect = async (key: DropdownOptionType) => {break;case "delete":if (contextMenuContext.node.worksheet) {- handleDeleteSheet(contextMenuContext.node.worksheet);+ handleDeleteSheet(contextMenuContext.node.worksheet.name);} else {handleDeleteFolder(contextMenuContext.node);}break;case "duplicate":if (contextMenuContext.node.worksheet) {- handleDuplicateSheet(contextMenuContext.node.worksheet);+ handleDuplicateSheet(contextMenuContext.node.worksheet.name);}break;case "add-folder":@@ -582,10 +594,7 @@ const handleContextMenuSelect = async (key: DropdownOptionType) => {create(WorksheetSchema, {title: "new worksheet",project: project.value,- visibility:- props.view === "shared"- ? Worksheet_Visibility.PROJECT_READ- : Worksheet_Visibility.PRIVATE,+ visibility: Worksheet_Visibility.PRIVATE,}));const folders = contextMenuContext.node.key@@ -643,7 +652,12 @@ const updateWorksheetFolders = async (return node.worksheet;}});- await batchUpdateWorksheetFolders(worksheets);+ await batchUpdateWorksheetFolders(+ worksheets.map((worksheet) => ({+ name: worksheet.name,+ folders: worksheet.folders,+ }))+ );};const replaceExpandedKeys = (oldKey: string, newKey: string) => {diff --git a/frontend/src/views/sql-editor/AsidePanel/WorksheetPane/SheetList/TreeNodePrefix.vue b/frontend/src/views/sql-editor/AsidePanel/WorksheetPane/SheetList/TreeNodePrefix.vuenew file mode 100644index 0000000000..4f09d9528d--- /dev/null+++ b/frontend/src/views/sql-editor/AsidePanel/WorksheetPane/SheetList/TreeNodePrefix.vue@@ -0,0 +1,54 @@+<template>+ <FileCodeIcon+ v-if="node.worksheet"+ class="w-4 h-auto text-gray-600"+ />+ <FolderOpenIcon+ v-else-if="expandedKeys.has(node.key)"+ class="w-4 h-auto text-gray-600"+ />+ <template v-else-if="node.key === rootPath">+ <FolderPenIcon+ v-if="view === 'draft'"+ class="w-4 h-auto text-gray-600"+ />+ <FolderSyncIcon+ v-else-if="view === 'shared'"+ class="w-4 h-auto text-gray-600"+ />+ <FolderCodeIcon+ v-else+ class="w-4 h-auto text-gray-600"+ />+ </template>+ <FolderMinusIcon+ v-else-if="node.empty"+ class="w-4 h-auto text-gray-600"+ />+ <FolderCodeIcon+ v-else+ class="w-4 h-auto text-gray-600"+ />+</template>++<script setup lang="ts">+import {+ FileCodeIcon,+ FolderCodeIcon,+ FolderMinusIcon,+ FolderOpenIcon,+ FolderPenIcon,+ FolderSyncIcon,+} from "lucide-vue-next";+import type {+ SheetViewMode,+ WorsheetFolderNode,+} from "@/views/sql-editor/Sheet";++defineProps<{+ node: WorsheetFolderNode;+ expandedKeys: Set<string>;+ rootPath: string;+ view: SheetViewMode;+}>();+</script>diff --git a/frontend/src/views/sql-editor/AsidePanel/WorksheetPane/SheetList/TreeNodeRenders.tsx b/frontend/src/views/sql-editor/AsidePanel/WorksheetPane/SheetList/TreeNodeRenders.tsxdeleted file mode 100644index 943cea97a9..0000000000--- a/frontend/src/views/sql-editor/AsidePanel/WorksheetPane/SheetList/TreeNodeRenders.tsx+++ /dev/null@@ -1,172 +0,0 @@-import {- FileCodeIcon,- FolderCodeIcon,- FolderMinusIcon,- FolderOpenIcon,- FolderSyncIcon,- MoreHorizontalIcon,- StarIcon,- UsersIcon,-} from "lucide-vue-next";-import { NTooltip } from "naive-ui";-import { defineComponent, type PropType } from "vue";-import { t } from "@/plugins/i18n";-import { useUserStore } from "@/store";-import {- type Worksheet,- Worksheet_Visibility,-} from "@/types/proto-es/v1/worksheet_service_pb";-import type { WorsheetFolderNode } from "@/views/sql-editor/Sheet";--// Prefix icon component-export const TreeNodePrefix = defineComponent({- name: "TreeNodePrefix",- props: {- node: {- type: Object as PropType<WorsheetFolderNode>,- required: true,- },- expandedKeys: {- type: Object as PropType<Set<string>>,- required: true,- },- rootPath: {- type: String,- required: true,- },- view: {- type: String as PropType<"my" | "shared">,- required: true,- },- },- setup(props) {- return () => {- if (props.node.worksheet) {- // the node is file- return <FileCodeIcon class="w-4 h-auto text-gray-600" />;- }- if (props.expandedKeys.has(props.node.key)) {- // is opened folder- return <FolderOpenIcon class="w-4 h-auto text-gray-600" />;- }- if (props.node.key === props.rootPath) {- // root folder icon- if (props.view === "shared") {- return <FolderSyncIcon class="w-4 h-auto text-gray-600" />;- }- return <FolderCodeIcon class="w-4 h-auto text-gray-600" />;- }- if (props.node.empty) {- // empty folder icon- return <FolderMinusIcon class="w-4 h-auto text-gray-600" />;- }- // fallback to normal folder icon- return <FolderCodeIcon class="w-4 h-auto text-gray-600" />;- };- },-});--// Suffix icons component-export const TreeNodeSuffix = defineComponent({- name: "TreeNodeSuffix",- props: {- node: {- type: Object as PropType<WorsheetFolderNode>,- required: true,- },- isWorksheetCreator: {- type: Function as PropType<(worksheet: Worksheet) => boolean>,- required: true,- },- },- emits: ["contextMenuShow", "sharePanelShow", "toggleStar"],- setup(props, { emit }) {- const userStore = useUserStore();-- const visibilityDisplayName = (visibility: Worksheet_Visibility) => {- switch (visibility) {- case Worksheet_Visibility.PRIVATE:- return t("sql-editor.private");- case Worksheet_Visibility.PROJECT_READ:- return t("sql-editor.project-read");- case Worksheet_Visibility.PROJECT_WRITE:- return t("sql-editor.project-write");- default:- return "";- }- };-- const creatorForSheet = (sheet: Worksheet) => {- return (- userStore.getUserByIdentifier(sheet.creator)?.title ?? sheet.creator- );- };-- const renderShareIcon = (worksheet: Worksheet) => {- if (- worksheet.visibility !== Worksheet_Visibility.PROJECT_READ &&- worksheet.visibility !== Worksheet_Visibility.PROJECT_WRITE- ) {- return null;- }-- return (- <NTooltip>- {{- trigger: () => (- <UsersIcon- class="w-4 text-gray-400"- onClick={(e) => emit("sharePanelShow", e, props.node)}- />- ),- default: () => {- return (- <div>- <div>- {t("common.visibility")}- {": "}- {visibilityDisplayName(worksheet.visibility)}- </div>- {props.isWorksheetCreator(worksheet) ? null : (- <div>- {t("common.creator")}- {": "}- {creatorForSheet(worksheet)}- </div>- )}- </div>- );- },- }}- </NTooltip>- );- };-- return () => {- if (!props.node.worksheet) {- return (- <MoreHorizontalIcon- class="w-4 h-auto text-gray-600"- onClick={(e: MouseEvent) => emit("contextMenuShow", e, props.node)}- />- );- }-- return (- <div class="inline-flex gap-1">- {renderShareIcon(props.node.worksheet)}- <StarIcon- class={`w-4 h-auto text-gray-400 ${props.node.worksheet.starred ? "text-yellow-400" : ""}`}- onClick={() =>- props.node.worksheet && emit("toggleStar", props.node.worksheet)- }- />- <MoreHorizontalIcon- class="w-4 h-auto text-gray-600"- onClick={(e: MouseEvent) => emit("contextMenuShow", e, props.node)}- />- </div>- );- };- },-});diff --git a/frontend/src/views/sql-editor/AsidePanel/WorksheetPane/SheetList/TreeNodeSuffix.vue b/frontend/src/views/sql-editor/AsidePanel/WorksheetPane/SheetList/TreeNodeSuffix.vuenew file mode 100644index 0000000000..7a06a05c1e--- /dev/null+++ b/frontend/src/views/sql-editor/AsidePanel/WorksheetPane/SheetList/TreeNodeSuffix.vue@@ -0,0 +1,158 @@++<template>+ <template v-if="view === 'draft'">+ <XIcon+ v-if="node.worksheet"+ class="w-4 h-auto text-gray-600"+ @click="handleDeleteDraft"+ />+ </template>+ <MoreHorizontalIcon+ v-else-if="!node.worksheet"+ class="w-4 h-auto text-gray-600"+ @click="handleContextMenuShow"+ />+ <div+ v-else-if="worksheetLite"+ class="inline-flex gap-1"+ >+ <NTooltip+ v-if="+ worksheetLite.visibility === Worksheet_Visibility.PROJECT_READ ||+ worksheetLite.visibility === Worksheet_Visibility.PROJECT_WRITE+ "+ >+ <template #trigger>+ <UsersIcon+ class="w-4 text-gray-400"+ @click="handleSharePanelShow"+ />+ </template>+ <div>+ <div>+ {{ t("common.visibility") }}{{ ": " }}{{ visibilityDisplayName(worksheetLite.visibility) }}+ </div>+ <div+ v-if="!isWorksheetCreator(worksheetLite.creator)"+ >+ {{ t("common.creator") }}{{ ": " }}{{ creatorForSheet(worksheetLite.creator) }}+ </div>+ </div>+ </NTooltip>+ <StarIcon+ :class="`w-4 h-auto text-gray-400 ${worksheetLite.starred ? 'text-yellow-400' : ''}`"+ @click="handleToggleStar"+ />+ <MoreHorizontalIcon+ class="w-4 h-auto text-gray-600"+ @click="handleContextMenuShow"+ />+ </div>+</template>++<script setup lang="ts">+import {+ MoreHorizontalIcon,+ StarIcon,+ UsersIcon,+ XIcon,+} from "lucide-vue-next";+import { NTooltip } from "naive-ui";+import { computed } from "vue";+import { t } from "@/plugins/i18n";+import {+ useCurrentUserV1,+ useSQLEditorTabStore,+ useTabViewStateStore,+ useUserStore,+ useWorkSheetStore,+} from "@/store";+import { Worksheet_Visibility } from "@/types/proto-es/v1/worksheet_service_pb";+import type {+ SheetViewMode,+ WorsheetFolderNode,+} from "@/views/sql-editor/Sheet";++const props = defineProps<{+ node: WorsheetFolderNode;+ view: SheetViewMode;+}>();++const emit = defineEmits<{+ (e: "contextMenuShow", event: MouseEvent, node: WorsheetFolderNode): void;+ (e: "sharePanelShow", event: MouseEvent, node: WorsheetFolderNode): void;+ (e: "toggleStar", item: { worksheet: string; starred: boolean }): void;+}>();++const userStore = useUserStore();+const worksheetStore = useWorkSheetStore();+const me = useCurrentUserV1();+const { removeViewState } = useTabViewStateStore();+const tabStore = useSQLEditorTabStore();++const worksheetLite = computed(() => {+ if (!props.node.worksheet) {+ return undefined;+ }+ const sheet = worksheetStore.getWorksheetByName(props.node.worksheet.name);+ if (!sheet) {+ return undefined;+ }+ return {+ name: sheet.name,+ starred: sheet.starred,+ visibility: sheet.visibility,+ creator: sheet.creator,+ };+});++const visibilityDisplayName = (visibility: Worksheet_Visibility) => {+ switch (visibility) {+ case Worksheet_Visibility.PRIVATE:+ return t("sql-editor.private");+ case Worksheet_Visibility.PROJECT_READ:+ return t("sql-editor.project-read");+ case Worksheet_Visibility.PROJECT_WRITE:+ return t("sql-editor.project-write");+ default:+ return "";+ }+};++const creatorForSheet = (creator: string) => {+ return userStore.getUserByIdentifier(creator)?.title ?? creator;+};++const isWorksheetCreator = (creator: string) => {+ return creator === `users/${me.value.email}`;+};++const handleDeleteDraft = () => {+ if (props.node.worksheet && props.node.worksheet.name) {+ const draft = tabStore.tabList.find(+ (t) => t.id === props.node.worksheet!.name+ );+ if (draft) {+ tabStore.removeTab(draft);+ }+ removeViewState(props.node.worksheet.name);+ }+};++const handleContextMenuShow = (e: MouseEvent) => {+ emit("contextMenuShow", e, props.node);+};++const handleSharePanelShow = (e: MouseEvent) => {+ emit("sharePanelShow", e, props.node);+};++const handleToggleStar = () => {+ if (worksheetLite.value) {+ emit("toggleStar", {+ worksheet: worksheetLite.value.name,+ starred: !worksheetLite.value.starred,+ });+ }+};+</script>diff --git a/frontend/src/views/sql-editor/AsidePanel/WorksheetPane/SheetList/dropdown.ts b/frontend/src/views/sql-editor/AsidePanel/WorksheetPane/SheetList/dropdown.tsindex bff9637feb..0ec0f15b82 100644--- a/frontend/src/views/sql-editor/AsidePanel/WorksheetPane/SheetList/dropdown.ts+++ b/frontend/src/views/sql-editor/AsidePanel/WorksheetPane/SheetList/dropdown.ts@@ -9,10 +9,13 @@ import {import { type DropdownOption } from "naive-ui";import { computed, h, reactive, watch } from "vue";import { t } from "@/plugins/i18n";-import { useCurrentUserV1 } from "@/store";+import { useCurrentUserV1, useWorkSheetStore } from "@/store";import { type Position } from "@/types";import { isWorksheetWritableV1 } from "@/utils";-import { type WorsheetFolderNode } from "@/views/sql-editor/Sheet";+import type {+ SheetViewMode,+ WorsheetFolderNode,+} from "@/views/sql-editor/Sheet";export type DropdownOptionType =| "share"@@ -33,8 +36,9 @@ interface DropdownContext {node?: WorsheetFolderNode;}-export const useDropdown = () => {+export const useDropdown = (viewMode: SheetViewMode) => {const me = useCurrentUserV1();+ const sheetStore = useWorkSheetStore();const context = reactive<DropdownContext>({position: {@@ -73,30 +77,38 @@ export const useDropdown = () => {});- const isCreator = computed(() => {- return context.node?.worksheet?.creator === `users/${me.value.email}`;+ const worksheetEntity = computed(() => {+ if (viewMode === "draft" || !context.node?.worksheet) {+ return undefined;+ }+ return sheetStore.getWorksheetByName(context.node.worksheet.name);});const options = computed((): WorksheetDropdown[] => {- if (!context.node) {+ if (viewMode === "draft" || !context.node) {return [];}const items: WorksheetDropdown[] = [];if (context.node.worksheet) {+ if (!worksheetEntity.value) {+ return [];+ }+ const isCreator =+ worksheetEntity.value.creator === `users/${me.value.email}`;items.push({icon: () => h(FilesIcon, { class: "w-4 text-gray-600" }),key: "duplicate",- label: isCreator.value ? t("common.duplicate") : t("common.fork"),+ label: isCreator ? t("common.duplicate") : t("common.fork"),});- if (isCreator.value) {+ if (isCreator) {items.push({icon: () => h(Share2Icon, { class: "w-4 text-gray-600" }),key: "share",label: t("common.share"),});}- const canWriteSheet = isWorksheetWritableV1(context.node.worksheet);+ const canWriteSheet = isWorksheetWritableV1(worksheetEntity.value);if (canWriteSheet) {items.push({@@ -112,18 +124,18 @@ export const useDropdown = () => {);}} else {- items.push(- {- icon: () => h(FolderIcon, { class: "w-4 text-gray-600" }),- key: "add-folder",- label: t("sql-editor.tab.context-menu.actions.add-folder"),- },- {+ items.push({+ icon: () => h(FolderIcon, { class: "w-4 text-gray-600" }),+ key: "add-folder",+ label: t("sql-editor.tab.context-menu.actions.add-folder"),+ });+ if (viewMode === "my") {+ items.push({icon: () => h(FileCodeIcon, { class: "w-4 text-gray-600" }),key: "add-worksheet",label: t("sql-editor.tab.context-menu.actions.add-worksheet"),- }- );+ });+ }if (context.node.editable) {items.push({@@ -170,6 +182,7 @@ export const useDropdown = () => {return {context,options,+ worksheetEntity,handleMenuShow,handleSharePanelShow,handleClickOutside,diff --git a/frontend/src/views/sql-editor/AsidePanel/WorksheetPane/SheetList/index.ts b/frontend/src/views/sql-editor/AsidePanel/WorksheetPane/SheetList/index.tsindex c3e79b9f16..e0d14d77ab 100644--- a/frontend/src/views/sql-editor/AsidePanel/WorksheetPane/SheetList/index.ts+++ b/frontend/src/views/sql-editor/AsidePanel/WorksheetPane/SheetList/index.ts@@ -1,4 +1,3 @@-import DraftTree from "./DraftTree.vue";import SheetTree from "./SheetTree.vue";-export { SheetTree, DraftTree };+export { SheetTree };diff --git a/frontend/src/views/sql-editor/AsidePanel/WorksheetPane/WorksheetPane.vue b/frontend/src/views/sql-editor/AsidePanel/WorksheetPane/WorksheetPane.vueindex 985f532bbf..7970992e60 100644--- a/frontend/src/views/sql-editor/AsidePanel/WorksheetPane/WorksheetPane.vue+++ b/frontend/src/views/sql-editor/AsidePanel/WorksheetPane/WorksheetPane.vue@@ -26,9 +26,7 @@</NDropdown></div><div class="flex-1 flex flex-col gap-y-2 overflow-y-auto worksheet-scroll">- <SheetTree v-if="filter.showMine" view="my" />- <SheetTree v-if="filter.showShared" view="shared" />- <DraftTree v-if="filter.showDraft" :keyword="filter.keyword" />+ <SheetTree v-for="view in views" :key="view" :view="view" /></div></div></template>@@ -39,9 +37,10 @@ import { type DropdownOption, NButton, NDropdown } from "naive-ui";import { computed, ref } from "vue";import { SearchBox } from "@/components/v2";import { t } from "@/plugins/i18n";+import { type SheetViewMode } from "@/views/sql-editor/Sheet";import { useSheetContext } from "../../Sheet";import FilterMenuItem from "./FilterMenuItem.vue";-import { DraftTree, SheetTree } from "./SheetList";+import { SheetTree } from "./SheetList";const { filter, filterChanged } = useSheetContext();const showDropdown = ref<boolean>(false);@@ -96,6 +95,20 @@ const options = computed((): DropdownOption[] => {},];});++const views = computed((): SheetViewMode[] => {+ const results: SheetViewMode[] = [];+ if (filter.value.showMine) {+ results.push("my");+ }+ if (filter.value.showShared) {+ results.push("shared");+ }+ if (filter.value.showDraft) {+ results.push("draft");+ }+ return results;+});</script><style lang="postcss" scoped>diff --git a/frontend/src/views/sql-editor/Sheet/context.ts b/frontend/src/views/sql-editor/Sheet/context.tsindex 3baa1cc640..b0bc9e89dc 100644--- a/frontend/src/views/sql-editor/Sheet/context.ts+++ b/frontend/src/views/sql-editor/Sheet/context.ts@@ -2,6 +2,7 @@ import { useDebounceFn } from "@vueuse/core";import Emittery from "emittery";import { isEqual, orderBy } from "lodash-es";import type { TreeOption } from "naive-ui";+import { storeToRefs } from "pinia";import scrollIntoView from "scroll-into-view-if-needed";import type { ComputedRef, InjectionKey, Ref } from "vue";import { computed, inject, nextTick, provide, ref, watch } from "vue";@@ -10,6 +11,7 @@ import {pushNotification,useCurrentUserV1,useDatabaseV1Store,+ useSQLEditorStore,useSQLEditorTabStore,useWorkSheetStore,} from "@/store";@@ -21,7 +23,6 @@ import {} from "@/types/proto-es/v1/worksheet_service_pb";import {emptySQLEditorConnection,- extractWorksheetUID,getSheetStatement,isWorksheetReadableV1,suggestedTabTitleForSQLEditorConnection,@@ -36,12 +37,19 @@ type SheetTreeEvents = Emittery<{"on-built": { viewMode: SheetViewMode };}>;+export interface WorksheetLikeItem {+ name: string;+ title: string;+ folders: string[];+ type: "worksheet" | "draft";+}+export interface WorsheetFolderNode extends TreeOption {key: string;label: string;editable: boolean;empty?: boolean;- worksheet?: Worksheet;+ worksheet?: WorksheetLikeItem;children: WorsheetFolderNode[];}@@ -53,14 +61,27 @@ interface WorksheetFilter {showDraft: boolean;}+const convertToWorksheetLikeItem = (+ worksheet: Worksheet+): WorksheetLikeItem => {+ return {+ name: worksheet.name,+ title: worksheet.title,+ folders: worksheet.folders,+ type: "worksheet",+ };+};+const useSheetTreeByView = (viewMode: SheetViewMode,- filter: ComputedRef<WorksheetFilter>+ filter: ComputedRef<WorksheetFilter>,+ project: ComputedRef<string>) => {const sheetStore = useWorkSheetStore();- const folderContext = useFolderByView(viewMode);+ const folderContext = useFolderByView(viewMode, project);const me = useCurrentUserV1();const events: SheetTreeEvents = new Emittery();+ const tabStore = useSQLEditorTabStore();const isInitialized = ref(false);const isLoading = ref(false);@@ -71,6 +92,8 @@ const useSheetTreeByView = (return t("sheet.mine");case "shared":return t("sheet.shared");+ case "draft":+ return t("common.draft");default:return "";}@@ -85,7 +108,7 @@ const useSheetTreeByView = (});const sheetTree = ref<WorsheetFolderNode>(getRootTreeNode());- const sheetList = computed(() => {+ const worksheetList = computed((): Worksheet[] => {let list: Worksheet[] = [];switch (viewMode) {case "my":@@ -95,15 +118,38 @@ const useSheetTreeByView = (list = sheetStore.sharedWorksheetList;break;default:- return [];+ break;}++ list = list.filter((sheet) => sheet.project === project.value);if (filter.value.onlyShowStarred) {return list.filter((sheet) => sheet.starred);}return list;});- const getPathesForWorksheet = (worksheet: Worksheet): string[] => {+ const sheetLikeItemList = computed((): WorksheetLikeItem[] => {+ switch (viewMode) {+ case "my":+ case "shared":+ return worksheetList.value.map(convertToWorksheetLikeItem);+ case "draft":+ return tabStore.tabList+ .filter((tab) => !tab.worksheet)+ .map((tab) => ({+ name: tab.id,+ title: tab.title,+ folders: [],+ type: "draft",+ }));+ default:+ return [];+ }+ });++ const getPathesForWorksheet = (worksheet: {+ folders: string[];+ }): string[] => {const pathes = [folderContext.rootPath.value];let currentPath = folderContext.rootPath.value;@@ -115,16 +161,16 @@ const useSheetTreeByView = (return pathes;};- const getPwdForWorksheet = (worksheet: Worksheet): string => {+ const getPwdForWorksheet = (worksheet: { folders: string[] }): string => {return folderContext.ensureFolderPath([folderContext.rootPath.value, ...worksheet.folders].join("/"));};- const getKeyForWorksheet = (worksheet: Worksheet): string => {+ const getKeyForWorksheet = (worksheet: WorksheetLikeItem): string => {return [getPwdForWorksheet(worksheet),- `bytebase-worksheets-${extractWorksheetUID(worksheet.name)}`,+ `bytebase-${worksheet.type}-${worksheet.name}`,].join("/");};@@ -136,19 +182,9 @@ const useSheetTreeByView = (.filter((p) => p);};- // Extract only tree-relevant properties to avoid rebuilding on unrelated changes- // (e.g., starred, content, visibility changes should NOT trigger rebuild)- const treeRelevantSheetData = computed(() => {- return sheetList.value.map((worksheet) => ({- name: worksheet.name,- title: worksheet.title,- folders: worksheet.folders,- }));- });-const buildTree = (parent: WorsheetFolderNode,- worksheetsByFolder: Map<string, Worksheet[]>+ worksheetsByFolder: Map<string, WorksheetLikeItem[]>) => {parent.children = folderContext.listSubFolders(parent.key)@@ -191,8 +227,8 @@ const useSheetTreeByView = (const folderTree = computed(() => buildTree(getRootTreeNode(), new Map()));const rebuildTree = useDebounceFn(() => {- const worksheetsByFolder = new Map<string, Worksheet[]>();- for (const worksheet of sheetList.value) {+ const worksheetsByFolder = new Map<string, WorksheetLikeItem[]>();+ for (const worksheet of sheetLikeItemList.value) {const pwd = getPwdForWorksheet(worksheet);if (!worksheetsByFolder.has(pwd)) {worksheetsByFolder.set(pwd, []);@@ -206,32 +242,42 @@ const useSheetTreeByView = (// Watch only relevant properties: folder structure and worksheet name/folders// No deep watch needed - computed will track changes to name, folders automatically- watch([() => folderContext.folders.value, treeRelevantSheetData], () => {- rebuildTree();- });+ watch(+ [() => folderContext.folders.value, () => sheetLikeItemList.value],+ () => {+ rebuildTree();+ }+ );- const fetchSheetList = async (project: string) => {+ const fetchSheetList = async () => {isLoading.value = true;- const filter = [];- if (project) {- filter.push(`project == "${project}"`);- }try {switch (viewMode) {case "my":- filter.push(`creator == "users/${me.value.email}"`);+ await sheetStore.fetchWorksheetList(+ [+ `project == "${project.value}"`,+ `creator == "users/${me.value.email}"`,+ ].join(" && ")+ );break;case "shared":- filter.push(- `creator != "users/${me.value.email}"`,- `visibility in ["${Worksheet_Visibility[Worksheet_Visibility.PROJECT_READ]}","${Worksheet_Visibility[Worksheet_Visibility.PROJECT_WRITE]}"]`+ await sheetStore.fetchWorksheetList(+ [+ `project == "${project.value}"`,+ `creator != "users/${me.value.email}"`,+ // TODO(ed): do we need the visibility filter?+ // If not provide it, the call will fetch all worksheet with read access.+ `visibility in ["${Worksheet_Visibility[Worksheet_Visibility.PROJECT_READ]}","${Worksheet_Visibility[Worksheet_Visibility.PROJECT_WRITE]}"]`,+ ].join(" && "));break;+ default:+ return;}- await sheetStore.fetchWorksheetList(filter.join(" && "));const folderPathes = new Set<string>([]);- for (const worksheet of sheetList.value) {+ for (const worksheet of sheetLikeItemList.value) {for (const path of getPathesForWorksheet(worksheet)) {folderPathes.add(path);}@@ -251,7 +297,6 @@ const useSheetTreeByView = (isLoading,sheetTree,folderTree,- sheetList,fetchSheetList,folderContext,getKeyForWorksheet,@@ -263,14 +308,16 @@ const useSheetTreeByView = (export type SheetContext = {view: Ref<SheetViewMode>;- views: Record<SheetViewMode, ReturnType<typeof useSheetTreeByView>>;+ viewContexts: Record<SheetViewMode, ReturnType<typeof useSheetTreeByView>>;filter: Ref<WorksheetFilter>;filterChanged: ComputedRef<boolean>;expandedKeys: Ref<Set<string>>;selectedKeys: Ref<string[]>;editingNode: Ref<{ node: WorsheetFolderNode; rawLabel: string } | undefined>;isWorksheetCreator: (worksheet: Worksheet) => boolean;- batchUpdateWorksheetFolders: (worksheets: Worksheet[]) => Promise<void>;+ batchUpdateWorksheetFolders: (+ worksheets: { name: string; folders: string[] }[]+ ) => Promise<void>;};export const KEY = Symbol("bb.sql-editor.sheet") as InjectionKey<SheetContext>;@@ -281,19 +328,19 @@ export const useSheetContext = () => {export const useSheetContextByView = (view: SheetViewMode) => {const context = useSheetContext();- return context.views[view];+ return context.viewContexts[view];};-export const revealWorksheets = (+export const revealWorksheets = <T>(node: WorsheetFolderNode,- callback: (node: WorsheetFolderNode) => Worksheet | undefined-): Worksheet[] => {+ callback: (node: WorsheetFolderNode) => T | undefined+): T[] => {if (node.worksheet) {const worksheet = callback(node);return worksheet ? [worksheet] : [];}- const worksheets: Worksheet[] = [];+ const worksheets: T[] = [];for (const child of node.children) {worksheets.push(...revealWorksheets(child, callback));}@@ -304,6 +351,7 @@ export const provideSheetContext = () => {const me = useCurrentUserV1();const tabStore = useSQLEditorTabStore();const worksheetV1Store = useWorkSheetStore();+ const { project } = storeToRefs(useSQLEditorStore());const initialFilter = computed((): WorksheetFilter => ({@@ -315,7 +363,9 @@ export const provideSheetContext = () => {}));const filter = useDynamicLocalStorage<WorksheetFilter>(- computed(() => `bb.sql-editor.worksheet-filter.${me.value.name}`),+ computed(+ () => `bb.sql-editor.${project.value}.worksheet-filter.${me.value.name}`+ ),{...initialFilter.value,}@@ -324,21 +374,33 @@ export const provideSheetContext = () => {() => !isEqual(filter.value, initialFilter.value));- const views = {+ const viewContexts = {my: useSheetTreeByView("my",- computed(() => filter.value)+ computed(() => filter.value),+ computed(() => project.value)),shared: useSheetTreeByView("shared",- computed(() => filter.value)+ computed(() => filter.value),+ computed(() => project.value)+ ),+ draft: useSheetTreeByView(+ "draft",+ computed(() => filter.value),+ computed(() => project.value)),};const expandedKeys = useDynamicLocalStorage<Set<string>>(- computed(() => `bb.sql-editor.worksheet-tree-expand-keys.${me.value.name}`),+ computed(+ () =>+ `bb.sql-editor.${project.value}.worksheet-tree-expand-keys.${me.value.name}`+ ),new Set([- ...Object.values(views).map((item) => item.folderContext.rootPath.value),+ ...Object.values(viewContexts).map(+ (item) => item.folderContext.rootPath.value+ ),]));const selectedKeys = ref<string[]>([]);@@ -350,32 +412,46 @@ export const provideSheetContext = () => {// Only watch the worksheet name, not the entire tab object// This prevents unnecessary re-runs when tab statement/status/etc changeswatch(- () => tabStore.currentTab?.worksheet,- async (worksheetName) => {+ () => ({+ tabId: tabStore.currentTab?.id,+ worksheetName: tabStore.currentTab?.worksheet,+ }),+ async ({ tabId, worksheetName }) => {selectedKeys.value = [];-- if (!worksheetName) {+ if (!tabId) {return;}- const worksheet = worksheetV1Store.getWorksheetByName(worksheetName);- if (!worksheet) {- return;- }+ let viewMode: SheetViewMode = "draft";+ let worksheetLikeItem: WorksheetLikeItem | undefined;- const isCreator = isWorksheetCreator(worksheet);- const view: SheetViewMode = isCreator ? "my" : "shared";- const viewContext = views[view];+ if (worksheetName) {+ const worksheet = worksheetV1Store.getWorksheetByName(worksheetName);+ if (!worksheet) {+ return;+ }+ worksheetLikeItem = convertToWorksheetLikeItem(worksheet);+ const isCreator = isWorksheetCreator(worksheet);+ viewMode = isCreator ? "my" : "shared";+ } else {+ worksheetLikeItem = {+ name: tabId,+ folders: [],+ title: "", // don't care about the name.+ type: "draft",+ };+ }+ const viewContext = viewContexts[viewMode];if (!viewContext) {return;}- const key = viewContext.getKeyForWorksheet(worksheet);+ const key = viewContext.getKeyForWorksheet(worksheetLikeItem);selectedKeys.value = [key];// Expand all parent folders to make the selected node visible- for (const path of viewContext.getPathesForWorksheet(worksheet)) {+ for (const path of viewContext.getPathesForWorksheet(worksheetLikeItem)) {expandedKeys.value.add(path);}@@ -392,12 +468,14 @@ export const provideSheetContext = () => {{ immediate: true });- const batchUpdateWorksheetFolders = async (worksheets: Worksheet[]) => {+ const batchUpdateWorksheetFolders = async (+ worksheets: { name: string; folders: string[] }[]+ ) => {await worksheetV1Store.batchUpsertWorksheetOrganizers(worksheets.map((worksheet) => ({organizer: {worksheet: worksheet.name,- starred: worksheet.starred,+ starred: false, // don't care about the starredfolders: worksheet.folders,},updateMask: ["folders"],@@ -409,7 +487,7 @@ export const provideSheetContext = () => {expandedKeys,selectedKeys,view: ref("my"),- views,+ viewContexts,filter,filterChanged,isWorksheetCreator,diff --git a/frontend/src/views/sql-editor/Sheet/folder.ts b/frontend/src/views/sql-editor/Sheet/folder.tsindex 60c2dff2c6..5f0a734b24 100644--- a/frontend/src/views/sql-editor/Sheet/folder.ts+++ b/frontend/src/views/sql-editor/Sheet/folder.ts@@ -1,14 +1,19 @@import { sortBy } from "lodash-es";-import { computed } from "vue";+import { type ComputedRef, computed } from "vue";import { useCurrentUserV1 } from "@/store";import { useDynamicLocalStorage } from "@/utils";import type { SheetViewMode } from "./types";-export const useFolderByView = (viewMode: SheetViewMode) => {+export const useFolderByView = (+ viewMode: SheetViewMode,+ project: ComputedRef<string>+) => {const me = useCurrentUserV1();+const rootPath = computed(() => `/${viewMode}`);const localCacheKey = computed(- () => `bb.sql-editor.worksheet-folder.${viewMode}.${me.value.name}`+ () =>+ `bb.sql-editor.${project.value}.worksheet-folder.${viewMode}.${me.value.name}`);const localCache = useDynamicLocalStorage<Set<string>>(localCacheKey,diff --git a/frontend/src/views/sql-editor/Sheet/types.ts b/frontend/src/views/sql-editor/Sheet/types.tsindex 31dfb6f435..ac17d8c9d3 100644--- a/frontend/src/views/sql-editor/Sheet/types.ts+++ b/frontend/src/views/sql-editor/Sheet/types.ts@@ -1,2 +1,2 @@-export const SheetViewModeList = ["my", "shared"] as const;+export const SheetViewModeList = ["my", "shared", "draft"] as const;export type SheetViewMode = (typeof SheetViewModeList)[number];