Debug

[lgabeskiria]

Is it possible to debug language server with vscode?

[felixfbecker]

Sure! Have you tried it with https://github.com/felixfbecker/vscode-php-debug?

This launch.json config works to run PHPUnit tests:

    {
      "name": "PHPUnit",
      "type": "php",
      "request": "launch",
      "program": "${workspaceRoot}\\vendor\\phpunit\\phpunit\\phpunit",
      "args": ["--bootstrap", "vendor/autoload.php", "tests"],
      "cwd": "${workspaceRoot}"
    }

If you want to debug it in action, I recommend to open vscode-php-intellisense in a seperate window and symlink vendor/felixfbecker/language-server to the git clone of the language server. Then in the window with php-language-server, you can use the "Listen for XDebug" configuration and set breakpoints. Then launch the extension from the window with vscode-php-intellisense.

[lgabeskiria]

I repeated steps that you described but nothing happens.

{
   "name": "Listen for XDebug",
   "type": "php",
   "request": "launch",
   "port": 9000
}

[felixfbecker]

Running PHPUnit or debugging with vscode-php-intellisense? Did you install XDebug properly?

[lgabeskiria]

running debug, yes XDebug is properly installed. I'll double check and let you know.

[felixfbecker]

You might wanna look into the troubleshooting section of vscode-php-debug. In particular, enable xdebug.remote_log in your php.ini.

[felixfbecker]

Try to run the tests with some breakpoints and see if that works.

[felixfbecker]

Just tried it again and it works for me.
Creating the symlink:

felix@FELIX-PC ~\git\OpenSource\vscode-php-intellisense\vendor\felixfbecker [master ≡]
$ rm -re -fo .\language-server\

felix@FELIX-PC ~\git\OpenSource\vscode-php-intellisense\vendor\felixfbecker [master ≡]
$ New-Symlink language-server ~\git\OpenSource\php-language-server

Mode                LastWriteTime         Length Name
----                -------------         ------ ----
d----l       11.09.2016     20:30                language-server

launch.json in php-language-server:

{
      "name": "Listen for XDebug",
      "type": "php",
      "request": "launch"
}

And the included "Launch Extension" config from vscode-php-intellisense. Of course you then need to open a PHP project so the extension gets activated.

[lgabeskiria]

without port option?

[felixfbecker]

Port defaults to 9000.

[felixfbecker]

Can you debug PHPUnit at least?

[lgabeskiria]

when I launch extension development host and execute command to list symbols in document nothing happens, progress bar just runs.

[lgabeskiria]

I just removed all breakpoints and extension work again, but without debugging :(

[felixfbecker]

Can you run PHPUnit with the debugger?

[lgabeskiria]

I have finally launched debugging. I've just unchecked warnings and exceptions in breakpoints section of debugger.

[felixfbecker]

It is very hard for me to help you if you provide so little information... What did you finally launch (PHPUnit/intellisense)? Can you hit breakpoints?

[lgabeskiria]

Yes, I can hit breakpoints. PHPUnit, Debugger and intellisense work.

[felixfbecker]

So everything is working now? It is probably a good idea to add some guidance to the readme.

[lgabeskiria]

Yes everything works fine. I don't know why, but exceptions and warnings option in debugger were causing this behavior.

[felixfbecker]

That's not the way it should be... please open an issue at vscode-php-debug. Make sure to include what versions of PHP/XDebug you are running and the log from xdebug.remote_log :)

[lgabeskiria]

ok. thank's for help.

[bmax]

Hello @felixfbecker,

Trying to do the same thing as @lgabeskiria and use xdebug on the php-language-server.

I followed all your steps but am not ableto get the breakpoints to execute. the PHPUnit xdebug does work and when I use the Listen for XDebug and launch extension development host, I get this:

as you can see there is Request's coming through but they never change from Running and I can't get that breakpoint to execute on https://github.com/felixfbecker/php-language-server/blob/master/src/LanguageServer.php#L114

Any help would be appreciated thanks!!

[felixfbecker]

I am confused, are you saying PHPUnit works or does not work?

Try setting the environment variable COMPOSER_ALLOW_XDEBUG to 1

[bmax]

PHPUnit does work. I just added COMPOSER_ALLOW_XDEBUG as an env variable and it worked, interesting.

Thank you.

[felixfbecker]

Could you do a PR to add that to the README?

This is the reason why it's needed:

php-language-server/bin/php-language-server.php

Lines 34 to 35 in b03b9a2

	// If XDebug is enabled, restart without it
	(new XdebugHandler(Factory::createOutput()))->check();

[bmax]

Sure! I'll do that tomorrow. -- How come we need to restart when xdebug is enabled?

Thanks for the help.