feat(structure): show comments and defaults in copy-fields dialog

This commit is contained in:
zipg authored and GitHub committed 2026-09-20 18:25:31 +08:00
1 parent dc399624c3
commit 1ef865008a
6 files changed
+99 -8

No files matched your search

@@ -4,6 +4,7 @@ import {
cloneColumnDraftAsNew,
combineDataTypeForDatabase,
combineDataTypeForDatabaseWithLengthUnit,
copySourceColumnDetails,
createCopiedColumnDrafts,
createColumnDrafts,
createTriggerDrafts,
@@ -20,6 +21,7 @@ import {
isMysqlCharacterDataType,
isMysqlEnumDataType,
isSqlServerIdentityCompatibleDataType,
matchesCopySourceColumnSearch,
mysqlEnumDataType,
parseExtraToColumnExtra,
rehydrateColumnDraftsFromMetadata,
@@ -706,6 +708,54 @@ describe("tableStructureEditorState", () => {
});
});
describe("copySourceColumnDetails", () => {
it("keeps the comment and default shown in the copy-fields dialog", () => {
expect(copySourceColumnDetails({ data_type: "varchar(20)", column_default: "'unknown'", comment: "名称" })).toEqual({ defaultValue: "'unknown'", comment: "名称" });
});
it("keeps falsy-looking defaults such as 0 and empty strings", () => {
expect(copySourceColumnDetails({ data_type: "int", column_default: "0", comment: null })).toEqual({ defaultValue: "0", comment: null });
expect(copySourceColumnDetails({ data_type: "varchar(20)", column_default: "''", comment: null })).toEqual({ defaultValue: "''", comment: null });
});
it("drops blank metadata instead of rendering an empty label", () => {
expect(copySourceColumnDetails({ data_type: "int", column_default: null, comment: null })).toEqual({ defaultValue: null, comment: null });
expect(copySourceColumnDetails({ data_type: "int", column_default: undefined, comment: undefined })).toEqual({ defaultValue: null, comment: null });
expect(copySourceColumnDetails({ data_type: "int", column_default: " ", comment: " " })).toEqual({ defaultValue: null, comment: null });
});
it("trims padded metadata for display", () => {
expect(copySourceColumnDetails({ data_type: "int", column_default: " 1 ", comment: " 备注 " })).toEqual({ defaultValue: "1", comment: "备注" });
});
it("normalizes defaults per database like the editor grid", () => {
expect(copySourceColumnDetails({ data_type: "character varying", column_default: "'unknown'::character varying", comment: null }, "postgres")).toEqual({ defaultValue: "'unknown'", comment: null });
expect(copySourceColumnDetails({ data_type: "int", column_default: "((0))", comment: null }, "sqlserver")).toEqual({ defaultValue: "0", comment: null });
expect(copySourceColumnDetails({ data_type: "varchar(50)", column_default: "", comment: null }, "mysql")).toEqual({ defaultValue: "''", comment: null });
});
});
describe("matchesCopySourceColumnSearch", () => {
const column = { name: "status", data_type: "tinyint", column_default: "1", comment: "状态:1启用 0停用" };
it("matches everything for a blank query", () => {
expect(matchesCopySourceColumnSearch(column, "")).toBe(true);
expect(matchesCopySourceColumnSearch(column, " ")).toBe(true);
});
it("matches name and type case-insensitively", () => {
expect(matchesCopySourceColumnSearch(column, "STAT")).toBe(true);
expect(matchesCopySourceColumnSearch(column, "TINY")).toBe(true);
expect(matchesCopySourceColumnSearch(column, "missing")).toBe(false);
});
it("matches comments and default values too", () => {
expect(matchesCopySourceColumnSearch(column, "启用")).toBe(true);
expect(matchesCopySourceColumnSearch(column, "1")).toBe(true);
expect(matchesCopySourceColumnSearch({ ...column, column_default: null, comment: null }, "1")).toBe(false);
});
});
describe("structureColumnNamesForCopy", () => {
const column = (name: string, markedForDrop = false) => ({ name, markedForDrop });
@@ -1,6 +1,37 @@
import type { ColumnInfo, DatabaseConnectionInfo, DatabaseType, ForeignKeyInfo, IndexInfo, TriggerInfo } from "@/types/database.ts";
import type { ColumnExtra, EditableStructureColumn, EditableStructureForeignKey, EditableStructureIndex, EditableStructureTrigger } from "@/lib/table/tableStructureEditorSql.ts";
export interface CopySourceColumnDetails {
/** Column default as shown in the copy-fields dialog, or null when there is none. */
defaultValue: string | null;
/** Column comment as shown in the copy-fields dialog, or null when there is none. */
comment: string | null;
}
/**
* Read-only summary rendered under a column name in the "copy fields from another
* table" dialog. The source table is not open while copying, so the comment and
* default value are the only hint about what an unfamiliar field means.
*/
export function copySourceColumnDetails(column: Pick<ColumnInfo, "column_default" | "comment" | "data_type">, databaseType?: DatabaseType): CopySourceColumnDetails {
// Match the main grid and the editor drafts so the dialog, the grid, and the
// copied result render the same normalized default for every database.
const defaultValue = column.column_default == null ? "" : columnDefaultForEditor(column, databaseType);
const rawComment = column.comment ?? "";
return {
defaultValue: defaultValue.trim() ? defaultValue.trim() : null,
comment: rawComment.trim() ? rawComment.trim() : null,
};
}
/** Copy-dialog search matches comments and default values on top of name and type. */
export function matchesCopySourceColumnSearch(column: Pick<ColumnInfo, "name" | "data_type" | "column_default" | "comment">, search: string, databaseType?: DatabaseType): boolean {
const query = search.trim().toLowerCase();
if (!query) return true;
const details = copySourceColumnDetails(column, databaseType);
return [column.name, column.data_type, details.defaultValue ?? "", details.comment ?? ""].some((value) => value.toLowerCase().includes(query));
}
/**
* Column names offered by the structure editor's "copy all column names" action.
* Fields marked for drop disappear on save, so they are not offered.
@@ -847,7 +878,7 @@ function stripSqlServerDefaultOuterParens(defaultValue: string): string {
return value;
}
function columnDefaultForEditor(column: ColumnInfo, databaseType?: DatabaseType): string {
function columnDefaultForEditor(column: Pick<ColumnInfo, "column_default" | "data_type">, databaseType?: DatabaseType): string {
if (column.column_default === null) return "";
const defaultValue = column.column_default;
if (databaseType === "mysql" && defaultValue === "" && isMysqlCharacterDataType(column.data_type)) {