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
0.6.16

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

257lines · modeblame

RawDownload
Latest commit unavailable.
e45838cbVladimir Kotikov9 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
4import * as Q from "q";
5import * as path from "path";
6import * as fs from "fs";
7import stripJsonComments = require("strip-json-comments");
8
b8999098Dmitry Zinovyev9 years ago9import { Telemetry } from "../common/telemetry";
10import { TelemetryHelper } from "../common/telemetryHelper";
11import { RemoteExtension } from "../common/remoteExtension";
3a155214Artem Egorov8 years ago12import { RemoteTelemetryReporter, ReassignableTelemetryReporter } from "../common/telemetryReporters";
2d876061Ruslan Bikkinin8 years ago13import { ChromeDebugSession, IChromeDebugSessionOpts, ChromeDebugAdapter, logger } from "vscode-chrome-debug-core";
e3b0fb3bChance An8 years ago14import { ContinuedEvent, TerminatedEvent, Logger, Response } from "vscode-debugadapter";
0a68f8dbArtem Egorov8 years ago15import { DebugProtocol } from "vscode-debugprotocol";
e45838cbVladimir Kotikov9 years ago16
17import { MultipleLifetimesAppWorker } from "./appWorker";
18
2d876061Ruslan Bikkinin8 years ago19import { ReactNativeProjectHelper } from "../common/reactNativeProjectHelper";
20
0a68f8dbArtem Egorov8 years ago21
b8999098Dmitry Zinovyev9 years ago22export function makeSession(
0a68f8dbArtem Egorov8 years ago23debugSessionClass: typeof ChromeDebugSession,
24debugSessionOpts: IChromeDebugSessionOpts,
b8999098Dmitry Zinovyev9 years ago25telemetryReporter: ReassignableTelemetryReporter,
0a68f8dbArtem Egorov8 years ago26appName: string, version: string): typeof ChromeDebugSession {
e45838cbVladimir Kotikov9 years ago27
28return class extends debugSessionClass {
29
30private projectRootPath: string;
31private remoteExtension: RemoteExtension;
5c8365a6Artem Egorov8 years ago32private appWorker: MultipleLifetimesAppWorker | null = null;
e45838cbVladimir Kotikov9 years ago33
34constructor(debuggerLinesAndColumnsStartAt1?: boolean, isServer?: boolean) {
35super(debuggerLinesAndColumnsStartAt1, isServer, debugSessionOpts);
36}
37
38// Override ChromeDebugSession's sendEvent to control what we will send to client
0a68f8dbArtem Egorov8 years ago39public sendEvent(event: DebugProtocol.Event): void {
e45838cbVladimir Kotikov9 years ago40// Do not send "terminated" events signaling about session's restart to client as it would cause it
41// to restart adapter's process, while we want to stay alive and don't want to interrupt connection
6c75098eVladimir9 years ago42// to packager.
b8999098Dmitry Zinovyev9 years ago43
720e992dArtem Egorov8 years ago44if (event.event === "terminated" && event.body && event.body.restart) {
b8999098Dmitry Zinovyev9 years ago45
46// Worker has been reloaded and switched to "continue" state
47// So we have to send "continued" event to client instead of "terminated"
48// Otherwise client might mistakenly show "stopped" state
0a68f8dbArtem Egorov8 years ago49let continuedEvent: ContinuedEvent = {
b8999098Dmitry Zinovyev9 years ago50event: "continued",
51type: "event",
52seq: event["seq"], // tslint:disable-line
53body: { threadId: event.body.threadId },
54};
55
56super.sendEvent(continuedEvent);
e45838cbVladimir Kotikov9 years ago57return;
58}
59
60super.sendEvent(event);
61}
62
0a68f8dbArtem Egorov8 years ago63protected dispatchRequest(request: DebugProtocol.Request): void {
e45838cbVladimir Kotikov9 years ago64if (request.command === "disconnect")
65return this.disconnect(request);
66
67if (request.command === "attach")
68return this.attach(request);
69
70if (request.command === "launch")
71return this.launch(request);
72
73return super.dispatchRequest(request);
74}
75
0a68f8dbArtem Egorov8 years ago76private launch(request: DebugProtocol.Request): void {
2d876061Ruslan Bikkinin8 years ago77this.requestSetup(request.arguments)
78.then(() => {
79return this.remoteExtension.launch(request);
80})
cbb0e869Artem Egorov8 years ago81.then(() => {
2e432a9eArtem Egorov8 years ago82return this.remoteExtension.getPackagerPort(request.arguments.program);
0a68f8dbArtem Egorov8 years ago83})
84.then((packagerPort: number) => {
6eeec3c0Serge Svekolnikov8 years ago85this.attachRequest({
86...request,
87arguments: {
88...request.arguments,
89port: packagerPort,
90},
91});
0a68f8dbArtem Egorov8 years ago92})
93.catch(error => {
748105d9Artem Egorov8 years ago94this.bailOut(error.data || error.message);
cbb0e869Artem Egorov8 years ago95});
e45838cbVladimir Kotikov9 years ago96}
97
0a68f8dbArtem Egorov8 years ago98private attach(request: DebugProtocol.Request): void {
2d876061Ruslan Bikkinin8 years ago99this.requestSetup(request.arguments)
100.then(() => {
101return this.remoteExtension.getPackagerPort(request.arguments.program);
102})
0a68f8dbArtem Egorov8 years ago103.then((packagerPort: number) => {
6eeec3c0Serge Svekolnikov8 years ago104this.attachRequest({
105...request,
106arguments: {
107...request.arguments,
e92278b5Serge Svekolnikov8 years ago108port: request.arguments.port || packagerPort,
6eeec3c0Serge Svekolnikov8 years ago109},
110});
2d876061Ruslan Bikkinin8 years ago111})
112.catch(error => {
113this.bailOut(error.data || error.message);
cbb0e869Artem Egorov8 years ago114});
e45838cbVladimir Kotikov9 years ago115}
116
0a68f8dbArtem Egorov8 years ago117private disconnect(request: DebugProtocol.Request): void {
e45838cbVladimir Kotikov9 years ago118// The client is about to disconnect so first we need to stop app worker
f920e582Vladimir Kotikov9 years ago119if (this.appWorker) {
120this.appWorker.stop();
121}
e45838cbVladimir Kotikov9 years ago122
123// Then we tell the extension to stop monitoring the logcat, and then we disconnect the debugging session
0a68f8dbArtem Egorov8 years ago124if (request.arguments.platform === "android") {
e45838cbVladimir Kotikov9 years ago125this.remoteExtension.stopMonitoringLogcat()
0a68f8dbArtem Egorov8 years ago126.catch(reason => logger.warn(`Couldn't stop monitoring logcat: ${reason.message || reason}`))
b8999098Dmitry Zinovyev9 years ago127.finally(() => super.dispatchRequest(request));
e45838cbVladimir Kotikov9 years ago128} else {
129super.dispatchRequest(request);
130}
131}
132
2d876061Ruslan Bikkinin8 years ago133private requestSetup(args: any): Q.Promise<void> {
0a68f8dbArtem Egorov8 years ago134let logLevel: string = args.trace;
135if (logLevel) {
136logLevel = logLevel.replace(logLevel[0], logLevel[0].toUpperCase());
137logger.setup(Logger.LogLevel[logLevel], false);
138} else {
139logger.setup(Logger.LogLevel.Log, false);
140}
141
2d876061Ruslan Bikkinin8 years ago142const projectRootPath = getProjectRoot(args);
143return ReactNativeProjectHelper.isReactNativeProject(projectRootPath)
144.then((result) => {
145if (!result) {
146throw new Error(`Seems to be that you are trying to debug from within directory that is not a React Native project root.
147If so, please, follow these instructions: https://github.com/Microsoft/vscode-react-native/blob/master/doc/customization.md#project-structure.`);
148}
149this.projectRootPath = projectRootPath;
150this.remoteExtension = RemoteExtension.atProjectRootPath(this.projectRootPath);
151
152// Start to send telemetry
153telemetryReporter.reassignTo(new RemoteTelemetryReporter(
154appName, version, Telemetry.APPINSIGHTS_INSTRUMENTATIONKEY, this.projectRootPath));
155return void 0;
156});
e45838cbVladimir Kotikov9 years ago157}
158
159/**
160* Runs logic needed to attach.
161* Attach should:
162* - Enable js debugging
163*/
0a68f8dbArtem Egorov8 years ago164// tslint:disable-next-line:member-ordering
031832ffArtem Egorov8 years ago165protected attachRequest(request: DebugProtocol.Request): Q.Promise<void> {
166const extProps = {
167platform: {
168value: request.arguments.platform,
169isPii: false,
170},
171};
172
173return TelemetryHelper.generate("attach", extProps, (generator) => {
e45838cbVladimir Kotikov9 years ago174return Q({})
175.then(() => {
0a68f8dbArtem Egorov8 years ago176logger.log("Starting debugger app worker.");
e45838cbVladimir Kotikov9 years ago177// TODO: remove dependency on args.program - "program" property is technically
178// no more required in launch configuration and could be removed
179const workspaceRootPath = path.resolve(path.dirname(request.arguments.program), "..");
180const sourcesStoragePath = path.join(workspaceRootPath, ".vscode", ".react");
181
182// If launch is invoked first time, appWorker is undefined, so create it here
6eeec3c0Serge Svekolnikov8 years ago183this.appWorker = new MultipleLifetimesAppWorker(
184request.arguments,
185sourcesStoragePath,
186this.projectRootPath,
187undefined);
e45838cbVladimir Kotikov9 years ago188this.appWorker.on("connected", (port: number) => {
0a68f8dbArtem Egorov8 years ago189logger.log("Debugger worker loaded runtime on port " + port);
e45838cbVladimir Kotikov9 years ago190// Don't mutate original request to avoid side effects
6eeec3c0Serge Svekolnikov8 years ago191let attachArguments = Object.assign({}, request.arguments, {
192address: "localhost",
193port,
194restart: true,
195request: "attach",
196remoteRoot: undefined,
197localRoot: undefined,
198});
6c75098eVladimir9 years ago199// Reinstantiate debug adapter, as the current implementation of ChromeDebugAdapter
200// doesn't allow us to reattach to another debug target easily. As of now it's easier
201// to throw previous instance out and create a new one.
0a68f8dbArtem Egorov8 years ago202(this as any)._debugAdapter = new (<any>debugSessionOpts.adapter)(debugSessionOpts, this);
e3b0fb3bChance An8 years ago203
204// Explicity call _debugAdapter.attach() to prevent directly calling dispatchRequest()
205// yield a response as "attach" even for "launch" request. Because dispatchRequest() will
206// decide to do a sendResponse() aligning with the request parameter passed in.
207Q((this as any)._debugAdapter.attach(attachArguments, request.seq))
2d876061Ruslan Bikkinin8 years ago208.then((responseBody) => {
209const response: DebugProtocol.Response = new Response(request);
210response.body = responseBody;
211this.sendResponse(response);
212});
e45838cbVladimir Kotikov9 years ago213});
214
215return this.appWorker.start();
216})
217.catch(error => this.bailOut(error.message));
218});
219}
220
221/**
222* Logs error to user and finishes the debugging process.
223*/
224private bailOut(message: string): void {
0a68f8dbArtem Egorov8 years ago225logger.error(`Could not debug. ${message}`);
226this.sendEvent(new TerminatedEvent());
27710197Vladimir Kotikov8 years ago227}
e45838cbVladimir Kotikov9 years ago228};
229}
230
0a68f8dbArtem Egorov8 years ago231export function makeAdapter(debugAdapterClass: typeof ChromeDebugAdapter): typeof ChromeDebugAdapter {
e45838cbVladimir Kotikov9 years ago232return class extends debugAdapterClass {
4f7b3bc0Anna Kocheshkova8 years ago233public doAttach(port: number, targetUrl?: string, address?: string, timeout?: number): Promise<void> {
4b86d595Vladimir Kotikov9 years ago234// We need to overwrite ChromeDebug's _attachMode to let Node2 adapter
e45838cbVladimir Kotikov9 years ago235// to set up breakpoints on initial pause event
0a68f8dbArtem Egorov8 years ago236(this as any)._attachMode = false;
e45838cbVladimir Kotikov9 years ago237return super.doAttach(port, targetUrl, address, timeout);
238}
239};
240}
241
242/**
243* Parses settings.json file for workspace root property
244*/
245function getProjectRoot(args: any): string {
246try {
247let vsCodeRoot = path.resolve(args.program, "../..");
248let settingsPath = path.resolve(vsCodeRoot, ".vscode/settings.json");
249let settingsContent = fs.readFileSync(settingsPath, "utf8");
250settingsContent = stripJsonComments(settingsContent);
251let parsedSettings = JSON.parse(settingsContent);
9a364375Serge Svekolnikov8 years ago252let projectRootPath = parsedSettings["react-native-tools.projectRoot"] || parsedSettings["react-native-tools"].projectRoot;
e45838cbVladimir Kotikov9 years ago253return path.resolve(vsCodeRoot, projectRootPath);
254} catch (e) {
255return path.resolve(args.program, "../..");
256}
257}