listen EADDRINUSE: address already in use :::9000

mloo

I'm remoted into a linux box using VS Code Unit Tests. Debugging is working elsewhere when I navigate web pages in the browser (using a port other than 9000), but when I click on a Unit Test's Bug Icon, I get a port conflict.

Listening to Xdebug on port 9000 failed: Error: listen EADDRINUSE: address already in use :::9000

A popup directs me to launch.json. I think 9000 isn't available on my server because of FPM and I'd like to switch to a different port like 9004. Despite what I try, the unit test bug icon button seems set on using port 9000. How can I switch the bug icon button to use a different port?

The JSON below shows some of my attempts.

        {
            "name": "Listen for Xdebug",
            "type": "php",
            "request": "launch",
            "port": [
                9004
            ],
            "env": {
                "XDEBUG_CONFIG": "remote_port=9004"
            }
        }

I also have a .user.ini file set to use port 9004 in the root directory of my project.
xdebug.client_port=9004

My php.ini is set like this.

; 2021-01-10
zend_extension=/usr/lib64/php/modules/xdebug.so
xdebug.mode=debug
xdebug.remote_host=127.0.0.1
xdebug.remote_port=9003

My php version looks like this:

PHP 7.3.20 (cli) (built: Jul  7 2020 07:53:49) ( NTS )
Copyright (c) 1997-2018 The PHP Group
Zend Engine v3.3.20, Copyright (c) 1998-2018 Zend Technologies
    with Xdebug v3.1.2, Copyright (c) 2002-2021, by Derick Rethans

Can the Unit Test Debug button be set to use a different port?

JakubMisek

Hi @mloo,

Thank you for the question.

It seems tests always use the port 9000.

We have fixed that, and since the next update, the tests debugger will respect the port setting "php.debug.port" (which tries to listen on both 9000 and 9003, and which can be changed in your settings).

I hope it helps,
Best,
Jakub

mloo

Hi JakubMisek ,

Thanks for the reply.

I saw in the change log that php.debug.port was added in version 1.6.8324

I see that I'm running version 1.6.8588

When I click the gear Icon to look at the settings for PHP Tools (@ext:DEVSENSE.phptools-vscode) I don't see php.debug.port in the list of options to configure.

I also tried manually appending the setting in settings.json like this...

"php.debug.port": 9004

But VSCode is greying out the setting with a tooltip message I'm not so sure is helpful in this case

This setting cannot be applied in this window. It will be applied when you open a local window.

Am I missing something?

mloo

PS. I also just tried rolling back to version 1.6.8324 and got the same result.

JakubMisek

@mloo - please see above - this will be fixed in the next update.

JakubMisek

we have just released the update - v1.7.8627 fixes the test debugger, it respects the "php.debug.port" setting now.

Thank you, and please let us know if it works for you!

phptools

How to get hold of v1.7.8627?
Mine seems stuck at v1.6.8448

JakubMisek

I guess it takes a few minutes for the update to appear ...
https://marketplace.visualstudio.com/items?itemName=DEVSENSE.phptools-vscode

mloo

I click the bug button and get the following...

The Blue "Listening to Xdebug on 9003" part wasn't there before. That part is different. The test is running now, but my breakpoints are not hit.

Also, as before, the GUI is not displaying the the php.debug.port setting and the settings.json doesn't seem to recognize the setting either.

So it appears that we are jumping from 9000 to 9003 and the test is running, but changing the port to something custom doesn't seem to be available yet in v1.7.8637
(also the breakpoints aren't hitting when it does run)

mloo

PS. I'm also noticing that Manually running the debugger. (not using the bug button) is allowing me to switch the port.
Once that is running, if I hit the bug button, I get...

And the break points are still not hit.

JakubMisek

Thanks @mloo - it seems the "php.debug.port" setting can be only configured in the user scope (File -> Preferences -> Settings) and not within the workspace. This is not correct, and we'll fix it in the next update, so the "php.debug.port" setting will be recognized.

9000 and 9003 are default values, and the debugger is trying both of them;

Once we'll fix the "php.debug.port" setting, the debugger will only attempt to use the 9004 port.

Workaround for now: move the "php.debug.port" setting to your global settings.

Thank you for letting us know!

mloo

I finally found the setting. Thanks for drawing my attention to it. In my case it's in my Remote machine settings.

In this scenario, I'm still not seeing it in the User or Workspace sections, but hopefully this will be the right place for my environment.

My server admin just did an upgrade so i have other xdebug things to configure, but I'll let you know how it goes when I can. Thanks!

mloo

I have manual breakpoints working on port 9004 using an FPM .user.ini file configured like this at the root of my website.

xdebug.client_port=9004

When I set my remote machine's settings.json to:

{
    "php.debug.port": [
        9004
      ]
}

I do see that it is noticed

However, my breakpoints are still not hit when clicking the bug button for port 9003 or 9004.

mloo

For what it's worth... I do have this configured in my bashrc file.
#Connect XDEBUG to VSCODE export XDEBUG_CONFIG="idekey=VSCODE"

JakubMisek

Just to confirm, do you have the Xdebug on your server configured to use the correct port?

The idekey is used for registering the debug session when using DBGpProxy (https://xdebug.org/docs/dbgpProxy). Otherwise (without DBGpProxy), the server always connects back to the specified port number.

If you are debugging on a server, you may need to provide "pathMappings" (to map server paths to your local paths): https://docs.devsense.com/en/vscode/debug/launch-json#listen-for-xdebug-locally-or-remote-debug

launch.json:

{
    "name": "Listen for Xdebug",
    "type": "php",
    "request": "launch",
    "port": 9004,
    "pathMappings": {
        "/var/www/html": "${workspaceRoot}",
    },
}

mloo

I'm overriding the 9003 port that the server is configured to use with 9004. (via settings.config, .user.ini, and launch.json)

To be clear:
Debugging and breakpoints work for me on a website when I click this button:

But they don't work for me when I run a NUnit Test Clicking this "bug" button:

The Bug button doesn't seem to use launch.json at all. If it did, I wonder what configuration it would choose. "Listen for Xdebug"?

mloo

@JakubMisek
My theory is that UNIT Tests need to send a trigger to initiate communication with xDebug the way the browser extensions do.

JakubMisek

I see, I think we've just found a bug;

The tests debugger does not use the correct port after all. We'll fix that.

Workaround for now is to set "php.debug.port": 9000.

mloo

Thanks. My port 9000 is not available because of FPM. When setting my port to 9000 anyways, the test debugger seems to be verifying this...

Looks like we know what is going on. I'll look forward to the fix. Thanks for all your help with this.

JakubMisek

Thank you, and thank you for all the information. It really helps us to find the culprit.
The fix is in progress.