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
0.17.0

Branches

Tags

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

Clone

HTTPS

Download ZIP

vscode-react-native/src/extension

src/extension/extensionServer.ts

361lines · modecode

RawDownload
Latest commit unavailable.
1// 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";
5import * as vscode from "vscode";
6import {MessagingHelper}from "../common/extensionMessaging";
7import {OutputChannelLogger} from "./log/OutputChannelLogger";
8import {Packager} from "../common/packager";
9import {ProjectVersionHelper} from "../common/projectVersionHelper";
10import {LogCatMonitor} from "./android/logCatMonitor";
11import {FileSystem} from "../common/node/fileSystem";
12import {SettingsHelper} from "./settingsHelper";
13import {Telemetry} from "../common/telemetry";
14import {PlatformResolver} from "./platformResolver";
15import {TelemetryHelper} from "../common/telemetryHelper";
16import {ErrorHelper} from "../common/error/errorHelper";
17import {InternalErrorCode} from "../common/error/internalErrorCode";
18import {TargetPlatformHelper} from "../common/targetPlatformHelper";
19import {MobilePlatformDeps} from "./generalMobilePlatform";
20import {IRemoteExtension, OpenFileRequest} from "../common/remoteExtension";
21import {CommandExecutor} from "../common/commandExecutor";
22import {ExperimentService} from "./experimentService/experimentService";
23import * as rpc from "noice-json-rpc";
24import * as WebSocket from "ws";
25import WebSocketServer = WebSocket.Server;
26import * as nls from "vscode-nls";
27const localize = nls.loadMessageBundle();
28
29export class ExtensionServer implements vscode.Disposable {
30 public api: IRemoteExtension;
31 public isDisposed: boolean = false;
32 private serverInstance: WebSocketServer | null;
33 private reactNativePackager: Packager;
34 private pipePath: string;
35 private logCatMonitor: LogCatMonitor | null = null;
36 private logger: OutputChannelLogger = OutputChannelLogger.getMainChannel();
37 private experimentService: ExperimentService;
38
39 public constructor(projectRootPath: string, reactNativePackager: Packager) {
40 this.pipePath = MessagingHelper.getPath(projectRootPath);
41 this.reactNativePackager = reactNativePackager;
42 this.experimentService = ExperimentService.create();
43 }
44
45 /**
46 * Starts the server.
47 */
48 public setup(): Q.Promise<void> {
49 this.isDisposed = false;
50
51 return Q.Promise((resolve, reject) => {
52 this._setup(resolve, reject);
53 });
54 }
55
56 /**
57 * Stops the server.
58 */
59 public dispose(): void {
60 this.isDisposed = true;
61 if (this.serverInstance) {
62 this.serverInstance.close();
63 this.serverInstance = null;
64 }
65
66 this.reactNativePackager.getStatusIndicator().dispose();
67 this.reactNativePackager.stop(true);
68 this.stopMonitoringLogCat();
69 }
70
71 private _setup(resolve: (val: void | Q.IPromise<void>) => void, reject: (reason: any) => void): void {
72 const errorCallback = this.recoverServer.bind(this, resolve, reject);
73 let launchCallback = (done: (val: void | Q.IPromise<void>) => void) => {
74 this.logger.debug(`Extension messaging server started at ${this.pipePath}.`);
75
76 if (this.serverInstance) {
77 this.serverInstance.removeListener("error", errorCallback);
78 this.serverInstance.on("error", this.recoverServer.bind(this, null, null));
79 }
80 done(void 0);
81 };
82
83 this.serverInstance = new WebSocketServer({port: <any>this.pipePath});
84 this.api = new rpc.Server(this.serverInstance).api();
85 this.serverInstance.on("listening", launchCallback.bind(this, resolve));
86 this.serverInstance.on("error", errorCallback);
87
88 this.setupApiHandlers();
89 }
90
91 private setupApiHandlers(): void {
92 let methods: any = {};
93 methods.stopMonitoringLogCat = this.stopMonitoringLogCat.bind(this);
94 methods.getPackagerPort = this.getPackagerPort.bind(this);
95 methods.sendTelemetry = this.sendTelemetry.bind(this);
96 methods.openFileAtLocation = this.openFileAtLocation.bind(this);
97 methods.showInformationMessage = this.showInformationMessage.bind(this);
98 methods.launch = this.launch.bind(this);
99 methods.showDevMenu = this.showDevMenu.bind(this);
100 methods.reloadApp = this.reloadApp.bind(this);
101
102 this.api.Extension.expose(methods);
103 }
104
105 private showDevMenu(deviceId?: string) {
106 this.api.Debugger.emitShowDevMenu(deviceId);
107 }
108
109 private reloadApp(deviceId?: string) {
110 this.api.Debugger.emitReloadApp(deviceId);
111 }
112
113 /**
114 * Recovers the server in case the named socket we use already exists, but no other instance of VSCode is active.
115 */
116 // eslint-disable-next-line
117 private recoverServer(resolve: (value: void) => {} , reject: (reason: any) => {}, error: any): void {
118 let errorHandler = (e: any) => {
119 /* The named socket is not used. */
120 if (e.code === "ECONNREFUSED") {
121 new FileSystem().removePathRecursivelyAsync(this.pipePath)
122 .then(() => {
123 if (resolve && reject) {
124 return this._setup(resolve, reject);
125 } else {
126 return this.setup();
127 }
128 })
129 .done();
130 }
131 };
132
133 /* The named socket already exists. */
134 if (error.code === "EADDRINUSE") {
135 let clientSocket = new WebSocket(`ws+unix://${this.pipePath}`);
136 clientSocket.on("error", errorHandler);
137 clientSocket.on("open", function() {
138 clientSocket.close();
139 });
140 }
141 }
142
143 /**
144 * Message handler for GET_PACKAGER_PORT.
145 */
146 private getPackagerPort(projectFolder: string): number {
147 return SettingsHelper.getPackagerPort(projectFolder);
148 }
149
150 /**
151 * Message handler for OPEN_FILE_AT_LOCATION
152 */
153 private openFileAtLocation(openFileRequest: OpenFileRequest): Promise<void> {
154 const { filename, lineNumber } = openFileRequest;
155 return new Promise((resolve) => {
156 vscode.workspace.openTextDocument(vscode.Uri.file(filename))
157 .then((document: vscode.TextDocument) => {
158 vscode.window.showTextDocument(document)
159 .then((editor: vscode.TextEditor) => {
160 let range = editor.document.lineAt(lineNumber - 1).range;
161 editor.selection = new vscode.Selection(range.start, range.end);
162 editor.revealRange(range, vscode.TextEditorRevealType.InCenter);
163 resolve();
164 });
165 });
166 });
167 }
168
169 private stopMonitoringLogCat(): void {
170 if (this.logCatMonitor) {
171 this.logCatMonitor.dispose();
172 this.logCatMonitor = null;
173 }
174 }
175
176 /**
177 * Sends telemetry
178 */
179 private sendTelemetry(telemetryRequest: Telemetry.TelemetryRequest): void {
180 const { extensionId, extensionVersion, appInsightsKey, eventName, properties, measures } = telemetryRequest;
181 Telemetry.sendExtensionTelemetry(extensionId, extensionVersion, appInsightsKey, eventName, properties, measures);
182 }
183
184 /**
185 * Message handler for SHOW_INFORMATION_MESSAGE
186 */
187 private showInformationMessage(message: string): void {
188 vscode.window.showInformationMessage(message);
189 }
190
191 private launch(request: any): Promise<any> {
192 this.experimentService.runExperiments()
193 .catch(err => {
194 this.logger.debug("An error occurred while running experiments. " + err.message);
195 });
196
197 let mobilePlatformOptions = requestSetup(request.arguments);
198
199 // We add the parameter if it's defined (adapter crashes otherwise)
200 if (!isNullOrUndefined(request.arguments.logCatArguments)) {
201 mobilePlatformOptions.logCatArguments = [parseLogCatArguments(request.arguments.logCatArguments)];
202 }
203
204 if (!isNullOrUndefined(request.arguments.variant)) {
205 mobilePlatformOptions.variant = request.arguments.variant;
206 }
207
208 if (!isNullOrUndefined(request.arguments.scheme)) {
209 mobilePlatformOptions.scheme = request.arguments.scheme;
210 }
211
212 if (!isNullOrUndefined(request.arguments.productName)) {
213 mobilePlatformOptions.productName = request.arguments.productName;
214 }
215
216 if (!isNullOrUndefined(request.arguments.launchActivity)) {
217 mobilePlatformOptions.debugLaunchActivity = request.arguments.launchActivity;
218 }
219
220 if (request.arguments.type === "reactnativedirect") {
221 mobilePlatformOptions.isDirect = true;
222 }
223
224 mobilePlatformOptions.packagerPort = SettingsHelper.getPackagerPort(request.arguments.cwd || request.arguments.program);
225 const platformDeps: MobilePlatformDeps = {
226 packager: this.reactNativePackager,
227 };
228 const mobilePlatform = new PlatformResolver()
229 .resolveMobilePlatform(request.arguments.platform, mobilePlatformOptions, platformDeps);
230 return new Promise((resolve, reject) => {
231 let extProps: any = {
232 platform: {
233 value: request.arguments.platform,
234 isPii: false,
235 },
236 };
237
238 if (mobilePlatformOptions.isDirect) {
239 extProps.isDirect = {
240 value: true,
241 isPii: false,
242 };
243 }
244
245 ProjectVersionHelper.getReactNativePackageVersionsFromNodeModules(mobilePlatformOptions.projectRoot, true)
246 .then(versions => {
247 mobilePlatformOptions.reactNativeVersions = versions;
248 extProps = TelemetryHelper.addPropertyToTelemetryProperties(versions.reactNativeVersion, "reactNativeVersion", extProps);
249 if (request.arguments.platform === "windows") {
250 if (ProjectVersionHelper.isVersionError(versions.reactNativeWindowsVersion)) {
251 throw ErrorHelper.getInternalError(InternalErrorCode.ReactNativeWindowsIsNotInstalled);
252 }
253 extProps = TelemetryHelper.addPropertyToTelemetryProperties(versions.reactNativeWindowsVersion, "reactNativeWindowsVersion", extProps);
254 }
255 TelemetryHelper.generate("launch", extProps, (generator) => {
256 generator.step("checkPlatformCompatibility");
257 TargetPlatformHelper.checkTargetPlatformSupport(mobilePlatformOptions.platform);
258 return mobilePlatform.beforeStartPackager()
259 .then(() => {
260 generator.step("startPackager");
261 return mobilePlatform.startPackager();
262 })
263 .then(() => {
264 // We've seen that if we don't prewarm the bundle cache, the app fails on the first attempt to connect to the debugger logic
265 // and the user needs to Reload JS manually. We prewarm it to prevent that issue
266 generator.step("prewarmBundleCache");
267 this.logger.info(localize("PrewarmingBundleCache", "Prewarming bundle cache. This may take a while ..."));
268 return mobilePlatform.prewarmBundleCache();
269 })
270 .then(() => {
271 generator.step("mobilePlatform.runApp").add("target", mobilePlatformOptions.target, false);
272 this.logger.info(localize("BuildingAndRunningApplication", "Building and running application."));
273 return mobilePlatform.runApp();
274 })
275 .then(() => {
276 if (mobilePlatformOptions.isDirect) {
277 generator.step("mobilePlatform.enableDirectDebuggingMode");
278 if (request.arguments.platform === "android") {
279 this.logger.info(localize("PrepareHermesDebugging", "Prepare Hermes debugging (experimental)"));
280 }
281 return mobilePlatform.disableJSDebuggingMode();
282 }
283 generator.step("mobilePlatform.enableJSDebuggingMode");
284 this.logger.info(localize("EnableJSDebugging", "Enable JS Debugging"));
285 return mobilePlatform.enableJSDebuggingMode();
286 })
287 .then(() => {
288 resolve();
289 })
290 .catch(error => {
291 generator.addError(error);
292 this.logger.error(error);
293 reject(error);
294 });
295 });
296 })
297 .catch(error => {
298 if (error && error.errorCode) {
299 if (error.errorCode === InternalErrorCode.ReactNativePackageIsNotInstalled) {
300 TelemetryHelper.sendErrorEvent(
301 "ReactNativePackageIsNotInstalled",
302 ErrorHelper.getInternalError(InternalErrorCode.ReactNativePackageIsNotInstalled)
303 );
304 } else if (error.errorCode === InternalErrorCode.ReactNativeWindowsIsNotInstalled) {
305 TelemetryHelper.sendErrorEvent(
306 "ReactNativeWindowsPackageIsNotInstalled",
307 ErrorHelper.getInternalError(InternalErrorCode.ReactNativeWindowsIsNotInstalled)
308 );
309 }
310 }
311 this.logger.error(error);
312 reject(error);
313 });
314 });
315 }
316}
317
318/**
319 * Parses log cat arguments to a string
320 */
321function parseLogCatArguments(userProvidedLogCatArguments: any): string {
322 return Array.isArray(userProvidedLogCatArguments)
323 ? userProvidedLogCatArguments.join(" ") // If it's an array, we join the arguments
324 : userProvidedLogCatArguments; // If not, we leave it as-is
325}
326
327function isNullOrUndefined(value: any): boolean {
328 return typeof value === "undefined" || value === null;
329}
330
331function requestSetup(args: any): any {
332 const workspaceFolder: vscode.WorkspaceFolder = <vscode.WorkspaceFolder>vscode.workspace.getWorkspaceFolder(vscode.Uri.file(args.cwd || args.program));
333 const projectRootPath = getProjectRoot(args);
334 let mobilePlatformOptions: any = {
335 workspaceRoot: workspaceFolder.uri.fsPath,
336 projectRoot: projectRootPath,
337 platform: args.platform,
338 env: args.env,
339 envFile: args.envFile,
340 target: args.target || "simulator",
341 };
342
343 if (args.platform === "exponent") {
344 mobilePlatformOptions.expoHostType = args.expoHostType || "tunnel";
345 }
346
347 CommandExecutor.ReactNativeCommand = SettingsHelper.getReactNativeGlobalCommandName(workspaceFolder.uri);
348
349 if (!args.runArguments) {
350 let runArgs = SettingsHelper.getRunArgs(args.platform, args.target || "simulator", workspaceFolder.uri);
351 mobilePlatformOptions.runArguments = runArgs;
352 } else {
353 mobilePlatformOptions.runArguments = args.runArguments;
354 }
355
356 return mobilePlatformOptions;
357}
358
359function getProjectRoot(args: any): string {
360 return SettingsHelper.getReactNativeProjectRoot(args.cwd || args.program);
361}
362