microsoft/vscode-react-native

Public

mirrored from https://github.com/microsoft/vscode-react-nativeAvailable

CodeCommitsIssuesPull requestsActionsInsightsSecurity
ce02073c89ef1969a08ecbd0afb7a3409141663d

Branches

Tags

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

Clone

HTTPS

Download ZIP

src/debugger/ios/iOSPlatform.ts

127lines · modeblame

488f1908Jimmy Thomson10 years ago1// Copyright (c) Microsoft Corporation. All rights reserved.
2// Licensed under the MIT license. See LICENSE file in the project root for details.
3
4import * as Q from "q";
c96fc63eMark Oswald10 years ago5import * as path from "path";
488f1908Jimmy Thomson10 years ago6
190e393cMeena Kunnathur Balakrishnan10 years ago7import {Log} from "../../common/log/log";
dbe130e4Jimmy Thomson10 years ago8import {ChildProcess} from "../../common/node/childProcess";
b0061ac6Meena Kunnathur Balakrishnan10 years ago9import {CommandExecutor} from "../../common/commandExecutor";
ac7fef0cPatricio Beltran9 years ago10import {GeneralMobilePlatform} from "../../common/generalMobilePlatform";
488f1908Jimmy Thomson10 years ago11import {Compiler} from "./compiler";
12import {DeviceDeployer} from "./deviceDeployer";
13import {DeviceRunner} from "./deviceRunner";
acf08bc2dlebu10 years ago14import {IRunOptions} from "../../common/launchArgs";
a9d96b7cdigeff10 years ago15import {PlistBuddy} from "../../common/ios/plistBuddy";
1ed272e1digeff10 years ago16import {IOSDebugModeManager} from "../../common/ios/iOSDebugModeManager";
f8b7022ddigeff10 years ago17import {OutputVerifier, PatternToFailure} from "../../common/outputVerifier";
488f1908Jimmy Thomson10 years ago18
299b0557Patricio Beltran10 years ago19export class IOSPlatform extends GeneralMobilePlatform {
bb77358cMark Oswald10 years ago20public static DEFAULT_IOS_PROJECT_RELATIVE_PATH = "ios";
21
bc7a32ceJimmy Thomson10 years ago22private static deviceString = "device";
23private static simulatorString = "simulator";
24
a9d96b7cdigeff10 years ago25private plistBuddy = new PlistBuddy();
26
110558c0Jimmy Thomson10 years ago27private simulatorTarget: string;
28private isSimulator: boolean;
398e2b0bMark Oswald10 years ago29private iosProjectPath: string;
110558c0Jimmy Thomson10 years ago30
7cc67271digeff10 years ago31// We should add the common iOS build/run erros we find to this list
32private static RUN_IOS_FAILURE_PATTERNS: PatternToFailure = {
33"No devices are booted": "Unable to launch iOS simulator. Try specifying a different target.",
cdf34447digeff10 years ago34"FBSOpenApplicationErrorDomain": "Unable to launch iOS simulator. Try specifying a different target.",
35};
7cc67271digeff10 years ago36
37private static RUN_IOS_SUCCESS_PATTERNS = ["BUILD SUCCEEDED"];
38
299b0557Patricio Beltran10 years ago39// We set remoteExtension = null so that if there is an instance of iOSPlatform that wants to have it's custom remoteExtension it can. This is specifically useful for tests.
40constructor(runOptions: IRunOptions, { remoteExtension = null } = {}) {
41super(runOptions, { remoteExtension: remoteExtension });
c764d5e2digeff10 years ago42this.simulatorTarget = this.runOptions.target || IOSPlatform.simulatorString;
43this.isSimulator = this.simulatorTarget.toLowerCase() !== IOSPlatform.deviceString;
bb77358cMark Oswald10 years ago44this.iosProjectPath = path.join(this.projectPath, this.runOptions.iosRelativeProjectPath);
7be1388cdigeff10 years ago45}
488f1908Jimmy Thomson10 years ago46
7be1388cdigeff10 years ago47public runApp(): Q.Promise<void> {
48// Compile, deploy, and launch the app on either a simulator or a device
110558c0Jimmy Thomson10 years ago49if (this.isSimulator) {
488f1908Jimmy Thomson10 years ago50// React native supports running on the iOS simulator from the command line
f8d32439dlebu10 years ago51let runArguments: string[] = [];
110558c0Jimmy Thomson10 years ago52if (this.simulatorTarget.toLowerCase() !== IOSPlatform.simulatorString) {
398e2b0bMark Oswald10 years ago53runArguments.push("--simulator", this.simulatorTarget);
54}
55
b7773a6fMark Oswald10 years ago56runArguments.push("--project-path", this.runOptions.iosRelativeProjectPath);
488f1908Jimmy Thomson10 years ago57
9596aa53digeff10 years ago58const runIosSpawn = new CommandExecutor(this.projectPath).spawnReactCommand("run-ios", runArguments);
f8b7022ddigeff10 years ago59return new OutputVerifier(
7cc67271digeff10 years ago60() =>
7be1388cdigeff10 years ago61this.generateSuccessPatterns(),
7cc67271digeff10 years ago62() =>
63Q(IOSPlatform.RUN_IOS_FAILURE_PATTERNS)).process(runIosSpawn);
488f1908Jimmy Thomson10 years ago64}
65
bb77358cMark Oswald10 years ago66return new Compiler(this.iosProjectPath).compile().then(() => {
67return new DeviceDeployer(this.iosProjectPath).deploy();
488f1908Jimmy Thomson10 years ago68}).then(() => {
bb77358cMark Oswald10 years ago69return new DeviceRunner(this.iosProjectPath).run();
488f1908Jimmy Thomson10 years ago70});
71}
72
7be1388cdigeff10 years ago73public enableJSDebuggingMode(): Q.Promise<void> {
488f1908Jimmy Thomson10 years ago74// Configure the app for debugging
110558c0Jimmy Thomson10 years ago75if (this.simulatorTarget.toLowerCase() === IOSPlatform.deviceString) {
488f1908Jimmy Thomson10 years ago76// Note that currently we cannot automatically switch the device into debug mode.
b044f0b9Jimmy Thomson10 years ago77Log.logMessage("Application is running on a device, please shake device and select 'Debug in Chrome' to enable debugging.");
488f1908Jimmy Thomson10 years ago78return Q.resolve<void>(void 0);
79}
80
bb77358cMark Oswald10 years ago81const iosDebugModeManager = new IOSDebugModeManager(this.iosProjectPath);
dbe130e4Jimmy Thomson10 years ago82
83// Wait until the configuration file exists, and check to see if debugging is enabled
84return Q.all([
85iosDebugModeManager.getSimulatorJSDebuggingModeSetting(),
b7773a6fMark Oswald10 years ago86this.getBundleId(),
dbe130e4Jimmy Thomson10 years ago87]).spread((debugModeSetting: string, bundleId: string) => {
88if (debugModeSetting !== IOSDebugModeManager.WEBSOCKET_EXECUTOR_NAME) {
89// Debugging must still be enabled
771dc596Jimmy Thomson10 years ago90// We enable debugging by writing to a plist file that backs a NSUserDefaults object,
91// but that file is written to by the app on occasion. To avoid races, we shut the app
92// down before writing to the file.
dbe130e4Jimmy Thomson10 years ago93const childProcess = new ChildProcess();
b3db6f6bJimmy Thomson10 years ago94
8bff2a55Jimmy Thomson10 years ago95return childProcess.execToString("xcrun simctl spawn booted launchctl list").then((output: string) => {
b3db6f6bJimmy Thomson10 years ago96// Try to find an entry that looks like UIKitApplication:com.example.myApp[0x4f37]
97const regex = new RegExp(`(\\S+${bundleId}\\S+)`);
8bff2a55Jimmy Thomson10 years ago98const match = regex.exec(output);
b3db6f6bJimmy Thomson10 years ago99
100// If we don't find a match, the app must not be running and so we do not need to close it
101if (match) {
102return childProcess.exec(`xcrun simctl spawn booted launchctl stop ${match[1]}`);
103}
dbe130e4Jimmy Thomson10 years ago104}).then(() => {
105// Write to the settings file while the app is not running to avoid races
106return iosDebugModeManager.setSimulatorJSDebuggingModeSetting(/*enable=*/ true);
107}).then(() => {
108// Relaunch the app
7be1388cdigeff10 years ago109return this.runApp();
dbe130e4Jimmy Thomson10 years ago110});
111}
112});
488f1908Jimmy Thomson10 years ago113}
110558c0Jimmy Thomson10 years ago114
299b0557Patricio Beltran10 years ago115public prewarmBundleCache(): Q.Promise<void> {
116return this.remoteExtension.prewarmBundleCache(this.platformName);
117}
118
7be1388cdigeff10 years ago119private generateSuccessPatterns(): Q.Promise<string[]> {
120return this.getBundleId().then(bundleId =>
7cc67271digeff10 years ago121IOSPlatform.RUN_IOS_SUCCESS_PATTERNS.concat([`Launching ${bundleId}\n${bundleId}: `]));
122}
7be1388cdigeff10 years ago123
124private getBundleId(): Q.Promise<string> {
5c32e64cMark Oswald10 years ago125return this.plistBuddy.getBundleId(this.iosProjectPath);
7be1388cdigeff10 years ago126}
a9d96b7cdigeff10 years ago127}