microsoft/vscode-react-native

Public

mirrored fromhttps://github.com/microsoft/vscode-react-nativeAvailable

CodeCommitsIssuesPull requestsActionsInsightsSecurity
4f4e082dd1d2adc773da8fdd1c2a71ffaa5837dd

Branches

Tags

  • No tags available.
0Branches0Tags
Go to file
Add file
Code

Clone

HTTPS

Download ZIP

src/common/entryPointHandler.ts

64lines · modepreview

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for details.


import {ErrorHelper} from "../common/error/errorHelper";
import {InternalError} from "../common/error/internalError";
import {InternalErrorCode} from "../common/error/internalErrorCode";
import {TelemetryHelper} from "../common/telemetryHelper";
import {Telemetry} from "../common/telemetry";
import {Log} from "../common/log/log";
import {ILogger} from "../common/log/loggers";

/* This class should we used for each entry point of the code, so we handle telemetry and error reporting properly */
export class EntryPointHandler {
    private isDebugeeProcess: boolean;

    constructor(isDebugeeProcess: boolean = false, logger?: ILogger) {
        if (logger) {
            Log.SetGlobalLogger(logger);
        }

        this.isDebugeeProcess = isDebugeeProcess;
    }


    /* This method should wrap any async entry points to the code, so we handle telemetry and error reporting properly */
    public runFunction(taskName: string, error: InternalError, codeToRun: () => Q.Promise<void> | void, errorsAreFatal: boolean = false): void {
        return this.handleErrors(error, TelemetryHelper.generate(taskName, codeToRun), /*errorsAreFatal*/ errorsAreFatal);
    }

    /* This method should wrap the entry point of the whole app, so we handle telemetry and error reporting properly */
    public runApp(appName: string, getAppVersion: () => string, error: InternalError, codeToRun: () => Q.Promise<void>): void {
        let telemetryError = ErrorHelper.getInternalError(InternalErrorCode.TelemetryInitializationFailed, error.message);
        try { // try-catch for sync errors in init telemetry
            return this.handleErrors(telemetryError, // handleErrors for async errors in init telemetry
                Telemetry.init("react-native", getAppVersion(), true).then(() =>
                    // After telemetry is initialized, we run the code. Errors in this main path are fatal so we rethrow them
                    this.runFunction(appName, error, codeToRun, /*errorsAreFatal*/ true)), /*errorsAreFatal*/ true);
        } catch (error) {
            Log.logError(ErrorHelper.wrapError(telemetryError, error), /*logStack*/ false);
            throw error;
        }
    }

    private handleErrors(error: InternalError, resultOfCode: Q.Promise<void>, errorsAreFatal: boolean): void {
        resultOfCode.done(() => { }, reason => {
            const shouldLogStack = !errorsAreFatal || this.isDebugeeProcess;
            Log.logError(ErrorHelper.wrapError(error, reason), /*logStack*/ shouldLogStack);
            if (errorsAreFatal) {
                /* The process is likely going to exit if errors are fatal, so we first
                send the telemetry, and then we exit or rethrow the exception */
                Telemetry.sendPendingData().finally(() => {
                    if (this.isDebugeeProcess) {
                        /* HACK: For the debugee process we don't want to throw an exception because the debugger
                                 will appear to the user if he turned on the VS Code uncaught exceptions feature. */
                        process.exit(1);
                    } else {
                        throw reason;
                    }
                }).done();
            }
        });
    }
}