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
4b86d59558d0d76a845ed887cf1dc88cf63fc141

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

256lines · 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
9import {Telemetry} from "../common/telemetry";
10import {TelemetryHelper} from "../common/telemetryHelper";
11import {RemoteExtension} from "../common/remoteExtension";
12import {IOSPlatform} from "./ios/iOSPlatform";
13import {PlatformResolver} from "./platformResolver";
14import {IRunOptions} from "../common/launchArgs";
15import {TargetPlatformHelper} from "../common/targetPlatformHelper";
16import {ExtensionTelemetryReporter, ReassignableTelemetryReporter} from "../common/telemetryReporters";
17import {NodeDebugAdapterLogger} from "../common/log/loggers";
18import {Log} from "../common/log/log";
19import {GeneralMobilePlatform} from "../common/generalMobilePlatform";
20
21import { MultipleLifetimesAppWorker } from "./appWorker";
22import { ForkedAppWorker } from "./forkedAppWorker";
23
24export function makeSession(debugSessionClass: typeof ChromeDebuggerCorePackage.ChromeDebugSession,
25debugSessionOpts: ChromeDebuggerCorePackage.IChromeDebugSessionOpts,
26debugAdapterPackage: typeof VSCodeDebugAdapterPackage,
27telemetryReporter: ReassignableTelemetryReporter,
28appName: string, version: string): typeof ChromeDebuggerCorePackage.ChromeDebugSession {
29
30return class extends debugSessionClass {
31
32private projectRootPath: string;
33private remoteExtension: RemoteExtension;
34private mobilePlatformOptions: IRunOptions;
35private appWorker: MultipleLifetimesAppWorker = null;
36
37constructor(debuggerLinesAndColumnsStartAt1?: boolean, isServer?: boolean) {
38super(debuggerLinesAndColumnsStartAt1, isServer, debugSessionOpts);
39}
40
41// Override ChromeDebugSession's sendEvent to control what we will send to client
42public sendEvent(event: VSCodeDebugAdapterPackage.Event): void {
43// Do not send "terminated" events signaling about session's restart to client as it would cause it
44// to restart adapter's process, while we want to stay alive and don't want to interrupt connection
45// to packager. Also in this case we need to reinstantiate the debug adapter, as the current
46// implementation of ChromeDebugAdapter doesn't allow us to reattach to another debug target easily.
47// As of now it's easier to throw previous instance out and create a new one.
48if (event.event === "terminated" && event.body && event.body.restart === true) {
49// Casting debugAdapter to any to make this compile, as TS doesn't allow instantiating abstract classes
50this._debugAdapter = new (<any>debugSessionOpts.adapter)(debugSessionOpts, this);
51return;
52}
53
54super.sendEvent(event);
55}
56
57protected dispatchRequest(request: VSCodeDebugAdapterPackage.Request): void {
58if (request.command === "disconnect")
59return this.disconnect(request);
60
61if (request.command === "attach")
62return this.attach(request);
63
64if (request.command === "launch")
65return this.launch(request);
66
67return super.dispatchRequest(request);
68}
69
70private launch(request: VSCodeDebugAdapterPackage.Request): void {
71this.requestSetup(request.arguments);
72this.mobilePlatformOptions.target = request.arguments.target || "simulator";
73this.mobilePlatformOptions.iosRelativeProjectPath = !isNullOrUndefined(request.arguments.iosRelativeProjectPath) ?
74request.arguments.iosRelativeProjectPath :
75IOSPlatform.DEFAULT_IOS_PROJECT_RELATIVE_PATH;
76
77// We add the parameter if it's defined (adapter crashes otherwise)
78if (!isNullOrUndefined(request.arguments.logCatArguments)) {
79this.mobilePlatformOptions.logCatArguments = [parseLogCatArguments(request.arguments.logCatArguments)];
80}
81
82if (!isNullOrUndefined(request.arguments.variant)) {
83this.mobilePlatformOptions.variant = request.arguments.variant;
84}
85
86TelemetryHelper.generate("launch", (generator) => {
87return this.remoteExtension.getPackagerPort()
88.then((packagerPort: number) => {
89this.mobilePlatformOptions.packagerPort = packagerPort;
90const mobilePlatform = new PlatformResolver()
91.resolveMobilePlatform(request.arguments.platform, this.mobilePlatformOptions);
92
93generator.step("checkPlatformCompatibility");
94TargetPlatformHelper.checkTargetPlatformSupport(this.mobilePlatformOptions.platform);
95generator.step("startPackager");
96return mobilePlatform.startPackager()
97.then(() => {
98// We've seen that if we don't prewarm the bundle cache, the app fails on the first attempt to connect to the debugger logic
99// and the user needs to Reload JS manually. We prewarm it to prevent that issue
100generator.step("prewarmBundleCache");
101Log.logMessage("Prewarming bundle cache. This may take a while ...");
102return mobilePlatform.prewarmBundleCache();
103})
104.then(() => {
105generator.step("mobilePlatform.runApp");
106Log.logMessage("Building and running application.");
107return mobilePlatform.runApp();
108})
109.then(() => {
f920e582Vladimir Kotikov9 years ago110return this.attachRequest(request, packagerPort, mobilePlatform);
e45838cbVladimir Kotikov9 years ago111});
f920e582Vladimir Kotikov9 years ago112})
113.catch(error => this.bailOut(error.message));
e45838cbVladimir Kotikov9 years ago114});
115
116}
117
118private attach(request: VSCodeDebugAdapterPackage.Request): void {
119this.requestSetup(request.arguments);
f920e582Vladimir Kotikov9 years ago120this.remoteExtension.getPackagerPort()
121.then((packagerPort: number) => this.attachRequest(request, packagerPort));
e45838cbVladimir Kotikov9 years ago122}
123
124private disconnect(request: VSCodeDebugAdapterPackage.Request): void {
125// The client is about to disconnect so first we need to stop app worker
f920e582Vladimir Kotikov9 years ago126if (this.appWorker) {
127this.appWorker.stop();
128}
e45838cbVladimir Kotikov9 years ago129
130// Then we tell the extension to stop monitoring the logcat, and then we disconnect the debugging session
131if (this.mobilePlatformOptions.platform === "android") {
132this.remoteExtension.stopMonitoringLogcat()
133.catch(reason => Log.logError(`WARNING: Couldn't stop monitoring logcat: ${reason.message || reason}\n`))
134.finally(() => super.dispatchRequest(request));
135} else {
136super.dispatchRequest(request);
137}
138}
139
f920e582Vladimir Kotikov9 years ago140private requestSetup(args: any): void {
e45838cbVladimir Kotikov9 years ago141this.projectRootPath = getProjectRoot(args);
142this.remoteExtension = RemoteExtension.atProjectRootPath(this.projectRootPath);
143this.mobilePlatformOptions = {
144projectRoot: this.projectRootPath,
145platform: args.platform,
146};
147
148// Start to send telemetry
149telemetryReporter.reassignTo(new ExtensionTelemetryReporter(
150appName, version, Telemetry.APPINSIGHTS_INSTRUMENTATIONKEY, this.projectRootPath));
151
152Log.SetGlobalLogger(new NodeDebugAdapterLogger(debugAdapterPackage, this));
153}
154
155/**
156* Runs logic needed to attach.
157* Attach should:
158* - Enable js debugging
159*/
f920e582Vladimir Kotikov9 years ago160private attachRequest(request: VSCodeDebugAdapterPackage.Request,
161packagerPort: number,
162mobilePlatform?: GeneralMobilePlatform): Q.Promise<void> {
e45838cbVladimir Kotikov9 years ago163return TelemetryHelper.generate("attach", (generator) => {
164return Q({})
165.then(() => {
166generator.step("mobilePlatform.enableJSDebuggingMode");
167if (mobilePlatform) {
168return mobilePlatform.enableJSDebuggingMode();
169} else {
170Log.logMessage("Debugger ready. Enable remote debugging in app.");
171}
172})
173.then(() => {
174
175Log.logMessage("Starting debugger app worker.");
176// TODO: remove dependency on args.program - "program" property is technically
177// no more required in launch configuration and could be removed
178const workspaceRootPath = path.resolve(path.dirname(request.arguments.program), "..");
179const sourcesStoragePath = path.join(workspaceRootPath, ".vscode", ".react");
180
181// If launch is invoked first time, appWorker is undefined, so create it here
f920e582Vladimir Kotikov9 years ago182this.appWorker = new MultipleLifetimesAppWorker(packagerPort, sourcesStoragePath, {
e45838cbVladimir Kotikov9 years ago183// Inject our custom debuggee worker
184sandboxedAppConstructor: (path: string, messageFunc: (message: any) => void) =>
f920e582Vladimir Kotikov9 years ago185new ForkedAppWorker(packagerPort, path, messageFunc),
e45838cbVladimir Kotikov9 years ago186}
187);
188
189this.appWorker.on("connected", (port: number) => {
f920e582Vladimir Kotikov9 years ago190Log.logMessage("Debugger worker loaded runtime on port " + port);
e45838cbVladimir Kotikov9 years ago191// Don't mutate original request to avoid side effects
192let attachArguments = Object.assign({}, request.arguments, { port, restart: true, request: "attach" });
193let attachRequest = Object.assign({}, request, { command: "attach", arguments: attachArguments });
194
195super.dispatchRequest(attachRequest);
196});
197
198return this.appWorker.start();
199})
200.catch(error => this.bailOut(error.message));
201});
202}
203
204/**
205* Logs error to user and finishes the debugging process.
206*/
207private bailOut(message: string): void {
208Log.logError(`Could not debug. ${message}`);
8049d420Vladimir Kotikov9 years ago209this.sendEvent(new debugAdapterPackage.TerminatedEvent());
e45838cbVladimir Kotikov9 years ago210};
211};
212}
213
214export function makeAdapter(debugAdapterClass: typeof Node2DebugAdapterPackage.Node2DebugAdapter): typeof Node2DebugAdapterPackage.Node2DebugAdapter {
215return class extends debugAdapterClass {
216public doAttach(port: number, targetUrl?: string, address?: string, timeout?: number): Promise<void> {
4b86d595Vladimir Kotikov9 years ago217// We need to overwrite ChromeDebug's _attachMode to let Node2 adapter
e45838cbVladimir Kotikov9 years ago218// to set up breakpoints on initial pause event
219this._attachMode = false;
220return super.doAttach(port, targetUrl, address, timeout);
221}
222};
223}
224
225/**
226* Parses log cat arguments to a string
227*/
228function parseLogCatArguments(userProvidedLogCatArguments: any): string {
229return Array.isArray(userProvidedLogCatArguments)
230? userProvidedLogCatArguments.join(" ") // If it's an array, we join the arguments
231: userProvidedLogCatArguments; // If not, we leave it as-is
232}
233
234/**
235* Helper method to know if a value is either null or undefined
236*/
237function isNullOrUndefined(value: any): boolean {
238return typeof value === "undefined" || value === null;
239}
240
241/**
242* Parses settings.json file for workspace root property
243*/
244function getProjectRoot(args: any): string {
245try {
246let vsCodeRoot = path.resolve(args.program, "../..");
247let settingsPath = path.resolve(vsCodeRoot, ".vscode/settings.json");
248let settingsContent = fs.readFileSync(settingsPath, "utf8");
249settingsContent = stripJsonComments(settingsContent);
250let parsedSettings = JSON.parse(settingsContent);
251let projectRootPath = parsedSettings["react-native-tools"].projectRoot;
252return path.resolve(vsCodeRoot, projectRootPath);
253} catch (e) {
254return path.resolve(args.program, "../..");
255}
256}