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,23 +1,25 @@
import { it } from 'vitest';
import { FunctionKeys } from '@/TypeHelpers';
import { ILogger } from '@/infrastructure/Log/ILogger';
type TestParameters = [string, number, { some: string }];
import { Logger } from '@/application/Common/Log/Logger';
export function itEachLoggingMethod(
handler: (
functionName: keyof ILogger,
testParameters: TestParameters,
functionName: keyof Logger,
testParameters: readonly unknown[]
) => void,
) {
const testParameters: TestParameters = ['test', 123, { some: 'object' }];
const loggerMethods: Array<FunctionKeys<ILogger>> = [
'info',
];
loggerMethods
.forEach((functionKey) => {
const testScenarios: {
readonly [FunctionName in keyof Logger]: Parameters<Logger[FunctionName]>;
} = {
info: ['single-string'],
warn: ['with number', 123],
debug: ['with simple object', { some: 'object' }],
error: ['with error object', new Error('error')],
};
Object.entries(testScenarios)
.forEach(([functionKey, testParameters]) => {
it(functionKey, () => {
handler(functionKey, testParameters);
handler(functionKey as keyof Logger, testParameters);
});
});
}