feat(sql-editor): reuse active connection for opened files
Closes #9263
This commit is contained in:
1 parent
0fd1d6108f
commit
5d13c5ecfc
12 files changed
+332
-40
No files matched your search
@@ -1,7 +1,17 @@
|
||||
// @vitest-environment happy-dom
|
||||
|
||||
import { beforeEach, describe, expect, it } from "vitest";
|
||||
import { EXTERNAL_SQL_FILE_TARGETS_STORAGE_KEY, MAX_EXTERNAL_SQL_FILE_TARGETS, forgetExternalSqlFileTarget, moveExternalSqlFileTarget, rememberExternalSqlFileTarget, resolveExternalSqlFileTarget, unassociatedExternalSqlFileTarget } from "@/lib/sql/externalSqlFileTarget";
|
||||
import {
|
||||
activeTabExternalSqlFileTarget,
|
||||
EXTERNAL_SQL_FILE_TARGETS_STORAGE_KEY,
|
||||
MAX_EXTERNAL_SQL_FILE_TARGETS,
|
||||
forgetExternalSqlFileTarget,
|
||||
moveExternalSqlFileTarget,
|
||||
rememberExternalSqlFileTarget,
|
||||
resolveExternalSqlFileTarget,
|
||||
resolveExternalSqlFileTargetForActiveTab,
|
||||
unassociatedExternalSqlFileTarget,
|
||||
} from "@/lib/sql/externalSqlFileTarget";
|
||||
|
||||
describe("external SQL file targets", () => {
|
||||
beforeEach(() => {
|
||||
@@ -18,6 +28,53 @@ describe("external SQL file targets", () => {
|
||||
});
|
||||
});
|
||||
|
||||
it("prefers a remembered target over the active SQL tab", () => {
|
||||
rememberExternalSqlFileTarget("/work/report.sql", { connectionId: "saved-connection", database: "saved_db", catalog: "saved_catalog", schema: "saved_schema" });
|
||||
const tabs = [{ id: "active-tab", connectionId: "active-connection", database: "active_db", catalog: "active_catalog", schema: "active_schema", mode: "query" as const }];
|
||||
|
||||
expect(
|
||||
resolveExternalSqlFileTargetForActiveTab("/work/report.sql", tabs, "active-tab", (connectionId) => {
|
||||
if (connectionId === "saved-connection" || connectionId === "active-connection") return { db_type: "postgres" };
|
||||
return undefined;
|
||||
}),
|
||||
).toEqual({
|
||||
connectionId: "saved-connection",
|
||||
database: "saved_db",
|
||||
catalog: "saved_catalog",
|
||||
schema: "saved_schema",
|
||||
});
|
||||
});
|
||||
|
||||
it("uses the active SQL tab context for a previously unassociated file", () => {
|
||||
const tabs = [{ id: "active-tab", connectionId: "active-connection", database: "analytics", catalog: "hive", schema: "reporting", mode: "query" as const }];
|
||||
|
||||
expect(resolveExternalSqlFileTargetForActiveTab("/work/new.sql", tabs, "active-tab", () => ({ db_type: "postgres" }))).toEqual({
|
||||
connectionId: "active-connection",
|
||||
database: "analytics",
|
||||
catalog: "hive",
|
||||
schema: "reporting",
|
||||
});
|
||||
});
|
||||
|
||||
it("keeps the fallback unassociated without an active tab", () => {
|
||||
const tabs = [{ id: "inactive-tab", connectionId: "sql-connection", database: "analytics", mode: "query" as const }];
|
||||
|
||||
expect(activeTabExternalSqlFileTarget(tabs, null, () => ({ db_type: "postgres" }))).toEqual(unassociatedExternalSqlFileTarget());
|
||||
expect(activeTabExternalSqlFileTarget(tabs, "missing-tab", () => ({ db_type: "postgres" }))).toEqual(unassociatedExternalSqlFileTarget());
|
||||
});
|
||||
|
||||
it.each(["mq", "zookeeper", "plugin", "redis"] as const)("does not reuse a non-SQL %s tab target", (dbType) => {
|
||||
const tabs = [{ id: "active-tab", connectionId: "non-sql-connection", database: "invalid", catalog: "invalid", schema: "invalid", mode: "query" as const }];
|
||||
|
||||
expect(activeTabExternalSqlFileTarget(tabs, "active-tab", () => ({ db_type: dbType }))).toEqual(unassociatedExternalSqlFileTarget());
|
||||
});
|
||||
|
||||
it.each(["plugin-workbench", "plugin-filesystem"] as const)("does not reuse a SQL connection borrowed by a %s tab", (mode) => {
|
||||
const tabs = [{ id: "plugin-tab", connectionId: "sql-connection", database: "invalid", mode }];
|
||||
|
||||
expect(activeTabExternalSqlFileTarget(tabs, "plugin-tab", () => ({ db_type: "postgres" }))).toEqual(unassociatedExternalSqlFileTarget());
|
||||
});
|
||||
|
||||
it("keeps same-named databases in different catalogs distinct", () => {
|
||||
rememberExternalSqlFileTarget("/work/hive.sql", { connectionId: "saved-connection", database: "sales", catalog: "hive" });
|
||||
rememberExternalSqlFileTarget("/work/iceberg.sql", { connectionId: "saved-connection", database: "sales", catalog: "iceberg" });
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
import { normalizeExternalSqlPath } from "@/lib/sql/sqlFileOpen";
|
||||
import { supportsSqlFileExecution } from "@/lib/database/databaseFeatureSupport";
|
||||
import type { ConnectionConfig, QueryTab } from "@/types/database";
|
||||
|
||||
export const EXTERNAL_SQL_FILE_TARGETS_STORAGE_KEY = "dbx-external-sql-file-targets-v1";
|
||||
export const MAX_EXTERNAL_SQL_FILE_TARGETS = 200;
|
||||
@@ -10,10 +12,26 @@ export interface ExternalSqlFileTarget {
|
||||
schema?: string;
|
||||
}
|
||||
|
||||
type ExternalSqlFileTargetTab = Pick<QueryTab, "id" | "connectionId" | "database" | "catalog" | "schema" | "mode">;
|
||||
type ExternalSqlFileTargetConnection = Pick<ConnectionConfig, "db_type">;
|
||||
type ExternalSqlFileConnectionLookup = (connectionId: string) => ExternalSqlFileTargetConnection | undefined;
|
||||
|
||||
export function unassociatedExternalSqlFileTarget(): ExternalSqlFileTarget {
|
||||
return { connectionId: "", database: "", catalog: undefined, schema: undefined };
|
||||
}
|
||||
|
||||
export function activeTabExternalSqlFileTarget(tabs: readonly ExternalSqlFileTargetTab[], activeTabId: string | null | undefined, getConnection: ExternalSqlFileConnectionLookup): ExternalSqlFileTarget {
|
||||
const activeTab = activeTabId ? tabs.find((tab) => tab.id === activeTabId) : undefined;
|
||||
const connection = activeTab?.connectionId ? getConnection(activeTab.connectionId) : undefined;
|
||||
if (!activeTab || activeTab.mode === "plugin-workbench" || activeTab.mode === "plugin-filesystem" || !connection || !supportsSqlFileExecution(connection.db_type)) return unassociatedExternalSqlFileTarget();
|
||||
return {
|
||||
connectionId: activeTab.connectionId,
|
||||
database: activeTab.database,
|
||||
catalog: activeTab.catalog,
|
||||
schema: activeTab.schema,
|
||||
};
|
||||
}
|
||||
|
||||
interface StoredExternalSqlFileTarget extends ExternalSqlFileTarget {
|
||||
path: string;
|
||||
updatedAt: number;
|
||||
@@ -84,3 +102,7 @@ export function resolveExternalSqlFileTarget(path: string, connectionExists: (co
|
||||
if (!saved || !connectionExists(saved.connectionId)) return fallback;
|
||||
return { connectionId: saved.connectionId, database: saved.database, catalog: saved.catalog, schema: saved.schema };
|
||||
}
|
||||
|
||||
export function resolveExternalSqlFileTargetForActiveTab(path: string, tabs: readonly ExternalSqlFileTargetTab[], activeTabId: string | null | undefined, getConnection: ExternalSqlFileConnectionLookup): ExternalSqlFileTarget {
|
||||
return resolveExternalSqlFileTarget(path, (connectionId) => !!getConnection(connectionId), activeTabExternalSqlFileTarget(tabs, activeTabId, getConnection));
|
||||
}
|
||||
Reference in new issue
Block a user