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
75c7d921c8412f73630c6d1964c571077e286014

Branches

Tags

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

Clone

HTTPS

Download ZIP

vscode-react-native/src/debugger

src/debugger/nodeDebugWrapper.ts

175lines · 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 fs from "fs";
5import * as path from "path";
6import * as http from "http";
7
8import {Telemetry} from "../common/telemetry";
9import {TelemetryHelper} from "../common/telemetryHelper";
10import {ExtensionMessageSender, ExtensionMessage} from "../common/extensionMessaging";
11
12// These typings do not reflect the typings as intended to be used
13// but rather as they exist in truth, so we can reach into the internals
14// and access what we need.
15declare module VSCodeDebugAdapter {
16 class DebugSession {
17 public static run: Function;
18 public sendEvent(event: VSCodeDebugAdapter.InitializedEvent): void;
19 public start(input: any, output: any): void;
20 public launchRequest(response: any, args: any): void;
21 public disconnectRequest(response: any, args: any): void;
22 }
23 class InitializedEvent {
24 constructor();
25 }
26 class OutputEvent {
27 constructor(message: string, destination?: string);
28 }
29 class TerminatedEvent {
30 constructor();
31 }
32}
33
34declare class SourceMaps {
35 public _sourceToGeneratedMaps: {};
36 public _generatedToSourceMaps: {};
37 public _allSourceMaps: {};
38}
39
40declare class NodeDebugSession extends VSCodeDebugAdapter.DebugSession {
41 public _sourceMaps: SourceMaps;
42}
43
44interface ILaunchArgs {
45 platform: string;
46 target?: string;
47 internalDebuggerPort?: any;
48 args: string[];
49 logCatArguments: any;
50}
51
52let version = JSON.parse(fs.readFileSync(path.join(__dirname, "..", "..", "package.json"), "utf-8")).version;
53
54function bailOut(reason: string): void {
55 // Things have gone wrong in initialization: Report the error to telemetry and exit
56 TelemetryHelper.sendSimpleEvent(reason);
57 process.exit(1);
58}
59
60function parseLogCatArguments(userProvidedLogCatArguments: any) {
61 return Array.isArray(userProvidedLogCatArguments)
62 ? userProvidedLogCatArguments.join(" ") // If it's an array, we join the arguments
63 : userProvidedLogCatArguments; // If not, we leave it as-is
64}
65
66function isNullOrUndefined(value: any): boolean {
67 return typeof value === "undefined" || value === null;
68}
69
70// Enable telemetry
71Telemetry.init("react-native-debug-adapter", version, {isExtensionProcess: false});
72let nodeDebugFolder: string;
73let vscodeDebugAdapterPackage: typeof VSCodeDebugAdapter;
74
75// nodeDebugLocation.json is dynamically generated on extension activation.
76// If it fails, we must not have been in a react native project
77try {
78 /* tslint:disable:no-var-requires */
79 nodeDebugFolder = require("./nodeDebugLocation.json").nodeDebugPath;
80 vscodeDebugAdapterPackage = require(path.join(nodeDebugFolder, "node_modules", "vscode-debugadapter"));
81 /* tslint:enable:no-var-requires */
82} catch (e) {
83 // Nothing we can do here: can't even communicate back because we don't know how to speak debug adapter
84 bailOut("cannotFindDebugAdapter");
85}
86
87// Temporarily dummy out the DebugSession.run function so we do not start the debug adapter until we are ready
88const originalDebugSessionRun = vscodeDebugAdapterPackage.DebugSession.run;
89vscodeDebugAdapterPackage.DebugSession.run = function() { };
90
91let nodeDebug: { NodeDebugSession: typeof NodeDebugSession };
92
93try {
94 /* tslint:disable:no-var-requires */
95 nodeDebug = require(path.join(nodeDebugFolder, "out", "node", "nodeDebug"));
96 /* tslint:enable:no-var-requires */
97} catch (e) {
98 // Unable to find nodeDebug, but we can make our own communication channel now
99 const debugSession = new vscodeDebugAdapterPackage.DebugSession();
100 // Note: this will not work in the context of debugging the debug adapter and communicating over a socket,
101 // but in that case we have much better ways to investigate errors.
102 debugSession.start(process.stdin, process.stdout);
103 debugSession.sendEvent(new vscodeDebugAdapterPackage.OutputEvent("Unable to start debug adapter: " + e.toString(), "stderr"));
104 debugSession.sendEvent(new vscodeDebugAdapterPackage.TerminatedEvent());
105
106 bailOut("cannotFindNodeDebugAdapter");
107}
108
109vscodeDebugAdapterPackage.DebugSession.run = originalDebugSessionRun;
110
111// Intecept the "launchRequest" instance method of NodeDebugSession to interpret arguments
112const originalNodeDebugSessionLaunchRequest = nodeDebug.NodeDebugSession.prototype.launchRequest;
113nodeDebug.NodeDebugSession.prototype.launchRequest = function(request: any, args: ILaunchArgs) {
114 // Create a server waiting for messages to re-initialize the debug session;
115 const reinitializeServer = http.createServer((req, res) => {
116 res.statusCode = 404;
117 if (req.url === "/refreshBreakpoints") {
118 res.statusCode = 200;
119 if (this) {
120 const sourceMaps = this._sourceMaps;
121 if (sourceMaps) {
122 // Flush any cached source maps
123 sourceMaps._allSourceMaps = {};
124 sourceMaps._generatedToSourceMaps = {};
125 sourceMaps._sourceToGeneratedMaps = {};
126 }
127 // Send an "initialized" event to trigger breakpoints to be re-sent
128 this.sendEvent(new vscodeDebugAdapterPackage.InitializedEvent());
129 }
130 }
131 res.end();
132 });
133 const debugServerListeningPort = parseInt(args.internalDebuggerPort, 10) || 9090;
134
135 reinitializeServer.listen(debugServerListeningPort);
136 reinitializeServer.on("error", (err: Error) => {
137 TelemetryHelper.sendSimpleEvent("reinitializeServerError");
138 this.sendEvent(new vscodeDebugAdapterPackage.OutputEvent("Error in debug adapter server: " + err.toString(), "stderr"));
139 this.sendEvent(new vscodeDebugAdapterPackage.OutputEvent("Breakpoints may not update. Consider restarting and specifying a different 'internalDebuggerPort' in launch.json"));
140 });
141
142 // We do not permit arbitrary args to be passed to our process
143 args.args = [
144 args.platform,
145 debugServerListeningPort.toString(),
146 args.target || "simulator",
147 ];
148
149 if (!isNullOrUndefined(args.logCatArguments)) { // We add the parameter if it's defined (adapter crashes otherwise)
150 args.args = args.args.concat([parseLogCatArguments(args.logCatArguments)]);
151 }
152
153 originalNodeDebugSessionLaunchRequest.call(this, request, args);
154};
155
156// Intecept the "launchRequest" instance method of NodeDebugSession to interpret arguments
157const originalNodeDebugSessionDisconnectRequest = nodeDebug.NodeDebugSession.prototype.disconnectRequest;
158function customDisconnectRequest(response: any, args: any): void {
159 try {
160 // First we tell the extension to stop monitoring the logcat, and then we disconnect the debugging session
161 const extensionMessageSender = new ExtensionMessageSender();
162 extensionMessageSender.sendMessage(ExtensionMessage.STOP_MONITORING_LOGCAT)
163 .finally(() => originalNodeDebugSessionDisconnectRequest.call(this, response, args))
164 .done(() => {}, reason => // We just print a warning if something fails
165 process.stderr.write(`WARNING: Couldn't stop monitoring logcat: ${reason.message || reason}\n`));
166 } catch (exception) {
167 // This is a "nice to have" feature, so we just fire the message and forget. We don't event handle
168 // errors in the response promise
169 process.stderr.write(`WARNING: Couldn't stop monitoring logcat. Sync exception: ${exception.message || exception}\n`);
170 originalNodeDebugSessionDisconnectRequest.call(this, response, args);
171 }
172}
173nodeDebug.NodeDebugSession.prototype.disconnectRequest = customDisconnectRequest;
174
175vscodeDebugAdapterPackage.DebugSession.run(nodeDebug.NodeDebugSession);
176