feat(sql-editor): 关闭应用时提示保存未保存SQL

- 关闭应用前拦截 Wails 退出事件,前端弹出确认退出、保存退出和取消三按钮\n- 保存退出支持外部 SQL 文件和已保存查询,未命名临时查询保留草稿恢复语义\n- 补充退出保护后端测试、前端保存目标测试和多语言文案
This commit is contained in:
Syngnat
2026-06-29 11:16:55 +08:00
parent 8e857b9aee
commit ea4f88a20d
15 changed files with 634 additions and 23 deletions

View File

@@ -0,0 +1,120 @@
import { beforeEach, describe, expect, it, vi } from 'vitest';
import type { SavedQuery, TabData } from '../types';
import { clearQueryTabDraft, setQueryTabDraft, setSQLFileTabDraft } from './sqlFileTabDrafts';
import {
collectApplicationQuitUnsavedSQLTargets,
saveApplicationQuitUnsavedSQLTargets,
} from './sqlEditorApplicationQuit';
const createQueryTab = (overrides: Partial<TabData>): TabData => ({
id: 'tab-1',
title: 'Query',
type: 'query',
connectionId: 'conn-1',
dbName: 'main',
query: '',
...overrides,
});
const createSavedQuery = (overrides: Partial<SavedQuery> = {}): SavedQuery => ({
id: 'saved-1',
name: 'Saved query',
sql: 'select 1;',
connectionId: 'conn-1',
dbName: 'main',
createdAt: 1,
...overrides,
});
describe('sqlEditorApplicationQuit', () => {
beforeEach(() => {
clearQueryTabDraft('tab-1');
clearQueryTabDraft('tab-2');
clearQueryTabDraft('tab-3');
});
it('collects dirty external SQL file tabs by comparing the draft with disk content', async () => {
const tab = createQueryTab({
id: 'tab-1',
title: 'work_order.sql',
filePath: '/tmp/work_order.sql',
query: 'select * from old_table;',
});
setSQLFileTabDraft('tab-1', 'select * from mes_work_order;');
const readSQLFile = vi.fn().mockResolvedValue({
success: true,
data: { content: 'select * from old_table;' },
});
const targets = await collectApplicationQuitUnsavedSQLTargets([tab], [], readSQLFile);
expect(targets).toEqual([expect.objectContaining({
kind: 'sql-file',
tabId: 'tab-1',
title: 'work_order.sql',
filePath: '/tmp/work_order.sql',
draft: 'select * from mes_work_order;',
})]);
});
it('collects dirty saved-query tabs and ignores unnamed temporary query tabs', async () => {
const savedQuery = createSavedQuery();
const savedTab = createQueryTab({
id: 'tab-2',
title: 'Saved query',
savedQueryId: 'saved-1',
query: 'select 1;',
});
const unnamedTab = createQueryTab({
id: 'tab-3',
title: 'New query',
query: 'select * from draft_only;',
});
setQueryTabDraft('tab-2', 'select 2;');
setQueryTabDraft('tab-3', 'select * from draft_only;');
const targets = await collectApplicationQuitUnsavedSQLTargets([savedTab, unnamedTab], [savedQuery], vi.fn());
expect(targets).toHaveLength(1);
expect(targets[0]).toMatchObject({
kind: 'saved-query',
tabId: 'tab-2',
title: 'Saved query',
draft: 'select 2;',
connectionId: 'conn-1',
dbName: 'main',
});
});
it('saves external SQL files and existing saved queries before application quit', async () => {
const saveQuery = vi.fn(async (query: SavedQuery) => query);
const writeSQLFile = vi.fn(async () => ({ success: true }));
await saveApplicationQuitUnsavedSQLTargets([
{
kind: 'sql-file',
tabId: 'tab-1',
title: 'file.sql',
filePath: '/tmp/file.sql',
draft: 'select 1;',
},
{
kind: 'saved-query',
tabId: 'tab-2',
title: 'Saved query',
savedQuery: createSavedQuery(),
draft: 'select 2;',
connectionId: 'conn-2',
dbName: 'reporting',
},
], saveQuery, writeSQLFile);
expect(writeSQLFile).toHaveBeenCalledWith('/tmp/file.sql', 'select 1;');
expect(saveQuery).toHaveBeenCalledWith(expect.objectContaining({
id: 'saved-1',
sql: 'select 2;',
connectionId: 'conn-2',
dbName: 'reporting',
}));
});
});

View File

@@ -0,0 +1,147 @@
import type { SavedQuery, TabData } from '../types';
import { ReadSQLFile, WriteSQLFile } from '../../wailsjs/go/app/App';
import {
getSQLFileTabPath,
hasSQLFileTabUnsavedChanges,
isSQLFileMissingReadResult,
isSQLFileQueryTab,
normalizeSQLFileReadContent,
} from './sqlFileTabDirty';
import { getQueryTabDraft, getSQLFileTabDraft } from './sqlFileTabDrafts';
type QueryResultLike = {
success?: boolean;
message?: string;
data?: unknown;
};
export type ApplicationQuitUnsavedSQLTarget =
| {
kind: 'sql-file';
tabId: string;
title: string;
filePath: string;
draft: string;
}
| {
kind: 'saved-query';
tabId: string;
title: string;
savedQuery: SavedQuery;
draft: string;
connectionId: string;
dbName: string;
};
export type ReadSQLFileForQuit = (filePath: string) => Promise<QueryResultLike>;
export type WriteSQLFileForQuit = (filePath: string, content: string) => Promise<QueryResultLike>;
export type SaveQueryForQuit = (query: SavedQuery) => Promise<SavedQuery>;
const toTrimmedString = (value: unknown): string => String(value ?? '').trim();
const resolveTabTitle = (tab: TabData, fallback: string): string =>
toTrimmedString(tab.title) || fallback;
const resolveSavedQueryForTab = (
tab: TabData,
savedQueries: SavedQuery[],
): SavedQuery | null => {
if (tab.type !== 'query' || isSQLFileQueryTab(tab)) return null;
const savedId = toTrimmedString(tab.savedQueryId) || toTrimmedString(tab.id);
if (!savedId) return null;
return savedQueries.find((query) => query.id === savedId) || null;
};
const hasSavedQueryUnsavedChanges = (
tab: TabData,
savedQuery: SavedQuery,
draft: string,
): boolean => {
const connectionId = toTrimmedString(tab.connectionId || savedQuery.connectionId);
const dbName = toTrimmedString(tab.dbName || savedQuery.dbName);
return draft !== String(savedQuery.sql ?? '')
|| connectionId !== toTrimmedString(savedQuery.connectionId)
|| dbName !== toTrimmedString(savedQuery.dbName);
};
export const buildApplicationQuitUnsavedSQLLabel = (
targets: ApplicationQuitUnsavedSQLTarget[],
): string => {
if (targets.length === 0) return '';
if (targets.length === 1) return targets[0].title;
return String(targets.length);
};
export const collectApplicationQuitUnsavedSQLTargets = async (
tabs: TabData[],
savedQueries: SavedQuery[],
readSQLFile: ReadSQLFileForQuit = ReadSQLFile,
): Promise<ApplicationQuitUnsavedSQLTarget[]> => {
const targets: ApplicationQuitUnsavedSQLTarget[] = [];
for (const tab of tabs) {
if (tab.type !== 'query') continue;
if (isSQLFileQueryTab(tab)) {
const filePath = getSQLFileTabPath(tab);
const draft = getSQLFileTabDraft(tab.id, String(tab.query ?? ''));
const title = resolveTabTitle(tab, filePath);
try {
const res = await readSQLFile(filePath);
if (res?.success) {
if (hasSQLFileTabUnsavedChanges({ ...tab, query: draft }, normalizeSQLFileReadContent(res.data))) {
targets.push({ kind: 'sql-file', tabId: tab.id, title, filePath, draft });
}
continue;
}
if (isSQLFileMissingReadResult(res)) {
targets.push({ kind: 'sql-file', tabId: tab.id, title, filePath, draft });
continue;
}
throw new Error(res?.message || filePath);
} catch {
targets.push({ kind: 'sql-file', tabId: tab.id, title, filePath, draft });
}
continue;
}
const savedQuery = resolveSavedQueryForTab(tab, savedQueries);
if (!savedQuery) continue;
const draft = getQueryTabDraft(tab.id, String(tab.query ?? ''));
if (!hasSavedQueryUnsavedChanges(tab, savedQuery, draft)) continue;
targets.push({
kind: 'saved-query',
tabId: tab.id,
title: resolveTabTitle(tab, savedQuery.name),
savedQuery,
draft,
connectionId: toTrimmedString(tab.connectionId || savedQuery.connectionId),
dbName: toTrimmedString(tab.dbName || savedQuery.dbName),
});
}
return targets;
};
export const saveApplicationQuitUnsavedSQLTargets = async (
targets: ApplicationQuitUnsavedSQLTarget[],
saveQuery: SaveQueryForQuit,
writeSQLFile: WriteSQLFileForQuit = WriteSQLFile,
): Promise<void> => {
for (const target of targets) {
if (target.kind === 'sql-file') {
const res = await writeSQLFile(target.filePath, target.draft);
if (!res?.success) {
throw new Error(res?.message || target.filePath);
}
continue;
}
await saveQuery({
...target.savedQuery,
sql: target.draft,
connectionId: target.connectionId,
dbName: target.dbName,
});
}
};