This commit applies `strictNullChecks` to the entire codebase to improve maintainability and type safety. Key changes include: - Remove some explicit null-checks where unnecessary. - Add necessary null-checks. - Refactor static factory functions for a more functional approach. - Improve some test names and contexts for better debugging. - Add unit tests for any additional logic introduced. - Refactor `createPositionFromRegexFullMatch` to its own function as the logic is reused. - Prefer `find` prefix on functions that may return `undefined` and `get` prefix for those that always return a value.
63 lines
2.1 KiB
TypeScript
63 lines
2.1 KiB
TypeScript
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';
|
|
|
|
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 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 MockElectronLog
|
|
extends StubWithObservableMethodCalls<ElectronLog>
|
|
implements Partial<ElectronLog> {
|
|
public info(...args: unknown[]) {
|
|
this.registerMethodCall({
|
|
methodName: 'info',
|
|
args,
|
|
});
|
|
}
|
|
}
|