microsoft/vscode-react-native
Publicmirrored from https://github.com/microsoft/vscode-react-nativeAvailable
src/extension/commandPaletteHandler.ts
362lines · modeblame
bef522ffMeena Kunnathur Balakrishnan10 years ago | 1 | // Copyright (c) Microsoft Corporation. All rights reserved. |
| 2 | // Licensed under the MIT license. See LICENSE file in the project root for details. | |
| 3 | | |
6e179583digeff10 years ago | 4 | import * as vscode from "vscode"; |
| 5 | import * as Q from "q"; | |
0a68f8dbArtem Egorov8 years ago | 6 | import * as XDL from "./exponent/xdlInterface"; |
df4bce40digeff10 years ago | 7 | import {SettingsHelper} from "./settingsHelper"; |
0a68f8dbArtem Egorov8 years ago | 8 | import {OutputChannelLogger} from "./log/OutputChannelLogger"; |
4787ec09Artem Egorov8 years ago | 9 | import {Packager} from "../common/packager"; |
db6fd42aRuslan Bikkinin7 years ago | 10 | import {TargetType, GeneralMobilePlatform} from "./generalMobilePlatform"; |
0a68f8dbArtem Egorov8 years ago | 11 | import {AndroidPlatform} from "./android/androidPlatform"; |
| 12 | import {IOSPlatform} from "./ios/iOSPlatform"; | |
b0061ac6Meena Kunnathur Balakrishnan10 years ago | 13 | import {ReactNativeProjectHelper} from "../common/reactNativeProjectHelper"; |
aeaf46bcMeena Kunnathur Balakrishnan10 years ago | 14 | import {TargetPlatformHelper} from "../common/targetPlatformHelper"; |
d976d077Meena Kunnathur Balakrishnan10 years ago | 15 | import {TelemetryHelper} from "../common/telemetryHelper"; |
0a68f8dbArtem Egorov8 years ago | 16 | import {ExponentHelper} from "./exponent/exponentHelper"; |
4edcda70Artem Egorov8 years ago | 17 | import {ReactDirManager} from "./reactDirManager"; |
| 18 | import {ExtensionServer} from "./extensionServer"; | |
d1fc7f8aArtem Egorov8 years ago | 19 | import {IAndroidRunOptions, IIOSRunOptions} from "./launchArgs"; |
4787ec09Artem Egorov8 years ago | 20 | import { ExponentPlatform } from "./exponent/exponentPlatform"; |
4b37483dmax-mironov8 years ago | 21 | |
4edcda70Artem Egorov8 years ago | 22 | interface IReactNativeStuff { |
| 23 | packager: Packager; | |
2e432a9eArtem Egorov8 years ago | 24 | exponentHelper: ExponentHelper; |
4edcda70Artem Egorov8 years ago | 25 | reactDirManager: ReactDirManager; |
| 26 | extensionServer: ExtensionServer; | |
| 27 | } | |
640e6e98max-mironov8 years ago | 28 | |
4edcda70Artem Egorov8 years ago | 29 | interface IReactNativeProject extends IReactNativeStuff { |
2e432a9eArtem Egorov8 years ago | 30 | workspaceFolder: vscode.WorkspaceFolder; |
| 31 | } | |
| 32 | | |
e1c05e69dlebu10 years ago | 33 | export class CommandPaletteHandler { |
4edcda70Artem Egorov8 years ago | 34 | private static projectsCache: {[key: string]: IReactNativeProject} = {}; |
2e432a9eArtem Egorov8 years ago | 35 | private static logger: OutputChannelLogger = OutputChannelLogger.getMainChannel(); |
6a465861max-mironov8 years ago | 36 | |
4edcda70Artem Egorov8 years ago | 37 | public static addFolder(workspaceFolder: vscode.WorkspaceFolder, stuff: IReactNativeStuff): void { |
db6fd42aRuslan Bikkinin7 years ago | 38 | this.logger.debug(`Command palette: added folder ${workspaceFolder.uri.fsPath}`); |
4edcda70Artem Egorov8 years ago | 39 | this.projectsCache[workspaceFolder.uri.fsPath] = { |
| 40 | ...stuff, | |
2e432a9eArtem Egorov8 years ago | 41 | workspaceFolder, |
| 42 | }; | |
| 43 | } | |
bef522ffMeena Kunnathur Balakrishnan10 years ago | 44 | |
4edcda70Artem Egorov8 years ago | 45 | public static getFolder(workspaceFolder: vscode.WorkspaceFolder): IReactNativeProject { |
| 46 | return this.projectsCache[workspaceFolder.uri.fsPath]; | |
2e432a9eArtem Egorov8 years ago | 47 | } |
| 48 | | |
4edcda70Artem Egorov8 years ago | 49 | public static delFolder(workspaceFolder: vscode.WorkspaceFolder): void { |
| 50 | delete this.projectsCache[workspaceFolder.uri.fsPath]; | |
bef522ffMeena Kunnathur Balakrishnan10 years ago | 51 | } |
| 52 | | |
0904a0d7Meena Kunnathur Balakrishnan10 years ago | 53 | /** |
| 54 | * Starts the React Native packager | |
| 55 | */ | |
2e432a9eArtem Egorov8 years ago | 56 | public static startPackager(): Q.Promise<void> { |
| 57 | return this.selectProject() | |
| 58 | .then((project: IReactNativeProject) => { | |
4787ec09Artem Egorov8 years ago | 59 | return this.executeCommandInContext("startPackager", project.workspaceFolder, () => { |
| 60 | return project.packager.isRunning() | |
2e432a9eArtem Egorov8 years ago | 61 | .then((running) => { |
4edcda70Artem Egorov8 years ago | 62 | return running ? project.packager.stop() : Q.resolve(void 0); |
4787ec09Artem Egorov8 years ago | 63 | }); |
| 64 | }) | |
| 65 | .then(() => project.packager.start()); | |
2e432a9eArtem Egorov8 years ago | 66 | }); |
bef522ffMeena Kunnathur Balakrishnan10 years ago | 67 | } |
| 68 | | |
0904a0d7Meena Kunnathur Balakrishnan10 years ago | 69 | /** |
| 70 | * Kills the React Native packager invoked by the extension's packager | |
| 71 | */ | |
2e432a9eArtem Egorov8 years ago | 72 | public static stopPackager(): Q.Promise<void> { |
| 73 | return this.selectProject() | |
| 74 | .then((project: IReactNativeProject) => { | |
4787ec09Artem Egorov8 years ago | 75 | return this.executeCommandInContext("stopPackager", project.workspaceFolder, () => project.packager.stop()); |
2e432a9eArtem Egorov8 years ago | 76 | }); |
3194e9afMeena Kunnathur Balakrishnan10 years ago | 77 | } |
| 78 | | |
4edcda70Artem Egorov8 years ago | 79 | public static stopAllPackagers(): Q.Promise<void> { |
| 80 | let keys = Object.keys(this.projectsCache); | |
| 81 | let promises: Q.Promise<void>[] = []; | |
| 82 | keys.forEach((key) => { | |
| 83 | let project = this.projectsCache[key]; | |
4787ec09Artem Egorov8 years ago | 84 | promises.push(this.executeCommandInContext("stopPackager", project.workspaceFolder, () => project.packager.stop())); |
4edcda70Artem Egorov8 years ago | 85 | }); |
| 86 | | |
| 87 | return Q.all(promises).then(() => {}); | |
| 88 | } | |
| 89 | | |
f2a58eefBret Johnson9 years ago | 90 | /** |
| 91 | * Restarts the React Native packager | |
| 92 | */ | |
2e432a9eArtem Egorov8 years ago | 93 | public static restartPackager(): Q.Promise<void> { |
| 94 | return this.selectProject() | |
| 95 | .then((project: IReactNativeProject) => { | |
| 96 | return this.executeCommandInContext("restartPackager", project.workspaceFolder, () => | |
| 97 | this.runRestartPackagerCommandAndUpdateStatus(project)); | |
| 98 | }); | |
f2a58eefBret Johnson9 years ago | 99 | } |
| 100 | | |
7893fb7eJimmy Thomson9 years ago | 101 | /** |
| 102 | * Execute command to publish to exponent host. | |
| 103 | */ | |
2e432a9eArtem Egorov8 years ago | 104 | public static publishToExpHost(): Q.Promise<void> { |
| 105 | return this.selectProject() | |
| 106 | .then((project: IReactNativeProject) => { | |
| 107 | return this.executeCommandInContext("publishToExpHost", project.workspaceFolder, () => { | |
| 108 | return this.executePublishToExpHost(project).then((didPublish) => { | |
| 109 | if (!didPublish) { | |
| 110 | CommandPaletteHandler.logger.warning("Publishing was unsuccessful. Please make sure you are logged in Exponent and your project is a valid Exponentjs project"); | |
| 111 | } | |
| 112 | }); | |
| 113 | }); | |
7893fb7eJimmy Thomson9 years ago | 114 | }); |
| 115 | } | |
| 116 | | |
3194e9afMeena Kunnathur Balakrishnan10 years ago | 117 | /** |
| 118 | * Executes the 'react-native run-android' command | |
| 119 | */ | |
d1fc7f8aArtem Egorov8 years ago | 120 | public static runAndroid(target: TargetType = "simulator"): Q.Promise<void> { |
2e432a9eArtem Egorov8 years ago | 121 | return this.selectProject() |
| 122 | .then((project: IReactNativeProject) => { | |
0611729dRuslan Bikkinin7 years ago | 123 | TargetPlatformHelper.checkTargetPlatformSupport("android"); |
4787ec09Artem Egorov8 years ago | 124 | return this.executeCommandInContext("runAndroid", project.workspaceFolder, () => { |
db6fd42aRuslan Bikkinin7 years ago | 125 | const platform = <AndroidPlatform>this.createPlatform(project, "android", AndroidPlatform, target); |
4787ec09Artem Egorov8 years ago | 126 | return platform.beforeStartPackager() |
| 127 | .then(() => { | |
| 128 | return platform.startPackager(); | |
| 129 | }) | |
| 130 | .then(() => { | |
| 131 | return platform.runApp(/*shouldLaunchInAllDevices*/true); | |
| 132 | }) | |
2e432a9eArtem Egorov8 years ago | 133 | .then(() => { |
| 134 | return platform.disableJSDebuggingMode(); | |
| 135 | }); | |
4787ec09Artem Egorov8 years ago | 136 | }); |
0a68f8dbArtem Egorov8 years ago | 137 | }); |
3194e9afMeena Kunnathur Balakrishnan10 years ago | 138 | } |
| 139 | | |
| 140 | /** | |
| 141 | * Executes the 'react-native run-ios' command | |
| 142 | */ | |
d1fc7f8aArtem Egorov8 years ago | 143 | public static runIos(target: TargetType = "simulator"): Q.Promise<void> { |
2e432a9eArtem Egorov8 years ago | 144 | return this.selectProject() |
| 145 | .then((project: IReactNativeProject) => { | |
0611729dRuslan Bikkinin7 years ago | 146 | TargetPlatformHelper.checkTargetPlatformSupport("ios"); |
4787ec09Artem Egorov8 years ago | 147 | return this.executeCommandInContext("runIos", project.workspaceFolder, () => { |
db6fd42aRuslan Bikkinin7 years ago | 148 | const platform = <IOSPlatform>this.createPlatform(project, "ios", IOSPlatform, target); |
4787ec09Artem Egorov8 years ago | 149 | return platform.beforeStartPackager() |
| 150 | .then(() => { | |
| 151 | return platform.startPackager(); | |
| 152 | }) | |
| 153 | .then(() => { | |
| 154 | // Set the Debugging setting to disabled, because in iOS it's persisted across runs of the app | |
| 155 | return platform.disableJSDebuggingMode(); | |
| 156 | }) | |
2e432a9eArtem Egorov8 years ago | 157 | .catch(() => { }) // If setting the debugging mode fails, we ignore the error and we run the run ios command anyways |
| 158 | .then(() => { | |
| 159 | return platform.runApp(); | |
| 160 | }); | |
4787ec09Artem Egorov8 years ago | 161 | }); |
| 162 | }); | |
| 163 | } | |
| 164 | | |
| 165 | /** | |
| 166 | * Starts the Exponent packager | |
| 167 | */ | |
| 168 | public static runExponent(): Q.Promise<void> { | |
| 169 | return this.selectProject() | |
| 170 | .then((project: IReactNativeProject) => { | |
| 171 | return this.loginToExponent(project) | |
| 172 | .then(() => { | |
031832ffArtem Egorov8 years ago | 173 | return this.executeCommandInContext("runExponent", project.workspaceFolder, () => { |
db6fd42aRuslan Bikkinin7 years ago | 174 | const platform = <ExponentPlatform>this.createPlatform(project, "exponent", ExponentPlatform); |
4787ec09Artem Egorov8 years ago | 175 | return platform.beforeStartPackager() |
| 176 | .then(() => { | |
| 177 | return platform.startPackager(); | |
| 178 | }) | |
| 179 | .then(() => { | |
| 180 | return platform.runApp(); | |
| 181 | }); | |
| 182 | }); | |
| 183 | }); | |
2e432a9eArtem Egorov8 years ago | 184 | }); |
3194e9afMeena Kunnathur Balakrishnan10 years ago | 185 | } |
| 186 | | |
2e432a9eArtem Egorov8 years ago | 187 | public static showDevMenu(): Q.Promise<void> { |
a41f5c68Artem Egorov8 years ago | 188 | return this.selectProject() |
| 189 | .then((project: IReactNativeProject) => { | |
db6fd42aRuslan Bikkinin7 years ago | 190 | const androidPlatform = <AndroidPlatform>this.createPlatform(project, "android", AndroidPlatform); |
| 191 | androidPlatform.showDevMenu() | |
a41f5c68Artem Egorov8 years ago | 192 | .catch(() => { }); // Ignore any errors |
db6fd42aRuslan Bikkinin7 years ago | 193 | const iosPlatform = <IOSPlatform>this.createPlatform(project, "ios", IOSPlatform); |
| 194 | iosPlatform.showDevMenu() | |
a41f5c68Artem Egorov8 years ago | 195 | .catch(() => { }); // Ignore any errors |
| 196 | return Q.resolve(void 0); | |
| 197 | }); | |
7daed3fcArtem Egorov8 years ago | 198 | } |
| 199 | | |
2e432a9eArtem Egorov8 years ago | 200 | public static reloadApp(): Q.Promise<void> { |
a41f5c68Artem Egorov8 years ago | 201 | return this.selectProject() |
| 202 | .then((project: IReactNativeProject) => { | |
db6fd42aRuslan Bikkinin7 years ago | 203 | const androidPlatform = <AndroidPlatform>this.createPlatform(project, "android", AndroidPlatform); |
| 204 | androidPlatform.reloadApp() | |
a41f5c68Artem Egorov8 years ago | 205 | .catch(() => { }); // Ignore any errors |
db6fd42aRuslan Bikkinin7 years ago | 206 | const iosPlatform = <IOSPlatform>this.createPlatform(project, "ios", IOSPlatform); |
| 207 | iosPlatform.reloadApp() | |
a41f5c68Artem Egorov8 years ago | 208 | .catch(() => { }); // Ignore any errors |
| 209 | return Q.resolve(void 0); | |
| 210 | }); | |
7daed3fcArtem Egorov8 years ago | 211 | } |
| 212 | | |
031832ffArtem Egorov8 years ago | 213 | public static getPlatformByCommandName(commandName: string): string { |
| 214 | commandName = commandName.toLocaleLowerCase(); | |
| 215 | | |
| 216 | if (commandName.indexOf("android") > -1) { | |
| 217 | return "android"; | |
| 218 | } | |
| 219 | | |
| 220 | if (commandName.indexOf("ios") > -1) { | |
| 221 | return "ios"; | |
| 222 | } | |
| 223 | | |
| 224 | if (commandName.indexOf("exponent") > -1) { | |
| 225 | return "exponent"; | |
| 226 | } | |
| 227 | | |
| 228 | return ""; | |
| 229 | } | |
| 230 | | |
db6fd42aRuslan Bikkinin7 years ago | 231 | private static createPlatform(project: IReactNativeProject, platform: "ios" | "android" | "exponent", platformClass: typeof GeneralMobilePlatform, target?: TargetType): GeneralMobilePlatform { |
| 232 | const runOptions = CommandPaletteHandler.getRunOptions(project, platform, target); | |
| 233 | return new platformClass(runOptions, { | |
| 234 | packager: project.packager, | |
| 235 | }); | |
| 236 | } | |
| 237 | | |
2e432a9eArtem Egorov8 years ago | 238 | private static runRestartPackagerCommandAndUpdateStatus(project: IReactNativeProject): Q.Promise<void> { |
4787ec09Artem Egorov8 years ago | 239 | return project.packager.restart(SettingsHelper.getPackagerPort(project.workspaceFolder.uri.fsPath)); |
3194e9afMeena Kunnathur Balakrishnan10 years ago | 240 | } |
b3a793eeNisheet Jain10 years ago | 241 | |
| 242 | /** | |
| 243 | * Ensures that we are in a React Native project and then executes the operation | |
| 244 | * Otherwise, displays an error message banner | |
| 245 | * {operation} - a function that performs the expected operation | |
| 246 | */ | |
2e432a9eArtem Egorov8 years ago | 247 | private static executeCommandInContext(rnCommand: string, workspaceFolder: vscode.WorkspaceFolder, operation: () => Q.Promise<void>): Q.Promise<void> { |
031832ffArtem Egorov8 years ago | 248 | const extProps = { |
| 249 | platform: { | |
| 250 | value: CommandPaletteHandler.getPlatformByCommandName(rnCommand), | |
| 251 | isPii: false, | |
| 252 | }, | |
| 253 | }; | |
| 254 | | |
| 255 | return TelemetryHelper.generate("RNCommand", extProps, (generator) => { | |
8512ccfeMeena Kunnathur Balakrishnan10 years ago | 256 | generator.add("command", rnCommand, false); |
e4dd9aa4Serge Svekolnikov8 years ago | 257 | const projectRoot = SettingsHelper.getReactNativeProjectRoot(workspaceFolder.uri.fsPath); |
db6fd42aRuslan Bikkinin7 years ago | 258 | this.logger.debug(`Command palette: run project ${projectRoot} in context`); |
| 259 | return ReactNativeProjectHelper.isReactNativeProject(projectRoot) | |
| 260 | .then(isRNProject => { | |
| 261 | generator.add("isRNProject", isRNProject, false); | |
| 262 | if (isRNProject) { | |
| 263 | // Bring the log channel to focus | |
| 264 | this.logger.setFocusOnLogChannel(); | |
| 265 | | |
| 266 | // Execute the operation | |
| 267 | return operation(); | |
| 268 | } else { | |
| 269 | vscode.window.showErrorMessage(`${projectRoot} workspace is not a React Native project.`); | |
| 270 | return; | |
| 271 | } | |
| 272 | }); | |
10873e11digeff10 years ago | 273 | }); |
b3a793eeNisheet Jain10 years ago | 274 | } |
7893fb7eJimmy Thomson9 years ago | 275 | |
| 276 | /** | |
| 277 | * Publish project to exponent server. In order to do this we need to make sure the user is logged in exponent and the packager is running. | |
| 278 | */ | |
2e432a9eArtem Egorov8 years ago | 279 | private static executePublishToExpHost(project: IReactNativeProject): Q.Promise<boolean> { |
| 280 | CommandPaletteHandler.logger.info("Publishing app to Exponent server. This might take a moment."); | |
| 281 | return this.loginToExponent(project) | |
7059d307Patricio Beltran9 years ago | 282 | .then(user => { |
2e432a9eArtem Egorov8 years ago | 283 | CommandPaletteHandler.logger.debug(`Publishing as ${user.username}...`); |
4787ec09Artem Egorov8 years ago | 284 | return this.runExponent() |
7059d307Patricio Beltran9 years ago | 285 | .then(() => |
a41f5c68Artem Egorov8 years ago | 286 | XDL.publish(project.workspaceFolder.uri.fsPath)) |
7059d307Patricio Beltran9 years ago | 287 | .then(response => { |
| 288 | if (response.err || !response.url) { | |
| 289 | return false; | |
| 290 | } | |
| 291 | const publishedOutput = `App successfully published to ${response.url}`; | |
2e432a9eArtem Egorov8 years ago | 292 | CommandPaletteHandler.logger.info(publishedOutput); |
7059d307Patricio Beltran9 years ago | 293 | vscode.window.showInformationMessage(publishedOutput); |
| 294 | return true; | |
| 295 | }); | |
| 296 | }); | |
| 297 | } | |
| 298 | | |
2e432a9eArtem Egorov8 years ago | 299 | private static loginToExponent(project: IReactNativeProject): Q.Promise<XDL.IUser> { |
| 300 | return project.exponentHelper.loginToExponent( | |
5c8365a6Artem Egorov8 years ago | 301 | (message, password) => { |
| 302 | return Q.Promise((resolve, reject) => { | |
| 303 | vscode.window.showInputBox({ placeHolder: message, password: password }) | |
2e432a9eArtem Egorov8 years ago | 304 | .then(login => { |
| 305 | resolve(login || ""); | |
| 306 | }, reject); | |
5c8365a6Artem Egorov8 years ago | 307 | }); |
| 308 | }, | |
| 309 | (message) => { | |
| 310 | return Q.Promise((resolve, reject) => { | |
| 311 | vscode.window.showInformationMessage(message) | |
2e432a9eArtem Egorov8 years ago | 312 | .then(password => { |
| 313 | resolve(password || ""); | |
| 314 | }, reject); | |
5c8365a6Artem Egorov8 years ago | 315 | }); |
| 316 | } | |
4787ec09Artem Egorov8 years ago | 317 | ) |
| 318 | .catch((err) => { | |
| 319 | CommandPaletteHandler.logger.warning("An error has occured. Please make sure you are logged in to exponent, your project is setup correctly for publishing and your packager is running as exponent."); | |
| 320 | throw err; | |
| 321 | }); | |
7893fb7eJimmy Thomson9 years ago | 322 | } |
2e432a9eArtem Egorov8 years ago | 323 | |
| 324 | private static selectProject(): Q.Promise<IReactNativeProject> { | |
| 325 | let keys = Object.keys(this.projectsCache); | |
| 326 | if (keys.length > 1) { | |
| 327 | return Q.Promise((resolve, reject) => { | |
| 328 | vscode.window.showQuickPick(keys) | |
| 329 | .then((selected) => { | |
| 330 | if (selected) { | |
db6fd42aRuslan Bikkinin7 years ago | 331 | this.logger.debug(`Command palette: selected project ${selected}`); |
2e432a9eArtem Egorov8 years ago | 332 | resolve(this.projectsCache[selected]); |
| 333 | } | |
| 334 | }, reject); | |
| 335 | }); | |
| 336 | } else if (keys.length === 1) { | |
db6fd42aRuslan Bikkinin7 years ago | 337 | this.logger.debug(`Command palette: once project ${keys[0]}`); |
2e432a9eArtem Egorov8 years ago | 338 | return Q.resolve(this.projectsCache[keys[0]]); |
| 339 | } else { | |
db6fd42aRuslan Bikkinin7 years ago | 340 | return Q.reject(new Error("Current workspace does not contain React Native projects.")); |
2e432a9eArtem Egorov8 years ago | 341 | } |
| 342 | } | |
d1fc7f8aArtem Egorov8 years ago | 343 | |
4787ec09Artem Egorov8 years ago | 344 | private static getRunOptions(project: IReactNativeProject, platform: "ios" | "android" | "exponent", target: TargetType = "simulator"): IAndroidRunOptions | IIOSRunOptions { |
d1fc7f8aArtem Egorov8 years ago | 345 | const packagerPort = SettingsHelper.getPackagerPort(project.workspaceFolder.uri.fsPath); |
| 346 | const runArgs = SettingsHelper.getRunArgs(platform, target, project.workspaceFolder.uri); | |
| 347 | const envArgs = SettingsHelper.getEnvArgs(platform, target, project.workspaceFolder.uri); | |
| 348 | const envFile = SettingsHelper.getEnvFile(platform, target, project.workspaceFolder.uri); | |
| 349 | const projectRoot = SettingsHelper.getReactNativeProjectRoot(project.workspaceFolder.uri.fsPath); | |
| 350 | const runOptions: IAndroidRunOptions | IIOSRunOptions = { | |
| 351 | platform: platform, | |
| 352 | workspaceRoot: project.workspaceFolder.uri.fsPath, | |
| 353 | projectRoot: projectRoot, | |
| 354 | packagerPort: packagerPort, | |
| 355 | runArguments: runArgs, | |
| 356 | env: envArgs, | |
| 357 | envFile: envFile, | |
| 358 | }; | |
| 359 | | |
| 360 | return runOptions; | |
| 361 | } | |
0a283547Anna Kocheshkova8 years ago | 362 | } |