fix: check if Unix Domain socket file exists before listening. (#921)

* docs: Update CHANGELOG. * fix: Check if Unix Domain socket file exists before listening. * Test
xdebug · Jul 13, 2024 · 6d9a2d2 · 6d9a2d2
1 parent 5c37f12
commit 6d9a2d2
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/src/phpDebug.ts b/src/phpDebug.ts
@@ -414,6 +414,11 @@ class PhpDebugSession extends vscode.DebugSession {
                     throw new Error('Cannot have port and socketPath set at the same time')
                 }
                 if (args.hostname?.toLowerCase()?.startsWith('unix://') === true) {
+                    if (fs.existsSync(args.hostname.substring(7))) {
+                        throw new Error(
+                            `File ${args.hostname.substring(7)} exists and cannot be used for Unix Domain socket`
+                        )
+                    }
                     server.listen(args.hostname.substring(7))
                 } else if (args.hostname?.startsWith('\\\\') === true) {
                     server.listen(args.hostname)

diff --git a/src/test/adapter.ts b/src/test/adapter.ts
@@ -92,6 +92,16 @@ describe('PHP Debug Adapter', () => {
                 client.waitForEvent('terminated'),
             ])
         })
+        ;(process.platform === 'win32' ? it.skip : it)('should error on existing unix pipe', async () => {
+            await assert.isRejected(
+                client.launch({
+                    program,
+                    hostname: 'unix:///tmp',
+                    runtimeArgs: ['-dxdebug.client_host=unix:///tmp'],
+                }),
+                /File .+ exists and cannot be used for Unix Domain socket/
+            )
+        })
     })
 
     describe('continuation commands', () => {