Files
dbx/apps/desktop/src/lib/__tests__/sql/sqlNavigation.spec.ts
T

378 lines
17 KiB
TypeScript
Vendored

import { describe, expect, it } from "vitest";
import { quoteIdentifier } from "@/lib/editor/hoverTableSql";
import { tokenIsIdentifier, tokenizeSqlSemantic, unquoteSqlSemanticIdentifier } from "@/lib/sql/semantic/tokens";
import {
extractIdentifierAt,
extractIdentifierDetailsAt,
extractQualifiedIdentifierAt,
isSqlCallSiteIdentifierAt,
isSqlKeyword,
isSqlObjectNavigationRoutineType,
isSqlRelationColumnListContext,
isSqlRoutineCallNavigationCandidate,
matchSqlObject,
matchTable,
mergeSqlObjectNavigationType,
normalizeOracleNavigationIdentityName,
normalizeOracleNavigationTarget,
resolveSqlObjectNavigationIdentity,
splitQualifiedIdentifier,
sqlObjectHoverDetail,
sqlObjectNavigationSourceKind,
sqlObjectNavigationSourceName,
sqlObjectNavigationSourceSchema,
sqlObjectNavigationTableType,
sqlObjectNavigationTarget,
sqlObjectNavigationTargetFromIdentifier,
sqlObjectNavigationTargetFromIdentity,
sqlObjectNavigationTypeFromCompletionObjectType,
sqlObjectNavigationTypeFromTableType,
} from "@/lib/sql/sqlNavigation";
describe("extractIdentifierAt", () => {
it("extracts unquoted qualified identifiers", () => {
const sql = "select * from MAAC00.Accounts";
expect(extractIdentifierAt(sql, sql.indexOf("Accounts"))).toBe("MAAC00.Accounts");
});
it("extracts backtick-quoted qualified identifiers", () => {
const sql = "select * from `MAAC00`.Accounts";
expect(extractIdentifierAt(sql, sql.indexOf("Accounts"))).toBe("MAAC00.Accounts");
expect(extractIdentifierAt(sql, sql.indexOf("MAAC00"))).toBe("MAAC00.Accounts");
});
it("preserves quote metadata for quoted keyword identifiers", () => {
const sql = "SELECT * FROM `group` LIMIT 100;";
expect(extractIdentifierDetailsAt(sql, sql.indexOf("group"))).toEqual({
identifier: "group",
quoted: true,
});
expect(matchTable(extractIdentifierAt(sql, sql.indexOf("group")) ?? "", [{ name: "group" }])).toEqual({ name: "group" });
});
it("marks unquoted keyword identifiers as unquoted", () => {
const sql = "SELECT dept, COUNT(*) FROM users GROUP BY dept;";
const extracted = extractIdentifierDetailsAt(sql, sql.indexOf("GROUP"));
expect(extracted).toEqual({
identifier: "GROUP",
quoted: false,
});
expect(extracted && isSqlKeyword(extracted.identifier)).toBe(true);
});
it("extracts double-quoted qualified identifiers", () => {
const sql = 'select * from "MAAC00"."Accounts"';
expect(extractIdentifierAt(sql, sql.indexOf("Accounts"))).toBe("MAAC00.Accounts");
});
});
describe("splitQualifiedIdentifier", () => {
it("splits quoted and multi-part identifiers", () => {
expect(splitQualifiedIdentifier('catalog."MAAC00".Accounts')).toEqual(["catalog", "MAAC00", "Accounts"]);
expect(splitQualifiedIdentifier("`MAAC00`.Accounts")).toEqual(["MAAC00", "Accounts"]);
});
});
describe("extractQualifiedIdentifierAt", () => {
it("keeps the full quoted segment when it contains a hyphen", () => {
const sql = 'select * from log."public-rate_kingdee"';
const located = extractQualifiedIdentifierAt(sql, sql.indexOf("rate_kingdee"));
expect(located?.parts.map((part) => part.value)).toEqual(["log", "public-rate_kingdee"]);
});
it("re-quoting each part before rejoining survives a splitQualifiedIdentifier round trip", () => {
const sql = 'select * from log."public-rate_kingdee"';
const located = extractQualifiedIdentifierAt(sql, sql.indexOf("rate_kingdee"));
const requoted = located!.parts.map((part) => quoteIdentifier(part.value)).join(".");
expect(splitQualifiedIdentifier(requoted)).toEqual(["log", "public-rate_kingdee"]);
});
it("extracts unquoted Unicode identifiers (e.g. CJK CTE names and columns)", () => {
const sql = "WITH 窗口函数 AS (SELECT * FROM TABLENAME) SELECT 字段 FROM 窗口函数";
expect(extractIdentifierAt(sql, sql.indexOf("窗口函数", sql.indexOf("SELECT")))).toBe("窗口函数");
const outerReference = extractQualifiedIdentifierAt(sql, sql.lastIndexOf("窗口函数"));
expect(outerReference?.parts.map((part) => part.value)).toEqual(["窗口函数"]);
const mixed = "SELECT t.中文名 FROM orders t";
expect(extractQualifiedIdentifierAt(mixed, mixed.indexOf("中文名"))?.parts.map((part) => part.value)).toEqual(["t", "中文名"]);
});
it("keeps digits as continuation characters of Unicode identifiers", () => {
const sql = "select 字段1 from t";
expect(extractIdentifierAt(sql, sql.indexOf("1"))).toBe("字段1");
});
});
describe("matchTable", () => {
it("matches schema-qualified table identifiers", () => {
const table = { schema: "MAAC00", name: "Accounts", type: "view" as const };
expect(matchTable("maac00.accounts", [table])).toBe(table);
expect(matchTable("maac00.accounts", [table])?.type).toBe("view");
});
it("matches catalog.schema.table identifiers against schema-scoped tables", () => {
const table = { schema: "MAAC00", name: "Accounts" };
expect(matchTable("catalog.maac00.accounts", [table])).toBe(table);
});
it("uses the database qualifier when scoped tables provide it", () => {
const databaseA = { database: "DatabaseA", schema: "OUT", name: "orders" };
const databaseB = { database: "DatabaseB", schema: "OUT", name: "orders" };
expect(matchTable("[DatabaseB].[OUT].[orders]", [databaseA, databaseB])).toBe(databaseB);
});
it("matches quoted schema-qualified table identifiers", () => {
const table = { schema: "MAAC00", name: "Accounts" };
expect(matchTable("`MAAC00`.Accounts", [table])).toBe(table);
});
it("does not treat non-schema qualifiers as table matches", () => {
expect(matchTable("u.users", [{ schema: "public", name: "users" }])).toBeNull();
});
});
describe("SQL object navigation metadata", () => {
it("preserves view type and schema for command-click navigation", () => {
expect(sqlObjectNavigationTarget({ name: "active_users", database: "app", schema: "dbo", type: "view" })).toEqual({
name: "active_users",
database: "app",
schema: "dbo",
type: "view",
});
});
it("preserves procedure package-member metadata for command-click navigation", () => {
expect(
sqlObjectNavigationTarget({
name: "CALC_TAX",
schema: "HR",
type: "procedure",
parentName: "PAYROLL",
parentSchema: "HR",
signature: "CALC_TAX(p NUMBER)",
}),
).toEqual({
name: "CALC_TAX",
schema: "HR",
type: "procedure",
parentName: "PAYROLL",
parentSchema: "HR",
signature: "CALC_TAX(p NUMBER)",
});
});
it("uses the object type in hover details", () => {
expect(sqlObjectHoverDetail({ name: "active_users", schema: "dbo", type: "view" })).toBe("view in dbo");
expect(sqlObjectHoverDetail({ name: "active_users_mv", schema: "dbo", type: "materialized_view" })).toBe("materialized view in dbo");
expect(sqlObjectHoverDetail({ name: "users", schema: "dbo", type: "table" })).toBe("table in dbo");
expect(sqlObjectHoverDetail({ name: "calc_tax", schema: "hr", type: "procedure" })).toBe("procedure in hr");
expect(sqlObjectHoverDetail({ name: "calc_tax", type: "procedure", parentName: "payroll", parentSchema: "hr" })).toBe("procedure in hr.payroll");
});
it("maps navigation types to table metadata types", () => {
expect(sqlObjectNavigationTableType({ name: "active_users", type: "view" })).toBe("VIEW");
expect(sqlObjectNavigationTableType({ name: "active_users_mv", type: "materialized_view" })).toBe("MATERIALIZED_VIEW");
expect(sqlObjectNavigationTableType({ name: "users", type: "table" })).toBe("TABLE");
expect(sqlObjectNavigationSourceKind({ name: "active_users", type: "view" })).toBe("VIEW");
expect(sqlObjectNavigationSourceKind({ name: "active_users_mv", type: "materialized_view" })).toBe("MATERIALIZED_VIEW");
expect(sqlObjectNavigationSourceKind({ name: "users", type: "table" })).toBeUndefined();
expect(sqlObjectNavigationSourceKind({ name: "calc_tax", type: "procedure" })).toBe("PROCEDURE");
expect(sqlObjectNavigationSourceKind({ name: "get_version", type: "function" })).toBe("FUNCTION");
expect(sqlObjectNavigationSourceKind({ name: "pkg_utils", type: "package" })).toBe("PACKAGE");
// Package members open the owning package body source.
expect(sqlObjectNavigationSourceKind({ name: "calc_tax", type: "procedure", parentName: "payroll" })).toBe("PACKAGE_BODY");
expect(sqlObjectNavigationSourceName({ name: "calc_tax", type: "procedure", parentName: "payroll" })).toBe("payroll");
expect(sqlObjectNavigationSourceSchema({ name: "calc_tax", type: "procedure", parentName: "payroll", parentSchema: "hr" }, "app")).toBe("hr");
expect(isSqlObjectNavigationRoutineType("procedure")).toBe(true);
expect(isSqlObjectNavigationRoutineType("table")).toBe(false);
});
it("normalizes relation metadata without collapsing materialized views", () => {
expect(sqlObjectNavigationTypeFromTableType("BASE TABLE")).toBe("table");
expect(sqlObjectNavigationTypeFromTableType("VIEW")).toBe("view");
expect(sqlObjectNavigationTypeFromTableType("materialized view")).toBe("materialized_view");
expect(sqlObjectNavigationTypeFromTableType("PROCEDURE")).toBe("procedure");
expect(sqlObjectNavigationTypeFromCompletionObjectType("function")).toBe("function");
expect(mergeSqlObjectNavigationType("view", "materialized_view")).toBe("materialized_view");
expect(mergeSqlObjectNavigationType("table", "view")).toBe("view");
expect(mergeSqlObjectNavigationType("table", "procedure")).toBe("procedure");
});
});
describe("matchSqlObject", () => {
it("matches unqualified standalone procedures before package members", () => {
const standalone = { name: "CALC_TAX", schema: "HR", type: "procedure" as const };
const packaged = { name: "CALC_TAX", schema: "HR", parentName: "PAYROLL", type: "procedure" as const };
expect(matchSqlObject("calc_tax", [packaged, standalone])).toBe(standalone);
});
it("matches schema-qualified procedures", () => {
const procedure = { name: "CALC_TAX", schema: "HR", type: "procedure" as const };
expect(matchSqlObject("hr.calc_tax", [procedure])).toBe(procedure);
expect(matchSqlObject("other.calc_tax", [procedure])).toBeNull();
});
it("matches package members as package.proc and schema.package.proc", () => {
const member = { name: "CALC_TAX", schema: "HR", parentName: "PAYROLL", parentSchema: "HR", type: "procedure" as const };
expect(matchSqlObject("payroll.calc_tax", [member])).toBe(member);
expect(matchSqlObject("hr.payroll.calc_tax", [member])).toBe(member);
});
});
describe("call-site navigation helpers", () => {
it("detects procedure call sites after the identifier", () => {
const sql = "BEGIN\n PROC_STATIC_DATA_IMPORT()\nEND;";
const pos = sql.indexOf("PROC_STATIC_DATA_IMPORT") + 3;
expect(isSqlCallSiteIdentifierAt(sql, pos)).toBe(true);
expect(isSqlRoutineCallNavigationCandidate(sql, pos)).toBe(true);
expect(isSqlCallSiteIdentifierAt("SELECT * FROM users", "SELECT * FROM users".indexOf("users"))).toBe(false);
});
it("does not treat INSERT INTO relation(column list) as a routine call", () => {
const sql = "INSERT INTO ORDERS(ID, AMT) VALUES (1, 2);";
const pos = sql.indexOf("ORDERS") + 2;
expect(isSqlCallSiteIdentifierAt(sql, pos)).toBe(true);
expect(isSqlRelationColumnListContext(sql.slice(0, sql.indexOf("ORDERS")))).toBe(true);
expect(isSqlRoutineCallNavigationCandidate(sql, pos)).toBe(false);
const identity = resolveSqlObjectNavigationIdentity(sql, pos);
expect(identity?.role).toBe("relation_column_list");
expect(identity?.name).toBe("ORDERS");
});
it("does not treat CREATE TABLE column lists as routine calls", () => {
const sql = "CREATE TABLE ORDERS(id number);";
const pos = sql.indexOf("ORDERS") + 1;
expect(isSqlRoutineCallNavigationCandidate(sql, pos)).toBe(false);
expect(resolveSqlObjectNavigationIdentity(sql, pos)?.role).toBe("relation_column_list");
});
it("builds optimistic targets preferring package.member for ambiguous two-part calls", () => {
const sql = "BEGIN\n PAYROLL.CALC_TAX();\nEND;";
const identity = resolveSqlObjectNavigationIdentity(sql, sql.indexOf("CALC_TAX"));
expect(identity?.role).toBe("routine_call");
expect(identity?.twoPartAmbiguous).toBe(true);
expect(sqlObjectNavigationTargetFromIdentity(identity!, { fallbackSchema: "APP" })).toEqual({
name: "CALC_TAX",
schema: "APP",
parentName: "PAYROLL",
parentSchema: "APP",
type: "procedure",
});
// Metadata can force schema.routine when confirmed.
expect(sqlObjectNavigationTargetFromIdentity(identity!, { asSchemaRoutine: true })).toEqual({
name: "CALC_TAX",
schema: "PAYROLL",
type: "procedure",
});
});
it("builds three-part package member targets", () => {
const sql = "BEGIN\n HR.PAYROLL.CALC_TAX();\nEND;";
const identity = resolveSqlObjectNavigationIdentity(sql, sql.indexOf("CALC_TAX"));
expect(sqlObjectNavigationTargetFromIdentity(identity!)).toEqual({
name: "CALC_TAX",
schema: "HR",
parentName: "PAYROLL",
parentSchema: "HR",
type: "procedure",
});
});
it("preserves quoted mixed-case identities for Oracle normalization", () => {
const sql = 'BEGIN\n "MiXeDProc"();\nEND;';
const identity = resolveSqlObjectNavigationIdentity(sql, sql.indexOf("MiXeD") + 1);
expect(identity?.name).toBe("MiXeDProc");
expect(identity?.nameQuoted).toBe(true);
expect(normalizeOracleNavigationIdentityName(identity!.name, identity!.nameQuoted)).toBe("MiXeDProc");
expect(normalizeOracleNavigationIdentityName("mixedproc", false)).toBe("MIXEDPROC");
const target = sqlObjectNavigationTargetFromIdentity(identity!, { fallbackSchema: "APP" });
expect(normalizeOracleNavigationTarget(target!)).toEqual({
name: "MiXeDProc",
nameQuoted: true,
schema: "APP",
type: "procedure",
});
});
it("preserves quoted package.member mixed-case identities", () => {
const sql = 'BEGIN\n "Pkg"."Member"();\nEND;';
const identity = resolveSqlObjectNavigationIdentity(sql, sql.indexOf("Member"));
expect(identity?.name).toBe("Member");
expect(identity?.nameQuoted).toBe(true);
expect(identity?.qualifier).toBe("Pkg");
expect(identity?.qualifierQuoted).toBe(true);
const target = normalizeOracleNavigationTarget(sqlObjectNavigationTargetFromIdentity(identity!, { fallbackSchema: "APP", asPackageMember: true })!);
expect(target).toEqual({
name: "Member",
nameQuoted: true,
schema: "APP",
parentName: "Pkg",
parentNameQuoted: true,
parentSchema: "APP",
type: "procedure",
});
});
it("keeps legacy string helper for simple identifiers", () => {
expect(sqlObjectNavigationTargetFromIdentifier("PROC_STATIC_DATA_IMPORT", { fallbackSchema: "APP" })).toEqual({
name: "PROC_STATIC_DATA_IMPORT",
schema: "APP",
type: "procedure",
});
});
});
describe("标识符提取的字符边界", () => {
it("支持 @ / # / $ 作为标识符首字符", () => {
const sql = "select @var, #tmp, $col from t";
expect(extractIdentifierAt(sql, sql.indexOf("@var"))).toBe("@var");
expect(extractIdentifierAt(sql, sql.indexOf("#tmp"))).toBe("#tmp");
expect(extractIdentifierAt(sql, sql.indexOf("$col"))).toBe("$col");
});
it("数字开头的片段不被当作标识符(只识别其后的字母段)", () => {
const sql = "select 1abc from t";
expect(extractIdentifierAt(sql, sql.indexOf("1abc"))).toBeNull();
expect(extractIdentifierAt(sql, sql.indexOf("abc"))).toBe("abc");
});
it("引号包裹的中文标识符去掉引号并标记 quoted", () => {
const sql = 'select "中文列" from "订单表"';
const details = extractIdentifierDetailsAt(sql, sql.indexOf("中文列"));
expect(details?.identifier).toBe("中文列");
expect(details?.quoted).toBe(true);
expect(extractQualifiedIdentifierAt(sql, sql.indexOf("订单表"))?.parts).toEqual([{ value: "订单表", quoted: true }]);
});
it("对含中文/变量前缀的 SQL,逐 token 还原结果与语义分词器一致", () => {
const sql = "with 汇总 as (select 字段1, @变量 from t1) select 字段1 from 汇总";
const tokens = tokenizeSqlSemantic(sql);
const identifiers = tokens.filter((token) => tokenIsIdentifier(token));
expect(identifiers.map((token) => token.text)).toEqual(expect.arrayContaining(["汇总", "字段1", "@变量"]));
for (const token of identifiers) {
expect(extractIdentifierAt(sql, token.span.start)).toBe(unquoteSqlSemanticIdentifier(token));
}
});
});