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
155e1318250bcb2b04deb261a4c76412270c9163

Branches

Tags

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

Clone

HTTPS

Download ZIP

vscode-react-native/src/debugger

src/debugger/debugSessionBase.ts

242lines · modeblame

RawDownload
Latest commit unavailable.
2c19da7fRedMickey6 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 vscode from "vscode";
5import * as path from "path";
6import * as fs from "fs";
7import stripJsonComments = require("strip-json-comments");
984ca036RedMickey6 years ago8import { LoggingDebugSession, Logger, logger, ErrorDestination } from "vscode-debugadapter";
2c19da7fRedMickey6 years ago9import { DebugProtocol } from "vscode-debugprotocol";
10import { getLoggingDirectory, LogHelper } from "../extension/log/LogHelper";
11import { ReactNativeProjectHelper } from "../common/reactNativeProjectHelper";
12import { ErrorHelper } from "../common/error/errorHelper";
13import { InternalErrorCode } from "../common/error/internalErrorCode";
e23d1841RedMickey6 years ago14import { InternalError, NestedError } from "../common/error/internalError";
5471436aRedMickey5 years ago15import { IRunOptions, PlatformType } from "../extension/launchArgs";
2c19da7fRedMickey6 years ago16import { AppLauncher } from "../extension/appLauncher";
17import { LogLevel } from "../extension/log/LogHelper";
e23d1841RedMickey6 years ago18import * as nls from "vscode-nls";
34472878RedMickey5 years ago19nls.config({
20messageFormat: nls.MessageFormat.bundle,
21bundleFormat: nls.BundleFormat.standalone,
22})();
e23d1841RedMickey6 years ago23const localize = nls.loadMessageBundle();
2c19da7fRedMickey6 years ago24
25/**
26* Enum of possible statuses of debug session
27*/
28export enum DebugSessionStatus {
29/** A session has been just created */
30FirstConnection,
31/** This status is required in order to exclude the possible creation of several debug sessions at the first start */
32FirstConnectionPending,
33/** This status means that an application can be reloaded */
34ConnectionAllowed,
35/** This status means that an application is reloading now, and we shouldn't terminate the current debug session */
36ConnectionPending,
37/** A debuggee connected successfully */
38ConnectionDone,
39/** A debuggee failed to connect */
40ConnectionFailed,
41}
42
ebbd64f1RedMickey6 years ago43export interface TerminateEventArgs {
44debugSession: vscode.DebugSession;
45args: any;
46}
47
5471436aRedMickey5 years ago48export interface IAttachRequestArgs
49extends DebugProtocol.AttachRequestArguments,
50IRunOptions,
51vscode.DebugConfiguration {
259c018fYuri Skorokhodov5 years ago52webkitRangeMax: number;
53webkitRangeMin: number;
34472878RedMickey5 years ago54cwd: string /* Automatically set by VS Code to the currently opened folder */;
2c19da7fRedMickey6 years ago55port: number;
56url?: string;
57address?: string;
58trace?: string;
5d47053fRedMickey6 years ago59skipFiles?: [];
1bdccb66RedMickey6 years ago60sourceMaps?: boolean;
61sourceMapPathOverrides?: { [key: string]: string };
2c19da7fRedMickey6 years ago62}
63
34472878RedMickey5 years ago64export interface ILaunchRequestArgs
65extends DebugProtocol.LaunchRequestArguments,
66IAttachRequestArgs {}
2c19da7fRedMickey6 years ago67
68export abstract class DebugSessionBase extends LoggingDebugSession {
ebbd64f1RedMickey6 years ago69protected static rootSessionTerminatedEventEmitter: vscode.EventEmitter<TerminateEventArgs> = new vscode.EventEmitter<TerminateEventArgs>();
34472878RedMickey5 years ago70public static readonly onDidTerminateRootDebugSession =
71DebugSessionBase.rootSessionTerminatedEventEmitter.event;
ebbd64f1RedMickey6 years ago72
a2ddbba5RedMickey5 years ago73protected readonly stopCommand: string;
ebbd64f1RedMickey6 years ago74protected readonly pwaNodeSessionName: string;
75
2c19da7fRedMickey6 years ago76protected appLauncher: AppLauncher;
77protected projectRootPath: string;
78protected isSettingsInitialized: boolean; // used to prevent parameters reinitialization when attach is called from launch function
79protected previousAttachArgs: IAttachRequestArgs;
80protected cdpProxyLogLevel: LogLevel;
81protected debugSessionStatus: DebugSessionStatus;
82protected session: vscode.DebugSession;
e23d1841RedMickey6 years ago83protected cancellationTokenSource: vscode.CancellationTokenSource;
2c19da7fRedMickey6 years ago84
85constructor(session: vscode.DebugSession) {
86super();
87
ebbd64f1RedMickey6 years ago88// constants definition
89this.pwaNodeSessionName = "pwa-node"; // the name of node debug session created by js-debug extension
a2ddbba5RedMickey5 years ago90this.stopCommand = "workbench.action.debug.stop"; // the command which simulates a click on the "Stop" button
ebbd64f1RedMickey6 years ago91
92// variables definition
2c19da7fRedMickey6 years ago93this.session = session;
94this.isSettingsInitialized = false;
95this.debugSessionStatus = DebugSessionStatus.FirstConnection;
e23d1841RedMickey6 years ago96this.cancellationTokenSource = new vscode.CancellationTokenSource();
97}
98
34472878RedMickey5 years ago99protected initializeRequest(
100response: DebugProtocol.InitializeResponse,
101// eslint-disable-next-line @typescript-eslint/no-unused-vars
102args: DebugProtocol.InitializeRequestArguments,
103): void {
e23d1841RedMickey6 years ago104response.body = response.body || {};
105
106response.body.supportsConfigurationDoneRequest = true;
107response.body.supportsEvaluateForHovers = true;
108response.body.supportTerminateDebuggee = true;
109response.body.supportsCancelRequest = true;
110
111this.sendResponse(response);
2c19da7fRedMickey6 years ago112}
113
34472878RedMickey5 years ago114protected abstract establishDebugSession(
115attachArgs: IAttachRequestArgs,
116resolve?: (value?: void | PromiseLike<void> | undefined) => void,
117): void;
b7451aefRedMickey6 years ago118
ce5e88eeYuri Skorokhodov5 years ago119protected initializeSettings(args: any): Promise<any> {
2c19da7fRedMickey6 years ago120if (!this.isSettingsInitialized) {
121let chromeDebugCoreLogs = getLoggingDirectory();
122if (chromeDebugCoreLogs) {
123chromeDebugCoreLogs = path.join(chromeDebugCoreLogs, "DebugSessionLogs.txt");
124}
125let logLevel: string = args.trace;
126if (logLevel) {
127logLevel = logLevel.replace(logLevel[0], logLevel[0].toUpperCase());
128logger.setup(Logger.LogLevel[logLevel], chromeDebugCoreLogs || false);
34472878RedMickey5 years ago129this.cdpProxyLogLevel =
130LogLevel[logLevel] === LogLevel.Verbose ? LogLevel.Custom : LogLevel.None;
2c19da7fRedMickey6 years ago131} else {
132logger.setup(Logger.LogLevel.Log, chromeDebugCoreLogs || false);
34472878RedMickey5 years ago133this.cdpProxyLogLevel =
134LogHelper.LOG_LEVEL === LogLevel.Trace ? LogLevel.Custom : LogLevel.None;
2c19da7fRedMickey6 years ago135}
136
2db9ac85Yuri Skorokhodov5 years ago137if (typeof args.sourceMaps !== "boolean") {
2c19da7fRedMickey6 years ago138args.sourceMaps = true;
139}
140
5514e287RedMickey6 years ago141if (typeof args.enableDebug !== "boolean") {
142args.enableDebug = true;
143}
144
2c19da7fRedMickey6 years ago145const projectRootPath = getProjectRoot(args);
34472878RedMickey5 years ago146return ReactNativeProjectHelper.isReactNativeProject(projectRootPath).then(result => {
147if (!result) {
148throw ErrorHelper.getInternalError(
149InternalErrorCode.NotInReactNativeFolderError,
150);
151}
152this.projectRootPath = projectRootPath;
153this.appLauncher = AppLauncher.getAppLauncherByProjectRootPath(projectRootPath);
154this.isSettingsInitialized = true;
155
156return void 0;
157});
2c19da7fRedMickey6 years ago158} else {
ce5e88eeYuri Skorokhodov5 years ago159return Promise.resolve();
2c19da7fRedMickey6 years ago160}
161}
984ca036RedMickey6 years ago162
34472878RedMickey5 years ago163protected async disconnectRequest(
164response: DebugProtocol.DisconnectResponse,
165args: DebugProtocol.DisconnectArguments,
166// eslint-disable-next-line @typescript-eslint/no-unused-vars
167request?: DebugProtocol.Request,
168): Promise<void> {
a32e1e1fYuri Skorokhodov5 years ago169if (this.appLauncher) {
170await this.appLauncher.getRnCdpProxy().stopServer();
171}
e23d1841RedMickey6 years ago172
173this.cancellationTokenSource.cancel();
174this.cancellationTokenSource.dispose();
175
176// Then we tell the extension to stop monitoring the logcat, and then we disconnect the debugging session
259c018fYuri Skorokhodov5 years ago177if (this.previousAttachArgs && this.previousAttachArgs.platform === PlatformType.Android) {
e23d1841RedMickey6 years ago178try {
8df5011eYuri Skorokhodov5 years ago179this.appLauncher.getMobilePlatform().dispose();
e23d1841RedMickey6 years ago180} catch (err) {
34472878RedMickey5 years ago181logger.warn(
182localize(
183"CouldNotStopMonitoringLogcat",
184"Couldn't stop monitoring logcat: {0}",
185err.message || err,
186),
187);
e23d1841RedMickey6 years ago188}
189}
190
67ffa5b4RedMickey6 years ago191await logger.dispose();
192
ebbd64f1RedMickey6 years ago193DebugSessionBase.rootSessionTerminatedEventEmitter.fire({
194debugSession: this.session,
195args: {
a2ddbba5RedMickey5 years ago196forcedStop: !!(<any>args).forcedStop,
ebbd64f1RedMickey6 years ago197},
198});
199
200this.sendResponse(response);
e23d1841RedMickey6 years ago201}
202
203protected showError(error: Error, response: DebugProtocol.Response): void {
204// We can't print error messages after the debugging session is stopped. This could break the extension work.
34472878RedMickey5 years ago205if (
206(error instanceof InternalError || error instanceof NestedError) &&
207error.errorCode === InternalErrorCode.CancellationTokenTriggered
e23d1841RedMickey6 years ago208) {
209return;
210}
211
984ca036RedMickey6 years ago212this.sendErrorResponse(
213response,
e23d1841RedMickey6 years ago214{ format: error.message, id: 1 },
984ca036RedMickey6 years ago215undefined,
216undefined,
34472878RedMickey5 years ago217ErrorDestination.User,
984ca036RedMickey6 years ago218);
219}
2c19da7fRedMickey6 years ago220}
221
222/**
223* Parses settings.json file for workspace root property
224*/
225export function getProjectRoot(args: any): string {
226const vsCodeRoot = args.cwd ? path.resolve(args.cwd) : path.resolve(args.program, "../..");
227const settingsPath = path.resolve(vsCodeRoot, ".vscode/settings.json");
228try {
229let settingsContent = fs.readFileSync(settingsPath, "utf8");
230settingsContent = stripJsonComments(settingsContent);
231let parsedSettings = JSON.parse(settingsContent);
34472878RedMickey5 years ago232let projectRootPath =
233parsedSettings["react-native-tools.projectRoot"] ||
234parsedSettings["react-native-tools"].projectRoot;
2c19da7fRedMickey6 years ago235return path.resolve(vsCodeRoot, projectRootPath);
236} catch (e) {
34472878RedMickey5 years ago237logger.verbose(
238`${settingsPath} file doesn't exist or its content is incorrect. This file will be ignored.`,
239);
2c19da7fRedMickey6 years ago240return args.cwd ? path.resolve(args.cwd) : path.resolve(args.program, "../..");
241}
242}