feat(export): name result files from tab title

This commit is contained in:
t8y2 committed 2026-06-28 12:48:53 +08:00
1 parent 981da7bbbe
commit a7f3e6bbb4
4 files changed
+120 -15

No files matched your search

@@ -215,6 +215,7 @@ const props = defineProps<{
fullExportResult?: (onProgress?: (info: { rowsExported: number; totalRows: number | null }) => void) => Promise<QueryResult | undefined>; fullExportResult?: (onProgress?: (info: { rowsExported: number; totalRows: number | null }) => void) => Promise<QueryResult | undefined>;
queryResultExportRequest?: (options: { exportId: string; filePath: string; format: "csv" | "xlsx" }) => Promise<api.QueryResultExportRequest | undefined>; queryResultExportRequest?: (options: { exportId: string; filePath: string; format: "csv" | "xlsx" }) => Promise<api.QueryResultExportRequest | undefined>;
allExportResults?: Array<{ sheetName: string; result: QueryResult }>; allExportResults?: Array<{ sheetName: string; result: QueryResult }>;
exportFileBaseName?: string;
customSaveHandler?: import("@/composables/useDataGridEditor").CustomSaveHandler; customSaveHandler?: import("@/composables/useDataGridEditor").CustomSaveHandler;
}>(); }>();
@@ -4745,6 +4746,7 @@ const {
fullExportResult: props.fullExportResult, fullExportResult: props.fullExportResult,
queryResultExportRequest: props.queryResultExportRequest, queryResultExportRequest: props.queryResultExportRequest,
allExportResults: computed(() => props.allExportResults), allExportResults: computed(() => props.allExportResults),
exportFileBaseName: computed(() => props.exportFileBaseName),
exportProgressDialog, exportProgressDialog,
exportProgressState, exportProgressState,
exportCancelHandler, exportCancelHandler,
@@ -820,6 +820,7 @@ defineExpose({ focusSearch, refreshData, handleModRTarget, requestQueryEditorExe
:full-export-result="(onProgress?: (info: { rowsExported: number; totalRows: number | null }) => void) => queryStore.fetchTabResultForExport(activeTab.id, onProgress)" :full-export-result="(onProgress?: (info: { rowsExported: number; totalRows: number | null }) => void) => queryStore.fetchTabResultForExport(activeTab.id, onProgress)"
:query-result-export-request="(options: { exportId: string; filePath: string; format: 'csv' | 'xlsx' }) => queryStore.buildQueryResultExportRequest(activeTab.id, options)" :query-result-export-request="(options: { exportId: string; filePath: string; format: 'csv' | 'xlsx' }) => queryStore.buildQueryResultExportRequest(activeTab.id, options)"
:all-export-results="allResultExportSheets" :all-export-results="allResultExportSheets"
:export-file-base-name="activeTab.title"
@update:order-by-input="(v: string) => (activeTab.orderByInput = v)" @update:order-by-input="(v: string) => (activeTab.orderByInput = v)"
@reload="(sql?: string, searchText?: string, whereInput?: string, orderBy?: string, limit?: number, offset?: number) => emit('reload', sql, searchText, whereInput, orderBy, limit, offset)" @reload="(sql?: string, searchText?: string, whereInput?: string, orderBy?: string, limit?: number, offset?: number) => emit('reload', sql, searchText, whereInput, orderBy, limit, offset)"
@paginate="(offset: number, limit: number, whereInput?: string, orderBy?: string) => emit('paginate', offset, limit, whereInput, orderBy)" @paginate="(offset: number, limit: number, whereInput?: string, orderBy?: string) => emit('paginate', offset, limit, whereInput, orderBy)"
@@ -1011,6 +1012,7 @@ defineExpose({ focusSearch, refreshData, handleModRTarget, requestQueryEditorExe
:page-limit="activeTab.resultPageLimit" :page-limit="activeTab.resultPageLimit"
:on-execute-sql="async (sql: string) => emit('executeSql', sql)" :on-execute-sql="async (sql: string) => emit('executeSql', sql)"
:full-export-result="(onProgress?: (info: { rowsExported: number; totalRows: number | null }) => void) => queryStore.fetchTabResultForExport(activeTab.id, onProgress)" :full-export-result="(onProgress?: (info: { rowsExported: number; totalRows: number | null }) => void) => queryStore.fetchTabResultForExport(activeTab.id, onProgress)"
:export-file-base-name="activeTab.title"
@update:where-input="(v: string) => (activeTab.whereInput = v)" @update:where-input="(v: string) => (activeTab.whereInput = v)"
@update:order-by-input="(v: string) => (activeTab.orderByInput = v)" @update:order-by-input="(v: string) => (activeTab.orderByInput = v)"
@reload="(sql?: string, searchText?: string, whereInput?: string, orderBy?: string, limit?: number, offset?: number) => emit('reload', sql, searchText, whereInput, orderBy, limit, offset)" @reload="(sql?: string, searchText?: string, whereInput?: string, orderBy?: string, limit?: number, offset?: number) => emit('reload', sql, searchText, whereInput, orderBy, limit, offset)"
@@ -49,6 +49,7 @@ export interface UseDataGridExportOptions {
fullExportResult?: (onProgress?: (info: { rowsExported: number; totalRows: number | null }) => void) => Promise<QueryResult | undefined>; fullExportResult?: (onProgress?: (info: { rowsExported: number; totalRows: number | null }) => void) => Promise<QueryResult | undefined>;
queryResultExportRequest?: (options: { exportId: string; filePath: string; format: "csv" | "xlsx" }) => Promise<QueryResultExportRequest | undefined>; queryResultExportRequest?: (options: { exportId: string; filePath: string; format: "csv" | "xlsx" }) => Promise<QueryResultExportRequest | undefined>;
allExportResults?: ComputedRef<Array<{ sheetName: string; result: QueryResult }> | undefined>; allExportResults?: ComputedRef<Array<{ sheetName: string; result: QueryResult }> | undefined>;
exportFileBaseName?: ComputedRef<string | undefined>;
exportProgressDialog?: Ref<boolean>; exportProgressDialog?: Ref<boolean>;
exportProgressState?: Ref<{ exportProgressState?: Ref<{
title: string; title: string;
@@ -116,6 +117,7 @@ export function useDataGridExport(options: UseDataGridExportOptions) {
fullExportResult, fullExportResult,
queryResultExportRequest, queryResultExportRequest,
allExportResults, allExportResults,
exportFileBaseName,
exportProgressDialog, exportProgressDialog,
exportProgressState, exportProgressState,
exportCancelHandler, exportCancelHandler,
@@ -516,7 +518,7 @@ export function useDataGridExport(options: UseDataGridExportOptions) {
totalRows: result.rows.length, totalRows: result.rows.length,
}; };
} }
let outputPath = "export.csv"; let outputPath = exportFileName("export", "csv");
if (isTauriRuntime()) { if (isTauriRuntime()) {
const { save } = await import("@tauri-apps/plugin-dialog"); const { save } = await import("@tauri-apps/plugin-dialog");
const path = await save({ const path = await save({
@@ -555,7 +557,7 @@ export function useDataGridExport(options: UseDataGridExportOptions) {
async function exportCurrentPageCsv() { async function exportCurrentPageCsv() {
await runExclusiveExport(async () => { await runExclusiveExport(async () => {
try { try {
let outputPath = "export-page.csv"; let outputPath = exportFileName("export-page", "csv", { page: true });
if (isTauriRuntime()) { if (isTauriRuntime()) {
const { save } = await import("@tauri-apps/plugin-dialog"); const { save } = await import("@tauri-apps/plugin-dialog");
const path = await save({ const path = await save({
@@ -579,7 +581,7 @@ export function useDataGridExport(options: UseDataGridExportOptions) {
try { try {
if (await exportFullTableDataViaBackend("json", rowIds)) return; if (await exportFullTableDataViaBackend("json", rowIds)) return;
let outputPath = "export.json"; let outputPath = exportFileName("export", "json");
if (isTauriRuntime()) { if (isTauriRuntime()) {
const { save } = await import("@tauri-apps/plugin-dialog"); const { save } = await import("@tauri-apps/plugin-dialog");
const path = await save({ const path = await save({
@@ -601,7 +603,7 @@ export function useDataGridExport(options: UseDataGridExportOptions) {
async function exportCurrentPageJson() { async function exportCurrentPageJson() {
await runExclusiveExport(async () => { await runExclusiveExport(async () => {
try { try {
let outputPath = "export-page.json"; let outputPath = exportFileName("export-page", "json", { page: true });
if (isTauriRuntime()) { if (isTauriRuntime()) {
const { save } = await import("@tauri-apps/plugin-dialog"); const { save } = await import("@tauri-apps/plugin-dialog");
const path = await save({ const path = await save({
@@ -625,7 +627,7 @@ export function useDataGridExport(options: UseDataGridExportOptions) {
try { try {
if (await exportFullTableDataViaBackend("markdown", rowIds)) return; if (await exportFullTableDataViaBackend("markdown", rowIds)) return;
let outputPath = "export.md"; let outputPath = exportFileName("export", "md");
if (isTauriRuntime()) { if (isTauriRuntime()) {
const { save } = await import("@tauri-apps/plugin-dialog"); const { save } = await import("@tauri-apps/plugin-dialog");
const path = await save({ const path = await save({
@@ -647,7 +649,7 @@ export function useDataGridExport(options: UseDataGridExportOptions) {
async function exportCurrentPageMarkdown() { async function exportCurrentPageMarkdown() {
await runExclusiveExport(async () => { await runExclusiveExport(async () => {
try { try {
let outputPath = "export-page.md"; let outputPath = exportFileName("export-page", "md", { page: true });
if (isTauriRuntime()) { if (isTauriRuntime()) {
const { save } = await import("@tauri-apps/plugin-dialog"); const { save } = await import("@tauri-apps/plugin-dialog");
const path = await save({ const path = await save({
@@ -672,7 +674,7 @@ export function useDataGridExport(options: UseDataGridExportOptions) {
if (await exportQueryResultViaBackend("xlsx", rowIds)) return; if (await exportQueryResultViaBackend("xlsx", rowIds)) return;
if (await exportFullTableDataViaBackend("xlsx", rowIds)) return; if (await exportFullTableDataViaBackend("xlsx", rowIds)) return;
let outputPath = "export.xlsx"; let outputPath = exportFileName("export", "xlsx");
if (isTauriRuntime()) { if (isTauriRuntime()) {
const { save } = await import("@tauri-apps/plugin-dialog"); const { save } = await import("@tauri-apps/plugin-dialog");
const path = await save({ const path = await save({
@@ -739,7 +741,7 @@ export function useDataGridExport(options: UseDataGridExportOptions) {
async function exportCurrentPageXlsx() { async function exportCurrentPageXlsx() {
await runExclusiveExport(async () => { await runExclusiveExport(async () => {
try { try {
let outputPath = "export-page.xlsx"; let outputPath = exportFileName("export-page", "xlsx", { page: true });
if (isTauriRuntime()) { if (isTauriRuntime()) {
const { save } = await import("@tauri-apps/plugin-dialog"); const { save } = await import("@tauri-apps/plugin-dialog");
const path = await save({ const path = await save({
@@ -764,7 +766,7 @@ export function useDataGridExport(options: UseDataGridExportOptions) {
const sheets = (allExportResults?.value ?? []).filter((sheet) => sheet.result.columns.length > 0); const sheets = (allExportResults?.value ?? []).filter((sheet) => sheet.result.columns.length > 0);
if (sheets.length === 0) return; if (sheets.length === 0) return;
let outputPath = "query-results.xlsx"; let outputPath = exportFileName("query-results", "xlsx", { allResults: true });
if (isTauriRuntime()) { if (isTauriRuntime()) {
const { save } = await import("@tauri-apps/plugin-dialog"); const { save } = await import("@tauri-apps/plugin-dialog");
const path = await save({ const path = await save({
@@ -798,7 +800,7 @@ export function useDataGridExport(options: UseDataGridExportOptions) {
const extension = format === "markdown" ? "md" : format; const extension = format === "markdown" ? "md" : format;
const filterName = format === "csv" ? "CSV" : format === "xlsx" ? "Excel" : format === "json" ? "JSON" : format === "markdown" ? "Markdown" : "SQL"; const filterName = format === "csv" ? "CSV" : format === "xlsx" ? "Excel" : format === "json" ? "JSON" : format === "markdown" ? "Markdown" : "SQL";
let outputPath = `${meta.tableName || "export"}.${extension}`; let outputPath = exportFileName(meta.tableName || "export", extension, { preferFallback: true });
if (isTauriRuntime()) { if (isTauriRuntime()) {
const { save } = await import("@tauri-apps/plugin-dialog"); const { save } = await import("@tauri-apps/plugin-dialog");
const path = await save({ const path = await save({
@@ -877,7 +879,7 @@ export function useDataGridExport(options: UseDataGridExportOptions) {
const extension = format; const extension = format;
const filterName = format === "csv" ? "CSV" : "Excel"; const filterName = format === "csv" ? "CSV" : "Excel";
let outputPath = `query-result.${extension}`; let outputPath = exportFileName("query-result", extension);
if (isTauriRuntime()) { if (isTauriRuntime()) {
const { save } = await import("@tauri-apps/plugin-dialog"); const { save } = await import("@tauri-apps/plugin-dialog");
const path = await save({ const path = await save({
@@ -946,7 +948,7 @@ export function useDataGridExport(options: UseDataGridExportOptions) {
columnTypes: exportData.columnTypes, columnTypes: exportData.columnTypes,
rows: exportData.rows, rows: exportData.rows,
}); });
await saveTextFile(content, `${tableMeta.value?.tableName || "export"}.sql`, "SQL", "sql"); await saveTextFile(content, exportFileName(tableMeta.value?.tableName || "export", "sql", { preferFallback: true }), "SQL", "sql");
toast(t("grid.exported")); toast(t("grid.exported"));
} catch (e: any) { } catch (e: any) {
toast(t("grid.exportFailed", { message: e?.message || String(e) }), 5000); toast(t("grid.exportFailed", { message: e?.message || String(e) }), 5000);
@@ -967,7 +969,7 @@ export function useDataGridExport(options: UseDataGridExportOptions) {
columnTypes: exportData.columnTypes, columnTypes: exportData.columnTypes,
rows: exportData.rows, rows: exportData.rows,
}); });
await saveTextFile(content, "export-page.sql", "SQL", "sql"); await saveTextFile(content, exportFileName("export-page", "sql", { page: true }), "SQL", "sql");
toast(t("grid.exported")); toast(t("grid.exported"));
} catch (e: any) { } catch (e: any) {
toast(t("grid.exportFailed", { message: e?.message || String(e) }), 5000); toast(t("grid.exportFailed", { message: e?.message || String(e) }), 5000);
@@ -994,6 +996,11 @@ export function useDataGridExport(options: UseDataGridExportOptions) {
}; };
} }
function exportFileName(fallbackBaseName: string, extension: string, options: { page?: boolean; allResults?: boolean; preferFallback?: boolean } = {}): string {
const rawBaseName = options.preferFallback ? fallbackBaseName : exportFileBaseName?.value || fallbackBaseName;
return defaultDataGridExportFileName(rawBaseName, fallbackBaseName, extension, options);
}
return { return {
copyText, copyText,
copyCell, copyCell,
@@ -1053,6 +1060,41 @@ async function saveTextFile(content: string, defaultFileName: string, filterName
URL.revokeObjectURL(url); URL.revokeObjectURL(url);
} }
export function defaultDataGridExportFileName(baseName: string | undefined, fallbackBaseName: string, extension: string, options: { page?: boolean; allResults?: boolean } = {}): string {
const sanitizedBaseName = sanitizeExportBaseName(baseName || "") || sanitizeExportBaseName(fallbackBaseName) || "export";
const suffix = options.allResults ? "results" : options.page ? "page" : "";
return [sanitizedBaseName, suffix, compactLocalTimestamp()].filter(Boolean).join("_") + `.${extension}`;
}
function sanitizeExportBaseName(value: string): string {
return replaceControlCharacters(
value
.trim()
.replace(/\.[sS][qQ][lL]$/, "")
.replace(/[<>:"/\\|?*]/g, "_"),
"_",
)
.replace(/\s+/g, " ")
.replace(/[._\s-]+$/g, "")
.slice(0, 120);
}
function replaceControlCharacters(value: string, replacement: string): string {
return Array.from(value)
.map((char) => (char.charCodeAt(0) < 32 ? replacement : char))
.join("");
}
function compactLocalTimestamp(date = new Date()): string {
const yy = String(date.getFullYear() % 100).padStart(2, "0");
const month = String(date.getMonth() + 1).padStart(2, "0");
const day = String(date.getDate()).padStart(2, "0");
const hour = String(date.getHours()).padStart(2, "0");
const minute = String(date.getMinutes()).padStart(2, "0");
const second = String(date.getSeconds()).padStart(2, "0");
return `${yy}${month}${day}${hour}${minute}${second}`;
}
function effectiveColumns(sourceColumns: Array<string | undefined> | undefined, columns: string[]): Array<string | undefined> { function effectiveColumns(sourceColumns: Array<string | undefined> | undefined, columns: string[]): Array<string | undefined> {
if (!sourceColumns || sourceColumns.length !== columns.length) return columns; if (!sourceColumns || sourceColumns.length !== columns.length) return columns;
return sourceColumns; return sourceColumns;
+61 -2
View File
@@ -21,7 +21,7 @@ vi.mock("@/lib/tauriRuntime", () => ({ isTauriRuntime: () => false }));
vi.mock("@/composables/useToast", () => ({ useToast: () => ({ toast: vi.fn() }) })); vi.mock("@/composables/useToast", () => ({ useToast: () => ({ toast: vi.fn() }) }));
vi.mock("vue-i18n", () => ({ useI18n: () => ({ t: (key: string) => key }) })); vi.mock("vue-i18n", () => ({ useI18n: () => ({ t: (key: string) => key }) }));
const { useDataGridExport } = await import("../../apps/desktop/src/composables/useDataGridExport.ts"); const { defaultDataGridExportFileName, useDataGridExport } = await import("../../apps/desktop/src/composables/useDataGridExport.ts");
function installMemoryStorage() { function installMemoryStorage() {
const values = new Map<string, string>(); const values = new Map<string, string>();
@@ -41,7 +41,7 @@ function installMemoryStorage() {
}; };
} }
function buildExportHarness() { function buildExportHarness(options: { exportFileBaseName?: string } = {}) {
const exportProgressDialog = ref(false); const exportProgressDialog = ref(false);
const exportProgressState = ref({ const exportProgressState = ref({
title: "", title: "",
@@ -106,6 +106,7 @@ function buildExportHarness() {
hasRowSelection: computed(() => false), hasRowSelection: computed(() => false),
fullExportResult, fullExportResult,
queryResultExportRequest, queryResultExportRequest,
exportFileBaseName: computed(() => options.exportFileBaseName),
exportProgressDialog, exportProgressDialog,
exportProgressState, exportProgressState,
exportCancelHandler, exportCancelHandler,
@@ -192,6 +193,19 @@ beforeEach(() => {
}); });
}); });
test("default data grid export file names use sanitized base names and compact local timestamps", () => {
vi.useFakeTimers();
try {
vi.setSystemTime(new Date(2026, 5, 2, 15, 4, 5));
assert.equal(defaultDataGridExportFileName("daily/report.sql", "export", "csv"), "daily_report_260602150405.csv");
assert.equal(defaultDataGridExportFileName("daily/report.sql", "export", "xlsx", { page: true }), "daily_report_page_260602150405.xlsx");
assert.equal(defaultDataGridExportFileName(" .sql ", "query-result", "csv"), "query-result_260602150405.csv");
} finally {
vi.useRealTimers();
}
});
test("full query result CSV export streams through the backend without loading all rows", async () => { test("full query result CSV export streams through the backend without loading all rows", async () => {
const { composable, fullExportResult, queryResultExportRequest, exportProgressDialog, exportProgressState } = buildExportHarness(); const { composable, fullExportResult, queryResultExportRequest, exportProgressDialog, exportProgressState } = buildExportHarness();
@@ -205,6 +219,51 @@ test("full query result CSV export streams through the backend without loading a
assert.equal(exportProgressState.value.status, "Done"); assert.equal(exportProgressState.value.status, "Done");
}); });
test("full query result CSV export defaults to the saved SQL title", async () => {
vi.useFakeTimers();
try {
vi.setSystemTime(new Date(2026, 5, 2, 15, 4, 5));
const { composable, queryResultExportRequest } = buildExportHarness({ exportFileBaseName: "daily/report.sql" });
await composable.exportCsv();
assert.equal(queryResultExportRequest.mock.calls[0][0].filePath, "daily_report_260602150405.csv");
assert.equal(apiMock.startQueryResultExport.mock.calls[0][0].filePath, "daily_report_260602150405.csv");
} finally {
vi.useRealTimers();
}
});
test("selected query result CSV export defaults to the saved SQL title", async () => {
vi.useFakeTimers();
try {
vi.setSystemTime(new Date(2026, 5, 2, 15, 4, 5));
const { composable } = buildExportHarness({ exportFileBaseName: "daily/report.sql" });
await composable.exportCsv([1]);
assert.equal(apiMock.exportQueryResultCsv.mock.calls[0][0], "daily_report_260602150405.csv");
} finally {
vi.useRealTimers();
}
});
test("table data export keeps the table name as the default file base", async () => {
vi.useFakeTimers();
const restoreStorage = installMemoryStorage();
try {
vi.setSystemTime(new Date(2026, 5, 2, 15, 4, 5));
const { composable } = buildTableDataExportHarness();
await composable.exportCsv();
assert.equal(apiMock.startTableExport.mock.calls[0][0].filePath, "users_260602150405.csv");
} finally {
vi.useRealTimers();
restoreStorage();
}
});
test("query result CSV cancel handler passes export and execution ids", async () => { test("query result CSV cancel handler passes export and execution ids", async () => {
const { composable, exportCancelHandler } = buildExportHarness(); const { composable, exportCancelHandler } = buildExportHarness();
let resolveExport!: () => void; let resolveExport!: () => void;