microsoft/vscode-react-native

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

import * as Q from "q";

import {Log} from "../../common/log";
import {PromiseUtil} from "../../common/node/promise";
import {CommandExecutor} from "../../common/commandExecutor";
import {IAppPlatform} from "../platformResolver";
import {Compiler} from "./compiler";
import {DeviceDeployer} from "./deviceDeployer";
import {DeviceRunner} from "./deviceRunner";
import {IRunOptions} from "../launchArgs";
import {SimulatorPlist} from "./simulatorPlist";
import {PlistBuddy} from "./plistBuddy";

export class IOSPlatform implements IAppPlatform {
    private static deviceString = "device";
    private static simulatorString = "simulator";

    private projectPath: string;
    private simulatorTarget: string;
    private isSimulator: boolean;

    public runApp(launchArgs: IRunOptions): Q.Promise<void> {
        // Compile, deploy, and launch the app on either a simulator or a device
        this.consumeArguments(launchArgs);

        if (this.isSimulator) {
            // React native supports running on the iOS simulator from the command line
            let runArguments: string[] = [];
            if (this.simulatorTarget.toLowerCase() !== IOSPlatform.simulatorString) {
                runArguments.push("--simulator");
                runArguments.push(this.simulatorTarget);
            }

            return new CommandExecutor(this.projectPath).spawnReactCommand("run-ios", runArguments).then((runIos) => {
                const deferred = Q.defer<void>();
                runIos.on("error", (err: Error) => {
                    deferred.reject(err);
                });
                runIos.stderr.on("data", (data: Buffer) => {
                    const dataString = data.toString();
                    if (dataString.indexOf("No devices are booted") !== -1 // No emulators are started
                        || dataString.indexOf("FBSOpenApplicationErrorDomain") !== -1) { // The incorrect emulator is started
                        deferred.reject(new Error("Unable to launch iOS simulator. Try specifying a different target."));
                    }
                });
                runIos.on("exit", (code: number) => {
                    if (code !== 0) {
                        const err = new Error(`Command failed with exit code ${code}`);
                        Log.commandFailed(["react-native", "run-ios"].concat(runArguments).join(" "), err);
                        deferred.reject(err);
                    } else {
                        deferred.resolve(void 0);
                    }
                });
                return deferred.promise;
            });
        }

        // TODO: This is currently a stub, device debugging is not yet implemented
        return new Compiler(this.projectPath).compile().then(() => {
            return new DeviceDeployer(this.projectPath).deploy();
        }).then(() => {
            return new DeviceRunner(this.projectPath).run();
        });
    }

    public enableJSDebuggingMode(launchArgs: IRunOptions): Q.Promise<void> {
        // Configure the app for debugging
        this.consumeArguments(launchArgs);

        if (this.simulatorTarget.toLowerCase() === IOSPlatform.deviceString) {
            // Note that currently we cannot automatically switch the device into debug mode.
            Log.logMessage("Application is running on a device, please shake device and select 'Debug in Chrome' to enable debugging.");
            return Q.resolve<void>(void 0);
        }

        const plistBuddy = new PlistBuddy();
        const simulatorPlist = new SimulatorPlist(launchArgs.projectRoot);
        const pu = new PromiseUtil();
        // Find the plistFile with the configuration setting
        // There is a race here between us checking for the plist file, and the application starting up.
        return pu.retryAsync(() => simulatorPlist.findPlistFile().catch((): string => null),
            (file: string) => file !== null, 5, 2000, "Unable to find plist file to enable debugging")
            .then((plistFile: string) => {
                // Set the executorClass to be RCTWebSocketExecutor so on the next startup it will default into debug mode
                // This is approximately equivalent to clicking the "Debug in Chrome" button
                return plistBuddy.setPlistProperty(plistFile, ":RCTDevMenu:executorClass", "RCTWebSocketExecutor");
            }).then(() => {
                return plistBuddy.getBundleId(launchArgs.projectRoot);
            }).then((bundleId: string) => {
                // Relaunch the app so the new setting can take effect
                return new CommandExecutor().execute(`xcrun simctl launch booted ${bundleId}`);
            });
    }

    private consumeArguments(launchArgs: IRunOptions): void {
        this.projectPath = launchArgs.projectRoot;
        this.simulatorTarget = launchArgs.target || IOSPlatform.simulatorString;
        this.isSimulator = this.simulatorTarget.toLowerCase() !== IOSPlatform.deviceString;
    }
}