signal-desktop/ts/logging/set_up_renderer_logging.ts

157 lines
3.7 KiB
TypeScript
Raw Normal View History

// Copyright 2017-2021 Signal Messenger, LLC
// SPDX-License-Identifier: AGPL-3.0-only
/* eslint-env node */
/* eslint-disable no-console */
import { ipcRenderer as ipc } from 'electron';
2021-03-04 21:44:57 +00:00
import * as path from 'path';
2021-03-10 22:41:38 +00:00
import pino from 'pino';
import { createStream } from 'rotating-file-stream';
import {
initLogger,
LogLevel as SignalClientLogLevel,
} from '@signalapp/signal-client';
import {
LogLevel,
cleanArgs,
getLogLevelString,
levelMaxLength,
} from './shared';
import * as log from './log';
2021-08-18 20:08:14 +00:00
import { Environment, getEnvironment } from '../environment';
// Backwards-compatible logging, simple strings and no level (defaulted to INFO)
function now() {
const date = new Date();
return date.toJSON();
}
function consoleLog(...args: ReadonlyArray<unknown>) {
logAtLevel(LogLevel.Info, ...args);
}
if (window.console) {
console._log = console.log;
console.log = consoleLog;
}
2021-03-10 22:41:38 +00:00
let globalLogger: undefined | pino.Logger;
let shouldRestart = false;
export function beforeRestart(): void {
shouldRestart = true;
}
2021-03-04 21:44:57 +00:00
export function initialize(): void {
if (globalLogger) {
throw new Error('Already called initialize!');
}
const basePath = ipc.sendSync('get-user-data-path');
const logFile = path.join(basePath, 'logs', 'app.log');
2021-03-10 22:41:38 +00:00
const stream = createStream(logFile, {
interval: '1d',
rotate: 3,
2021-03-10 22:41:38 +00:00
});
const onClose = () => {
globalLogger = undefined;
if (shouldRestart) {
initialize();
}
};
stream.on('close', onClose);
stream.on('error', onClose);
2021-03-10 22:41:38 +00:00
globalLogger = pino(
{
timestamp: pino.stdTimeFunctions.isoTime,
},
stream
);
2021-03-04 21:44:57 +00:00
}
// A modern logging interface for the browser
function logAtLevel(level: LogLevel, ...args: ReadonlyArray<unknown>): void {
2021-08-18 20:08:14 +00:00
if (getEnvironment() !== Environment.Production) {
const prefix = getLogLevelString(level)
.toUpperCase()
.padEnd(levelMaxLength, ' ');
console._log(prefix, now(), ...args);
}
2021-03-04 21:44:57 +00:00
const levelString = getLogLevelString(level);
const msg = cleanArgs(args);
if (!globalLogger) {
throw new Error('Logger has not been initialized yet');
return;
}
2021-03-10 22:41:38 +00:00
globalLogger[levelString](msg);
}
log.setLogAtLevel(logAtLevel);
window.SignalContext = window.SignalContext || {};
window.SignalContext.log = {
fatal: log.fatal,
error: log.error,
warn: log.warn,
info: log.info,
debug: log.debug,
trace: log.trace,
};
window.onerror = (_message, _script, _line, _col, error) => {
const errorInfo = error && error.stack ? error.stack : JSON.stringify(error);
log.error(`Top-level unhandled error: ${errorInfo}`);
};
window.addEventListener('unhandledrejection', rejectionEvent => {
const error = rejectionEvent.reason;
const errorString =
error && error.stack ? error.stack : JSON.stringify(error);
log.error(`Top-level unhandled promise rejection: ${errorString}`);
});
initLogger(
SignalClientLogLevel.Info,
(
level: unknown,
target: string,
file: string | null,
line: number | null,
message: string
) => {
let fileString = '';
if (file && line) {
fileString = ` ${file}:${line}`;
} else if (file) {
fileString = ` ${file}`;
}
const logString = `@signalapp/signal-client ${message} ${target}${fileString}`;
if (level === SignalClientLogLevel.Trace) {
log.trace(logString);
} else if (level === SignalClientLogLevel.Debug) {
log.debug(logString);
} else if (level === SignalClientLogLevel.Info) {
log.info(logString);
} else if (level === SignalClientLogLevel.Warn) {
log.warn(logString);
} else if (level === SignalClientLogLevel.Error) {
log.error(logString);
} else {
log.error(`${logString} (unknown log level ${level})`);
}
}
);