Function captureLogs

src/shared/logging.ts:107–154

(logger: EmittingLogger, file: string, header: string, maxLogLineLength: number, logCategories: LogCategory[], excludeLogCategories = false)

}

export function captureLogs(logger: EmittingLogger, file: string, header: string, maxLogLineLength: number, logCategories: LogCategory[], excludeLogCategories = false): IAmDisposableAsync {
	if (!file || !path.isAbsolute(file))
		throw new Error("Path passed to logTo must be an absolute path");
	const time = (detailed = false) => detailed ? `[${(new Date()).toTimeString()}] ` : `[${(new Date()).toLocaleTimeString()}] `;
	createFolderForFile(file);
	let logStream: fs.WriteStream | undefined = fs.createWriteStream(file);
	if (header)
		logStream.write(header);

	const categoryNames = logCategories.map((c) => LogCategory[c]);
	logStream.write(`${excludeLogCategories ? "Not " : ""}Logging Categories:${platformEol}    ${categoryNames.join(", ")}${platformEol}${platformEol}`);

	logStream.write(`${(new Date()).toDateString()} ${time(true)}Log file started${platformEol}`);
	let fileLogger: IAmDisposableAsync | undefined = logger.onLog((e) => {
		if (!logStream)
			return;

		// We should log this event if:
		// - We don't have a category filter; or
		// - The category filter includes this category; or
		// - The log is WARN/ERROR (they get logged everywhere).
		const shouldLog = (excludeLogCategories
			? !logCategories.includes(e.category)
			: logCategories.includes(e.category))
			|| e.severity === LogSeverity.Warn
			|| e.severity === LogSeverity.Error;
		if (!shouldLog)
			return;

		logStream.write(`${e.toLine(maxLogLineLength)}${os.EOL}`);
	});
	return {
		async dispose(): Promise<void> {
			if (fileLogger) {
				await fileLogger.dispose();
				fileLogger = undefined;
			}
			return new Promise((resolve) => {
				if (logStream) {
					logStream.write(`${(new Date()).toDateString()} ${time(true)}Log file ended${os.EOL}`);
					logStream.once("finish", resolve);
					logStream.end();
					logStream = undefined;
				}
			});
		},
	};
}

export class RingLog {
	private readonly lines: string[];