Can I use xdebug with grpc rr?

[lanphan]

Hello,

I see that we have doc about enable XDebug for http plugin here: https://roadrunner.dev/docs/php-debugging

Is it possible to apply this to grpc plugin?

I tried but seems it doesn't work, here is my .rr.yaml:

version: '2.7'

rpc:
  listen: tcp://127.0.0.1:6001

status:
  address: 127.0.0.1:2114

server:
  command: "/usr/local/bin/php /source_code/worker.php"
  relay: "pipes"
  relay_timeout: "20s"
  env:
    XDEBUG_SESSION: 1

grpc:
  listen: "tcp://0.0.0.0:9001"
  proto: ${PROTO}

  max_send_msg_size: 50
  max_recv_msg_size: 50
  max_connection_idle: 0s
  max_connection_age: 0s
  max_connection_age_grace: 0s
  max_concurrent_streams: 10
  ping_time: 1s
  timeout: 200s

  pool:
    num_workers: ${NUM_WORKERS}
    max_jobs: ${MAX_JOBS}
    allocate_timeout: ${ALLOCATE_TIMEOUT}
    destroy_timeout: 60
    debug: true

logs:
  mode: development
  encoding: console
  level: debug
  output: stderr

metrics:
  address: 127.0.0.1:2112

My xdebug.ini:

zend_extension=xdebug

[xdebug]
xdebug.mode=develop,debug
xdebug.idekey=docker
xdebug.start_with_request=yes
xdebug.discover_client_host=1
xdebug.client_port = 9003
xdebug.start_with_request=yes
xdebug.log=/dev/stdout
xdebug.log_level=0
xdebug.connect_timeout_ms=2000

I use VSCode with PHP Debug extension, with debug launch config below:

{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Listen for Xdebug",
            "type": "php",
            "request": "launch",
            "port": 9000,
            "pathMappings": {
                "/source_code/": "${workspaceFolder}"
            },
            "ignore": [
                "**/vendor/**/*.php"
            ]
        }
    ]
}

( value of "port", I tried both 9000 and 9003, but both don't work)

My RR runs in docker container, with docker-compose.yaml below:

app:
      container_name: app
      image: php8-rr
      restart: always
      environment:
        - PROTO=/source_code/protos/app/services.proto
        - NUM_WORKERS=2
        - MAX_JOBS=5
        - ALLOCATE_TIMEOUT=60s
      command: ["sh", "/source_code/docker/run-rr2.sh"]
      volumes:
        - ../:/source_code
        - ./xdebug/xdebug.ini:/usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini
      ports:
        - "9001:9001"

[rustatian]

Hey @lanphan. HTTP plugin used as a sample, but it's should be possible with any plugin which uses workers. Try to use 1 worker instead of 2 and check the number of xdebug connections, which should be by the number of the workers.

[lanphan]

Hi @rustatian ,
How can I check the number of xdebug connection?

Another question is, which port should I set in vscode for debug launch, port 9000 (as in rr document) or port 9003 (default port of xdebug)?

[rustatian]

How can I check the number of xdebug connection?

I'm not a PHP programmer, sorry. I guess that should be an option somewhere.

Another question is, which port should I set in vscode for debug launch, port 9000 (as in rr document) or port 9003 (default port of xdebug)?

9003 or port on which your xdebug instance is running.

[lanphan]

Thank @rustatian ,

It works now :).

Updated my configuration:

• launch.json for vscode:

{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Listen for Xdebug",
            "type": "php",
            "request": "launch",
            "port": 9003,
            "hostname": "localhost",
            "pathMappings": {
                "/source_code/": "${workspaceFolder}"
            },
            "ignore": [
                "**/vendor/**/*.php"
            ]
        }
    ]
}

• xdebug.ini:

zend_extension=xdebug

[xdebug]
xdebug.mode=develop,debug
xdebug.idekey=docker
xdebug.start_with_request=yes
xdebug.client_host=host.docker.internal
xdebug.client_port=9003
xdebug.start_with_request=yes
xdebug.log=/dev/stdout
xdebug.log_level=0
xdebug.connect_timeout_ms=2000