XDEBUG 3 complains about xdebug.remote_autostart = 1 in /usr/local/etc/php/conf.d/xxx-lando-default.ini

[zuernBernhard]

When I run a current PHP Version in lando (eg 8.1) Xdebug (>=3) complains about config which is only compatible with XDEBUG2.

So every command which uses PHP like lando php -v results in a message like

$ lando php -v
Xdebug: [Config] The setting 'xdebug.remote_autostart' has been renamed, see the upgrading guide at https://xdebug.org/docs/upgrade_guide#changed-xdebug.remote_autostart (See: https://xdebug.org/docs/errors#CFG-C-CHANGED)
PHP 8.1.18 (cli) (built: May  3 2023 05:11:38) (NTS)
Copyright (c) The PHP Group
Zend Engine v4.1.18, Copyright (c) Zend Technologies
    with Zend OPcache v8.1.18, Copyright (c), by Zend Technologies
    with Xdebug v3.2.1, Copyright (c) 2002-2023, by Derick Rethans

[zuernBernhard]

Perhaps this solution is too simple ?

#93

[AaronFeledy]

Some older php versions supported by Lando still use Xdebug 2 for compatibility reasons. Currently, Lando shares this single config file across the two versions of Xdebug. Simply removing the older config will fix this warning, but will also break Xdebug in older PHP versions. This could be changed so that there are two possible config files and Lando could choose the correct one based on the version of PHP. An example of this type of behavior can be found in the Lando Drupal plugin where there is a separate config for MySQL 8.

I would suggest creating a new ini file containing just xdebug 2 config, then adding logic similar to Drupal's MySQL config selection to add it in when an older PHP version is used. https://github.com/lando/drupal/blob/eb8152876ff67d0f2760b44ce7f62438f454d719/builders/_drupaly.js#L99-L103

[maskedjellybean]

I've been trying to find a work around for this until it's resolved correctly within Lando. I want to automatically remove the xdebug.remote_autostart = 1 line from /usr/local/etc/php/conf.d/xxx-lando-default.ini

I can remove it by doing it manually:

$ lando ssh
$ echo "$( cat /usr/local/etc/php/conf.d/xxx-lando-default.ini | sed 's/xdebug.remote_autostart = 1//')"  >  /usr/local/etc/php/conf.d/xxx-lando-default.ini

Then I use nano (I've installed nano in my build steps so you probably don't have it) or vim to check the file and verify the line is removed. I no longer see the error when running lando php -v.

However I can't figure out how to automate this. When I add the command to services.appserver.build_as_root or services.appserver.run_as_root in .lando.yml, the file is not modified.

[maskedjellybean]

Ok, it seems that whatever we do to /usr/local/etc/php/conf.d/xxx-lando-default.ini during any build step is overwritten later.

So the only way I can find to automatically remove the xdebug.remote_autostart = 1 line is to do it just before the php command is run. Since I had already overridden lando php with a custom tooling command that lets me load a custom .ini for PHP CLI, this turned out to be somewhat easy.

.lando.yml

tooling:
  php:
    service: appserver
    description: Runs php commands
    cmd:
      - /app/lando/scripts/php.sh

./lando/scripts/php.sh

#!/usr/bin/env bash

# NOTE: This part is not necessary to fixing the xdebug.remote_autostart error. You can delete it if you're not going to use it.
# Run PHP CLI commands using settings in
# /lando/configs/php/php-cli/php.ini, but inheriting settings from /lando/configs/php/php.ini.
export PHP_INI_SCAN_DIR=:/app/lando/configs/php:/app/lando/configs/php/php-cli

# Remove outdated Xdebug 2 config from default Lando .ini file to avoid PHP CLI throwing
# "The setting 'xdebug.remote_autostart' has been renamed" error to PHP error log.
# See: https://github.com/lando/php/issues/92
if [ -e "/usr/local/etc/php/conf.d/xxx-lando-default.ini" ]; then
  echo "$( cat /usr/local/etc/php/conf.d/xxx-lando-default.ini | sed 's/xdebug.remote_autostart = 1//')"  >  /usr/local/etc/php/conf.d/xxx-lando-default.ini
fi

php "$@"

With this I no longer see the xdebug.remote_autostart error in my PHP error log when running lando php.

If you're using Drupal like me you're probably also using Drush. Drush will throw the same error. To avoid that you'll need to add this to the top of any script/file that runs a Drush command:

# Remove outdated Xdebug 2 config from default Lando .ini file to avoid Drush throwing
# "The setting 'xdebug.remote_autostart' has been renamed" error to PHP error log.
# See: https://github.com/lando/php/issues/92
if [ -e "/usr/local/etc/php/conf.d/xxx-lando-default.ini" ]; then
  echo "$( cat /usr/local/etc/php/conf.d/xxx-lando-default.ini | sed 's/xdebug.remote_autostart = 1//')"  >  /usr/local/etc/php/conf.d/xxx-lando-default.ini
fi

You might want to overwrite the default lando drush with a tooling command following the pattern I showed for overriding lando php. Doing this would resolve the xdebug.remote_autostart error thrown when running lando drush.

This is unrelated but I left the custom .ini bit in my php.sh example even in case anyone wants a separate .ini file for PHP CLI (which overrides the one you set in .lando.yml). You just need to create those .ini files. You can follow the same pattern to have a separate .ini for Drush.