microsoft/vscode-react-native

Public

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

CodeCommitsIssuesPull requestsActionsInsightsSecurity
c7e52880e5823a1c28c7aaeb169e495c5140c6e0

Branches

Tags

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

Clone

HTTPS

Download ZIP

src/debugger/nodeDebugWrapper.ts

178lines · modeblame

65bb0c85Jimmy Thomson10 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
d976d077Meena Kunnathur Balakrishnan10 years ago4import * as fs from "fs";
65bb0c85Jimmy Thomson10 years ago5import * as path from "path";
6import * as http from "http";
7
d976d077Meena Kunnathur Balakrishnan10 years ago8import {Telemetry} from "../common/telemetry";
dd442738Jimmy Thomson10 years ago9import {TelemetryHelper} from "../common/telemetryHelper";
c2bf3c4fdigeff10 years ago10import {ExtensionMessageSender, ExtensionMessage} from "../common/extensionMessaging";
d976d077Meena Kunnathur Balakrishnan10 years ago11
65bb0c85Jimmy Thomson10 years ago12// 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 {
16class DebugSession {
17public static run: Function;
5547a16fJimmy Thomson10 years ago18public sendEvent(event: VSCodeDebugAdapter.InitializedEvent): void;
19public start(input: any, output: any): void;
20public launchRequest(response: any, args: any): void;
c2bf3c4fdigeff10 years ago21public disconnectRequest(response: any, args: any): void;
65bb0c85Jimmy Thomson10 years ago22}
23class InitializedEvent {
5547a16fJimmy Thomson10 years ago24constructor();
25}
26class OutputEvent {
27constructor(message: string, destination?: string);
28}
29class TerminatedEvent {
30constructor();
65bb0c85Jimmy Thomson10 years ago31}
32}
33
34declare class SourceMaps {
35public _sourceToGeneratedMaps: {};
36public _generatedToSourceMaps: {};
37public _allSourceMaps: {};
38}
39
5547a16fJimmy Thomson10 years ago40declare class NodeDebugSession extends VSCodeDebugAdapter.DebugSession {
65bb0c85Jimmy Thomson10 years ago41public _sourceMaps: SourceMaps;
42}
43
5e54f6f2Jimmy Thomson10 years ago44interface ILaunchArgs {
45platform: string;
46target?: string;
47internalDebuggerPort?: any;
48args: string[];
710f8655digeff10 years ago49logCatArguments: any;
5e54f6f2Jimmy Thomson10 years ago50}
51
2d3a052eMeena Kunnathur Balakrishnan10 years ago52let version = JSON.parse(fs.readFileSync(path.join(__dirname, "..", "..", "package.json"), "utf-8")).version;
5547a16fJimmy Thomson10 years ago53
642490c1Jimmy Thomson10 years ago54function bailOut(reason: string): void {
55// Things have gone wrong in initialization: Report the error to telemetry and exit
56TelemetryHelper.sendSimpleEvent(reason);
57Telemetry.sendPendingData().finally(() => {
58process.exit(1);
59});
60}
61
c31e59fbdigeff10 years ago62function parseLogCatArguments(userProvidedLogCatArguments: any) {
63return Array.isArray(userProvidedLogCatArguments)
64? userProvidedLogCatArguments.join(" ") // If it's an array, we join the arguments
65: userProvidedLogCatArguments; // If not, we leave it as-is
66}
67
68function isNullOrUndefined(value: any): boolean {
69return typeof value === "undefined" || value === null;
70}
71
2d3a052eMeena Kunnathur Balakrishnan10 years ago72// Enable telemetry
48efc4d6Meena Kunnathur Balakrishnan10 years ago73Telemetry.init("react-native-debug-adapter", version, true).then(() => {
2d3a052eMeena Kunnathur Balakrishnan10 years ago74let nodeDebugFolder: string;
75let vscodeDebugAdapterPackage: typeof VSCodeDebugAdapter;
b8ef4af9Jimmy Thomson10 years ago76
2d3a052eMeena Kunnathur Balakrishnan10 years ago77/* tslint:disable:no-var-requires */
65bb0c85Jimmy Thomson10 years ago78
2d3a052eMeena Kunnathur Balakrishnan10 years ago79// nodeDebugLocation.json is dynamically generated on extension activation.
80// If it fails, we must not have been in a react native project
4881129dMeena Kunnathur Balakrishnan10 years ago81try {
82nodeDebugFolder = require("./nodeDebugLocation.json").nodeDebugPath;
83vscodeDebugAdapterPackage = require(path.join(nodeDebugFolder, "node_modules", "vscode-debugadapter"));
84} catch (e) {
642490c1Jimmy Thomson10 years ago85// Nothing we can do here: can't even communicate back because we don't know how to speak debug adapter
86return bailOut("cannotFindDebugAdapter");
4881129dMeena Kunnathur Balakrishnan10 years ago87}
65bb0c85Jimmy Thomson10 years ago88
4881129dMeena Kunnathur Balakrishnan10 years ago89// Temporarily dummy out the DebugSession.run function so we do not start the debug adapter until we are ready
90const originalDebugSessionRun = vscodeDebugAdapterPackage.DebugSession.run;
91vscodeDebugAdapterPackage.DebugSession.run = function() { };
92
93let nodeDebug: { NodeDebugSession: typeof NodeDebugSession };
94
95try {
96nodeDebug = require(path.join(nodeDebugFolder, "out", "node", "nodeDebug"));
97} catch (e) {
98// Unable to find nodeDebug, but we can make our own communication channel now
99const 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.
102debugSession.start(process.stdin, process.stdout);
103debugSession.sendEvent(new vscodeDebugAdapterPackage.OutputEvent("Unable to start debug adapter: " + e.toString(), "stderr"));
104debugSession.sendEvent(new vscodeDebugAdapterPackage.TerminatedEvent());
dd442738Jimmy Thomson10 years ago105
642490c1Jimmy Thomson10 years ago106return bailOut("cannotFindNodeDebugAdapter");
4881129dMeena Kunnathur Balakrishnan10 years ago107}
2d3a052eMeena Kunnathur Balakrishnan10 years ago108
4881129dMeena Kunnathur Balakrishnan10 years ago109/* tslint:enable:no-var-requires */
110
111vscodeDebugAdapterPackage.DebugSession.run = originalDebugSessionRun;
112
113// Intecept the "launchRequest" instance method of NodeDebugSession to interpret arguments
114const originalNodeDebugSessionLaunchRequest = nodeDebug.NodeDebugSession.prototype.launchRequest;
115nodeDebug.NodeDebugSession.prototype.launchRequest = function(request: any, args: ILaunchArgs) {
116// Create a server waiting for messages to re-initialize the debug session;
117const reinitializeServer = http.createServer((req, res) => {
118res.statusCode = 404;
119if (req.url === "/refreshBreakpoints") {
120res.statusCode = 200;
121if (this) {
122const sourceMaps = this._sourceMaps;
123if (sourceMaps) {
124// Flush any cached source maps
125sourceMaps._allSourceMaps = {};
126sourceMaps._generatedToSourceMaps = {};
127sourceMaps._sourceToGeneratedMaps = {};
48efc4d6Meena Kunnathur Balakrishnan10 years ago128}
4881129dMeena Kunnathur Balakrishnan10 years ago129// Send an "initialized" event to trigger breakpoints to be re-sent
130this.sendEvent(new vscodeDebugAdapterPackage.InitializedEvent());
131}
132}
133res.end();
2d3a052eMeena Kunnathur Balakrishnan10 years ago134});
4881129dMeena Kunnathur Balakrishnan10 years ago135const debugServerListeningPort = parseInt(args.internalDebuggerPort, 10) || 9090;
136
137reinitializeServer.listen(debugServerListeningPort);
138reinitializeServer.on("error", (err: Error) => {
642490c1Jimmy Thomson10 years ago139TelemetryHelper.sendSimpleEvent("reinitializeServerError");
4881129dMeena Kunnathur Balakrishnan10 years ago140this.sendEvent(new vscodeDebugAdapterPackage.OutputEvent("Error in debug adapter server: " + err.toString(), "stderr"));
141this.sendEvent(new vscodeDebugAdapterPackage.OutputEvent("Breakpoints may not update. Consider restarting and specifying a different 'internalDebuggerPort' in launch.json"));
142});
143
144// We do not permit arbitrary args to be passed to our process
145args.args = [
146args.platform,
147debugServerListeningPort.toString(),
148args.target || "simulator"
149];
150
710f8655digeff10 years ago151if (!isNullOrUndefined(args.logCatArguments)) { // We add the parameter if it's defined (adapter crashes otherwise)
152args.args = args.args.concat([parseLogCatArguments(args.logCatArguments)]);
153}
154
4881129dMeena Kunnathur Balakrishnan10 years ago155originalNodeDebugSessionLaunchRequest.call(this, request, args);
156};
157
c2bf3c4fdigeff10 years ago158// Intecept the "launchRequest" instance method of NodeDebugSession to interpret arguments
159const originalNodeDebugSessionDisconnectRequest = nodeDebug.NodeDebugSession.prototype.disconnectRequest;
160function customDisconnectRequest(response: any, args: any): void {
161try {
162// First we tell the extension to stop monitoring the logcat, and then we disconnect the debugging session
163const extensionMessageSender = new ExtensionMessageSender();
164extensionMessageSender.sendMessage(ExtensionMessage.STOP_MONITORING_LOGCAT)
165.finally(() => originalNodeDebugSessionDisconnectRequest.call(this, response, args))
166.done(() => {}, reason => // We just print a warning if something fails
167process.stderr.write(`WARNING: Couldn't stop monitoring logcat: ${reason.message || reason}\n`));
168} catch (exception) {
169// This is a "nice to have" feature, so we just fire the message and forget. We don't event handle
170// errors in the response promise
171process.stderr.write(`WARNING: Couldn't stop monitoring logcat. Sync exception: ${exception.message || exception}\n`);
172originalNodeDebugSessionDisconnectRequest.call(this, response, args);
173}
174}
175nodeDebug.NodeDebugSession.prototype.disconnectRequest = customDisconnectRequest;
176
4881129dMeena Kunnathur Balakrishnan10 years ago177vscodeDebugAdapterPackage.DebugSession.run(nodeDebug.NodeDebugSession);
710f8655digeff10 years ago178});