feat: default Xdebug port changed to 9003 (#585)

* Change default Xdebug port from 9000 to 9003.

* Update port in tests. Changelog.

Author: zobo

.github/workflows/build.yml

@@ -50,10 +50,10 @@ jobs:
           ini-values: >-
             xdebug.mode = debug,
             xdebug.start_with_request = yes,
-            xdebug.client_port = 9000,
 
             xdebug.remote_enable = 1,
             xdebug.remote_autostart = 1,
+            xdebug.remote_port = 9003,
             xdebug.remote_log = /tmp/xdebug.log
       - name: Run tests
         run: npm run cover

CHANGELOG.md

@@ -10,6 +10,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 
 - Option to start PHP built-in web server without router script.
 
+### Changed
+
+- Switched to Xdebug 3 default port 9003.
+
 ### Fixed
 
 - Internal Source Reference for virtual source files fixed - when stepping into eval()

README.md

@@ -34,17 +34,17 @@ This extension is a debug adapter between VS Code and [Xdebug](https://xdebug.or
    ```ini
    xdebug.mode = debug
    xdebug.start_with_request = yes
-   xdebug.client_port = 9000
    ```
 
    For Xdebug v2.x.x:
 
    ```ini
    xdebug.remote_enable = 1
    xdebug.remote_autostart = 1
+   xdebug.remote_port = 9003
    ```
 
-   There are other ways to tell Xdebug to connect to a remote debugger, like cookies, query parameters or browser extensions. I recommend `remote_autostart` (Xdebug v2)/`start_with_request` (Xdebug v3) because it "just works". There are also a variety of other options, like the port, please see the [Xdebug documentation on remote debugging](https://xdebug.org/docs/remote#starting) for more information. Please note that the default Xdebug port changed between Xdebug v2 to v3 from 9000 to 9003. The extension still defaults to 9000, so make sure your configuration in `launch.json` and `php.ini` match.
+   There are other ways to tell Xdebug to connect to a remote debugger, like cookies, query parameters or browser extensions. I recommend `remote_autostart` (Xdebug v2)/`start_with_request` (Xdebug v3) because it "just works". There are also a variety of other options, like the port, please see the [Xdebug documentation on remote debugging](https://xdebug.org/docs/remote#starting) for more information. Please note that the default Xdebug port changed between Xdebug v2 to v3 from 9000 to 9003.
 
 4. If you are doing web development, don't forget to restart your webserver to reload the settings.
 
@@ -55,7 +55,7 @@ This extension is a debug adapter between VS Code and [Xdebug](https://xdebug.or
 In your project, go to the debugger and hit the little gear icon and choose _PHP_. A new launch configuration will be created for you with three configurations:
 
 - **Listen for Xdebug**
-  This setting will simply start listening on the specified port (by default 9000) for Xdebug. If you configured Xdebug like recommended above, every time you make a request with a browser to your webserver or launch a CLI script Xdebug will connect and you can stop on breakpoints, exceptions etc.
+  This setting will simply start listening on the specified port (by default 9003) for Xdebug. If you configured Xdebug like recommended above, every time you make a request with a browser to your webserver or launch a CLI script Xdebug will connect and you can stop on breakpoints, exceptions etc.
 - **Launch currently open script**
   This setting is an example of CLI debugging. It will launch the currently opened script as a CLI, show all stdout/stderr output in the debug console and end the debug session once the script exits.
 - **Launch Built-in web server**
@@ -67,7 +67,7 @@ More general information on debugging with VS Code can be found on https://code.
 
 - `request`: Always `"launch"`
 - `hostname`: The address to bind to when listening for Xdebug (default: all IPv6 connections if available, else all IPv4 connections)
-- `port`: The port on which to listen for Xdebug (default: `9000`)
+- `port`: The port on which to listen for Xdebug (default: `9003`)
 - `stopOnEntry`: Whether to break at the beginning of the script (default: `false`)
 - `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.

package.json

@@ -212,7 +212,7 @@
               "port": {
                 "type": "number",
                 "description": "Port on which to listen for Xdebug",
-                "default": 9000
+                "default": 9003
               },
               "serverSourceRoot": {
                 "type": "string",
@@ -271,15 +271,15 @@
             "name": "Listen for Xdebug",
             "type": "php",
             "request": "launch",
-            "port": 9000
+            "port": 9003
           },
           {
             "name": "Launch currently open script",
             "type": "php",
             "request": "launch",
             "program": "${file}",
             "cwd": "${fileDirname}",
-            "port": 9000
+            "port": 9003
           },
           {
             "name": "Launch Built-in web server",
@@ -293,7 +293,7 @@
             ],
             "program": "",
             "cwd": "${workspaceRoot}",
-            "port": 9000,
+            "port": 9003,
             "serverReadyAction": {
               "pattern": "Development Server \\(http://localhost:([0-9]+)\\) started",
               "uriFormat": "http://localhost:%s",
@@ -309,7 +309,7 @@
               "name": "Listen for Xdebug",
               "type": "php",
               "request": "launch",
-              "port": 9000
+              "port": 9003
             }
           },
           {
@@ -321,7 +321,7 @@
               "request": "launch",
               "program": "^\"${1:\\${file\\}}\"",
               "cwd": "^\"${2:\\${fileDirname\\}}\"",
-              "port": 9000
+              "port": 9003
             }
           },
           {
@@ -339,7 +339,7 @@
               ],
               "program": "",
               "cwd": "^\"${2:\\${workspaceRoot\\}}\"",
-              "port": 9000,
+              "port": 9003,
               "serverReadyAction": {
                 "pattern": "Development Server \\\\(http://localhost:([0-9]+)\\\\) started",
                 "uriFormat": "http://localhost:%s",

src/phpDebug.ts

@@ -53,7 +53,7 @@ function formatPropertyValue(property: xdebug.BaseProperty): string {
 interface LaunchRequestArguments extends VSCodeDebugProtocol.LaunchRequestArguments {
     /** The address to bind to for listening for Xdebug connections (default: all IPv6 connections if available, else all IPv4 connections) */
     hostname?: string
-    /** The port where the adapter should listen for Xdebug connections (default: 9000) */
+    /** The port where the adapter should listen for Xdebug connections (default: 9003) */
     port?: number
     /** Automatically stop target after launch. If not specified, target does not stop. */
     stopOnEntry?: boolean
@@ -338,7 +338,7 @@ class PhpDebugSession extends vscode.DebugSession {
                     this.sendEvent(new vscode.OutputEvent(util.inspect(error) + '\n'))
                     this.sendErrorResponse(response, <Error>error)
                 })
-                server.listen(args.port || 9000, args.hostname, () => resolve())
+                server.listen(args.port || 9003, args.hostname, () => resolve())
             })
         try {
             if (!args.noDebug) {

testproject/.vscode/launch.json

@@ -6,7 +6,7 @@
       "name": "Listen for Xdebug",
       "type": "php",
       "request": "launch",
-      "port": 9000,
+      "port": 9003,
       "log": true
     },
     {
@@ -16,7 +16,7 @@
       "request": "launch",
       "program": "${file}",
       "cwd": "${fileDirname}",
-      "port": 9000
+      "port": 9003
     },
     {
       //"debugServer": 4711, // Uncomment for debugging the adapter
@@ -26,7 +26,7 @@
       "runtimeArgs": ["-dxdebug.mode=debug", "-dxdebug.start_with_request=yes", "-S", "localhost:0"],
       "program": "",
       "cwd": "${workspaceRoot}",
-      "port": 9000,
+      "port": 9003,
       "serverReadyAction": {
         "pattern": "Development Server \\(http://localhost:([0-9]+)\\) started",
         "uriFormat": "http://localhost:%s",