feat: Ignore exceptions based on class name (#882)

* Add possibility to ignore exceptions based on class name * Add ignore exception test * Update readme and comments * Fix test error * Add package.json definition, renamed setting to ignoreExceptions, fix tests. * Changelog. --------- Co-authored-by: Damjan Cvetko <damjan.cvetko@gmail.com>
xdebug · Feb 23, 2023 · 120f688 · 120f688
1 parent 75c3e1d
commit 120f688
Show file tree

Hide file tree

Showing 7 changed files with 42 additions and 5 deletions.
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](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.32.0]
+
+- New launch setting ignoreExceptions.
+
 ## [1.31.1]
 
 - Fix relative paths and path mappings support.

diff --git a/README.md b/README.md
@@ -76,6 +76,7 @@ More general information on debugging with VS Code can be found on https://code.
 - `pathMappings`: A list of server paths mapping to the local source paths on your machine, see "Remote Host Debugging" below
 - `log`: Whether to log all communication between VS Code and the adapter to the debug console. See _Troubleshooting_ further down.
 - `ignore`: An optional array of glob patterns that errors should be ignored from (for example `**/vendor/**/*.php`)
+- `ignoreExceptions`: An optional array of exception class names that should be ignored (for example `BaseException`)
 - `skipFiles`: An array of glob patterns, to skip when debugging. Star patterns and negations are allowed, for example, `**/vendor/**` or `!**/vendor/my-module/**`.
 - `maxConnections`: Accept only this number of parallel debugging sessions. Additional connections will be dropped and their execution will continue without debugging.
 - `proxy`: DBGp Proxy settings

diff --git a/package.json b/package.json
@@ -278,6 +278,11 @@
                   "**/vendor/**"
                 ]
               },
+              "ignoreExceptions": {
+                "type": "array",
+                "items": "string",
+                "description": "An array of exception class names that should be ignored."
+              },
               "log": {
                 "type": "boolean",
                 "description": "If true, will log all communication between VS Code and the adapter"

diff --git a/src/phpDebug.ts b/src/phpDebug.ts
@@ -76,6 +76,8 @@ export interface LaunchRequestArguments extends VSCodeDebugProtocol.LaunchReques
     log?: boolean
     /** Array of glob patterns that errors should be ignored from */
     ignore?: string[]
+    /** Array of glob patterns that exceptions should be ignored from */
+    ignoreExceptions?: string[]
     /** Array of glob patterns that debugger should not step in */
     skipFiles?: string[]
     /** Xdebug configuration */
@@ -667,15 +669,20 @@ class PhpDebugSession extends vscode.DebugSession {
             if (response.exception) {
                 // If one of the ignore patterns matches, ignore this exception
                 if (
-                    this._args.ignore &&
-                    this._args.ignore.some(glob =>
-                        minimatch(convertDebuggerPathToClient(response.fileUri).replace(/\\/g, '/'), glob)
-                    )
+                    // ignore files
+                    (this._args.ignore &&
+                        this._args.ignore.some(glob =>
+                            minimatch(convertDebuggerPathToClient(response.fileUri).replace(/\\/g, '/'), glob)
+                        )) ||
+                    // ignore exception class name
+                    (this._args.ignoreExceptions &&
+                        this._args.ignoreExceptions.some(glob => minimatch(response.exception.name, glob)))
                 ) {
                     const response = await connection.sendRunCommand()
                     await this._checkStatus(response)
                     return
                 }
+
                 stoppedEventReason = 'exception'
                 exceptionText = response.exception.name + ': ' + response.exception.message // this seems to be ignored currently by VS Code
             } else if (this._args.stopOnEntry && !this._hasStoppedOnEntry) {

diff --git a/src/test/adapter.ts b/src/test/adapter.ts
@@ -212,6 +212,14 @@ describe('PHP Debug Adapter', () => {
                 await Promise.all([client.configurationDoneRequest(), client.waitForEvent('terminated')])
             })
 
+            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.setExceptionBreakpointsRequest({ filters: ['*'] })
+                await Promise.all([client.configurationDoneRequest(), client.waitForEvent('terminated')])
+            })
+
             it('should support stopping only on a notice', async () => {
                 await client.launch({ program })
                 await client.setExceptionBreakpointsRequest({ filters: ['Notice'] })

diff --git a/testproject/.vscode/launch.json b/testproject/.vscode/launch.json
@@ -21,7 +21,8 @@
       "env": {
         "XDEBUG_MODE": "debug,develop",
         "XDEBUG_CONFIG": "client_port=${port}"
-      }
+      },
+      "ignoreExceptions": ["IgnoreException"]
     },
     {
       //"debugServer": 4711, // Uncomment for debugging the adapter

diff --git a/testproject/ignore_exception.php b/testproject/ignore_exception.php
@@ -0,0 +1,11 @@
+<?php
+
+class IgnoreException extends Exception
+{}
+
+try {
+    // see launch.json ignoreExceptions
+    throw new IgnoreException('this is an ignored exception');
+} catch (Exception $e) {
+    //
+}