GitVita
New repositoryImport repositoryNew issue
Your repositories Your dashboard Sign in

microsoft/vscode-react-native

Public

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

Watch0Fork0Star0
CodeCommitsIssuesPull requestsActionsInsightsSecurity
f5edf87f2af14e37e63c6f6638d9558fc6a5d1ee

Branches

Tags

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

Clone

HTTPS

Download ZIP

vscode-react-native/src/debugger

src/debugger/appWorker.ts

234lines · 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 vm from "vm";
5import * as Q from "q";
6import * as path from "path";
7import * as WebSocket from "ws";
8import {ScriptImporter} from "./scriptImporter";
9import {Packager} from "../common/packager";
10import {Log, LogLevel} from "../common/log";
11import {Node} from "../common/node/node";
12
13import Module = require("module");
14
15// This file is a replacement of: https://github.com/facebook/react-native/blob/8d397b4cbc05ad801cfafb421cee39bcfe89711d/local-cli/server/util/debugger.html for Node.JS
16
17interface DebuggerWorkerSandbox {
18 __filename: string;
19 __dirname: string;
20 self: DebuggerWorkerSandbox;
21 console: typeof console;
22 require: (id: string) => any;
23 importScripts: (url: string) => void;
24 postMessage: (object: any) => void;
25 onmessage: (object: RNAppMessage) => void;
26 postMessageArgument: RNAppMessage; // We use this argument to pass messages to the worker
27}
28
29interface RNAppMessage {
30 method: string;
31 // These objects have also other properties but that we don't currently use
32}
33
34function printDebuggingError(message: string, reason: any) {
35 Log.logWarning(`${message}. Debugging won't work: Try reloading the JS from inside the app, or Reconnect the VS Code debugger`, reason);
36}
37
38export class SandboxedAppWorker {
39 /** This class will run the RN App logic inside a sandbox. The framework to run the logic is provided by the file
40 * debuggerWorker.js (designed to run on a WebWorker). We load that file inside a sandbox, and then we use the
41 * PROCESS_MESSAGE_INSIDE_SANDBOX script to execute the logic to respond to a message inside the sandbox.
42 * The code inside the debuggerWorker.js will call the global function postMessage to send a reply back to the app,
43 * so we define our custom function there, so we can handle the message. We also provide our own importScript function
44 * to download any script used by debuggerWorker.js
45 */
46 private sourcesStoragePath: string;
47 private debugAdapterPort: number;
48 private postReplyToApp: (message: any) => void;
49
50 private sandbox: DebuggerWorkerSandbox;
51 private sandboxContext: vm.Context;
52 private scriptToReceiveMessageInSandbox: vm.Script;
53
54 private pendingScriptImport = Q(void 0);
55
56 private static PROCESS_MESSAGE_INSIDE_SANDBOX = "onmessage({ data: postMessageArgument });";
57
58 constructor(sourcesStoragePath: string, debugAdapterPort: number, postReplyToApp: (message: any) => void) {
59 this.sourcesStoragePath = sourcesStoragePath;
60 this.debugAdapterPort = debugAdapterPort;
61 this.postReplyToApp = postReplyToApp;
62 this.scriptToReceiveMessageInSandbox = new vm.Script(SandboxedAppWorker.PROCESS_MESSAGE_INSIDE_SANDBOX);
63 }
64
65 public start(): Q.Promise<void> {
66 let scriptToRunPath = require.resolve(path.join(this.sourcesStoragePath, ScriptImporter.DEBUGGER_WORKER_FILE_BASENAME));
67 this.initializeSandboxAndContext(scriptToRunPath);
68 return this.readFileContents(scriptToRunPath).then(fileContents =>
69 // On a debugger worker the onmessage variable already exist. We need to declare it before the
70 // javascript file can assign it. We do it in the first line without a new line to not break
71 // the debugging experience of debugging debuggerWorker.js itself (as part of the extension)
72 this.runInSandbox(scriptToRunPath, "var onmessage = null; " + fileContents));
73 }
74
75 public postMessage(object: RNAppMessage): void {
76 this.sandbox.postMessageArgument = object;
77 this.scriptToReceiveMessageInSandbox.runInContext(this.sandboxContext);
78 }
79
80 private initializeSandboxAndContext(scriptToRunPath: string): void {
81 let scriptToRunModule = new Module(scriptToRunPath);
82
83 this.sandbox = {
84 __filename: scriptToRunPath,
85 __dirname: path.dirname(scriptToRunPath),
86 self: null,
87 console: console,
88 require: (filePath: string) => scriptToRunModule.require(filePath), // Give the sandbox access to require("<filePath>");
89 importScripts: (url: string) => this.importScripts(url), // Import script like using <script/>
90 postMessage: (object: any) => this.gotResponseFromDebuggerWorker(object), // Post message back to the UI thread
91 onmessage: null,
92 postMessageArgument: null
93 };
94 this.sandbox.self = this.sandbox;
95
96 this.sandboxContext = vm.createContext(this.sandbox);
97 }
98
99 private runInSandbox(filename: string, fileContents?: string): Q.Promise<void> {
100 let fileContentsPromise = fileContents
101 ? Q(fileContents)
102 : this.readFileContents(filename);
103
104 return fileContentsPromise.then(contents => {
105 vm.runInContext(contents, this.sandboxContext, filename);
106 });
107 }
108
109 private readFileContents(filename: string) {
110 return new Node.FileSystem().readFile(filename).then(contents => contents.toString());
111 }
112
113 private importScripts(url: string): void {
114 /* The debuggerWorker.js executes this code:
115 importScripts(message.url);
116 sendReply();
117
118 In the original code importScripts is a sync call. In our code it's async, so we need to mess with sendReply() so we won't
119 actually send the reply back to the application until after importScripts has finished executing. We use
120 this.pendingScriptImport to make the gotResponseFromDebuggerWorker() method hold the reply back, until've finished importing
121 and running the script */
122 let defer = Q.defer<{}>();
123 this.pendingScriptImport = defer.promise;
124
125 // The next line converts to any due to the incorrect typing on node.d.ts of vm.runInThisContext
126 new ScriptImporter(this.sourcesStoragePath).downloadAppScript(url, this.debugAdapterPort)
127 .then(downloadedScript =>
128 this.runInSandbox(downloadedScript.filepath, downloadedScript.contents))
129 .done(() => {
130 // Now we let the reply to the app proceed
131 defer.resolve({});
132 }, reason => {
133 printDebuggingError(`Couldn't import script at <${url}>`, reason);
134 });
135 }
136
137 private gotResponseFromDebuggerWorker(object: any): void {
138 // We might need to hold the response until a script is imported. See comments on this.importScripts()
139 this.pendingScriptImport.done(() =>
140 this.postReplyToApp(object), reason => {
141 printDebuggingError("Unexpected internal error while processing a message from the RN App.", reason);
142 });
143 }
144}
145
146export class MultipleLifetimesAppWorker {
147 /** This class will create a SandboxedAppWorker that will run the RN App logic, and then create a socket
148 * and send the RN App messages to the SandboxedAppWorker. The only RN App message that this class handles
149 * is the prepareJSRuntime, which we reply to the RN App that the sandbox was created succesfully.
150 * When the socket closes, we'll create a new SandboxedAppWorker and a new socket pair and discard the old ones.
151 */
152 private sourcesStoragePath: string;
153 private debugAdapterPort: number;
154 private socketToApp: WebSocket;
155 private singleLifetimeWorker: SandboxedAppWorker;
156
157 constructor(sourcesStoragePath: string, debugAdapterPort: number) {
158 this.sourcesStoragePath = sourcesStoragePath;
159 this.debugAdapterPort = debugAdapterPort;
160 console.assert(!!this.sourcesStoragePath, "The sourcesStoragePath argument was null or empty");
161 }
162
163 public start(): Q.Promise<void> {
164 this.singleLifetimeWorker = new SandboxedAppWorker(this.sourcesStoragePath, this.debugAdapterPort, (message) => {
165 this.sendMessageToApp(message);
166 });
167 return this.singleLifetimeWorker.start().then(() => {
168 this.socketToApp = this.createSocketToApp();
169 });
170 }
171
172 private createSocketToApp() {
173 let socketToApp = new WebSocket(this.debuggerProxyUrl());
174 socketToApp.on("open", () =>
175 this.onSocketOpened());
176 socketToApp.on("close", () =>
177 this.onSocketClose());
178 socketToApp.on("message",
179 (message: any) => this.onMessage(message));
180 socketToApp.on("error",
181 (error: Error) => printDebuggingError("An error ocurred while using the socket to communicate with the React Native app", error));
182 return socketToApp;
183 }
184
185 private debuggerProxyUrl() {
186 return `ws://${Packager.HOST}/debugger-proxy?role=debugger&name=vscode`;
187 }
188
189 private onSocketOpened() {
190 Log.logMessage("Established a connection with the Proxy (Packager) to the React Native application");
191 }
192
193 private onSocketClose() {
194 // TODO: Add some logic to not print this message that often, we'll spam the user
195 Log.logMessage("Disconnected from the Proxy (Packager) to the React Native application. Retrying reconnection soon...");
196 setTimeout(() => this.start(), 100);
197 }
198
199 private onMessage(message: string) {
200 try {
201 Log.logInternalMessage(LogLevel.Trace, "From RN APP: " + message);
202 let object = <RNAppMessage>JSON.parse(message);
203 if (object.method === "prepareJSRuntime") {
204 // The MultipleLifetimesAppWorker will handle prepareJSRuntime aka create new lifetime
205 this.gotPrepareJSRuntime(object);
206 } else if (object.method) {
207 // All the other messages are handled by the single lifetime worker
208 this.singleLifetimeWorker.postMessage(object);
209 } else {
210 // Message doesn't have a method. Ignore it. This is an info message instead of warn because it's normal and expected
211 Log.logInternalMessage(LogLevel.Info, "The react-native app sent a message without specifying a method: " + message);
212 }
213 } catch (exception) {
214 printDebuggingError(`Failed to process message from the React Native app. Message:\n${message}`, exception);
215 }
216 }
217
218 private gotPrepareJSRuntime(message: any): void {
219 // Create the sandbox, and replay that we finished processing the message
220 this.sendMessageToApp({ replyID: parseInt(message.id, 10) });
221 }
222
223 private sendMessageToApp(message: any) {
224 let stringified: string = null;
225 try {
226 stringified = JSON.stringify(message);
227 Log.logInternalMessage(LogLevel.Trace, "To RN APP: " + stringified);
228 this.socketToApp.send(stringified);
229 } catch (exception) {
230 let messageToShow = stringified || ("" + message); // Try to show the stringified version, but show the toString if unavailable
231 printDebuggingError(`Failed to send message to the React Native app. Message:\n${messageToShow}`, exception);
232 }
233 }
234}
235