GitVita
New repositoryImport repositoryNew issue
Your repositories Your dashboard Sign in

microsoft/vscode-react-native

Public

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

Watch0Fork0Star0
CodeCommitsIssuesPull requestsActionsInsightsSecurity
9748aa65e60ea4fa507c8c637bc84a8e56f45b35

Branches

Tags

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

Clone

HTTPS

Download ZIP

vscode-react-native/src/common

src/common/commandExecutor.ts

212lines · modeblame

RawDownload
Latest commit unavailable.
a31b007cunknown10 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
10873e11digeff10 years ago4import * as Q from "q";
af1474acRedMickey6 years ago5import * as path from "path";
2e15926eMeena Kunnathur Balakrishnan10 years ago6import {ChildProcess} from "child_process";
0a68f8dbArtem Egorov8 years ago7import {ILogger} from "../extension/log/LogHelper";
af1474acRedMickey6 years ago8import {NullLogger} from "../extension/log/NullLogger";
9import {ReactNativeProjectHelper} from "../common/reactNativeProjectHelper";
b0061ac6Meena Kunnathur Balakrishnan10 years ago10import {Node} from "./node/node";
cb6d0922digeff10 years ago11import {ISpawnResult} from "./node/childProcess";
5c8365a6Artem Egorov8 years ago12import {HostPlatform, HostPlatformId} from "./hostPlatform";
190e393cMeena Kunnathur Balakrishnan10 years ago13import {ErrorHelper} from "./error/errorHelper";
14import {InternalErrorCode} from "./error/internalErrorCode";
e2644f37Yuri Skorokhodov7 years ago15import * as nls from "vscode-nls";
16const localize = nls.loadMessageBundle();
3fb37ad5unknown10 years ago17
831f4a85Patricio Beltran9 years ago18export enum CommandVerbosity {
19OUTPUT,
20SILENT,
21PROGRESS,
22}
23
3fb37ad5unknown10 years ago24interface EnvironmentOptions {
25REACT_DEBUGGER?: string;
26}
27
28interface Options {
29env?: EnvironmentOptions;
831f4a85Patricio Beltran9 years ago30verbosity?: CommandVerbosity;
0d827d9bJimmy Thomson9 years ago31cwd?: string;
3fb37ad5unknown10 years ago32}
33
17161993Meena Kunnathur Balakrishnan10 years ago34export enum CommandStatus {
35Start = 0,
27710197Vladimir Kotikov8 years ago36End = 1,
17161993Meena Kunnathur Balakrishnan10 years ago37}
38
3fb37ad5unknown10 years ago39export class CommandExecutor {
94cd5149Artem Egorov8 years ago40
af1474acRedMickey6 years ago41public static ReactNativeCommand: string | null;
9596aa53digeff10 years ago42private childProcess = new Node.ChildProcess();
3fb37ad5unknown10 years ago43
0a68f8dbArtem Egorov8 years ago44constructor(
45private currentWorkingDirectory: string = process.cwd(),
46private logger: ILogger = new NullLogger()
47) { }
3fb37ad5unknown10 years ago48
fb2bae06Daniel10 years ago49public execute(command: string, options: Options = {}): Q.Promise<void> {
0a68f8dbArtem Egorov8 years ago50this.logger.debug(CommandExecutor.getCommandStatusString(command, CommandStatus.Start));
9596aa53digeff10 years ago51return this.childProcess.execToString(command, { cwd: this.currentWorkingDirectory, env: options.env })
3fb37ad5unknown10 years ago52.then(stdout => {
0a68f8dbArtem Egorov8 years ago53this.logger.info(stdout);
54this.logger.debug(CommandExecutor.getCommandStatusString(command, CommandStatus.End));
3fb37ad5unknown10 years ago55},
cb6d0922digeff10 years ago56(reason: Error) =>
57this.generateRejectionForCommand(command, reason));
3fb37ad5unknown10 years ago58}
59
45944d15Meena Kunnathur Balakrishnan10 years ago60/**
61* Spawns a child process with the params passed
62* This method waits until the spawned process finishes execution
63* {command} - The command to be invoked in the child process
64* {args} - Arguments to be passed to the command
65* {options} - additional options with which the child process needs to be spawned
66*/
323a3cc0Meena Kunnathur Balakrishnan10 years ago67public spawn(command: string, args: string[], options: Options = {}): Q.Promise<any> {
9596aa53digeff10 years ago68return this.spawnChildProcess(command, args, options).outcome;
45944d15Meena Kunnathur Balakrishnan10 years ago69}
70
6126d899Meena Kunnathur Balakrishnan10 years ago71/**
72* Spawns the React Native packager in a child process.
73*/
9596aa53digeff10 years ago74public spawnReactPackager(args: string[], options: Options = {}): ISpawnResult {
75return this.spawnReactCommand("start", args, options);
6126d899Meena Kunnathur Balakrishnan10 years ago76}
77
b8a56999Patricio Beltran10 years ago78public getReactNativeVersion(): Q.Promise<string> {
af1474acRedMickey6 years ago79return ReactNativeProjectHelper.getReactNativeVersion(this.currentWorkingDirectory);
b8a56999Patricio Beltran10 years ago80}
81
c3a987a7Meena Kunnathur Balakrishnan10 years ago82/**
83* Kills the React Native packager in a child process.
84*/
5c8365a6Artem Egorov8 years ago85public killReactPackager(packagerProcess?: ChildProcess): Q.Promise<void> {
c9b4fa6cMeena Kunnathur Balakrishnan10 years ago86if (packagerProcess) {
a1005420dlebu10 years ago87return Q({}).then(() => {
88if (HostPlatform.getPlatformId() === HostPlatformId.WINDOWS) {
9596aa53digeff10 years ago89return this.childProcess.exec("taskkill /pid " + packagerProcess.pid + " /T /F").outcome;
a1005420dlebu10 years ago90} else {
91packagerProcess.kill();
5c8365a6Artem Egorov8 years ago92return Q.resolve(void 0);
a1005420dlebu10 years ago93}
94}).then(() => {
e2644f37Yuri Skorokhodov7 years ago95this.logger.info(localize("PackagerStopped", "Packager stopped"));
a1005420dlebu10 years ago96});
97
c3a987a7Meena Kunnathur Balakrishnan10 years ago98} else {
e2644f37Yuri Skorokhodov7 years ago99this.logger.warning(localize("PackagerNotFound", "Packager not found"));
10873e11digeff10 years ago100return Q.resolve<void>(void 0);
c3a987a7Meena Kunnathur Balakrishnan10 years ago101}
102}
103
f8d32439dlebu10 years ago104/**
105* Executes a react native command and waits for its completion.
106*/
e390ca0aVladimir Kotikov8 years ago107public spawnReactCommand(command: string, args: string[] = [], options: Options = {}): ISpawnResult {
af1474acRedMickey6 years ago108const reactCommand = HostPlatform.getNpmCliCommand(this.selectReactNativeCLI());
94cd5149Artem Egorov8 years ago109return this.spawnChildProcess(reactCommand, [command, ...args], options);
5b0582f3digeff10 years ago110}
111
831f4a85Patricio Beltran9 years ago112/**
113* Spawns a child process with the params passed
114* This method has logic to do while the command is executing
115* {command} - The command to be invoked in the child process
116* {args} - Arguments to be passed to the command
117* {options} - additional options with which the child process needs to be spawned
118*/
119public spawnWithProgress(command: string, args: string[], options: Options = { verbosity: CommandVerbosity.OUTPUT }): Q.Promise<void> {
120let deferred = Q.defer<void>();
121const spawnOptions = Object.assign({}, { cwd: this.currentWorkingDirectory }, options);
122const commandWithArgs = command + " " + args.join(" ");
123const timeBetweenDots = 1500;
b0af599cJimmy Thomson9 years ago124let lastDotTime = 0;
831f4a85Patricio Beltran9 years ago125
126const printDot = () => {
b0af599cJimmy Thomson9 years ago127const now = Date.now();
128if (now - lastDotTime > timeBetweenDots) {
129lastDotTime = now;
0a68f8dbArtem Egorov8 years ago130this.logger.logStream(".", process.stdout);
b0af599cJimmy Thomson9 years ago131}
831f4a85Patricio Beltran9 years ago132};
133
134if (options.verbosity === CommandVerbosity.OUTPUT) {
0a68f8dbArtem Egorov8 years ago135this.logger.debug(CommandExecutor.getCommandStatusString(commandWithArgs, CommandStatus.Start));
831f4a85Patricio Beltran9 years ago136}
137
138const result = this.childProcess.spawn(command, args, spawnOptions);
139
140result.stdout.on("data", (data: Buffer) => {
141if (options.verbosity === CommandVerbosity.OUTPUT) {
0a68f8dbArtem Egorov8 years ago142this.logger.logStream(data, process.stdout);
b0af599cJimmy Thomson9 years ago143} else if (options.verbosity === CommandVerbosity.PROGRESS) {
831f4a85Patricio Beltran9 years ago144printDot();
145}
146});
147
148result.stderr.on("data", (data: Buffer) => {
149if (options.verbosity === CommandVerbosity.OUTPUT) {
0a68f8dbArtem Egorov8 years ago150this.logger.logStream(data, process.stderr);
b0af599cJimmy Thomson9 years ago151} else if (options.verbosity === CommandVerbosity.PROGRESS) {
831f4a85Patricio Beltran9 years ago152printDot();
153}
154});
155
156result.outcome = result.outcome.then(
157() => {
158if (options.verbosity === CommandVerbosity.OUTPUT) {
0a68f8dbArtem Egorov8 years ago159this.logger.debug(CommandExecutor.getCommandStatusString(commandWithArgs, CommandStatus.End));
831f4a85Patricio Beltran9 years ago160}
0a68f8dbArtem Egorov8 years ago161this.logger.logStream("\n", process.stdout);
831f4a85Patricio Beltran9 years ago162deferred.resolve(void 0);
163},
164reason => {
0d827d9bJimmy Thomson9 years ago165deferred.reject(reason);
831f4a85Patricio Beltran9 years ago166return this.generateRejectionForCommand(commandWithArgs, reason);
167});
168return deferred.promise;
169}
170
af1474acRedMickey6 years ago171public selectReactNativeCLI(): string {
172return CommandExecutor.ReactNativeCommand || path.resolve(this.currentWorkingDirectory, "node_modules", ".bin", "react-native");
173}
174
9596aa53digeff10 years ago175private spawnChildProcess(command: string, args: string[], options: Options = {}): ISpawnResult {
176const spawnOptions = Object.assign({}, { cwd: this.currentWorkingDirectory }, options);
177const commandWithArgs = command + " " + args.join(" ");
3fb37ad5unknown10 years ago178
0a68f8dbArtem Egorov8 years ago179this.logger.debug(CommandExecutor.getCommandStatusString(commandWithArgs, CommandStatus.Start));
9596aa53digeff10 years ago180const result = this.childProcess.spawn(command, args, spawnOptions);
3fb37ad5unknown10 years ago181
182result.stderr.on("data", (data: Buffer) => {
0a68f8dbArtem Egorov8 years ago183this.logger.logStream(data, process.stderr);
3fb37ad5unknown10 years ago184});
185
186result.stdout.on("data", (data: Buffer) => {
0a68f8dbArtem Egorov8 years ago187this.logger.logStream(data, process.stdout);
3fb37ad5unknown10 years ago188});
189
10873e11digeff10 years ago190result.outcome = result.outcome.then(
9596aa53digeff10 years ago191() =>
0a68f8dbArtem Egorov8 years ago192this.logger.debug(CommandExecutor.getCommandStatusString(commandWithArgs, CommandStatus.End)),
10873e11digeff10 years ago193reason =>
4f7c7447Meena Kunnathur Balakrishnan10 years ago194this.generateRejectionForCommand(commandWithArgs, reason));
efa076b0Meena Kunnathur Balakrishnan10 years ago195return result;
3fb37ad5unknown10 years ago196}
10873e11digeff10 years ago197
3677173cdigeff10 years ago198private generateRejectionForCommand(command: string, reason: any): Q.Promise<void> {
4f7c7447Meena Kunnathur Balakrishnan10 years ago199return Q.reject<void>(ErrorHelper.getNestedError(reason, InternalErrorCode.CommandFailed, command));
10873e11digeff10 years ago200}
0a68f8dbArtem Egorov8 years ago201
202private static getCommandStatusString(command: string, status: CommandStatus) {
203switch (status) {
204case CommandStatus.Start:
fc602bb6Yuri Skorokhodov7 years ago205return `Executing command: ${command}`;
0a68f8dbArtem Egorov8 years ago206case CommandStatus.End:
fc602bb6Yuri Skorokhodov7 years ago207return `Finished executing: ${command}`;
0a68f8dbArtem Egorov8 years ago208default:
fc602bb6Yuri Skorokhodov7 years ago209throw ErrorHelper.getInternalError(InternalErrorCode.UnsupportedCommandStatus);
0a68f8dbArtem Egorov8 years ago210}
211}
3fb37ad5unknown10 years ago212}