microsoft/vscode-react-native
Publicmirrored fromhttps://github.com/microsoft/vscode-react-nativeAvailable
src/debugger/ios/iOSPlatform.ts
121lines · modecode
| 1 | // Copyright (c) Microsoft Corporation. All rights reserved. |
| 2 | // Licensed under the MIT license. See LICENSE file in the project root for details. |
| 3 | |
| 4 | import * as Q from "q"; |
| 5 | |
| 6 | import {Log} from "../../common/log/log"; |
| 7 | import {ChildProcess} from "../../common/node/childProcess"; |
| 8 | import {CommandExecutor} from "../../common/commandExecutor"; |
| 9 | import {IAppPlatform} from "../platformResolver"; |
| 10 | import {Compiler} from "./compiler"; |
| 11 | import {DeviceDeployer} from "./deviceDeployer"; |
| 12 | import {DeviceRunner} from "./deviceRunner"; |
| 13 | import {IRunOptions} from "../../common/launchArgs"; |
| 14 | import {PlistBuddy} from "../../common/ios/plistBuddy"; |
| 15 | import {IOSDebugModeManager} from "../../common/ios/iOSDebugModeManager"; |
| 16 | import {OutputVerifier, PatternToFailure} from "../../common/outputVerifier"; |
| 17 | |
| 18 | export class IOSPlatform implements IAppPlatform { |
| 19 | private static deviceString = "device"; |
| 20 | private static simulatorString = "simulator"; |
| 21 | |
| 22 | private plistBuddy = new PlistBuddy(); |
| 23 | |
| 24 | private projectPath: string; |
| 25 | private simulatorTarget: string; |
| 26 | private isSimulator: boolean; |
| 27 | |
| 28 | // We should add the common iOS build/run erros we find to this list |
| 29 | private static RUN_IOS_FAILURE_PATTERNS: PatternToFailure = { |
| 30 | "No devices are booted": "Unable to launch iOS simulator. Try specifying a different target.", |
| 31 | "FBSOpenApplicationErrorDomain": "Unable to launch iOS simulator. Try specifying a different target.", |
| 32 | }; |
| 33 | |
| 34 | private static RUN_IOS_SUCCESS_PATTERNS = ["BUILD SUCCEEDED"]; |
| 35 | |
| 36 | constructor(private runOptions: IRunOptions) { |
| 37 | this.consumeArguments(); |
| 38 | } |
| 39 | |
| 40 | public runApp(): Q.Promise<void> { |
| 41 | // Compile, deploy, and launch the app on either a simulator or a device |
| 42 | if (this.isSimulator) { |
| 43 | // React native supports running on the iOS simulator from the command line |
| 44 | let runArguments: string[] = []; |
| 45 | if (this.simulatorTarget.toLowerCase() !== IOSPlatform.simulatorString) { |
| 46 | runArguments.push("--simulator"); |
| 47 | runArguments.push(this.simulatorTarget); |
| 48 | } |
| 49 | |
| 50 | const runIosSpawn = new CommandExecutor(this.projectPath).spawnChildReactCommandProcess("run-ios", runArguments); |
| 51 | return new OutputVerifier( |
| 52 | () => |
| 53 | this.generateSuccessPatterns(), |
| 54 | () => |
| 55 | Q(IOSPlatform.RUN_IOS_FAILURE_PATTERNS)).process(runIosSpawn); |
| 56 | } |
| 57 | |
| 58 | return new Compiler(this.projectPath).compile().then(() => { |
| 59 | return new DeviceDeployer(this.projectPath).deploy(); |
| 60 | }).then(() => { |
| 61 | return new DeviceRunner(this.projectPath).run(); |
| 62 | }); |
| 63 | } |
| 64 | |
| 65 | public enableJSDebuggingMode(): Q.Promise<void> { |
| 66 | // Configure the app for debugging |
| 67 | if (this.simulatorTarget.toLowerCase() === IOSPlatform.deviceString) { |
| 68 | // Note that currently we cannot automatically switch the device into debug mode. |
| 69 | Log.logMessage("Application is running on a device, please shake device and select 'Debug in Chrome' to enable debugging."); |
| 70 | return Q.resolve<void>(void 0); |
| 71 | } |
| 72 | |
| 73 | const iosDebugModeManager = new IOSDebugModeManager(this.projectPath); |
| 74 | |
| 75 | // Wait until the configuration file exists, and check to see if debugging is enabled |
| 76 | return Q.all([ |
| 77 | iosDebugModeManager.getSimulatorJSDebuggingModeSetting(), |
| 78 | this.getBundleId(), |
| 79 | ]).spread((debugModeSetting: string, bundleId: string) => { |
| 80 | if (debugModeSetting !== IOSDebugModeManager.WEBSOCKET_EXECUTOR_NAME) { |
| 81 | // Debugging must still be enabled |
| 82 | // We enable debugging by writing to a plist file that backs a NSUserDefaults object, |
| 83 | // but that file is written to by the app on occasion. To avoid races, we shut the app |
| 84 | // down before writing to the file. |
| 85 | const childProcess = new ChildProcess(); |
| 86 | |
| 87 | return childProcess.execToString("xcrun simctl spawn booted launchctl list").then((output: string) => { |
| 88 | // Try to find an entry that looks like UIKitApplication:com.example.myApp[0x4f37] |
| 89 | const regex = new RegExp(`(\\S+${bundleId}\\S+)`); |
| 90 | const match = regex.exec(output); |
| 91 | |
| 92 | // If we don't find a match, the app must not be running and so we do not need to close it |
| 93 | if (match) { |
| 94 | return childProcess.exec(`xcrun simctl spawn booted launchctl stop ${match[1]}`); |
| 95 | } |
| 96 | }).then(() => { |
| 97 | // Write to the settings file while the app is not running to avoid races |
| 98 | return iosDebugModeManager.setSimulatorJSDebuggingModeSetting(/*enable=*/ true); |
| 99 | }).then(() => { |
| 100 | // Relaunch the app |
| 101 | return this.runApp(); |
| 102 | }); |
| 103 | } |
| 104 | }); |
| 105 | } |
| 106 | |
| 107 | private consumeArguments(): void { |
| 108 | this.projectPath = this.runOptions.projectRoot; |
| 109 | this.simulatorTarget = this.runOptions.target || IOSPlatform.simulatorString; |
| 110 | this.isSimulator = this.simulatorTarget.toLowerCase() !== IOSPlatform.deviceString; |
| 111 | } |
| 112 | |
| 113 | private generateSuccessPatterns(): Q.Promise<string[]> { |
| 114 | return this.getBundleId().then(bundleId => |
| 115 | IOSPlatform.RUN_IOS_SUCCESS_PATTERNS.concat([`Launching ${bundleId}\n${bundleId}: `])); |
| 116 | } |
| 117 | |
| 118 | private getBundleId(): Q.Promise<string> { |
| 119 | return this.plistBuddy.getBundleId(this.projectPath); |
| 120 | } |
| 121 | } |
| 122 | |