microsoft/vscode-react-native

Public

mirrored fromhttps://github.com/microsoft/vscode-react-nativeAvailable

CodeCommitsIssuesPull requestsActionsInsightsSecurity
0.4.1

Branches

Tags

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

Clone

HTTPS

Download ZIP

src/extension/extensionServer.ts

285lines · 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
4import * as net from "net";
5import * as Q from "q";
6import * as vscode from "vscode";
7
8import * as em from "../common/extensionMessaging";
9import {Log} from "../common/log/log";
10import {LogLevel} from "../common/log/logHelper";
11import {Packager, PackagerRunAs} from "../common/packager";
12import {PackagerStatus, PackagerStatusIndicator} from "./packagerStatusIndicator";
13import {LogCatMonitor} from "./android/logCatMonitor";
14import {FileSystem} from "../common/node/fileSystem";
15import {ConfigurationReader} from "../common/configurationReader";
16import {SettingsHelper} from "./settingsHelper";
17import {Telemetry} from "../common/telemetry";
18import {ExponentHelper} from "../common/exponent/exponentHelper";
19
20export class ExtensionServer implements vscode.Disposable {
21 private serverInstance: net.Server = null;
22 private messageHandlerDictionary: { [id: number]: ((...argArray: any[]) => Q.Promise<any>) } = {};
23 private reactNativePackager: Packager;
24 private reactNativePackageStatusIndicator: PackagerStatusIndicator;
25 private pipePath: string;
26 private logCatMonitor: LogCatMonitor = null;
27 private exponentHelper: ExponentHelper;
28
29 public constructor(projectRootPath: string, reactNativePackager: Packager, packagerStatusIndicator: PackagerStatusIndicator, exponentHelper: ExponentHelper) {
30
31 this.pipePath = new em.MessagingChannel(projectRootPath).getPath();
32 this.reactNativePackager = reactNativePackager;
33 this.reactNativePackageStatusIndicator = packagerStatusIndicator;
34 this.exponentHelper = exponentHelper;
35
36 /* register handlers for all messages */
37 this.messageHandlerDictionary[em.ExtensionMessage.START_PACKAGER] = this.startPackager;
38 this.messageHandlerDictionary[em.ExtensionMessage.STOP_PACKAGER] = this.stopPackager;
39 this.messageHandlerDictionary[em.ExtensionMessage.RESTART_PACKAGER] = this.restartPackager;
40 this.messageHandlerDictionary[em.ExtensionMessage.PREWARM_BUNDLE_CACHE] = this.prewarmBundleCache;
41 this.messageHandlerDictionary[em.ExtensionMessage.START_MONITORING_LOGCAT] = this.startMonitoringLogCat;
42 this.messageHandlerDictionary[em.ExtensionMessage.STOP_MONITORING_LOGCAT] = this.stopMonitoringLogCat;
43 this.messageHandlerDictionary[em.ExtensionMessage.GET_PACKAGER_PORT] = this.getPackagerPort;
44 this.messageHandlerDictionary[em.ExtensionMessage.SEND_TELEMETRY] = this.sendTelemetry;
45 this.messageHandlerDictionary[em.ExtensionMessage.OPEN_FILE_AT_LOCATION] = this.openFileAtLocation;
46 this.messageHandlerDictionary[em.ExtensionMessage.START_EXPONENT_PACKAGER] = this.startExponentPackager;
47 this.messageHandlerDictionary[em.ExtensionMessage.SHOW_INFORMATION_MESSAGE] = this.showInformationMessage;
48 }
49
50 /**
51 * Starts the server.
52 */
53 public setup(): Q.Promise<void> {
54
55 let deferred = Q.defer<void>();
56
57 let launchCallback = (error: any) => {
58 Log.logInternalMessage(LogLevel.Info, `Extension messaging server started at ${this.pipePath}.`);
59 if (error) {
60 deferred.reject(error);
61 } else {
62 deferred.resolve(null);
63 }
64 };
65
66 this.serverInstance = net.createServer(this.handleSocket.bind(this));
67 this.serverInstance.on("error", this.recoverServer.bind(this));
68 this.serverInstance.listen(this.pipePath, launchCallback);
69
70 return deferred.promise;
71 }
72
73 /**
74 * Stops the server.
75 */
76 public dispose(): void {
77 if (this.serverInstance) {
78 this.serverInstance.close();
79 this.serverInstance = null;
80 }
81
82 this.stopMonitoringLogCat();
83 }
84
85 /**
86 * Message handler for GET_PACKAGER_PORT.
87 */
88 private getPackagerPort(): Q.Promise<number> {
89 return Q(SettingsHelper.getPackagerPort());
90 }
91
92 /**
93 * Message handler for START_PACKAGER.
94 */
95 private startPackager(): Q.Promise<any> {
96 return this.reactNativePackager.isRunning().then((running) => {
97 if (running) {
98 if (this.reactNativePackager.getRunningAs() !== PackagerRunAs.REACT_NATIVE) {
99 return this.reactNativePackager.stop().then(() =>
100 this.reactNativePackageStatusIndicator.updatePackagerStatus(PackagerStatus.PACKAGER_STOPPED)
101 );
102 }
103
104 Log.logMessage("Attaching to running React Native packager");
105 }
106 })
107 .then(() => {
108 return this.reactNativePackager.startAsReactNative();
109 })
110 .then(() =>
111 this.reactNativePackageStatusIndicator.updatePackagerStatus(PackagerStatus.PACKAGER_STARTED));
112 }
113
114 /**
115 * Message handler for START_EXPONENT_PACKAGER.
116 */
117 private startExponentPackager(): Q.Promise<any> {
118 return this.reactNativePackager.isRunning().then((running) => {
119 if (running) {
120 if (this.reactNativePackager.getRunningAs() !== PackagerRunAs.EXPONENT) {
121 return this.reactNativePackager.stop().then(() =>
122 this.reactNativePackageStatusIndicator.updatePackagerStatus(PackagerStatus.PACKAGER_STOPPED));
123 }
124
125 Log.logMessage("Attaching to running Exponent packager");
126 }
127 }).then(() =>
128 this.exponentHelper.configureExponentEnvironment()
129 ).then(() =>
130 this.exponentHelper.loginToExponent(
131 (message, password) => { return Q(vscode.window.showInputBox({ placeHolder: message, password: password })); },
132 (message) => { return Q(vscode.window.showInformationMessage(message)); }
133 ))
134 .then(() => {
135 return this.reactNativePackager.startAsExponent();
136 })
137 .then(exponentUrl => {
138 vscode.commands.executeCommand("vscode.previewHtml", vscode.Uri.parse(exponentUrl), 1, "Expo QR code");
139 this.reactNativePackageStatusIndicator.updatePackagerStatus(PackagerStatus.EXPONENT_PACKAGER_STARTED);
140 return exponentUrl;
141 });
142 }
143
144 /**
145 * Message handler for STOP_PACKAGER.
146 */
147 private stopPackager(): Q.Promise<any> {
148 return this.reactNativePackager.stop()
149 .then(() => this.reactNativePackageStatusIndicator.updatePackagerStatus(PackagerStatus.PACKAGER_STOPPED));
150 }
151
152 /**
153 * Message handler for RESTART_PACKAGER.
154 */
155 private restartPackager(port?: any): Q.Promise<any> {
156 const portToUse = ConfigurationReader.readIntWithDefaultSync(port, SettingsHelper.getPackagerPort());
157 return this.reactNativePackager.restart(portToUse)
158 .then(() =>
159 this.reactNativePackageStatusIndicator.updatePackagerStatus(PackagerStatus.PACKAGER_STARTED));
160 }
161
162 /**
163 * Message handler for PREWARM_BUNDLE_CACHE.
164 */
165 private prewarmBundleCache(platform: string): Q.Promise<any> {
166 return this.reactNativePackager.prewarmBundleCache(platform);
167 }
168
169 /**
170 * Message handler for START_MONITORING_LOGCAT.
171 */
172 private startMonitoringLogCat(deviceId: string, logCatArguments: string): Q.Promise<any> {
173 this.stopMonitoringLogCat(); // Stop previous logcat monitor if it's running
174
175 // this.logCatMonitor can be mutated, so we store it locally too
176 const logCatMonitor = this.logCatMonitor = new LogCatMonitor(deviceId, logCatArguments);
177 logCatMonitor.start() // The LogCat will continue running forever, so we don't wait for it
178 .catch(error =>
179 Log.logWarning("Error while monitoring LogCat", error))
180 .done();
181
182 return Q.resolve<void>(void 0);
183 }
184
185 /**
186 * Message handler for OPEN_FILE_AT_LOCATION
187 */
188 private openFileAtLocation(filename: string, lineNumber: number): Q.Promise<void> {
189 return Q(vscode.workspace.openTextDocument(vscode.Uri.file(filename)).then((document: vscode.TextDocument) => {
190 return vscode.window.showTextDocument(document).then((editor: vscode.TextEditor) => {
191 let range = editor.document.lineAt(lineNumber - 1).range;
192 editor.selection = new vscode.Selection(range.start, range.end);
193 editor.revealRange(range, vscode.TextEditorRevealType.InCenter);
194 });
195 }));
196 }
197
198 private stopMonitoringLogCat(): Q.Promise<void> {
199 if (this.logCatMonitor) {
200 this.logCatMonitor.dispose();
201 this.logCatMonitor = null;
202 }
203
204 return Q.resolve<void>(void 0);
205 }
206
207 /**
208 * Sends telemetry
209 */
210 private sendTelemetry(extensionId: string, extensionVersion: string, appInsightsKey: string, eventName: string, properties: {[key: string]: string}, measures: {[key: string]: number}): Q.Promise<any> {
211 Telemetry.sendExtensionTelemetry(extensionId, extensionVersion, appInsightsKey, eventName, properties, measures);
212 return Q.resolve({});
213 }
214
215 /**
216 * Extension message handler.
217 */
218 private handleExtensionMessage(messageWithArgs: em.MessageWithArguments): Q.Promise<any> {
219 let handler = this.messageHandlerDictionary[messageWithArgs.message];
220 if (handler) {
221 Log.logInternalMessage(LogLevel.Info, "Handling message: " + em.ExtensionMessage[messageWithArgs.message]);
222 return handler.apply(this, messageWithArgs.args);
223 } else {
224 return Q.reject("Invalid message: " + messageWithArgs.message);
225 }
226 }
227
228 /**
229 * Handles connections to the server.
230 */
231 private handleSocket(socket: net.Socket): void {
232 let handleError = (e: any) => {
233 Log.logError(e);
234 socket.end(em.ErrorMarker);
235 };
236
237 let dataCallback = (data: any) => {
238 try {
239 let messageWithArgs: em.MessageWithArguments = JSON.parse(data);
240 this.handleExtensionMessage(messageWithArgs)
241 .then(result => {
242 socket.end(JSON.stringify(result));
243 })
244 .catch((e) => { handleError(e); })
245 .done();
246 } catch (e) {
247 handleError(e);
248 }
249 };
250
251 socket.on("data", dataCallback);
252 };
253
254 /**
255 * Recovers the server in case the named socket we use already exists, but no other instance of VSCode is active.
256 */
257 private recoverServer(error: any): void {
258 let errorHandler = (e: any) => {
259 /* The named socket is not used. */
260 if (e.code === "ECONNREFUSED") {
261 new FileSystem().removePathRecursivelyAsync(this.pipePath)
262 .then(() => {
263 this.serverInstance.listen(this.pipePath);
264 })
265 .done();
266 }
267 };
268
269 /* The named socket already exists. */
270 if (error.code === "EADDRINUSE") {
271 let clientSocket = new net.Socket();
272 clientSocket.on("error", errorHandler);
273 clientSocket.connect(this.pipePath, function() {
274 clientSocket.end();
275 });
276 }
277 }
278
279 /**
280 * Message handler for SHOW_INFORMATION_MESSAGE
281 */
282 private showInformationMessage(message: string): Q.Promise<void> {
283 return Q(vscode.window.showInformationMessage(message)).then(() => {});
284 }
285}
286