Debugging in Drupal 8

Drupal Summer Barcelona 2016

Juampy NR - @juampynr

Juampy NR - @juampynr

Senior Developer at Lullabot


  1. Intro: why a debugger?
  2. Navigating through code
  3. Scenario A: the visible bug
  4. Scenario B: the traitor
  5. Scenario C: The failing test
  6. Debugging scripts
  7. Other debugging tools

Why a debugger?

A typical IRC discussion

JoseCarlosss> buenas a todos, a que puede ser debido que ejecuto comando de drush y funciona perfectamente y si creo un script de drush cuando ejecuto dicho script me da permiso denegado al ejecutar un comando de drush dentro del script ?
JoseCarlosss> es decir, mismo comando en script me da permiso denegado y por consola me funciona
leandro> JoseCarlosss: comprueba la ruta desde la q ejecutas el script y, dentro de éste, si se posiciona correctamente en el directorio adecuado donde tengas instalado el Drupal
JoseCarlosss> ok, lo miro aunque creo que está correcto al 99% seguro
JoseCarlosss> gracias leandro
 nesimo ( has joined #drupal-es
e0ipso> plopesc te veré en la drupalcamp?
plopesc> yep e0ipso , llego el viernes a medio día
e0ipso> mola
e0ipso> igual que yo
JoseCarlosss> leandro,  comprobado y nada
juampynr> leandro, hola! vienes a la camp?
JoseCarlosss> no es tema de rutas
JoseCarlosss> juampynr, como andas maestro ya estás por granada?
juampynr> JoseCarlosss, cómo invocas el comando desde el script? qué comando es?
juampynr> JoseCarlosss, hola! no, salgo a las 3 hoy
JoseCarlosss> es un drush make

Hours later...

JoseCarlosss> lo curioso es que en dos ordenadores funciona y un tercero no..
JoseCarlosss> no se que habrá raro ..
juampynr> JoseCarlosss, qué error recibes?
JoseCarlosss> yo tiro pallá el viernes al final
JoseCarlosss> permiso denegado
leandro> juampynr: hola ^^ no, no creo que vaya. me vienen mal las fechas.
juampynr> si es un make, entonces se está descargando módulos, no? quizás los permisos de algunos de esos directorios estén mal
juampynr> prueba a ejecutar el omando con -v -d JoseCarlosss
juampynr> eso te va a dar más info
JoseCarlosss> lo curioso es que si hago el drush make en consola sin el script me rula
juampynr> qué pena leandro
juampynr> JoseCarlosss, qué tiene de especial el script?
juampynr> el usuario de consola es el mismo que el que ejecuta el script?
JoseCarlosss> si
JoseCarlosss> tiene que ser un tema relacionado con eso
JoseCarlosss> pero n olo veo
 gvso ( has joined #drupal-es
 ajmantis has quit (Remote host closed the connection)
juampynr> JoseCarlosss, cómo se llamaba el de la tele, del de AAAAA JUGAAAAAAAR
juampynr> recuerdas?
JoseCarlosss> joaquín prat no?

Why does this happen?

Because the Drupal 7's call stack is quite large. And it is even larger for Drupal 8.

A simple debugger

Scenario A: The visible bug


  1. Set a breakpoint at the failing line.
  2. Reproduce the error.
  3. Inspect current variables. Navigate the backtrace to understand what is going on.
  4. If needed, set a breakpoint at a higher level of the backtrace and then reproduce the error again.

Scenario B: The traitor

If you are lost, then dig, dig, dig!


  1. Start by exploring the codebase. Set a few breakpoints and see if you hit any of them.
  2. When you run out of ideas, go through the request. If you pass the bug, set a breakpoint and start over.
  3. Repeat until you nail down what is going on.

The trickier the bug, the deeper you will dig, so the more you will learn about Drupal's internals.

Scenario C: The failing test

Drupal 8 has the following types of tests:

  • JavaScript tests (extend from JavascriptTestBase)
  • Browswer tests (extend from BrowserTestBase)
  • Kernel tests (extend from KernelTestBase)
  • Unit tests (extend from UnitTestBase)

All of the above can be tested. We just need to make sure that:

  1. Xdebug is installed both in the web server and the command line.
  2. Our IDE is able to listen to several connections.

Example: debugging a JavaScript test

Debugging command-line scripts

Debugging a Drush command

Some tasks, such as route definition, happen when Drush rebuilds Drupal's data structures (drush cr). Therefore, we need to be able to listen to command line connections in order to debug this logic.

In the following clip we will debug the execution of drush cron.

Debugging a Console command

Same as we did with Drush commands, Console commands can be debugged too.

Other debugging tools


Thanks! Questions?