- 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.
68 lines
1.9 KiB
TypeScript
68 lines
1.9 KiB
TypeScript
import { describe, expect } from 'vitest';
|
|
import { StubWithObservableMethodCalls } from '@tests/unit/shared/Stubs/StubWithObservableMethodCalls';
|
|
import { ConsoleLogger } from '@/infrastructure/Log/ConsoleLogger';
|
|
import { itEachAbsentObjectValue } from '@tests/unit/shared/TestCases/AbsentTests';
|
|
import { itEachLoggingMethod } from './LoggerTestRunner';
|
|
|
|
describe('ConsoleLogger', () => {
|
|
describe('throws if console is missing', () => {
|
|
itEachAbsentObjectValue((absentValue) => {
|
|
// arrange
|
|
const expectedError = 'missing console';
|
|
const console = absentValue as never;
|
|
// act
|
|
const act = () => new ConsoleLogger(console);
|
|
// assert
|
|
expect(act).to.throw(expectedError);
|
|
}, { excludeUndefined: true });
|
|
});
|
|
describe('methods log the provided params', () => {
|
|
itEachLoggingMethod((functionName, testParameters) => {
|
|
// arrange
|
|
const expectedParams = testParameters;
|
|
const consoleMock = new MockConsole();
|
|
const logger = new ConsoleLogger(consoleMock);
|
|
|
|
// act
|
|
logger[functionName](...expectedParams);
|
|
|
|
// assert
|
|
expect(consoleMock.callHistory).to.have.lengthOf(1);
|
|
expect(consoleMock.callHistory[0].methodName).to.equal(functionName);
|
|
expect(consoleMock.callHistory[0].args).to.deep.equal(expectedParams);
|
|
});
|
|
});
|
|
});
|
|
|
|
class MockConsole
|
|
extends StubWithObservableMethodCalls<Console>
|
|
implements Partial<Console> {
|
|
public info(...args: unknown[]) {
|
|
this.registerMethodCall({
|
|
methodName: 'info',
|
|
args,
|
|
});
|
|
}
|
|
|
|
public warn(...args: unknown[]) {
|
|
this.registerMethodCall({
|
|
methodName: 'warn',
|
|
args,
|
|
});
|
|
}
|
|
|
|
public debug(...args: unknown[]) {
|
|
this.registerMethodCall({
|
|
methodName: 'debug',
|
|
args,
|
|
});
|
|
}
|
|
|
|
public error(...args: unknown[]) {
|
|
this.registerMethodCall({
|
|
methodName: 'error',
|
|
args,
|
|
});
|
|
}
|
|
}
|