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:
@@ -3,7 +3,7 @@ import {
|
||||
} from 'vitest';
|
||||
import { IRuntimeEnvironment } from '@/infrastructure/RuntimeEnvironment/IRuntimeEnvironment';
|
||||
import { ClientLoggerFactory } from '@/presentation/bootstrapping/ClientLoggerFactory';
|
||||
import { ILogger } from '@/infrastructure/Log/ILogger';
|
||||
import { Logger } from '@/application/Common/Log/Logger';
|
||||
import { WindowInjectedLogger } from '@/infrastructure/Log/WindowInjectedLogger';
|
||||
import { ConsoleLogger } from '@/infrastructure/Log/ConsoleLogger';
|
||||
import { NoopLogger } from '@/infrastructure/Log/NoopLogger';
|
||||
@@ -29,7 +29,7 @@ describe('ClientLoggerFactory', () => {
|
||||
});
|
||||
const testCases: Array<{
|
||||
readonly description: string,
|
||||
readonly expectedType: Constructible<ILogger>,
|
||||
readonly expectedType: Constructible<Logger>,
|
||||
readonly environment: IRuntimeEnvironment,
|
||||
}> = [
|
||||
{
|
||||
|
||||
@@ -17,6 +17,7 @@ describe('DependencyProvider', () => {
|
||||
useClipboard: createTransientTests(),
|
||||
useCurrentCode: createTransientTests(),
|
||||
useUserSelectionState: createTransientTests(),
|
||||
useLogger: createTransientTests(),
|
||||
};
|
||||
Object.entries(testCases).forEach(([key, runTests]) => {
|
||||
const registeredKey = InjectionKeys[key].key;
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
import { describe, it, expect } from 'vitest';
|
||||
import { useLogger } from '@/presentation/components/Shared/Hooks/UseLogger';
|
||||
import { LoggerStub } from '@tests/unit/shared/Stubs/LoggerStub';
|
||||
import { LoggerFactoryStub } from '@tests/unit/shared/Stubs/LoggerFactoryStub';
|
||||
|
||||
describe('UseLogger', () => {
|
||||
it('returns expected logger from factory', () => {
|
||||
// arrange
|
||||
const expectedLogger = new LoggerStub();
|
||||
const factory = new LoggerFactoryStub()
|
||||
.withLogger(expectedLogger);
|
||||
// act
|
||||
const { log: actualLogger } = useLogger(factory);
|
||||
// assert
|
||||
expect(actualLogger).to.equal(expectedLogger);
|
||||
});
|
||||
});
|
||||
@@ -3,7 +3,7 @@ import { provideWindowVariables } from '@/presentation/electron/preload/WindowVa
|
||||
import { SystemOperationsStub } from '@tests/unit/shared/Stubs/SystemOperationsStub';
|
||||
import { OperatingSystem } from '@/domain/OperatingSystem';
|
||||
import { ISystemOperations } from '@/infrastructure/SystemOperations/ISystemOperations';
|
||||
import { ILogger } from '@/infrastructure/Log/ILogger';
|
||||
import { Logger } from '@/application/Common/Log/Logger';
|
||||
import { LoggerStub } from '@tests/unit/shared/Stubs/LoggerStub';
|
||||
|
||||
describe('WindowVariablesProvider', () => {
|
||||
@@ -55,7 +55,7 @@ class TestContext {
|
||||
|
||||
private os: OperatingSystem = OperatingSystem.Android;
|
||||
|
||||
private log: ILogger = new LoggerStub();
|
||||
private log: Logger = new LoggerStub();
|
||||
|
||||
public withSystem(system: ISystemOperations): this {
|
||||
this.system = system;
|
||||
@@ -67,7 +67,7 @@ class TestContext {
|
||||
return this;
|
||||
}
|
||||
|
||||
public withLogger(log: ILogger): this {
|
||||
public withLogger(log: Logger): this {
|
||||
this.log = log;
|
||||
return this;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user