errors.ts

import * as util from "util";
import * as path from "path";
import * as _ from "lodash";
import { SourceMapConsumer } from "source-map";
import { isInteractive } from "./helpers";
import { deprecated } from "./decorators";
import { ErrorCodes, IErrors, IFailOptions } from "./declarations";
import { IInjector } from "./definitions/yok";
import { injector } from "./yok";

// we need this to overwrite .stack property (read-only in Error)
function Exception() {
	/* intentionally left blank */
}

Exception.prototype = new Error();

async function resolveCallStack(error: Error): Promise<string> {
	const stackLines: string[] = error.stack.split("\n");
	const parsed = _.map(stackLines, (line: string): any => {
		let match = line.match(/^\s*at ([^(]*) \((.*?):([0-9]+):([0-9]+)\)$/);
		if (match) {
			return match;
		}

		match = line.match(/^\s*at (.*?):([0-9]+):([0-9]+)$/);
		if (match) {
			match.splice(1, 0, "<anonymous>");
			return match;
		}

		return line;
	});

	const fs = require("fs");

	const remapped = await Promise.all(
		_.map(parsed, async (parsedLine) => {
			if (_.isString(parsedLine)) {
				return parsedLine;
			}

			const functionName = parsedLine[1];
			const fileName = parsedLine[2];
			const line = +parsedLine[3];
			const column = +parsedLine[4];

			const mapFileName = fileName + ".map";
			if (!fs.existsSync(mapFileName)) {
				return parsedLine.input;
			}

			const mapData = JSON.parse(fs.readFileSync(mapFileName).toString());

			return await SourceMapConsumer.with(mapData, null, (consumer) => {
				const sourcePos = consumer.originalPositionFor({
					line: line,
					column: column,
				});
				if (sourcePos && sourcePos.source) {
					const source = path.join(path.dirname(fileName), sourcePos.source);
					return util.format(
						"    at %s (%s:%s:%s)",
						functionName,
						source,
						sourcePos.line,
						sourcePos.column
					);
				}

				return util.format(
					"    at %s (%s:%s:%s)",
					functionName,
					fileName,
					line,
					column
				);
			});
		})
	);

	let outputMessage = remapped.join("\n");

	if (outputMessage.indexOf(error.message) === -1) {
		// when fibers throw error in node 0.12.x, the stack does NOT contain the message
		outputMessage = outputMessage.replace(/Error/, "Error: " + error.message);
	}

	return outputMessage;
}

export function installUncaughtExceptionListener(
	actionOnException?: () => void
): void {
	const handler = async (err: Error) => {
		try {
			let callstack = err.stack;
			if (callstack) {
				try {
					callstack = await resolveCallStack(err);
				} catch (err) {
					console.error("Error while resolving callStack:", err);
				}
			}

			console.error(callstack || err.toString());

			await tryTrackException(err, injector);

			if (actionOnException) {
				actionOnException();
			}
		} catch (err) {
			// In case the handler throws error and we do not catch it, we'll go in infinite loop of unhandled rejections.
			// We cannot do anything here as even `console.error` may fail. So just exit the process.
			process.exit(ErrorCodes.UNHANDLED_REJECTION_FAILURE);
		}
	};

	process.on("uncaughtException", handler);
	process.on("unhandledRejection", handler);
}

async function tryTrackException(
	error: Error,
	localInjector: IInjector
): Promise<void> {
	let disableAnalytics: boolean;
	try {
		disableAnalytics = localInjector.resolve("staticConfig").disableAnalytics;
	} catch (err) {
		// We should get here only in our unit tests.
		disableAnalytics = true;
	}

	if (!disableAnalytics) {
		try {
			const analyticsService = localInjector.resolve("analyticsService");
			await analyticsService.trackException(error, error.message);
		} catch (e) {
			// Do not replace with logger due to cyclic dependency
			console.error("Error while reporting exception: " + e);
		}
	}
}

export class Errors implements IErrors {
	constructor(private $injector: IInjector) {}

	public printCallStack: boolean = false;

	public fail(optsOrFormatStr: string | IFailOptions, ...args: any[]): never {
		const opts = this.getFailOptions(optsOrFormatStr);
		return this.failWithOptions(opts, false, ...args);
	}

	@deprecated("Use `fail` instead.")
	public failWithoutHelp(
		optsOrFormatStr: string | IFailOptions,
		...args: any[]
	): never {
		return this.fail(optsOrFormatStr, ...args);
	}

	public failWithHelp(
		optsOrFormatStr: string | IFailOptions,
		...args: any[]
	): never {
		const opts = this.getFailOptions(optsOrFormatStr);

		return this.failWithOptions(opts, true, ...args);
	}

	private getFailOptions(optsOrFormatStr: string | IFailOptions): IFailOptions {
		let opts = optsOrFormatStr;
		if (_.isString(opts)) {
			opts = { formatStr: opts };
		}

		return opts;
	}

	private failWithOptions(
		opts: IFailOptions,
		suggestCommandHelp: boolean,
		...args: any[]
	): never {
		const argsArray = args || [];
		const exception: any = new (<any>Exception)();
		exception.name = opts.name || "Exception";
		exception.message = util.format.apply(
			null,
			[opts.formatStr].concat(argsArray)
		);
		try {
			const $messagesService = this.$injector.resolve("messagesService");
			exception.message = $messagesService.getMessage.apply(
				$messagesService,
				[opts.formatStr].concat(argsArray)
			);
		} catch (err) {
			// Ignore
		}

		exception.stack = new Error(exception.message).stack;
		exception.errorCode = opts.errorCode || ErrorCodes.UNKNOWN;
		exception.suggestCommandHelp = suggestCommandHelp;
		exception.proxyAuthenticationRequired = !!opts.proxyAuthenticationRequired;
		exception.printOnStdout = opts.printOnStdout;
		this.$injector.resolve("logger").trace(opts.formatStr);

		throw exception;
	}

	public async beginCommand(
		action: () => Promise<boolean>,
		printCommandHelpSuggestion: () => Promise<void>
	): Promise<boolean> {
		try {
			return await action();
		} catch (ex) {
			const logger = this.$injector.resolve("logger");
			const loggerLevel: string = logger.getLevel().toUpperCase();
			const printCallStack =
				this.printCallStack ||
				loggerLevel === "TRACE" ||
				loggerLevel === "DEBUG";
			const message = printCallStack
				? await resolveCallStack(ex)
				: isInteractive()
				? `\x1B[31;1m${ex.message}\x1B[0m`
				: ex.message;

			if (ex.printOnStdout) {
				logger.info(message);
			} else {
				logger.error(message);
			}

			if (ex.suggestCommandHelp) {
				await printCommandHelpSuggestion();
			}

			await tryTrackException(ex, this.$injector);
			process.exit(
				_.isNumber(ex.errorCode) ? ex.errorCode : ErrorCodes.UNKNOWN
			);
		}
	}

	// If you want to activate this function, start Node with flags --nouse_idle_notification and --expose_gc
	verifyHeap(message: string): void {
		if (global.gc) {
			console.log("verifyHeap: '%s'", message);
			global.gc();
		}
	}
}
injector.register("errors", Errors);