fix(doris): enable explain plan support

This commit is contained in:
jearhe authored and GitHub committed 2026-09-10 00:28:40 +08:00
1 parent 1663f3633f
commit e2240d4ed1
8 files changed
+193 -9

No files matched your search

@@ -0,0 +1,91 @@
import { createPinia, setActivePinia } from "pinia";
import { beforeEach, describe, expect, it, vi } from "vitest";
import type { QueryResult } from "@/types/database";
const mocks = vi.hoisted(() => ({
buildExplainSql: vi.fn(),
parseExplainResult: vi.fn(),
executeQuery: vi.fn(),
closeClientSession: vi.fn(),
saveOpenTabsState: vi.fn(),
getConfig: vi.fn(),
}));
vi.mock("@/lib/diagram/explainPlan", () => ({
buildExplainSql: mocks.buildExplainSql,
parseExplainResult: mocks.parseExplainResult,
parseDamengExplainText: vi.fn(),
parseOracleExplainText: vi.fn(),
sqlServerExplainResult: vi.fn(),
}));
vi.mock("@/lib/backend/api", () => ({
executeQuery: mocks.executeQuery,
closeClientConnectionSession: mocks.closeClientSession,
saveOpenTabsState: mocks.saveOpenTabsState,
}));
vi.mock("@/stores/connectionStore", () => ({
useConnectionStore: () => ({
getConfig: mocks.getConfig,
recordConnectionLostError: vi.fn(),
}),
}));
vi.mock("@/stores/settingsStore", () => ({
useSettingsStore: () => ({
editorSettings: { pageSize: 100, openTabsRestoreMode: "all", confirmUnsavedSqlClose: false },
}),
}));
function installLocalStorage() {
const data = new Map<string, string>();
vi.stubGlobal("localStorage", {
getItem: vi.fn((key: string) => data.get(key) ?? null),
setItem: vi.fn((key: string, value: string) => data.set(key, value)),
removeItem: vi.fn((key: string) => data.delete(key)),
});
}
const SOURCE_SQL = "SELECT * FROM users";
const EXPLAIN_SQL = "EXPLAIN SELECT * FROM users";
const DORIS_RESULT: QueryResult = {
columns: ["Explain String"],
rows: [["PLAN FRAGMENT 0"], [" 0:VSCAN NODE"]],
affected_rows: 0,
execution_time_ms: 1,
};
const PARSED_PLAN = { databaseType: "doris", raw: "PLAN FRAGMENT 0\n 0:VSCAN NODE", nodes: [] };
describe("queryStore Doris EXPLAIN", () => {
beforeEach(() => {
vi.clearAllMocks();
vi.unstubAllGlobals();
installLocalStorage();
setActivePinia(createPinia());
mocks.getConfig.mockReturnValue({ id: "doris-1", name: "Doris", db_type: "doris", query_timeout_secs: 30 });
mocks.buildExplainSql.mockResolvedValue({ ok: true, sql: EXPLAIN_SQL });
mocks.executeQuery.mockResolvedValue(DORIS_RESULT);
mocks.parseExplainResult.mockReturnValue(PARSED_PLAN);
mocks.closeClientSession.mockResolvedValue(undefined);
mocks.saveOpenTabsState.mockResolvedValue(undefined);
});
it("executes native EXPLAIN and dispatches the text result to the Doris parser", async () => {
const { useQueryStore } = await import("@/stores/queryStore");
const store = useQueryStore();
const tabId = store.createTab("doris-1", "analytics", "Query", "query", "warehouse");
await store.explainTabSql(tabId, SOURCE_SQL, "doris");
expect(mocks.buildExplainSql).toHaveBeenCalledWith("doris", SOURCE_SQL);
expect(mocks.executeQuery).toHaveBeenCalledWith("doris-1", "analytics", EXPLAIN_SQL, "warehouse", expect.any(String), expect.objectContaining({ clientSessionId: `${tabId}:explain` }));
expect(mocks.parseExplainResult).toHaveBeenCalledWith("doris", DORIS_RESULT);
expect(store.tabs.find((tab) => tab.id === tabId)).toMatchObject({
isExplaining: false,
explainPlan: PARSED_PLAN,
explainSql: EXPLAIN_SQL,
explainError: undefined,
});
});
});
+2 -2
View File
@@ -5,7 +5,7 @@ import { useI18n } from "vue-i18n";
import type { BatchSqlExecution, ConnectionConfig, DatabaseType, IndexInfo, NacosConfigEditorViewport, ObjectBrowserViewport, QueryResult, QueryResultSourceColumnRef, QueryTab, TableInfoTab, TableStructureEditorTarget } from "@/types/database";
import { orderPinnedFirst } from "@/lib/app/pinnedItems";
import { canCancelQueryExecution } from "@/lib/sql/queryExecutionState";
import { buildExplainSql, parseExplainResult, parseDamengExplainText, parseOracleExplainText, sqlServerExplainResult, type BuildExplainSqlResult } from "@/lib/diagram/explainPlan";
import { buildExplainSql, parseExplainResult, parseDamengExplainText, parseOracleExplainText, sqlServerExplainResult, type BuildExplainSqlResult, type ExplainPlanDatabaseType } from "@/lib/diagram/explainPlan";
import { mysqlExplainCompatibilityHint } from "@/lib/diagram/mysqlExplainCompatibility";
import { allEditableColumnsWriteable, allPrimaryKeysPresent, analyzeEditableQueryEditability, analyzeSelectStructureForDisplay, resolveMetadataColumnName, resolveSourceColumnsByOrdinal, sourceColumnsForResult, type EditableQueryInfo, type EditableQuerySource } from "@/lib/sql/sqlAnalysis";
import { buildQueryWithHiddenPrimaryKeys, hiddenResultColumnIndexes, type HiddenPrimaryKeyProjection } from "@/lib/sql/editableQueryHiddenKeys";
@@ -7097,7 +7097,7 @@ export const useQueryStore = defineStore("query", () => {
});
const current = tabs.value.find((t) => t.id === id);
if (current?.explainExecutionId === executionId) {
current.explainPlan = parseExplainResult(databaseType as "mysql" | "postgres", result);
current.explainPlan = parseExplainResult(databaseType as ExplainPlanDatabaseType, result);
current.explainError = undefined;
}
} catch (e: any) {