1606762 - Set up xdebug

Status: RESOLVED FIXED

(Conduit :: Phabricator, enhancement, P2)

Description

[Mitchell Hentges [:mhentges] 🦀]

We should be able to use a debugger while working on Phabricator.

Steps:

1. Document that your IDE/debugger should be configured to listen on 9000, the XDebug default port
2. (dependent on 1606383) separate production and development Phabricator image build steps
3. In the development Phabricator image, install PHP XDebug
4. When docker-compose spools up, our containers run in a network like 172.[same number for all containers].0.[unique number per container. Importantly, 172.[number].0.1 refers to the host. In entrypoint.sh, calculate the host's ip in this virtual network, and add the following options to PHP for dev_start:

• -d xdebug.remote_host = 172.[number].0.1
• -d xdebug.remote_enable = 1

5. Document installing the XDebug helper for Firefox and how to use it
6. Test ^, I might've forgotten an XDebug feature

Comment 1

[Mitchell Hentges [:mhentges] 🦀]

This is especially valuable to me for two reasons:

1. I'm getting up-to-speed with Phabricator, and having the ability to step into data structures ergonomically is enormously helpful in spooling up
2. Being able to step through logic to find out why a bug is happening (so you can, y'know, de-bug your software 😛) can make the process much faster

Comment 2

[Mitchell Hentges [:mhentges] 🦀]

Ugh, manually specifying path mappings has to be done too, this should be documented as part of the patch as well

Comment 3

[Mitchell Hentges [:mhentges] 🦀]

Attachment: Bug 1606762 - support xdebug for phabricator

Targets development phabricator image which includes xdebug support

Comment 4

[Mitchell Hentges [:mhentges] 🦀]

Attachment: Bug 1606762 - Updates Dockerfile to support xdebug

Splits dockerfile into multi-stage-build so that we have a production and development target.
Installs xdebug in the development target.

Documents how to set up your IDE for xdebug

Depends on D57720

Comment 5

[Mitchell Hentges [:mhentges] 🦀]

Attachment: Bug 1606762 - Updates Dockerfile to support xdebug

Splits dockerfile into multi-stage-build so that we have a production and development target.
Installs xdebug in the development target.

Documents how to set up your IDE for xdebug

Depends on D57720

Comment 6

[Mitchell Hentges [:mhentges] 🦀]

Don't forget this patch

Comment 7

[Mitchell Hentges [:mhentges] 🦀]

Three things:

1. Initial xdebug support only worked for debugging webserver pages, but not the daemon. I added support for that, but:
2. The phabricator daemon runs a lot of processes. These would fill up all of PHPStorm's "max. simultaneous connections", making page loads hang. This is worked around by bumping the max connections (TODO: document and update my PR!) or by not running a debugger (so, non-debugger users won't be affected)
3. I still need to test attaching a debugger and catching a "moz-phab submit" operation, which will be awesome when it works

Comment 8

[Mitchell Hentges [:mhentges] 🦀]

Attachment: Bug 1606762 - Updates Dockerfile to support xdebug

Splits dockerfile into multi-stage-build so that we have a production and development target.
Installs xdebug in the development target.

Documents how to set up your IDE for xdebug

Comment 9

[Mitchell Hentges [:mhentges] 🦀]

This is ready for review now 👍