feat(nacos): add access control support

This commit is contained in:
二丫讲梵 authored and GitHub committed 2026-08-16 11:23:53 +08:00
1 parent 1838a4726e
commit c63c517b4f
67 files changed
+9062 -135

No files matched your search

@@ -626,7 +626,10 @@ const filteredNodes = computed(() => {
nodes = filterGloballyIndexedRegexTables(nodes);
const q = deferredSearchQuery.value;
nodes = filterSidebarTree(nodes, q, searchCollapsedIds.value, searchableNodeTypes.value, { regexMode: regexMode.value });
nodes = filterSidebarTree(nodes, q, searchCollapsedIds.value, searchableNodeTypes.value, {
regexMode: regexMode.value,
resolveLabel: (node) => (node.type === "nacos-access-control" ? t("nacos.accessControlSidebarLabel") : node.label),
});
if (q && !regexMode.value) {
nodes = filterSidebarSearchRootsByConnectionState(nodes, store.connectedIds);
}
@@ -101,7 +101,7 @@ import {
usesTreeSchemaMode,
isSingleDatabase,
} from "@/lib/database/databaseCapabilities";
import { copyDisplayPathForTreeNode, copyNameForTreeNode, isDirectNavigationTreeNode, isDocumentBrowserTreeNode, objectSourceTargetForTreeNode, shouldRunTreeNodeRowAction, treeNodeRowAction, treeNodeRowDoubleClickAction } from "@/lib/sidebar/treeNodeClick";
import { copyDisplayPathForTreeNode, copyNameForTreeNode, isDirectNavigationTreeNode, isDocumentBrowserTreeNode, isRepeatableNavigationTreeNode, objectSourceTargetForTreeNode, shouldRunTreeNodeRowAction, treeNodeRowAction, treeNodeRowDoubleClickAction } from "@/lib/sidebar/treeNodeClick";
import { customTypeCapabilities, supportsTypeObjectSource } from "@/lib/database/databaseObjectCapabilities";
import { mongoCollectionTableTypeFromNode, mongoDropIndexFailureCount } from "@/lib/sidebar/mongoCollectionMutation";
import { dataTabOpenModeFromTreeClick, type DataTabOpenMode } from "@/lib/sidebar/dataTabOpenPolicy";
@@ -313,6 +313,16 @@ const props = defineProps<{
const activeNode = shallowRef<TreeNode>(props.node);
let acceptedSelectionIds: readonly string[] | null = null;
let latestNavigationRequestId = 0;
function beginNavigationRequest(): number {
latestNavigationRequestId += 1;
return latestNavigationRequestId;
}
function isCurrentNavigationRequest(requestId: number): boolean {
return requestId === latestNavigationRequestId;
}
function releaseActiveNodeReference(nodeIds: readonly string[]) {
activeNode.value = releaseRemovedSidebarActionTarget(activeNode.value, nodeIds);
@@ -599,25 +609,32 @@ function isGroupLabel(node: TreeNode): boolean {
return groupTypes.has(node.type);
}
async function openDirectNavigationNode(node: TreeNode) {
async function openDirectNavigationNode(node: TreeNode, requestId: number) {
if (!node.connectionId) return;
await connectionStore.ensureConnected(node.connectionId);
const connectionName = connectionStore.getConfig(node.connectionId)?.name || "Consul";
const isNacosNavigation = node.type === "nacos-namespace" || node.type === "nacos-access-control";
await connectionStore.ensureConnected(node.connectionId, isNacosNavigation ? { verifyHealth: false } : undefined);
if (!isCurrentNavigationRequest(requestId)) return;
const connectionName = connectionStore.getConfig(node.connectionId)?.name || (isNacosNavigation ? "Nacos" : "Consul");
if (node.type === "consul-root") {
queryStore.createTab(node.connectionId, "", `${connectionName}:keys`, "consul");
refreshActiveKvBrowserAfterOpen("consul", node.connectionId);
} else if (node.type === "consul-overview") {
queryStore.createTab(node.connectionId, "", `${connectionName}:${t("consul.ui.overview")}`, "consul-overview");
} else if (node.type === "nacos-namespace") {
queryStore.openNacosAdmin(node.connectionId, { namespace: node.nacosNamespace || "", namespaceName: node.nacosNamespaceName || node.label });
} else if (node.type === "nacos-access-control") {
queryStore.createTab(node.connectionId, "", `${connectionName}:access-control`, "nacos-access-control");
}
}
async function toggle() {
async function toggle(requestId = beginNavigationRequest()) {
const node = activeNode.value;
const treeLoadSearchOptions = sidebarTreeContext?.getTreeLoadSearchOptions?.(node);
if (isDirectNavigationTreeNode(node.type)) {
try {
await openDirectNavigationNode(node);
await openDirectNavigationNode(node, requestId);
} catch (e: any) {
if (!isCurrentNavigationRequest(requestId)) return;
const errMsg = e?.message || String(e);
if (errMsg.includes(CONNECTION_ATTEMPT_CANCELLED_MESSAGE)) return;
toast(t("connection.connectFailed", { message: translateBackendError(t, e) }), 5000);
@@ -764,9 +781,6 @@ async function toggle() {
await connectionStore.ensureConnected(node.connectionId);
const topicFromId = node.id.endsWith(":mqtt-topic:__console__") ? undefined : node.id.split(":mqtt-topic:")[1] || node.label;
queryStore.openMqttAdmin(node.connectionId, topicFromId ? { initialTopic: topicFromId } : undefined);
} else if (node.type === "nacos-namespace" && node.connectionId) {
await connectionStore.ensureConnected(node.connectionId);
queryStore.openNacosAdmin(node.connectionId, { namespace: node.nacosNamespace || "", namespaceName: node.nacosNamespaceName || node.label });
} else if (node.type === "etcd-root" && node.connectionId) {
await connectionStore.ensureConnected(node.connectionId);
const tabTitle = `${connectionStore.getConfig(node.connectionId)?.name || "etcd"}:keys`;
@@ -872,6 +886,7 @@ async function toggle() {
}
emitNodeToggled(node, wasExpanded);
} catch (e: any) {
if (!isCurrentNavigationRequest(requestId)) return;
if (!wasExpanded) node.isExpanded = false;
const errMsg = e?.message || String(e);
if (errMsg.includes(CONNECTION_ATTEMPT_CANCELLED_MESSAGE)) return;
@@ -880,7 +895,7 @@ async function toggle() {
}
}
function runRowClickAction(clickDetail: number) {
function runRowClickAction(clickDetail: number, requestId: number) {
const node = activeNode.value;
if (node.type === "load-more") {
if (clickDetail > 1) return;
@@ -897,7 +912,10 @@ function runRowClickAction(clickDetail: number) {
return;
}
const action = treeNodeRowAction(node.type, canExpand.value, settingsStore.editorSettings.sidebarActivation, currentDatabaseType(), settingsStore.editorSettings.sidebarOpenDatabaseOnSingleClick, canOpenObjectBrowser.value);
if (!shouldRunTreeNodeRowAction(action, clickDetail, isGroupLabel(node))) return;
// WebKit can keep incrementing click.detail while the pointer moves quickly
// between adjacent rows. Nacos entries are idempotent navigation targets, so
// do not mistake that rapid one-click switching for a double-click toggle.
if (!shouldRunTreeNodeRowAction(action, clickDetail, isGroupLabel(node) || isRepeatableNavigationTreeNode(node.type))) return;
if (action === "open-data") {
scheduleOpenData(node);
} else if (action === "open-object-browser") {
@@ -914,7 +932,7 @@ function runRowClickAction(clickDetail: number) {
} else if (isDocumentBrowserTreeNode(node.type)) {
openMongoTreeData(node);
} else if (action === "toggle") {
toggle();
void toggle(requestId);
}
}
@@ -4811,7 +4829,7 @@ function buildSpecialSidebarMenu(context: SidebarMenuFactoryContext): boolean {
return true;
}
if (node.type === "etcd-root" || node.type === "etcd-dashboard" || node.type === "etcd-access-control" || node.type === "zookeeper-root" || node.type === "consul-root" || node.type === "consul-overview") {
if (node.type === "nacos-access-control" || node.type === "etcd-root" || node.type === "etcd-dashboard" || node.type === "etcd-access-control" || node.type === "zookeeper-root" || node.type === "consul-root" || node.type === "consul-overview") {
items.push({ label: t("contextMenu.openConnection"), action: toggle, icon: Database });
return true;
}
@@ -5398,16 +5416,19 @@ function buildContextMenu(node: TreeNode): ContextMenuItem[] {
}
function handleRowClick(node: TreeNode, clickDetail: number) {
const requestId = beginNavigationRequest();
activateRuntimeNode(node);
runRowClickAction(clickDetail);
runRowClickAction(clickDetail, requestId);
}
function handleRowDoubleClick(node: TreeNode, event: MouseEvent) {
beginNavigationRequest();
activateRuntimeNode(node);
onDoubleClick(event);
}
function handleRowKeydown(node: TreeNode, event: KeyboardEvent) {
beginNavigationRequest();
activateRuntimeNode(node);
onKeydown(event);
}
@@ -5439,7 +5460,7 @@ function requestPaste(node: TreeNode): boolean {
function toggleNode(node: TreeNode) {
activateRuntimeNode(node);
void toggle();
void toggle(beginNavigationRequest());
}
defineExpose({
@@ -282,6 +282,8 @@ function getIconInfo(node: TreeNode): { icon: any; colorClass: string } | null {
return { icon: FolderOpen, colorClass: "text-sky-400" };
case "nacos-namespace":
return { icon: FolderOpen, colorClass: "text-sky-500" };
case "nacos-access-control":
return { icon: ShieldCheck, colorClass: "text-sky-500" };
case "etcd-root":
return { icon: Database, colorClass: "text-sky-500" };
case "etcd-dashboard":
@@ -364,6 +366,9 @@ function isGroupLabel(node: TreeNode): boolean {
function displayLabel(node: TreeNode): string {
if (node.type === "load-more") return t(node.label);
if (node.type === "object-browser") return t(node.label, { count: node.objectCount ?? 0 });
// Use the canonical key for persisted trees created before this label was
// internationalized; those nodes may still contain the old Chinese text.
if (node.type === "nacos-access-control") return t("nacos.accessControlSidebarLabel");
if (node.type === "user-admin" || node.type === "dameng-users" || node.type === "dameng-roles" || node.type === "dameng-job-admin") return t(node.label);
if (node.type === "linked-server-root") return t(node.label);
if (node.type === "saved-sql-root") return t(node.label);
@@ -7,7 +7,7 @@ import { Dialog, DialogContent, DialogFooter, DialogHeader, DialogTitle } from "
import { Input } from "@/components/ui/input";
import { useConnectionStore } from "@/stores/connectionStore";
import * as api from "@/lib/backend/api";
import { normalizeNacosNamespaceSelection, normalizeNacosNamespacesForDisplay } from "@/lib/nacos/nacosNamespaceVisibility";
import { loadReadableNacosNamespaces, normalizeNacosNamespaceSelection } from "@/lib/nacos/nacosNamespaceVisibility";
import type { NacosNamespaceInfo } from "@/types/nacos";
const props = defineProps<{
@@ -65,7 +65,7 @@ async function loadNamespaces() {
searchText.value = "";
try {
await connectionStore.ensureConnected(props.connectionId);
const fetched = normalizeNacosNamespacesForDisplay(await api.nacosListNamespaces(props.connectionId));
const fetched = await loadReadableNacosNamespaces(props.connectionId, api);
namespaces.value = [...fetched].sort((left, right) => nacosNamespaceLabel(left).localeCompare(nacosNamespaceLabel(right)));
connectionStore.recordPrimaryVisibleObjectNames(props.connectionId, namespaces.value.map(nacosNamespaceValue));
const configured = connection.value?.visible_databases;
@@ -13,7 +13,8 @@ const connectionStore = {
sidebarSearchQuery: "",
canUseLoadedTreeNodeToggle: vi.fn(() => true),
releaseCollapsedTreeNodeChildren: vi.fn(),
getConfig: vi.fn(() => ({ db_type: "mysql" })),
getConfig: vi.fn(() => ({ db_type: "mysql", name: "connection" })),
ensureConnected: vi.fn(async () => undefined),
loadPackageMembers: vi.fn(async (node: TreeNode) => {
node.isExpanded = true;
}),
@@ -22,13 +23,18 @@ const connectionStore = {
}),
};
const queryStore = {
createTab: vi.fn(),
openNacosAdmin: vi.fn(),
};
vi.mock("@/stores/connectionStore", () => ({
CONNECTION_ATTEMPT_CANCELLED_MESSAGE: "connection attempt cancelled",
useConnectionStore: () => connectionStore,
}));
vi.mock("@/stores/queryStore", () => ({ useQueryStore: () => ({}) }));
vi.mock("@/stores/settingsStore", () => ({ useSettingsStore: () => ({ editorSettings: {} }) }));
vi.mock("@/stores/queryStore", () => ({ useQueryStore: () => queryStore }));
vi.mock("@/stores/settingsStore", () => ({ useSettingsStore: () => ({ editorSettings: { sidebarActivation: "single" } }) }));
vi.mock("@/stores/savedSqlStore", () => ({ useSavedSqlStore: () => ({}) }));
vi.mock("@/composables/useToast", () => ({ useToast: () => ({ toast: vi.fn() }) }));
vi.mock("@/composables/useSqlHighlighter", () => ({ useSqlHighlighter: () => ({ highlight: vi.fn() }) }));
@@ -49,7 +55,7 @@ afterEach(() => {
connectionStore.sidebarSearchQuery = "";
vi.clearAllMocks();
connectionStore.canUseLoadedTreeNodeToggle.mockReturnValue(true);
connectionStore.getConfig.mockReturnValue({ db_type: "mysql" });
connectionStore.getConfig.mockReturnValue({ db_type: "mysql", name: "connection" });
});
describe("SidebarTreeRuntimeHost expansion", () => {
@@ -122,6 +128,70 @@ describe("SidebarTreeRuntimeHost expansion", () => {
expect(toggled).toHaveBeenCalledWith(packageNode, true);
});
it("keeps the latest Nacos navigation click when connection checks finish out of order", async () => {
let resolveNamespaceConnection!: () => void;
let resolveAccessControlConnection!: () => void;
const namespaceConnection = new Promise<void>((resolve) => {
resolveNamespaceConnection = resolve;
});
const accessControlConnection = new Promise<void>((resolve) => {
resolveAccessControlConnection = resolve;
});
connectionStore.ensureConnected.mockImplementationOnce(() => namespaceConnection).mockImplementationOnce(() => accessControlConnection);
connectionStore.getConfig.mockReturnValue({ db_type: "nacos", name: "local-nacos-v2" });
const namespaceNode: TreeNode = {
id: "nacos:nacos-namespace:public",
label: "public",
type: "nacos-namespace",
connectionId: "nacos",
nacosNamespace: "",
nacosNamespaceName: "public",
};
const accessControlNode: TreeNode = {
id: "nacos:nacos-access-control",
label: "nacos.accessControlSidebarLabel",
type: "nacos-access-control",
connectionId: "nacos",
// Persisted/reused tree state must not turn an application entry point
// back into a generic expand/collapse action on the first click.
isExpanded: true,
children: [],
};
connectionStore.treeNodes = [namespaceNode, accessControlNode];
const host = ref<InstanceType<typeof SidebarTreeRuntimeHost> | null>(null);
const app = createApp(
defineComponent({
setup: () => () => h(SidebarTreeRuntimeHost, { ref: host, node: namespaceNode, depth: 0 }),
}),
);
mountedApps.push(app);
const container = document.createElement("div");
document.body.append(container);
app.use(i18n);
app.mount(container);
await nextTick();
expect(host.value).not.toBeNull();
host.value!.handleRowClick(namespaceNode, 1);
host.value!.handleRowClick(accessControlNode, 1);
await vi.waitFor(() => expect(connectionStore.ensureConnected).toHaveBeenCalledTimes(2));
expect(connectionStore.ensureConnected).toHaveBeenNthCalledWith(1, "nacos", { verifyHealth: false });
expect(connectionStore.ensureConnected).toHaveBeenNthCalledWith(2, "nacos", { verifyHealth: false });
resolveAccessControlConnection();
await vi.waitFor(() => expect(queryStore.createTab).toHaveBeenCalledWith("nacos", "", "local-nacos-v2:access-control", "nacos-access-control"));
expect(accessControlNode.isExpanded).toBe(true);
resolveNamespaceConnection();
await namespaceConnection;
await nextTick();
expect(queryStore.openNacosAdmin).not.toHaveBeenCalled();
});
it("expands an unloaded object group without leaking the regex source as a search filter", async () => {
const group: TreeNode = {
id: "mysql:basic:__tables",
@@ -0,0 +1,11 @@
import { readFileSync } from "node:fs";
import { describe, expect, it } from "vitest";
const source = readFileSync(new URL("../VisibleNacosNamespacesDialog.vue", import.meta.url), "utf8");
describe("VisibleNacosNamespacesDialog", () => {
it("offers only namespaces readable by the current Nacos connection", () => {
expect(source).toContain("loadReadableNacosNamespaces(props.connectionId, api)");
expect(source).toContain("recordPrimaryVisibleObjectNames(props.connectionId, namespaces.value.map(nacosNamespaceValue))");
});
});