paulmataruso/zulip-desktop
1
0
Fork 0
mirror of https://github.com/zulip/zulip-desktop.git synced 2025-11-21 15:08:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

logger-util: Clean up typing disaster zone.

Browse Source 
Signed-off-by: Anders Kaseorg <anders@zulip.com>
This commit is contained in:
Anders Kaseorg
2020-05-03 19:53:58 -07:00
parent 8ea32a7a96
commit ae4f03f4ba
1 changed files with 19 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
app/renderer/js/utils/logger-util.ts
View File

@@ -1,4 +1,4 @@
import {Console as NodeConsole} from 'console'; // eslint-disable-line node/prefer-global/console import {Console} from 'console'; // eslint-disable-line node/prefer-global/console
import {initSetUp} from './default-util'; import {initSetUp} from './default-util';
import {sentryInit, captureException} from './sentry-util'; import {sentryInit, captureException} from './sentry-util';
@@ -6,11 +6,6 @@ import fs from 'fs';
import os from 'os'; import os from 'os';
import isDev from 'electron-is-dev'; import isDev from 'electron-is-dev';
import electron from 'electron'; import electron from 'electron';
// This interface adds [key: string]: any so
// we can do console[type] later on in the code
interface PatchedConsole extends Console {
[key: string]: any;
}
interface LoggerOptions { interface LoggerOptions {
timestamp?: true | (() => string); timestamp?: true | (() => string);
@@ -41,12 +36,20 @@ if (process.type === 'renderer') {
app = electron.app; app = electron.app;
} }
const browserConsole: PatchedConsole = console;
const logDir = `${app.getPath('userData')}/Logs`; const logDir = `${app.getPath('userData')}/Logs`;
type Level = 'log' | 'debug' | 'info' | 'warn' | 'error';
const levels: Level[] = ['log', 'debug', 'info', 'warn', 'error'];
type LogMethod = (...args: unknown[]) => void;
export default class Logger { export default class Logger {
[key: string]: any; log: LogMethod;
nodeConsole: PatchedConsole; debug: LogMethod;
info: LogMethod;
warn: LogMethod;
error: LogMethod;
nodeConsole: Console;
timestamp?: () => string; timestamp?: () => string;
level: boolean; level: boolean;
logInDevMode: boolean; logInDevMode: boolean;
@@ -72,7 +75,7 @@ export default class Logger {
} }
const fileStream = fs.createWriteStream(file, {flags: 'a'}); const fileStream = fs.createWriteStream(file, {flags: 'a'});
const nodeConsole = new NodeConsole(fileStream); const nodeConsole = new Console(fileStream);
this.nodeConsole = nodeConsole; this.nodeConsole = nodeConsole;
this.timestamp = timestamp; this.timestamp = timestamp;
@@ -81,11 +84,10 @@ export default class Logger {
this.setUpConsole(); this.setUpConsole();
} }
_log(type: string, ...args: any[]): void { _log(type: Level, ...args: unknown[]): void {
const { const {
nodeConsole, timestamp, level, logInDevMode nodeConsole, timestamp, level, logInDevMode
} = this; } = this;
let nodeConsoleLog;
/* eslint-disable no-fallthrough */ /* eslint-disable no-fallthrough */
switch (true) { switch (true) {
@@ -96,27 +98,23 @@ export default class Logger {
args.unshift(type.toUpperCase() + ' |'); args.unshift(type.toUpperCase() + ' |');
case isDev || logInDevMode: case isDev || logInDevMode:
nodeConsoleLog = nodeConsole[type] || nodeConsole.log; nodeConsole[type](...args);
nodeConsoleLog.apply(null, args); // eslint-disable-line prefer-spread
default: break; default: break;
} }
/* eslint-enable no-fallthrough */ /* eslint-enable no-fallthrough */
browserConsole[type].apply(null, args); console[type](...args);
} }
setUpConsole(): void { setUpConsole(): void {
for (const type of Object.keys(browserConsole)) { for (const type of levels) {
this.setupConsoleMethod(type); this.setupConsoleMethod(type);
} }
} }
setupConsoleMethod(type: string): void { setupConsoleMethod(type: Level): void {
this[type] = (...args: any[]) => { this[type] = (...args: unknown[]) => this._log(type, ...args);
const log = this._log.bind(this, type, ...args);
log();
};
} }
getTimestamp(): string { getTimestamp(): string {