This commit introduces system-native error dialogs on desktop application for code save or execution failures, addressing user confusion described in issue #264. This commit adds informative feedback when script execution or saving fails. Changes: - Implement support for system-native error dialogs. - Refactor `CodeRunner` and `Dialog` interfaces and their implementations to improve error handling and provide better type safety. - Introduce structured error handling, allowing UI to display detailed error messages. - Replace error throwing with an error object interface for controlled handling. This ensures that errors are propagated to the renderer process without being limited by Electron's error object serialization limitations as detailed in electron/electron#24427. - Add logging for dialog actions to aid in troubleshooting. - Rename `fileName` to `defaultFilename` in `saveFile` functions to clarify its purpose. - Centralize message assertion in `LoggerStub` for consistency. - Introduce `expectTrue` in tests for clearer boolean assertions. - Standardize `filename` usage across the codebase. - Enhance existing test names and organization for clarity. - Update related documentation.
109 lines
3.4 KiB
TypeScript
109 lines
3.4 KiB
TypeScript
import { describe, it, expect } from 'vitest';
|
|
import { FileType, SaveFileOutcome } from '@/presentation/common/Dialog';
|
|
import { BrowserDialog, WindowDialogAccessor } from '@/infrastructure/Dialog/Browser/BrowserDialog';
|
|
import { BrowserSaveFileDialog } from '@/infrastructure/Dialog/Browser/BrowserSaveFileDialog';
|
|
import { expectExists } from '@tests/shared/Assertions/ExpectExists';
|
|
|
|
describe('BrowserDialog', () => {
|
|
describe('saveFile', () => {
|
|
it('forwards arguments', async () => {
|
|
// arrange
|
|
const expectedSaveFileArgs = createTestSaveFileArguments();
|
|
let actualSaveFileArgs: Parameters<BrowserSaveFileDialog['saveFile']> | undefined;
|
|
const fileSaverDialogSpy: BrowserSaveFileDialog = {
|
|
saveFile: (...args) => {
|
|
actualSaveFileArgs = args;
|
|
return { success: true };
|
|
},
|
|
};
|
|
const browserDialog = new BrowserDialogBuilder()
|
|
.withBrowserSaveFileDialog(fileSaverDialogSpy)
|
|
.build();
|
|
|
|
// act
|
|
await browserDialog.saveFile(...expectedSaveFileArgs);
|
|
|
|
// assert
|
|
expect(actualSaveFileArgs).to.deep.equal(expectedSaveFileArgs);
|
|
});
|
|
it('forwards outcome', async () => {
|
|
// arrange
|
|
const expectedResult: SaveFileOutcome = {
|
|
success: true,
|
|
};
|
|
const fileSaverDialogMock: BrowserSaveFileDialog = {
|
|
saveFile: () => expectedResult,
|
|
};
|
|
const browserDialog = new BrowserDialogBuilder()
|
|
.withBrowserSaveFileDialog(fileSaverDialogMock)
|
|
.build();
|
|
|
|
// act
|
|
const actualResult = await browserDialog.saveFile(...createTestSaveFileArguments());
|
|
|
|
// assert
|
|
expect(actualResult).to.equal(expectedResult);
|
|
});
|
|
});
|
|
describe('showError', () => {
|
|
it('alerts with formatted error message', () => {
|
|
// arrange
|
|
const errorTitle = 'Expected Error Title';
|
|
const errorMessage = 'expected error message';
|
|
const expectedMessage = `❌ ${errorTitle}\n\n${errorMessage}`;
|
|
let actualShowErrorArgs: Parameters<WindowDialogAccessor['alert']> | undefined;
|
|
const windowDialogAccessorSpy: WindowDialogAccessor = {
|
|
alert: (...args) => {
|
|
actualShowErrorArgs = args;
|
|
},
|
|
};
|
|
const browserDialog = new BrowserDialogBuilder()
|
|
.withWindowDialogAccessor(windowDialogAccessorSpy)
|
|
.build();
|
|
|
|
// act
|
|
browserDialog.showError(errorTitle, errorMessage);
|
|
|
|
// assert
|
|
expectExists(actualShowErrorArgs);
|
|
const [actualMessage] = actualShowErrorArgs;
|
|
expect(actualMessage).to.equal(expectedMessage);
|
|
});
|
|
});
|
|
});
|
|
|
|
function createTestSaveFileArguments(): Parameters<BrowserSaveFileDialog['saveFile']> {
|
|
return [
|
|
'test file content',
|
|
'test filename',
|
|
FileType.ShellScript,
|
|
];
|
|
}
|
|
|
|
class BrowserDialogBuilder {
|
|
private browserSaveFileDialog: BrowserSaveFileDialog = {
|
|
saveFile: () => ({ success: true }),
|
|
};
|
|
|
|
private windowDialogAccessor: WindowDialogAccessor = {
|
|
alert: () => { /* NOOP */ },
|
|
};
|
|
|
|
public withBrowserSaveFileDialog(browserSaveFileDialog: BrowserSaveFileDialog): this {
|
|
this.browserSaveFileDialog = browserSaveFileDialog;
|
|
return this;
|
|
}
|
|
|
|
public withWindowDialogAccessor(windowDialogAccessor: WindowDialogAccessor): this {
|
|
this.windowDialogAccessor = windowDialogAccessor;
|
|
return this;
|
|
}
|
|
|
|
public build() {
|
|
return new BrowserDialog(
|
|
this.windowDialogAccessor,
|
|
this.browserSaveFileDialog,
|
|
);
|
|
}
|
|
}
|