Cleanup

Author: ManuelHentschel

package-lock.json

@@ -2,17 +2,17 @@
   "name": "r-debugger",
   "displayName": "R Debugger",
   "description": "R Debugger for VS Code",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "publisher": "RDebugger",
   "license": "MIT",
   "author": {
     "name": "Manuel Hentschel"
   },
   "rPackageInfo": {
     "name": "vscDebugger",
-    "required": "0.3.0",
-    "recommended": "0.3.1",
-    "warnIfNewer": "0.4.0"
+    "required": "0.4.0",
+    "recommended": "0.4.0",
+    "warnIfNewer": "0.5.0"
   },
   "repository": {
     "type": "git",
@@ -113,7 +113,6 @@
                 "default": false,
                 "description": "Whether to show the overwritten output in the normal stdout/stderr as well."
               },
-
               "overwritePrint": {
                 "type": "boolean",
                 "default": true,
@@ -200,7 +199,6 @@
                 "default": "main",
                 "description": "The name of the main function, if a single function is being debugged. Must be callable without arguments."
               },
-
               "overwritePrint": {
                 "type": "boolean",
                 "default": true,
@@ -274,6 +272,12 @@
             "file": "${file}",
             "mainFunction": "main",
             "allowGlobalDebugging": false
+          },
+          {
+            "type": "R-Debugger",
+            "request": "attach",
+            "name": "Attach to R process",
+            "splitOverwrittenOutput": true
           }
         ]
       }
@@ -321,6 +325,11 @@
           ],
           "default": "recommended",
           "description": "Whether to check the version of the R package before launching the debugger."
+        },
+        "rdebugger.trackTerminals": {
+          "type": "boolean",
+          "default": true,
+          "description": "Whether to track terminals opened while using the extension. Recommended for debugging in attached mode on windows."
         }
       }
     }

package.json

@@ -43,6 +43,8 @@ To install the latest development version of the required R-package from GitHub,
 or install from the artifacts found 
 [here](https://github.com/ManuelHentschel/vscDebugger/actions).
 
+If your R path is neither in the Windows registry nor the `PATH` environment variable, make sure to provide a valid path to the R executable in `rdebugger.rterm.*`.
+
 **Note on the package version:**
 Since the debugger is still under initial development, both this extension and the accompanying R package are major version 0.y.z.
 The minor version (x.Y.z) is incremented when backward incompatible changes to the interface/communication between the VS Code extension and the R package are introduced.
@@ -51,16 +53,27 @@ The patch version (x.y.Z) is incremented independently for all other changes tha
 
 
 ## Using the Debugger
-* Install this extension in VS Code.
-* Install the package [**vscDebugger**](https://github.com/ManuelHentschel/vscDebugger) in R.
-* If your R path is neither in the Windows registry nor the `PATH` environment variable, make sure to provide a valid path to the R executable in `rdebugger.rterm.*`.
+### Launch Mode
 * Press F5 and select `R Debugger` as debugger. With the default launch configuration, the debugger will start a new R session.
 * To run a file, focus the file in the editor and press F5 (or the continue button in the debug controls)
 * Output will be printed to the debug console,
 expressions entered into the debug console are evaluated in the currently active frame
 * During debugging in the global workspace it is often necessary to click the dummy frame
 in the callstack labelled 'Global Workspace' to see the variables in `.GlobalEnv`.
 
+### Attach Mode
+* Start R in a terminal
+* Load `library(vscDebugger)`
+* Call `.vsc.listen()`
+* Start the debugger with launch configuration including `"request":"attach"`, e.g.:
+``` json
+{
+    "type": "R-Debugger",
+    "request": "attach",
+    "name": "Attach to R process"
+}
+```
+
 ## Configuration
 For a detailed explanation of possible launch config entries and other settings, see
 [configuration.md](./configuration.md) on github.

readme.md

@@ -4,6 +4,11 @@ import { DebugProtocol } from 'vscode-debugprotocol';
 import * as VsCode from 'vscode';
 // import { DebugProtocol } from './debugProtocol';
 
+
+//
+// Regular extension of the DAP:
+//
+
 export type DebugMode = "function"|"file"|"workspace";
 
 export interface RStartupArguments {
@@ -14,11 +19,6 @@ export interface RStartupArguments {
     cwd: string;
 }
 
-export interface Source extends DebugProtocol.Source {
-    content?: string;
-}
-
-
 export interface DebugConfiguration extends VsCode.DebugConfiguration {
     type: "R-Debugger";
     request: "launch"|"attach";
@@ -91,6 +91,16 @@ export interface RStrings {
     packageName?: string;
 }
 
+
+
+
+//
+// Non standard extension/modification of the DAP:
+// 
+
+export interface InitializeRequest extends DebugProtocol.InitializeRequest {
+    arguments: InitializeRequestArguments;
+}
 export interface InitializeRequestArguments extends DebugProtocol.InitializeRequestArguments {
     rStrings?: RStrings;
     threadId?: number;
@@ -103,32 +113,22 @@ export interface InitializeRequestArguments extends DebugProtocol.InitializeRequ
     extensionVersion?: string;
 }
 
-export interface InitializeRequest extends DebugProtocol.InitializeRequest {
-    arguments: InitializeRequestArguments;
+export interface InitializeResponse extends DebugProtocol.InitializeResponse {
+    packageInfo?: PackageInfo;
 }
-
 export interface PackageInfo {
     Package: string;
     Version: string;
 };
 
-export interface InitializeResponse extends DebugProtocol.InitializeResponse {
-    packageInfo?: PackageInfo;
+export interface ContinueRequest extends DebugProtocol.ContinueRequest {
+    arguments: ContinueArguments;
 }
-
 export interface ContinueArguments extends DebugProtocol.ContinueArguments {
     callDebugSource?: boolean;
     source?: DebugProtocol.Source;
 }
 
-export interface ContinueRequest extends DebugProtocol.ContinueRequest {
-    arguments: ContinueArguments;
-}
-
-export interface SourceArguments extends DebugProtocol.SourceArguments {
-    source?: Source;
-}
-
 
 export interface ResponseWithBody extends DebugProtocol.Response {
     body?: { [key: string]: any; };

src/debugProtocolModifications.ts

@@ -16,6 +16,7 @@ const { Subject } = require('await-notify');
 
 import * as log from 'loglevel';
 const logger = log.getLogger("DebugRuntime");
+logger.setLevel(config().get<log.LogLevelDesc>('logLevelRuntime', 'info'));
 
 
 export type LineHandler = (line: string, from: DataSource, isFullLine: boolean) => string;
@@ -74,7 +75,6 @@ export class DebugRuntime extends EventEmitter {
 	// constructor
 	constructor() {
 		super();
-		logger.setLevel(config().get<log.LogLevelDesc>('logLevelRuntime', 'info'));
 	}
 
 	public async initializeRequest(response: DebugProtocol.InitializeResponse, args: MDebugProtocol.InitializeRequestArguments, request: MDebugProtocol.InitializeRequest) {
@@ -383,9 +383,8 @@ export class DebugRuntime extends EventEmitter {
 				console.log('invalid wop');
 			}
 		} else {
-			const cmdListen = `.vsc.listenOnPort(timeout = -1)`;
+			const cmdListen = this.rStrings.packageName + `::.vsc.listenForJSON(timeout = -1)`;
 			this.rSession.writeToStdin(cmdListen);
-			// this.rSession.callFunction('.vsc.listenOnPort', {timeout: -1});
 			this.sendShowingPromptRequest(which, text);
 		}
 	}

src/debugRuntime.ts

@@ -3,14 +3,14 @@
 
 import { basename } from 'path';
 import { DebugRuntime } from './debugRuntime';
-import { Response } from 'vscode-debugadapter/lib/messages';
 import { ProtocolServer } from 'vscode-debugadapter/lib/protocol';
 import { DebugProtocol } from 'vscode-debugprotocol';
 import { InitializeRequest, ResponseWithBody, InitializeRequestArguments, ContinueRequest } from './debugProtocolModifications';
 import { config, getVSCodePackageVersion } from './utils';
 
 import * as log from 'loglevel';
 const logger = log.getLogger("DebugSession");
+logger.setLevel(config().get<log.LogLevelDesc>('logLevelSession', 'INFO'));
 
 export class DebugSession extends ProtocolServer {
 
@@ -35,8 +35,6 @@ export class DebugSession extends ProtocolServer {
     constructor() {
         super();
 
-		logger.setLevel(config().get<log.LogLevelDesc>('logLevelSession', 'INFO'));
-
 		// construct R runtime
 		this._runtime = new DebugRuntime();
 
@@ -79,7 +77,13 @@ export class DebugSession extends ProtocolServer {
     }
 
     protected dispatchRequest(request: DebugProtocol.Request) {
-        const response: ResponseWithBody = new Response(request);
+        const response: DebugProtocol.Response = {
+            command: request.command,
+            request_seq: request.seq,
+            seq: 0,
+            success: true,
+            type: 'response'
+        };
         var dispatchToR: boolean = false; // the cases handled here are not sent to R
         var sendResponse: boolean = true; // for cases handled here, the response must also be sent from here
         try {

src/debugSession.ts

@@ -6,6 +6,10 @@ import { WriteToStdinEvent, WriteToStdinBody } from './debugProtocolModification
 import * as vscode from 'vscode';
 import { config, getPortNumber } from './utils';
 
+import * as log from 'loglevel';
+const logger = log.getLogger("DebugRuntime");
+logger.setLevel(config().get<log.LogLevelDesc>('logLevelTerminals', 'INFO'));
+
 let doTrackTerminals: boolean = false;
 
 export function trackTerminals(){
@@ -75,14 +79,15 @@ export class TerminalHandler {
     public constructor(port: number = 0, host: string = 'localhost'){
         const timeout = config().get<number>('timeouts.startup', 1000);
         this.server = net.createServer((socket) => {
+            logger.debug('Cusotm server: connection!');
             socket.on('data', (data) => {
                 this.handleData(data, socket);
             });
         });
         const portPromise = new Promise<number>((resolve, reject) => {
             this.server.listen(port, host, () => {
                 const port = getPortNumber(this.server);
-                console.log(`Server listening on ${host}:${port}`);
+                logger.info(`Custom server listening on ${host}:${port}`);
                 resolve(port);
             });
             setTimeout(() => {
@@ -94,7 +99,7 @@ export class TerminalHandler {
     }
 
     public close(){
-        console.log('closing terminal handler connections');
+        console.log('Closing custom server connections');
         this.lineCache.forEach((_, socket) => {
             socket.destroy();
         });
@@ -146,6 +151,7 @@ async function writeToStdin(args: WriteToStdinArgs){
         terminal.sendText(args.text, args.addNewLine);
         return true;
     } else{
+        logger.debug('No terminal found.')
         return false;
     }
 }
@@ -161,6 +167,7 @@ async function findTerminal(args: WriteToStdinArgs): Promise<vscode.Terminal|und
         for(term of vscode.window.terminals){
             const pid: number = await term.processId;
             if(pid === args.pid || pid === args.ppid){
+                logger.debug('identified terminal by pid');
                 return term;
             }
         }
@@ -169,12 +176,14 @@ async function findTerminal(args: WriteToStdinArgs): Promise<vscode.Terminal|und
     if(args.terminalId && doTrackTerminals){
         for(term of vscode.window.terminals){
             if('vscodeRDebuggerTerminalId' in term && args.terminalId === term.vscodeRDebuggerTerminalId){
+                logger.debug('identified terminal by terminalId');
                 return term;
             }
         }
     }
     // resort to active terminal
     if(args.useActiveTerminal){
+        logger.debug('resort to active terminal');
         return vscode.window.activeTerminal;
     }
     // give up...

src/terminals.ts

@@ -0,0 +1,2 @@
+
+options(vsc.supportSetVariable = FALSE)

test/R/.Rprofile

@@ -8,7 +8,7 @@
             "type": "R-Debugger",
             "request": "attach",
             "name": "Attach to R process",
-            "supportsWriteToStdinEvent": false,
+            "supportsWriteToStdinEvent": true,
             "splitOverwrittenOutput": false,
             "useCustomSocket": true
         },

test/R/.vscode/launch.json

@@ -2,12 +2,12 @@
     "rdebugger.checkVersion": "none",
     // "rdebugger.printStdout": "all",
     // "rdebugger.printSinkSocket": "all",
-    "rdebugger.logLevelRSession": "debug",
+    // "rdebugger.logLevelRSession": "debug",
     // "rdebugger.logLevelSession": "debug",
-    "rdebugger.logLevelRuntime": "debug",
+    // "rdebugger.logLevelRuntime": "debug",
     "terminal.integrated.env.windows": {
-        "VSCODE_R_DEBUGGER_TERMINAL_ID": "53"
+        "VSCODE_R_DEBUGGER_TERMINAL_ID": "81"
     },
-    "rdebugger.trackTerminals": false
+    "rdebugger.trackTerminals": true
     // "rdebugger.rterm.windows": "\"C:\\Program Files\\R\\R-4.0.2\\bin\\x64\\R.exe\""
 }