Appendix:

Adding php xdebug

A number of things were done to make the local Lando deployment of your ‘develop’ container more appropriate for the development work you expect to do for a CI/CD workflow to better your site over time. These were things like turning off annoying cache disruptions, halting js & css aggregation, stopping the site hardening you definitely want in production but not while you are trying to work on changes, etc. These types of changes to your ‘develop’ environment make your site building efforts easier. This would include configuration work, twig_debugging and other front-end type work on js & css theme efforts that will get most people the vast majority of what they need to be productive. However, we probably shouldn’t be putting on a “developer” hat that some of the more hardcore Drupal experts will bring. They may be working on their own modules or at least patches to modules or tweaking modules to their own unique needs as a code level; not for sissies stuff. To do that kind for work, one more step might logically be taken and that is to turn on php xdebug in the ‘develop’ environment.

As good as that sounds, there is a reason that it isn’t simply on all the time and that is it can slow things to a drag. Therefore, we really would like to have it sit in the ready but turn it on and off on an as needed basis while working. Being able to use lando xdebug-on to enable Xdebug and lando xdebug-off to disable Xdebug is the aim. Adding the following to your .lando.yml file should do that:

name: example-xdebug
recipe: drupal9

config:
webroot: .
# Xdebug is off by default. We use the tooling below to turn it on as needed.
xdebug: false

services:
appserver:
overrides:
environment:
XDEBUG_MODE: 'debug'

tooling:
xdebug-on:
service: appserver
description: Enable Xdebug.
user: root
cmd:
- docker-php-ext-enable xdebug && kill -USR2 $(pgrep -o php-fpm) || /etc/init.d/apache2 reload
- tput setaf 2 && echo "Xdebug On" && tput sgr 0 && echo

xdebug-off:
service: appserver
description: Disable Xdebug.
user: root
cmd:
- rm /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini && kill -USR2 $(pgrep -o php-fpm) || /etc/init.d/apache2 reload
- tput setaf 1 && echo "Xdebug Off" && tput sgr 0 && echo

You can also make a ‘json’ file that will allow triggering with VSCode.

You also want to make sure your browser has its xdebug extention.