- Migrate to `electron-log` v5.X.X, centralizing log files to adhere to best-practices. - Add critical event logging in the log file. - Replace `ElectronLog` type with `LogFunctions` for better abstraction. - Unify log handling in `desktop-runtime-error` by removing `renderer.log` due to `electron-log` v5 changes. - Update and extend logger interfaces, removing 'I' prefix and adding common log levels to abstract `electron-log` completely. - Move logger interfaces to the application layer as it's cross-cutting concern, meanwhile keeping the implementations in the infrastructure layer. - Introduce `useLogger` hook for easier logging in Vue components. - Simplify `WindowVariables` by removing nullable properties. - Improve documentation to clearly differentiate between desktop and web versions, outlining specific features of each.
78 lines
1.9 KiB
TypeScript
78 lines
1.9 KiB
TypeScript
import { describe, expect } from 'vitest';
|
|
import { StubWithObservableMethodCalls } from '@tests/unit/shared/Stubs/StubWithObservableMethodCalls';
|
|
import { createElectronLogger } from '@/infrastructure/Log/ElectronLogger';
|
|
import { itEachLoggingMethod } from './LoggerTestRunner';
|
|
import type { LogFunctions } from 'electron-log';
|
|
|
|
describe('ElectronLogger', () => {
|
|
describe('methods log the provided params', () => {
|
|
itEachLoggingMethod((functionName, testParameters) => {
|
|
// arrange
|
|
const expectedParams = testParameters;
|
|
const electronLogMock = new ElectronLogStub();
|
|
const logger = createElectronLogger(electronLogMock);
|
|
|
|
// act
|
|
logger[functionName](...expectedParams);
|
|
|
|
// assert
|
|
expect(electronLogMock.callHistory).to.have.lengthOf(1);
|
|
expect(electronLogMock.callHistory[0].methodName).to.equal(functionName);
|
|
expect(electronLogMock.callHistory[0].args).to.deep.equal(expectedParams);
|
|
});
|
|
});
|
|
});
|
|
|
|
class ElectronLogStub
|
|
extends StubWithObservableMethodCalls<LogFunctions>
|
|
implements LogFunctions {
|
|
public error(...args: unknown[]) {
|
|
this.registerMethodCall({
|
|
methodName: 'error',
|
|
args,
|
|
});
|
|
}
|
|
|
|
public warn(...args: unknown[]) {
|
|
this.registerMethodCall({
|
|
methodName: 'warn',
|
|
args,
|
|
});
|
|
}
|
|
|
|
public verbose(...args: unknown[]): void {
|
|
this.registerMethodCall({
|
|
methodName: 'verbose',
|
|
args,
|
|
});
|
|
}
|
|
|
|
public debug(...args: unknown[]) {
|
|
this.registerMethodCall({
|
|
methodName: 'debug',
|
|
args,
|
|
});
|
|
}
|
|
|
|
public silly(...args: unknown[]) {
|
|
this.registerMethodCall({
|
|
methodName: 'silly',
|
|
args,
|
|
});
|
|
}
|
|
|
|
public log(...args: unknown[]) {
|
|
this.registerMethodCall({
|
|
methodName: 'log',
|
|
args,
|
|
});
|
|
}
|
|
|
|
public info(...args: unknown[]) {
|
|
this.registerMethodCall({
|
|
methodName: 'info',
|
|
args,
|
|
});
|
|
}
|
|
}
|