fix(paths): lowercase Windows drive letters (#245)

Closes #239

Author: johnrom

src/paths.ts

@@ -52,7 +52,8 @@ export function convertDebuggerPathToClient(
 export function convertClientPathToDebugger(localPath: string, pathMapping?: { [index: string]: string }): string {
     let localSourceRoot: string | undefined
     let serverSourceRoot: string | undefined
-    let localFileUri = fileUrl(localPath, { resolve: false })
+    // XDebug always lowercases Windows drive letters in file URIs
+    let localFileUri = fileUrl(localPath.replace(/^[A-Z]:\\/, match => match.toLowerCase()), { resolve: false })
     let serverFileUri: string
     if (pathMapping) {
         for (const mappedServerPath of Object.keys(pathMapping)) {
@@ -65,6 +66,12 @@ export function convertClientPathToDebugger(localPath: string, pathMapping?: { [
             }
         }
     }
+    if (localSourceRoot) {
+        localSourceRoot = localSourceRoot.replace(/^[A-Z]:\\/, match => match.toLowerCase())
+    }
+    if (serverSourceRoot) {
+        serverSourceRoot = serverSourceRoot.replace(/^[A-Z]:\\/, match => match.toLowerCase())
+    }
     if (serverSourceRoot && localSourceRoot) {
         let localSourceRootUrl = fileUrl(localSourceRoot, { resolve: false })
         if (!localSourceRootUrl.endsWith('/')) {

src/test/paths.ts

@@ -29,7 +29,7 @@ describe('paths', () => {
             it('should convert a windows path to a URI', () => {
                 assert.equal(
                     convertClientPathToDebugger('C:\\Users\\felix\\test.php'),
-                    'file:///C:/Users/felix/test.php'
+                    'file:///c:/Users/felix/test.php'
                 )
             })
             it('should convert a unix path to a URI', () => {
@@ -64,15 +64,15 @@ describe('paths', () => {
                         'C:\\Program Files\\Apache\\2.4\\htdocs': '/home/felix/mysite',
                         'C:\\Program Files\\MySource': '/home/felix/mysource',
                     }),
-                    'file:///C:/Program%20Files/Apache/2.4/htdocs/site.php'
+                    'file:///c:/Program%20Files/Apache/2.4/htdocs/site.php'
                 )
                 // source
                 assert.equal(
                     convertClientPathToDebugger('/home/felix/mysource/source.php', {
                         'C:\\Program Files\\Apache\\2.4\\htdocs': '/home/felix/mysite',
                         'C:\\Program Files\\MySource': '/home/felix/mysource',
                     }),
-                    'file:///C:/Program%20Files/MySource/source.php'
+                    'file:///c:/Program%20Files/MySource/source.php'
                 )
             })
             // windows to unix
@@ -94,6 +94,19 @@ describe('paths', () => {
                     'file:///app/source.php'
                 )
             })
+            ;(process.platform === 'win32' ? it : it.skip)(
+                'should convert a windows path with inconsistent casing to a unix URI',
+                () => {
+                    const localSourceRoot = 'C:\\Users\\felix\\myproject'
+                    const serverSourceRoot = '/var/www'
+                    assert.equal(
+                        convertClientPathToDebugger('c:\\Users\\felix\\myproject\\test.php', {
+                            [serverSourceRoot]: localSourceRoot,
+                        }),
+                        'file:///var/www/test.php'
+                    )
+                }
+            )
             // windows to windows
             ;(process.platform === 'win32' ? it : it.skip)('should convert a windows path to a windows URI', () => {
                 // site
@@ -102,15 +115,15 @@ describe('paths', () => {
                         'C:\\Program Files\\Apache\\2.4\\htdocs': 'C:\\Users\\felix\\mysite',
                         'C:\\Program Files\\MySource': 'C:\\Users\\felix\\mysource',
                     }),
-                    'file:///C:/Program%20Files/Apache/2.4/htdocs/site.php'
+                    'file:///c:/Program%20Files/Apache/2.4/htdocs/site.php'
                 )
                 // source
                 assert.equal(
                     convertClientPathToDebugger('C:\\Users\\felix\\mysource\\source.php', {
                         'C:\\Program Files\\Apache\\2.4\\htdocs': 'C:\\Users\\felix\\mysite',
                         'C:\\Program Files\\MySource': 'C:\\Users\\felix\\mysource',
                     }),
-                    'file:///C:/Program%20Files/MySource/source.php'
+                    'file:///c:/Program%20Files/MySource/source.php'
                 )
             })
         })