Function formatErrors

src/platform/logging/index.ts:128–190

(...args: Arguments)

}

function formatErrors(...args: Arguments) {
    // Format the error message, if showing verbose then include all of the error stack & other details.
    const formatError = globalLoggingLevel <= LogLevel.Debug ? false : true;
    if (!formatError) {
        return args;
    }
    return args.map((arg) => {
        if (!(arg instanceof Error)) {
            return arg;
        }
        // Only format errors raised by Jupyter extension.
        if (!('isJupyterError' in arg)) {
            return arg;
        }
        const info: string[] = [`${arg.name}: ${arg.message}`.trim()];
        if (
            'kernelConnectionMetadata' in arg &&
            arg.kernelConnectionMetadata &&
            typeof arg.kernelConnectionMetadata === 'object' &&
            'id' in arg.kernelConnectionMetadata
        ) {
            info.push(`Kernel Id = ${arg.kernelConnectionMetadata.id}`);
            if (
                'interpreter' in arg.kernelConnectionMetadata &&
                arg.kernelConnectionMetadata.interpreter &&
                typeof arg.kernelConnectionMetadata.interpreter === 'object' &&
                'id' in arg.kernelConnectionMetadata.interpreter &&
                typeof arg.kernelConnectionMetadata.interpreter.id === 'string'
            ) {
                info.push(`Interpreter Id = ${getDisplayPath(arg.kernelConnectionMetadata.interpreter.id)}`);
            }
        }
        if (arg.stack) {
            const stack = splitLines(arg.stack);
            const firstStackLine = stack.find((l) => l.indexOf('at ') === 0);
            if (stack.length === 1) {
                //
            } else if (stack.length === 1) {
                info.push(stack[0]);
            } else if (stack.length > 1 && firstStackLine?.length) {
                info.push(firstStackLine);
            } else {
                info.push(stack[0]);
            }
        }
        const propertiesToIgnore = [
            'stack',
            'message',
            'name',
            'kernelConnectionMetadata',
            'category',
            'exitCode',
            'isJupyterError'
        ];
        Object.keys(arg)
            .filter((key) => propertiesToIgnore.indexOf(key) === -1)
            .forEach((key) => info.push(`${key} = ${String((arg as any)[key]).trim()}`));
        return info