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
66412fdf630d6715b0e5e34416d24e54ded635bb

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

273lines · 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 path from "path";
6import * as fs from "fs";
7import stripJsonComments = require("strip-json-comments");
8
9import { Telemetry } from "../common/telemetry";
10import { TelemetryHelper } from "../common/telemetryHelper";
11import { RemoteExtension } from "../common/remoteExtension";
12import { RemoteTelemetryReporter, ReassignableTelemetryReporter } from "../common/telemetryReporters";
13import { ChromeDebugSession, IChromeDebugSessionOpts, ChromeDebugAdapter, logger } from "vscode-chrome-debug-core";
14import { ContinuedEvent, TerminatedEvent, Logger, Response } from "vscode-debugadapter";
15import { DebugProtocol } from "vscode-debugprotocol";
16
17import { MultipleLifetimesAppWorker } from "./appWorker";
18
19import { ReactNativeProjectHelper } from "../common/reactNativeProjectHelper";
20import * as nls from "vscode-nls";
21import { ErrorHelper } from "../common/error/errorHelper";
22import { InternalErrorCode } from "../common/error/internalErrorCode";
23import { getLoggingDirectory } from "../extension/log/LogHelper";
24const localize = nls.loadMessageBundle();
25
26export function makeSession(
27 debugSessionClass: typeof ChromeDebugSession,
28 debugSessionOpts: IChromeDebugSessionOpts,
29 telemetryReporter: ReassignableTelemetryReporter,
30 appName: string, version: string): typeof ChromeDebugSession {
31
32 return class extends debugSessionClass {
33
34 private projectRootPath: string;
35 private remoteExtension: RemoteExtension;
36 private appWorker: MultipleLifetimesAppWorker | null = null;
37
38 constructor(debuggerLinesAndColumnsStartAt1?: boolean, isServer?: boolean) {
39 super(debuggerLinesAndColumnsStartAt1, isServer, debugSessionOpts);
40 }
41
42 // Override ChromeDebugSession's sendEvent to control what we will send to client
43 public sendEvent(event: DebugProtocol.Event): void {
44 // Do not send "terminated" events signaling about session's restart to client as it would cause it
45 // to restart adapter's process, while we want to stay alive and don't want to interrupt connection
46 // to packager.
47
48 if (event.event === "terminated" && event.body && event.body.restart) {
49
50 // Worker has been reloaded and switched to "continue" state
51 // So we have to send "continued" event to client instead of "terminated"
52 // Otherwise client might mistakenly show "stopped" state
53 let continuedEvent: ContinuedEvent = {
54 event: "continued",
55 type: "event",
56 seq: event["seq"], // tslint:disable-line
57 body: { threadId: event.body.threadId },
58 };
59
60 super.sendEvent(continuedEvent);
61 return;
62 }
63
64 super.sendEvent(event);
65 }
66
67 protected dispatchRequest(request: DebugProtocol.Request): void {
68 if (request.command === "disconnect")
69 return this.disconnect(request);
70
71 if (request.command === "attach")
72 return this.attach(request);
73
74 if (request.command === "launch")
75 return this.launch(request);
76
77 return super.dispatchRequest(request);
78 }
79
80 private launch(request: DebugProtocol.Request): void {
81 this.requestSetup(request.arguments)
82 .then(() => {
83 logger.verbose(`Handle launch request: ${JSON.stringify(request.arguments, null , 2)}`);
84 return this.remoteExtension.launch(request);
85 })
86 .then(() => {
87 return this.remoteExtension.getPackagerPort(request.arguments.program);
88 })
89 .then((packagerPort: number) => {
90 this.attachRequest({
91 ...request,
92 arguments: {
93 ...request.arguments,
94 port: packagerPort,
95 },
96 });
97 })
98 .catch(error => {
99 this.bailOut(error.data || error.message);
100 });
101 }
102
103 private attach(request: DebugProtocol.Request): void {
104 this.requestSetup(request.arguments)
105 .then(() => {
106 logger.verbose(`Handle attach request: ${JSON.stringify(request.arguments, null , 2)}`);
107 return this.remoteExtension.getPackagerPort(request.arguments.program);
108 })
109 .then((packagerPort: number) => {
110 this.attachRequest({
111 ...request,
112 arguments: {
113 ...request.arguments,
114 port: request.arguments.port || packagerPort,
115 },
116 });
117 })
118 .catch(error => {
119 this.bailOut(error.data || error.message);
120 });
121 }
122
123 private disconnect(request: DebugProtocol.Request): void {
124 // The client is about to disconnect so first we need to stop app worker
125 if (this.appWorker) {
126 this.appWorker.stop();
127 }
128
129 // Then we tell the extension to stop monitoring the logcat, and then we disconnect the debugging session
130 if (request.arguments.platform === "android") {
131 this.remoteExtension.stopMonitoringLogcat()
132 .catch(reason => logger.warn(localize("CouldNotStopMonitoringLogcat", "Couldn't stop monitoring logcat: {0}", reason.message || reason)))
133 .finally(() => super.dispatchRequest(request));
134 } else {
135 super.dispatchRequest(request);
136 }
137 }
138
139 private requestSetup(args: any): Q.Promise<void> {
140 // If special env variables are defined, then write process outputs to file
141 let chromeDebugCoreLogs = getLoggingDirectory();
142 if (chromeDebugCoreLogs) {
143 chromeDebugCoreLogs = path.join(chromeDebugCoreLogs, "ChromeDebugCoreLogs.txt");
144 }
145 let logLevel: string = args.trace;
146 if (logLevel) {
147 logLevel = logLevel.replace(logLevel[0], logLevel[0].toUpperCase());
148 logger.setup(Logger.LogLevel[logLevel], chromeDebugCoreLogs || false);
149 } else {
150 logger.setup(Logger.LogLevel.Log, chromeDebugCoreLogs || false);
151 }
152
153 const projectRootPath = getProjectRoot(args);
154 return ReactNativeProjectHelper.isReactNativeProject(projectRootPath)
155 .then((result) => {
156 if (!result) {
157 throw ErrorHelper.getInternalError(InternalErrorCode.NotInReactNativeFolderError);
158 }
159 this.projectRootPath = projectRootPath;
160 this.remoteExtension = RemoteExtension.atProjectRootPath(this.projectRootPath);
161
162 // Start to send telemetry
163 telemetryReporter.reassignTo(new RemoteTelemetryReporter(
164 appName, version, Telemetry.APPINSIGHTS_INSTRUMENTATIONKEY, this.projectRootPath));
165 return void 0;
166 });
167 }
168
169 /**
170 * Runs logic needed to attach.
171 * Attach should:
172 * - Enable js debugging
173 */
174 // tslint:disable-next-line:member-ordering
175 protected attachRequest(request: DebugProtocol.Request): Q.Promise<void> {
176 const extProps = {
177 platform: {
178 value: request.arguments.platform,
179 isPii: false,
180 },
181 };
182
183 return TelemetryHelper.generate("attach", extProps, (generator) => {
184 return Q({})
185 .then(() => {
186 logger.log(localize("StartingDebuggerAppWorker", "Starting debugger app worker."));
187 // TODO: remove dependency on args.program - "program" property is technically
188 // no more required in launch configuration and could be removed
189 const workspaceRootPath = path.resolve(path.dirname(request.arguments.program), "..");
190 const sourcesStoragePath = path.join(workspaceRootPath, ".vscode", ".react");
191
192 // If launch is invoked first time, appWorker is undefined, so create it here
193 this.appWorker = new MultipleLifetimesAppWorker(
194 request.arguments,
195 sourcesStoragePath,
196 this.projectRootPath,
197 undefined);
198 this.appWorker.on("connected", (port: number) => {
199 logger.log(localize("DebuggerWorkerLoadedRuntimeOnPort", "Debugger worker loaded runtime on port {0}", port));
200 // Don't mutate original request to avoid side effects
201 let attachArguments = Object.assign({}, request.arguments, {
202 address: "localhost",
203 port,
204 restart: true,
205 request: "attach",
206 remoteRoot: undefined,
207 localRoot: undefined,
208 });
209 // Reinstantiate debug adapter, as the current implementation of ChromeDebugAdapter
210 // doesn't allow us to reattach to another debug target easily. As of now it's easier
211 // to throw previous instance out and create a new one.
212 (this as any)._debugAdapter = new (<any>debugSessionOpts.adapter)(debugSessionOpts, this);
213
214 // Explicity call _debugAdapter.attach() to prevent directly calling dispatchRequest()
215 // yield a response as "attach" even for "launch" request. Because dispatchRequest() will
216 // decide to do a sendResponse() aligning with the request parameter passed in.
217 Q((this as any)._debugAdapter.attach(attachArguments, request.seq))
218 .then((responseBody) => {
219 const response: DebugProtocol.Response = new Response(request);
220 response.body = responseBody;
221 this.sendResponse(response);
222 });
223 });
224
225 return this.appWorker.start();
226 })
227 .catch(error => this.bailOut(error.message));
228 });
229 }
230
231 /**
232 * Logs error to user and finishes the debugging process.
233 */
234 private bailOut(message: string): void {
235 logger.error(localize("CouldNotDebug", "Could not debug. {0}" , message));
236 this.sendEvent(new TerminatedEvent());
237 }
238 };
239}
240
241export function makeAdapter(debugAdapterClass: typeof ChromeDebugAdapter): typeof ChromeDebugAdapter {
242 return class extends debugAdapterClass {
243 public doAttach(port: number, targetUrl?: string, address?: string, timeout?: number): Promise<void> {
244 // We need to overwrite ChromeDebug's _attachMode to let Node2 adapter
245 // to set up breakpoints on initial pause event
246 (this as any)._attachMode = false;
247 return super.doAttach(port, targetUrl, address, timeout);
248 }
249
250 public async terminate(args: DebugProtocol.TerminatedEvent) {
251 return this.disconnect({
252 terminateDebuggee: true,
253 });
254 }
255 };
256}
257
258/**
259 * Parses settings.json file for workspace root property
260 */
261function getProjectRoot(args: any): string {
262 try {
263 let vsCodeRoot = path.resolve(args.program, "../..");
264 let settingsPath = path.resolve(vsCodeRoot, ".vscode/settings.json");
265 let settingsContent = fs.readFileSync(settingsPath, "utf8");
266 settingsContent = stripJsonComments(settingsContent);
267 let parsedSettings = JSON.parse(settingsContent);
268 let projectRootPath = parsedSettings["react-native-tools.projectRoot"] || parsedSettings["react-native-tools"].projectRoot;
269 return path.resolve(vsCodeRoot, projectRootPath);
270 } catch (e) {
271 return path.resolve(args.program, "../..");
272 }
273}
274