Debugging in drupal 8

Debugging in Drupal 8
Life After DPM : Creating and Debugging a Module
Allie Jones

Review of Resources
Gitbook of Configuration Steps: https://www.gitbook.com/book/zivtech/debug-tools-for-drupal8/details
Github Repo of ZRMS and Module: https://github.com/AllieRays/debugging-drupal-8
Demo Site: http://zivte.ch/1Ss473k
Slide Deck: http://zivte.ch/1VxWF60
Zivtech Rocks My Socks
Demo Site
Bear Install Profile Drupal 8 Site

Plan Ahead:
Configuration to avoid frustration
Reduce technical debt
Why is this Important?
Stop ‘Googling’ all of your problems away
(If this blog post doesn’t solve my problem another one will)
● Fix problems & code faster
Stop thinking about debugging after the fact. You should be logically thinking through as you develop.

Overview
Debugging is a Personal Choice. Pick Your Tools.
Drupal Console IDE Xdebug
Continuous
Integration

Zivtech Rocks My Socks ( demo site http://zivte.ch/1Ss47k )

But First, Basic Configuration

Easy / Low Hanging Configuration Options
PHP.ini
Set Error Reporting to Strict: error_reporting = E_ALL & ~E_DEPRECATED & ~E_STRICT
Display Errors as Html: display_errors = On
Log your errors to a php_error file: log_errors = On || log_errors_max_len = 1024

Configuration Settings: Use your setting.local.php.
In setting.php add an include
if (file_exists(__DIR__ . '/settings.local.php')) {
include __DIR__ . '/settings.local.php';
}
setting.local.php
Show all error messages, with backtrace information.
$config['system.logging']['error_level'] = 'verbose';
Disable CSS and JS aggregation.
$config['system.performance']['css']['preprocess'] = FALSE;
$config['system.performance']['js']['preprocess'] = FALSE;

Documentation: https://api.drupal.org/api/drupal/8
Community: StackOverflow, Drupal.StackExchange & Drupal IRC
Change Records: https://www.drupal.org/list-changes/drupal

Change Records:
https://www.drupal.org/list-changes/drupal

Drupal Print Message
The Devel Module provides helper functions to print variables in the browser.
function dpm($input, $name = NULL, $type = 'status') {
if (Drupal::currentUser()->hasPermission('access devel information')) {
$export = kprint_r($input, TRUE, $name);
drupal_set_message($export, $type, TRUE);
}
return $input;
}
What is DPM anyways?

Caching
From the Terminal:
● Drush: drush cr (new as of D8)
● Drupal Console: drupal cache:rebuild
Everyone’s favorite love / hate relationship
From the Browser:
● Admin Ui: /admin/config/development/performance
● Chrome Settings: Disable cache

But Seriously,
Did You
Clear Your Cache?

"Log. (Huh) What is it good for. Absolutely ..."
Debugging
/admin/reports/dblog

Devel Module
Drupal 7 Drupal 8

Devel Submodule: Kint
prettify all the things
“It's var_dump() and
debug_backtrace() on steroids”
print data in a human readable way
backtracing

Devel Submodule: Web Profiler
/admin/config/development/devel/webprofiler
Based on Symfony’s toolbar
Summary toolbar
Resources admin page
Review resource utilization
Cache effectiveness
Database queries
Views

Drupal Console
Built on the Symfony console library
Debug Your Code
drupal routes:debug
drupal router:debug [internal route name]
Clear Cache
drupal router:rebuild
Generate Code
drupal generate:module
drupal generate:controller
drupal generate:entity:config
drupal generate:form

Zivtech Rocks My Socks (demo site)

Module & Basic Controller:
drupal generate:module
generate:controller

Config Entity : drupal generate:entity:config

PHPStorm
PHP IDE Integrated Development Environment by Jetbrains
Code hinting
Auto completion
Breakpoints
Built in Drupal settings support

Controller Goal: Display a basic page
namespace DrupalsocksController;
use DrupalCoreControllerControllerBase;
class SockController extends ControllerBase {
public function content() {
$sockContent = Drupal::service('socks.sock_content');
$somethings = $sockContent->displaySomethings();
return [
'#type' => 'markup',
'#markup' => t($somethings)
];
}
}
socks.sock_controller_content:
path: 'socks'
defaults:
_controller: 'DrupalsocksControllerSockController::content'
_title: 'All the Socks'
requirements:
_permission: 'access content'
socks/src/Controller/SockController.php socks/socks.routing.yml

Controller
namespace DrupalsocksController;
class SockController extends ControllerBase {
public function content() {
$sockContent = Drupal::service('socks.sock_content');
$somethings = $sockContent->displaySomethings();
return [
'#type' => 'markup',
'#markup' => t($somethings)
];
}
}
Problem Solution

Problem: Accessing
Private and
Protected Methods

Goal: Create a configurable entity type of Sock
namespace DrupalsocksEntity;
use DrupalCoreConfigEntityConfigEntityBase;
class Sock extends ConfigEntityBase {
public $id;
public $uuid;
public $label;
public $description;
public $fabric;
public $rating;
}
socks/Entity/Sock.php
class SockListBuilder extends ConfigEntityListBuilder {
public function buildRow(EntityInterface $entity) {
$row['id'] = $entity->id();
$row['description'] = $entity->description;
$row['fabric'] = $entity->fabric;
$row['rating'] = $entity->rating;
return $row + parent::buildRow($entity);
}
}
socks/src/Controller/SockListBuilder.php
Config Entity

class Sock extends ConfigEntityBase {
/**
* The sock's rating.
* @var string
*/
protected $rating;
}
$row['rating'] = $entity->rating;
}
PROBLEM
Config Entity

SOLUTION
protected $rating;
/**
* @return string
*/
public function getRating() {
return $this->rating;
}
/**
* @param string $rating
*/
public function setRating($rating) {
$this->rating = $rating;
}
$row['rating'] = $entity->getRating();
}
Sock Entity
Sock List Builder
Accessing a protected property by creating methods

Xdebug
Allows script execution to be paused at any point to read through variables
Support stack and execution traces in error messages
Profiling to find performance bottlenecks
https://zivtech.gitbooks.io/zrms/content/xdebug.html admin/reports/status/php

public function submitForm(array &$form, FormStateInterface $form_state) {
$result = $form_state->getValue('fav_sock');
drupal_set_message($this->t('Your favorite sock is @fav_sock',
array('@fav_sock' => $result)));
if ($result == 'Ankle Biters') {
$form_state->setRedirect('socks.knee_highs_controller_content');
}
else {
if ($result == 'Old Fashions') {
$form_state->setRedirect('socks.old_fashions_controller_content');
}
else {
}
}
}
Form Goal: Let users pick their favorite sock
class FavoriteSockForm extends FormBase {
public function getFormId() {
return 'favorite_sock_form';
}
public function buildForm(array $form,
FormStateInterface $form_state) {
$form['fav_sock'] = array(
'#type' => 'radios',
'#options' => array(
'Ankle Biters' => $this->t('Ankle Biters'),
'Old Fashions' => $this->t('Old Fashions'),
'Knee Highs' => $this->t('Knee Highs')
),
);
$form['submit'] = array(
'#type' => 'submit',
'#value' => t('Submit'),
);
return $form;
}
socks/src/Form/FavoriteSockForm.php

Form
class FavoriteSockForm extends FormBase {
public function getFormId() {
return 'favorite_sock_form';
}
public function buildForm(array $form,
FormStateInterface $form_state) {
$form['fav_sock'] = array(
'#type' => 'radios',
'#options' => array(
'Ankle Biters' => $this->t('Ankle Biters'),
'Old Fashions' => $this->t('Old Fashions'),
'Knee Highs' => $this->t('Knee Highs')
),
);
$form['submit'] = array(
'#type' => 'submit',
'#value' => t('Submit'),
);
return $form;
}
public function submitForm(array &$form, FormStateInterface $form_state) {
$result = $form_state['values']['fav_sock'];
drupal_set_message($this->t('Your favorite sock is @fav_sock',
array('@fav_sock' => $result)));
if ($result == 'Ankle Biters') {
}
else {
if ($result == 'Old Fashions') {
$form_state->setRedirect('socks.old_fashions_controller_content');
}
else {
}
}
}
socks/src/Form/FavoriteSockForm.php

Xdebug
$form_state->getValue is an object,
but the code is trying to access it as if it were an array.
Change $form_state['values']['fav_sock'] to $form_state->getValue('fav_sock')

Debugging and QA does not stop at code
completion.

Problem:
Shared Staging Environment
Client Approval Process

Probo CI
Probo CI creates test environments for each new feature
Visual representation of the project
while development is in progress
with Pull Request builds
Code more confidently &
Speed up approval process
Continuous integration

Probo CI
assets:
- dev.sql.gz
steps:
- name: Example site setup
plugin: Drupal
database: dev.sql.gz
databaseGzipped: true
databaseUpdates: true
revertFeatures: true
clearCaches: true
SOLUTION
https://github.com/AllieRays/debugging-drupal-8/blob/probos/.probo.yaml

Problem:
Cherry Picked
Deployments

Pull Requests with Probo CI
SOLUTION
https://github.com/AllieRays/debugging-drupal-8/pull/1
https://9365d60b-17fa-4834-bb2b-3bba252a14c6.probo.build/ || zivte.ch/1Ss473k

Gitbook of Configuration Steps: https://www.gitbook.com/book/zivtech/debug-tools-for-drupal8/details
Github Repo of ZRMS and Module: https://github.com/AllieRays/debugging-drupal-8
Demo Site: http://zivte.ch/1Ss473k
Slide Deck: http://zivte.ch/1VxWF60
Step 1: Logically think through as you develop.
Step 2: Identify the goal/objective of your code.
Step 3: Identify problem and use appropriate tools to solve your problem.
Step 4: Fix and Test.
Step 5: Test Again.
Step 6: Success!
Review

Gitbook of Configuration Steps:
https://www.gitbook.com/book/zivte
ch/debug-tools-for-drupal8/details

Debugging in drupal 8

More Related Content

What's hot (20)

Similar to Debugging in drupal 8 (20)

Recently uploaded (20)

Debugging in drupal 8

Editor's Notes