fix: support relative paths and path mappings (#887)

zobo · web-flow · commit 75c3e1d3cb55 · 2023-02-14T22:53:37.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/) and this project adheres to [Semantic Versioning](https://semver.org/).
 
+## [1.31.1]
+
+- Fix relative paths and path mappings support.
+
 ## [1.31.0]
 
 - Allow more flexible path mappings in url format.
diff --git a/src/paths.ts b/src/paths.ts
@@ -1,6 +1,6 @@
 import fileUrl from 'file-url'
 import * as url from 'url'
-import * as path from 'path'
+import * as Path from 'path'
 import minimatch from 'minimatch'
 
 /** converts a server-side Xdebug file URI to a local path for VS Code with respect to source root settings */
@@ -45,7 +45,7 @@ export function convertDebuggerPathToClient(fileUri: string, pathMapping?: { [in
         let pathname = u.pathname
         if (isWindowsUri(fileUri)) {
             // From Node.js lib/internal/url.js pathToFileURL
-            pathname = pathname.replace(/\//g, path.win32.sep)
+            pathname = pathname.replace(/\//g, Path.win32.sep)
             pathname = decodeURIComponent(pathname)
             if (u.hostname !== '') {
                 localPath = `\\\\${url.domainToUnicode(u.hostname)}${pathname}`
@@ -123,14 +123,16 @@ function pathOrUrlToUrl(path: string): string {
         try {
             // try to parse, but do not modify
             new URL(path).toString()
-            return path
+            // super simple relative path resolver
+            return simpleResolveUrl(path)
         } catch (ex) {
             // should be a path
         }
     }
     // Not a URL, do some windows path mangling before it is converted to URL
     if (path.startsWith('\\\\')) {
         // UNC
+        path = Path.win32.resolve(path)
         const hostEndIndex = path.indexOf('\\', 2)
         const host = path.substring(2, hostEndIndex)
         const outURL = new URL('file://')
@@ -147,6 +149,7 @@ function pathOrUrlToUrl(path: string): string {
     //     // Xdebug always lowercases Windows drive letters in file URIs
     //     //path = path.replace(/^[A-Z]:/, match => match.toLowerCase())
     // }
+    path = isWindowsPath(path) ? Path.win32.resolve(path) : Path.posix.resolve(path)
     return fileUrl(path, { resolve: false })
 }
 
@@ -163,3 +166,15 @@ export function isPositiveMatchInGlobs(path: string, globs: string[]): boolean {
     const f = globs.find(glob => minimatch(path, glob.charAt(0) == '!' ? glob.substring(1) : glob))
     return f !== undefined && f.charAt(0) !== '!'
 }
+
+function simpleResolveUrl(path: string): string {
+    if (path.indexOf('/../') != -1) {
+        const pp = path.split('/')
+        let i
+        while ((i = pp.findIndex(v => v == '..')) > 0) {
+            pp.splice(i - 1, 2)
+        }
+        path = pp.join('/')
+    }
+    return path
+}
diff --git a/src/test/paths.ts b/src/test/paths.ts
@@ -180,6 +180,38 @@ describe('paths', () => {
                 )
             })
         })
+        describe('relative paths', () => {
+            it('should resolve relative path posix', () => {
+                assert.equal(convertClientPathToDebugger('/var/www/foo/../bar'), 'file:///var/www/bar')
+            })
+            it('should resolve relative path maps posix', () => {
+                assert.equal(
+                    convertClientPathToDebugger('/work/foo/test.php', {
+                        '/var/www/html/bar': '/work/project/folder/../../foo',
+                    }),
+                    'file:///var/www/html/bar/test.php'
+                )
+            })
+            it('should resolve relative path win32', () => {
+                assert.equal(convertClientPathToDebugger('C:\\var\\www\\foo\\..\\bar'), 'file:///C:/var/www/bar')
+            })
+            it('should resolve relative path maps win32 to posix', () => {
+                assert.equal(
+                    convertClientPathToDebugger('C:\\work\\foo\\test.php', {
+                        '/var/www/html/bar': 'C:\\work\\project\\folder\\..\\..\\foo',
+                    }),
+                    'file:///var/www/html/bar/test.php'
+                )
+            })
+            it('should resolve relative path maps win32 to win32', () => {
+                assert.equal(
+                    convertClientPathToDebugger('C:\\work\\foo\\test.php', {
+                        'C:\\var\\www\\html\\bar': 'C:\\work\\project\\folder\\..\\..\\foo',
+                    }),
+                    'file:///C:/var/www/html/bar/test.php'
+                )
+            })
+        })
     })
     describe('convertDebuggerPathToClient', () => {
         describe('without source mapping', () => {
@@ -366,6 +398,22 @@ describe('paths', () => {
                 'ssh://host/path/file.php'
             )
         })
+        it('should map sshfs to remote unix relative', () => {
+            assert.equal(
+                convertClientPathToDebugger('ssh://host/path/file.php', {
+                    '/root/path': 'ssh://host/test/../path/',
+                }),
+                'file:///root/path/file.php'
+            )
+        })
+        it('should map remote unix to sshfs relative', () => {
+            assert.equal(
+                convertDebuggerPathToClient('file:///root/path/file.php', {
+                    '/root/path': 'ssh://host/test/../path/',
+                }),
+                'ssh://host/path/file.php'
+            )
+        })
     })
     describe('UNC', () => {
         it('should convert UNC to url', () => {
