Centralize log file and refactor desktop logging

- 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.
This commit is contained in:
undergroundwires
2023-12-02 11:50:25 +01:00
parent 8f5d7ed3cf
commit 08dbfead7c
40 changed files with 347 additions and 191 deletions

View File

@@ -1,42 +1,15 @@
import { describe, expect } from 'vitest';
import { ElectronLog } from 'electron-log';
import { StubWithObservableMethodCalls } from '@tests/unit/shared/Stubs/StubWithObservableMethodCalls';
import { createElectronLogger } from '@/infrastructure/Log/ElectronLogger';
import { itEachAbsentObjectValue } from '@tests/unit/shared/TestCases/AbsentTests';
import { itEachLoggingMethod } from './LoggerTestRunner';
import type { LogFunctions } from 'electron-log';
describe('ElectronLogger', () => {
describe('throws if logger is missing', () => {
itEachAbsentObjectValue((absentValue) => {
// arrange
const expectedError = 'missing logger';
const electronLog = absentValue as never;
// act
const act = () => createElectronLogger(electronLog);
// assert
expect(act).to.throw(expectedError);
}, { excludeUndefined: true });
});
describe('throws if log function is missing', () => {
itEachLoggingMethod((functionName, testParameters) => {
// arrange
const expectedError = `missing "${functionName}" function`;
const electronLogMock = {} as Partial<ElectronLog>;
electronLogMock[functionName] = undefined;
const logger = createElectronLogger(electronLogMock);
// act
const act = () => logger[functionName](...testParameters);
// assert
expect(act).to.throw(expectedError);
});
});
describe('methods log the provided params', () => {
itEachLoggingMethod((functionName, testParameters) => {
// arrange
const expectedParams = testParameters;
const electronLogMock = new MockElectronLog();
const electronLogMock = new ElectronLogStub();
const logger = createElectronLogger(electronLogMock);
// act
@@ -50,9 +23,51 @@ describe('ElectronLogger', () => {
});
});
class MockElectronLog
extends StubWithObservableMethodCalls<ElectronLog>
implements Partial<ElectronLog> {
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',