modifications to map paths during remote debugging

DonJayamanne · DonJayamanne · commit 72f20ad2f730 · 2016-03-09T10:43:35.000+11:00
diff --git a/README.md b/README.md
@@ -1,6 +1,5 @@
 # Python
-Linting, Debugging (multi threaded, web apps), Intellisense, auto-completion, code formatting, snippets, unit testing, and more.
-Works on both Windows and Mac.
+Linting, Debugging (multi-threaded, web apps, remote), Intellisense, auto-completion, code formatting, snippets, unit testing, and more.
  
 ##Features
 * Linting (PyLint, Pep8, Flake8 with config files and plugins)
@@ -20,10 +19,7 @@ Works on both Windows and Mac.
 ##[Wiki](https://github.com/DonJayamanne/pythonVSCode/wiki)
 
 ##[Issues and Feature Requests](https://github.com/DonJayamanne/pythonVSCode/issues)
-* Support of shebang (testing)
-* Remote Debugging (testing)
 * Support for Virtual Environments (in development)
-* More features on the way
 
 ## Feature Details (with confiuration)
 * IDE Features
@@ -67,6 +63,7 @@ Works on both Windows and Mac.
  + Multiple Threads and Web Applications (such as Flask) (Windows and Mac)
  + Expanding values (viewing children, properties, etc) (Windows and Mac)
  + Conditional breakpoints
+ + Remote debugging
 * Unit Testing
  + unittests (default is on)
  + nosetests (default is off)
@@ -106,6 +103,9 @@ Works on both Windows and Mac.
 
 ## Change Log
 
+### Version 0.3.1
+* Remote debugging (updated documentation and fixed minor issues)
+
 ### Version 0.3.0
 * Remote debugging (attaching to local and remote processes)
 * Debugging with support for shebang
diff --git a/src/client/debugger/Main.ts b/src/client/debugger/Main.ts
@@ -238,7 +238,7 @@ export class PythonDebugger extends DebugSession {
                         breakpoint.Enabled = true;
                     }
                     else {
-                        breakpoint = this.buildBreakpointDetails(args.source.path, bk.line, bk.condition);
+                        breakpoint = this.buildBreakpointDetails(this.convertClientPathToDebugger(args.source.path), bk.line, bk.condition);
                     }
 
                     this.pythonProcess.BindBreakpoint(breakpoint).then(() => {
@@ -288,7 +288,28 @@ export class PythonDebugger extends DebugSession {
         };
         this.sendResponse(response);
     }
-
+    /** converts the remote path to local path */
+    protected convertDebuggerPathToClient(remotePath: string): string {
+        if (this.attachArgs && this.attachArgs.localRoot && this.attachArgs.remoteRoot) {
+            // get the part of the path that is relative to the source root
+            const pathRelativeToSourceRoot = path.relative(this.attachArgs.remoteRoot, remotePath);
+            // resolve from the local source root
+            return path.resolve(this.attachArgs.localRoot, pathRelativeToSourceRoot);
+        } else {
+            return remotePath;
+        }
+    }
+    /** converts the local path to remote path */
+    protected convertClientPathToDebugger(clientPath: string): string {
+        if (this.attachArgs && this.attachArgs.localRoot && this.attachArgs.remoteRoot) {
+            // get the part of the path that is relative to the client root
+            const pathRelativeToClientRoot = path.relative(this.attachArgs.localRoot, clientPath);
+            // resolve from the remote source root
+            return path.resolve(this.attachArgs.remoteRoot, pathRelativeToClientRoot);
+        } else {
+            return clientPath;
+        }
+    }
     protected stackTraceRequest(response: DebugProtocol.StackTraceResponse, args: DebugProtocol.StackTraceArguments): void {
         this.debuggerLoaded.then(() => {
             if (!this.pythonProcess.Threads.has(args.threadId)) {
