PHP xdebug (dbgp) proxy
This is expandable dbgp xdebug proxy based on amphp., (*1)
The idea is described in the document Multi-user debugging in PhpStorm with Xdebug and DBGp proxy., (*2)
The main benefit is that this proxy is written in php - the language you know., (*3)
, (*4)
Installation
This package can be installed as a Composer project:, (*5)
composer.phar create-project mougrim/php-xdebug-proxy
Or dependency:, (*6)
composer.phar require mougrim/php-xdebug-proxy --dev
For parse XML you should install ext-dom., (*7)
For write logs by default you should install amphp/log (use --dev if you installed php-xdebug-proxy as dependency):, (*8)
composer.phar require amphp/log '^1.0.0'
Run
You can run next command:, (*9)
bin/xdebug-proxy
The proxy will be run with default config:, (*10)
Using config path /path/to/php-xdebug-proxy/config
[2019-02-14 10:46:24] xdebug-proxy.NOTICE: Use default ide: 127.0.0.1:9000 array ( ) array ( )
[2019-02-14 10:46:24] xdebug-proxy.NOTICE: Use predefined ides array ( 'predefinedIdeList' => array ( 'idekey' => '127.0.0.1:9000', ), ) array ( )
[2019-02-14 10:46:24] xdebug-proxy.NOTICE: [Proxy][IdeRegistration] Listening for new connections on '127.0.0.1:9001'... array ( ) array ( )
[2019-02-14 10:46:24] xdebug-proxy.NOTICE: [Proxy][Xdebug] Listening for new connections on '127.0.0.1:9002'... array ( ) array ( )
So by default proxy listens 127.0.0.1:9001 for ide registration connections and 127.0.0.1:9002 for xdebug connections, use 127.0.0.1:9000 as default IDE and predefined IDE with key idekey., (*11)
Config
If you want to configure listening ports, etc., you can use custom config path. Just copy config directory to your custom path:, (*12)
cp -r /path/to/php-xdebug-proxy/config /your/custom/path
There are 3 files:, (*13)
-
config.php:
php
<?php
return [
'xdebugServer' => [
// xdebug proxy server host:port
'listen' => '127.0.0.1:9002',
],
'ideServer' => [
// if proxy can't find ide, then it uses default ide,
// pass empty string if you want to disable default ide
// defaultIde is useful when there is only one user for proxy
'defaultIde' => '127.0.0.1:9000',
// predefined ide list in format 'idekey' => 'host:port',
// pass empty array if you don't need predefined ide list
// predefinedIdeList is useful when proxy's users aren't changed often,
// so they don't need to register in proxy each proxy restart
'predefinedIdeList' => [
'idekey' => '127.0.0.1:9000',
],
],
'ideRegistrationServer' => [
// host:port for register ide in proxy
// pass empty string if you want to disable ide registration
'listen' => '127.0.0.1:9001',
],
];
-
logger.php: you can customize a logger, the file should return an object, which is instance of \Psr\Log\LoggerInterface;
-
factory.php: you can customize classes, which are used in proxy, file should return object, which is instanceof Factory\Factory.
Then change configs and run:, (*14)
bin/xdebug-proxy --configs=/your/custom/path/config
Extending
As mentioned above you can customize classes using your custom factory, which implements Factory\Factory. By default Factory\DefaultFactory factory is used., (*15)
The most powerful are the request preparers. You can override Factory\DefaultFactory::createRequestPreparers(). It should return an array of objects which implement RequestPreparer\RequestPreparer interface., (*16)
Request preparers will be called:
- on request to ide from first to last
- on request to xdebug from last to first, (*17)
You can use request preparer for example for changing path to files (in break points and execution files)., (*18)
Good example of the request preparer is RequestPreparer\SoftMocksRequestPreparer. You can see its usage in Factory\SoftMocksFactory., (*19)
Using with soft-mocks
For soft-mocks you can use softMocksConfig config directory:, (*20)
bin/xdebug-proxy --configs=/path/to/php-xdebug-proxy/softMocksConfig
If you you want to provide path to custom soft-mocks init script, then copy softMocksConfig and change config.php:, (*21)
...
'softMocks' => [
// if empty string, then vendor/badoo/soft-mocks/src/init_with_composer.php is used
'initScript' => '/your/custom/init-script.php',
],
...
For more information see doc in soft-mocks project., (*22)
Thanks
Many thanks to Eelf for proxy example smdbgpproxy., (*23)
Thanks to Dmitry Ananyev for help with docs., (*24)
Wallogit.com
Mougrim