fix: ignore exception patterns and namespaces (#892)

zobo · zobo · commit d80aa382fb8e · 2023-03-22T13:02:36.000+01:00
* fix: Ignore Exception patterns

* Update launch.json
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -31,7 +31,30 @@
       "args": ["out/test", "--no-timeouts", "--colors"],
       "cwd": "${workspaceRoot}",
       "sourceMaps": true,
+      "env": {
+        "VSCODE_DEBUG_PORT": "4711"
+      },
       "outFiles": ["${workspaceFolder}/out/**/*.js"]
     }
+  ],
+  "compounds": [
+    {
+      "name": "PHP Debug",
+      "stopAll": true,
+      "configurations": ["Debug adapter", "Launch Extension"],
+      "presentation": {
+        "group": "0_php",
+        "order": 1
+      }
+    },
+    {
+      "name": "Unit tests",
+      "stopAll": true,
+      "configurations": ["Debug adapter", "Mocha"],
+      "presentation": {
+        "group": "0_php",
+        "order": 2
+      }
+    }
   ]
 }
diff --git a/src/ignore.ts b/src/ignore.ts
@@ -0,0 +1,9 @@
+export function shouldIgnoreException(name: string, patterns: string[]): boolean {
+    return patterns.some(pattern => name.match(convertPattern(pattern)))
+}
+
+function convertPattern(pattern: string): string {
+    const esc = pattern.replace(/[|\\{}()[\]^$+*?.]/g, '\\$&').replace(/-/g, '\\x2d')
+    const proc = esc.replace(/\\\*\\\*/g, '.*').replace(/\\\*/g, '[^\\\\]*')
+    return '^' + proc + '$'
+}
diff --git a/src/phpDebug.ts b/src/phpDebug.ts
@@ -18,6 +18,7 @@ import { ProxyConnect } from './proxyConnect'
 import { randomUUID } from 'crypto'
 import { getConfiguredEnvironment } from './envfile'
 import { XdebugCloudConnection } from './cloud'
+import { shouldIgnoreException } from './ignore'
 
 if (process.env['VSCODE_NLS_CONFIG']) {
     try {
@@ -676,7 +677,7 @@ class PhpDebugSession extends vscode.DebugSession {
                         )) ||
                     // ignore exception class name
                     (this._args.ignoreExceptions &&
-                        this._args.ignoreExceptions.some(glob => minimatch(response.exception.name, glob)))
+                        shouldIgnoreException(response.exception.name, this._args.ignoreExceptions))
                 ) {
                     const response = await connection.sendRunCommand()
                     await this._checkStatus(response)
diff --git a/src/test/adapter.ts b/src/test/adapter.ts
@@ -215,7 +215,7 @@ describe('PHP Debug Adapter', () => {
             it('should not break on exception that matches the ignore pattern', async () => {
                 const program = path.join(TEST_PROJECT, 'ignore_exception.php')
 
-                await client.launch({ program, ignoreExceptions: ['IgnoreException'] })
+                await client.launch({ program, ignoreExceptions: ['NS1\\NS2\\IgnoreException'] })
                 await client.setExceptionBreakpointsRequest({ filters: ['*'] })
                 await Promise.all([client.configurationDoneRequest(), client.waitForEvent('terminated')])
             })
diff --git a/src/test/ignore.ts b/src/test/ignore.ts
@@ -0,0 +1,42 @@
+import { assert } from 'chai'
+import { describe, it } from 'mocha'
+import { shouldIgnoreException } from '../ignore'
+
+describe('ignoreExceptions', () => {
+    it('should match exact', () => {
+        assert.isTrue(shouldIgnoreException('BaseException', ['BaseException']))
+    })
+    it('should no match exact', () => {
+        assert.isFalse(shouldIgnoreException('BaseException', ['SomeOtherException']))
+    })
+    it('should match wildcard end exact', () => {
+        assert.isTrue(shouldIgnoreException('BaseException', ['BaseException*']))
+    })
+    it('should match wildcard end extra', () => {
+        assert.isTrue(shouldIgnoreException('BaseExceptionMore', ['BaseException*']))
+    })
+    it('should match namespaced exact', () => {
+        assert.isTrue(shouldIgnoreException('NS1\\BaseException', ['NS1\\BaseException']))
+    })
+    it('should match namespaced wildcard exact', () => {
+        assert.isTrue(shouldIgnoreException('NS1\\BaseException', ['NS1\\BaseException*']))
+    })
+    it('should match namespaced wildcard extra', () => {
+        assert.isTrue(shouldIgnoreException('NS1\\BaseExceptionMore', ['NS1\\BaseException*']))
+    })
+    it('should match namespaced wildcard whole level', () => {
+        assert.isTrue(shouldIgnoreException('NS1\\BaseException', ['NS1\\*']))
+    })
+    it('should not match namespaced wildcard more levels', () => {
+        assert.isFalse(shouldIgnoreException('NS1\\NS2\\BaseException', ['NS1\\*']))
+    })
+    it('should match namespaced wildcard in middle', () => {
+        assert.isTrue(shouldIgnoreException('NS1\\NS2\\BaseException', ['NS1\\*\\BaseException']))
+    })
+    it('should match namespaced wildcard multiple', () => {
+        assert.isTrue(shouldIgnoreException('NS1\\NS2\\NS3\\BaseException', ['NS1\\*\\*\\BaseException']))
+    })
+    it('should match namespaced wildcard levels', () => {
+        assert.isTrue(shouldIgnoreException('NS1\\NS2\\NS3\\BaseException', ['NS1\\**\\BaseException']))
+    })
+})
diff --git a/testproject/ignore_exception.php b/testproject/ignore_exception.php
@@ -1,11 +1,13 @@
 <?php
 
-class IgnoreException extends Exception
+namespace NS1\NS2;
+
+class IgnoreException extends \Exception
 {}
 
 try {
     // see launch.json ignoreExceptions
     throw new IgnoreException('this is an ignored exception');
-} catch (Exception $e) {
+} catch (\Exception $e) {
     //
 }
