Improve script error dialogs #304

- Include the script's directory path #304.
- Exclude Windows-specific instructions on non-Windows OS.
- Standardize language across dialogs for consistency.

Other supporting changes:

- Add script diagnostics data collection from main process.
- Document script file storage and execution tamper protection in
  SECURITY.md.
- Remove redundant comment in `NodeReadbackFileWriter`.
- Centralize error display for uniformity and simplicity.
- Simpify `WindowVariablesValidator` to omit checks when not on the
  renderer process.
- Improve and centralize Electron environment detection.
- Use more emphatic language (don't worry) in error messages.
This commit is contained in:
undergroundwires
2024-01-17 23:59:05 +01:00
parent f03fc24098
commit 6ada8d425c
34 changed files with 1182 additions and 450 deletions

View File

@@ -0,0 +1,27 @@
import { describe, it, expect } from 'vitest';
import { useScriptDiagnosticsCollector } from '@/presentation/components/Shared/Hooks/UseScriptDiagnosticsCollector';
import { ScriptDiagnosticsCollectorStub } from '@tests/unit/shared/Stubs/ScriptDiagnosticsCollectorStub';
import { WindowVariables } from '@/infrastructure/WindowVariables/WindowVariables';
describe('useScriptDiagnosticsCollector', () => {
it('returns undefined if collector is not present on the window object', () => {
// arrange
const emptyWindow = {} as WindowVariables;
// act
const { scriptDiagnosticsCollector } = useScriptDiagnosticsCollector(emptyWindow);
// assert
expect(scriptDiagnosticsCollector).to.equal(undefined);
});
it('returns the scriptDiagnosticsCollector when it is present on the window object', () => {
// arrange
const expectedCollector = new ScriptDiagnosticsCollectorStub();
const windowWithVariable: Partial<WindowVariables> = {
scriptDiagnosticsCollector: expectedCollector,
} as Partial<WindowVariables>;
// act
const { scriptDiagnosticsCollector } = useScriptDiagnosticsCollector(windowWithVariable);
// assert
expect(scriptDiagnosticsCollector).to.equal(expectedCollector);
});
});