Planète

Pourquoi il est important de passer de Drupal 7 a Drupal 8 pour être pret à passer à Drupal 9.

En septembre 2018, à l'occasion du Drupal Europe, Dries Buytaert, le fondateur de Drupal à annoncé la fin de vie de Drupal 7 et de Drupal 8 pour novembre 2021.

Quand Drupal 9 sort-il ?

Drupal 9 est prévu dans sa version stable pour juin 2020.

Qu'est-ce qu'une fin de vie pour une version de logiciel ?

La fin de vie signifie que le logiciel, dans cette version majeure n'aura plus aucune correction de sécurité. Si des failles de sécurités sont découvertes et publiées, elles pourront être exploitées car la communauté ne fournira plus de mise à jour de ces versions.

Comment faire pour éviter cela ?

Le plus simple est de continuer à maintenir son site à jour et de le faire monter en versions.

Pourquoi la fin de 2 versions, dont la dernière actuelle ?

Tout d'abord, la version 7 aurait dû se terminer à la sortie de Drupal 9.

Devant le nombre important d'utilisation de cette version et la complexité à faire migrer les sites existant vers une version 8, la durée de support de sécurité pour la version 7 a été allongée pour suivre la même date de fin de vie que la version 8. Cela permet ainsi d'avoir plus de temps pour penser à une refonte et prévoir le budget et les ressources adéquates.

Drupal 7 disposera d'un programme de support commercial longue durée. Moyennant finance, il sera possible de se prémunir des futures failles de sécurités trouvées dans le core de Drupal, et ce même après sa fin de vie. Toutefois, cela ne s'applique qu'au core, les modules "contrib" de la communauté et votre code spécifique ce sera pas supporté.
Il faut également prendre en compte que plus le temps passera, et moins de sociétés seront enclines à faire de la maintenance ou des corrections sur une version qui n'est plus supportée.

Ok pour Drupal 7, mais pourquoi Drupal 8 également ?

La raison est purement technique. La grande nouveauté de Drupal 8 était son utilisation des composants de Symfony 3.x. Or Symfony 3 ne sera plus supporté à partir de novembre 2021. A cette date, il sera déconseillé d'utiliser la version 3 de Symfony, et donc d'utiliser tout Drupal utilisant cette version, au risque d'être piraté.

Quand on travaille à plusieurs sur un projet, il peut être intéressant de mettre en place des outils de qualité de code afin d’harmoniser le code source que vous souhaitez mettre en place sur votre projet (linter, CodeSniffer et tests) mais pour cela, il faudra alors s'assurer que tous les collaborateurs les utilisent afin d'en tirer réellement partie et c'est là que GrumPHP rentre en jeux.

Une vue Drupal 8 prête à importer pour obtenir une page de l'ensemble des statistiques collectées par le module Statistics.

Configuration minimum pour lancer phpunit avec Drupal Fabien CLÉMENT
dim 11/08/2019 - 09:44

A l'heure de la virtualisation et de la containerisation, on n'a pas forcément tout un environnement lamp/wamp/mamp d'installé sur son local.

Sous Drupal 8.x, Si l'on souhaite lancer des test phpunit, nous n'avons besoin que de 3 applications :

PHP
SQLITE
Composer

Suivant votre OS, vous pouvez installer les 2 premiers :

Windows : avec leurs binaires
Linux : via les dépots
OSX : via homebrew

Pour composer, suivre les instructions sur https://getcomposer.org/download/.

Habituellement, nous aurions également besoin d'un serveur apache ou nginx pour pouvoir accéder à notre application, mais depuis la version 8.4.x, Drupal embarque ce qu'il faut pour lancer un serveur depuis php.

Lancer la commande :

php -S localhost:8888 .ht.router.php

Il ne reste plus qu'à configurer phpunit en copiant le fichier phpunit.xml.dist en phpunit.xml :

cp core/phpunit.xml.dist core/phpunit.xml

Créer le répertoire sites/default/simpletest et ajuster la configuration suivant vos besoins. Exemple :

Faire un composer install pour installer les dépendances de Drupal et obtenir phpunit.

Il ne reste plus qu'à lancer phpunit en ligne de commande ou depuis phpstorm.

Pour configurer phpstorm, aller dans le menu PHPStorm > Preferences, chercher PHP.

Ajouter votre binaire PHP puis chercher phpunit et dans Test Frameworks, configurer phpunit.

Sur une commande expresse de Vincent, voici comment modifier les formulaires de création / modification de nœud pour être redirigé sur la page de listing des nœuds plutôt que sur le nœud en lui même lors de la création ou de la modification d'un contenu.

1 - Altération du type d'entité

# mon_module.module
function mon_module_entity_type_alter(array &$entity_types) {
  $entity_types['node']->setFormClass('default', Drupal\mon_module\Entity\Form\CustomNodeForm::class);
  $entity_types['node']->setFormClass('edit', Drupal\mon_module\Entity\Form\CustomNodeForm::class);
}

2 - Classe du formulaire

# web/modules/mon_module/src/Entity/Form/CustomNodeForm.php
 
namespace Drupal\mon_module\Entity\Form;
 
use Drupal\Core\Form\FormStateInterface;
use Drupal\node\NodeForm;
 
class CustomNodeForm extends NodeForm {
 
  public function save(array $form, FormStateInterface $form_state) {
    parent::save($form, $form_state);
    $form_state->setRedirect('view.content.page_1');
  }
 
}

Chez l'Équipe.tech, nous avons toujours travaillé sous OSX avec des Macbook Pro. Pendant de nombreuses années nous en étions très content. Plus simple pour le web que sous Microsoft Windows qui n'est pas adapté pour du développement PHP, plus propre et clé en main que Linux, et finition impeccable.

La majorité de notre expérience sur cet environnement s'est fait avant l'avènement de Docker, et surtout avant que les machines d'Apple ne soient compatibles avec Docker, quand ils n'utilisaient pas encore de processeurs Intel.

Lorsque nos machines (et leur processeurs) nous l'ont permis, nous nous sommes alors mis à Docker et ses promesses. Exit les Vagrant, Virtualbox, LXC et compagnie. Et là c'est la douche froide.

Il fallait auparavant utiliser boot2docker (souvenir douloureux), ça avait le mérite de fonctionner, mais on s'arrêtait là. Manque de stabilité, perfs désastreuses.

Puis est arrivé Docker Desktop (for mac). Côté perfs, ce n'est toujours pas ça mais on a gagné en stabilité.

Pourquoi mon application PHP (Symfony, Drupal etc) avec Docker sous OSX est si lente ?

Le gros problème sous OSX avec docker, c'est la façon dont est gérée l'écriture disque et la synchronisation entre les données du container et le système hôte (osx).

Partant de ce constat, Eugen Meyer a créé Docker Sync.

Docker sync

Cet outil promet d'améliorer drastiquement les performances de votre application sous Docker. Une fois que tout est en place, c'est vrai que cela fonctionne comme convenu. C'est bien plus rapide. Mais il y a un mais !

Pour gagner en rapidité, il faut laisser docker sync... synchroniser. Et là c'est le drame. Le processeur en prend pour son grade. C'est violent, ça chauffe, pour peu que beaucoup de fichiers soient modifiés (c'est quand même le but), il faut attendre un certain temps que ça se mette à jour. Et comme il est gourmand, c'est a son tour de dégrader les performances d'osx cette fois.

Docker sync doit forcément être lancé avant vos containers et pour peu que d'autres personnes de l'équipe ne soit pas sous osx, il nous faut une configuration différente pour gérer docker sync sur notre projet. On est loin de la promesse de plateforme d'environnement uniformisée...

Enfin, dans le cas où on passe d'un projet à l'autre, il faut veiller a bien configurer le docker sync pour ne pas se marcher dessus entre les différents projets et surtout si vous avez besoin de reconstruire entièrement le projet, il faut alors vider docker sync et recommencer l'indexation (prenez un café, allez faire un tour, ou montrez-vous patient).

La solution : Les volumes

Docker sync a donc rapidement été abandonné. Une solution à base de VM virtualbox sous linux pour gérer notre docker à été testée. Les perfs étaient bien meilleures mais devoir lancer une machine virtuelle pour lancer un docker, c'est loin d'être optimal et ça risque vite de déraper en inception... Sans parler qu'avec Virtualbox, on a tendance à se prendre un beau BSOD sans prévenir...

Le top du top : jouer avec les volumes.

Au risque de se répéter, le problème c'est la synchronisation des fichiers entre le container et osx. Il est vrai que c'est bien plus simple de faire un gros volume et de synchroniser tous les fichiers, sauf que c'est là où docker et osx ne sont pas contents.

On utilise donc deux choses :

On segmente notre projet en différents volumes. On écarte ce qui est du code custom que l'on a besoin de modifier : notre code; de ce qui ne nous appartient pas et ne doit de toute façon pas être modifié : les vendors par exemple.
On utilise les options de montage de docker : cached, delegated, ro, rw.

Concernant le premier point, si vous faites du Symfony (ou du Drupal ou tout autre solution opensource), une partie du code de votre projet est issue de la communauté. Celui-ci bouge rarement, et s'il bouge, vous pouvez vous permettre d'avoir un temps de latence un peu plus important pour que votre container se mette a jour (on ne parle que d'une poignée de secondes). Toute ce code peut donc être monté dans un volume avec l'option cached voir mieux : delegated.

Pour votre code custom qui ne doit plus représenter grand chose par rapport au volume total du projet, vous pouvez alors le monter avec l'option cached.

Rien qu'avec cette configuration, vous allez remarquer une belle amélioration. Il est important de se rappeler que si des fichiers sont beaucoup modifiés mais ne sont pas du fait de votre développement, ils ne doivent pas être synchronisés directement sur votre hôte osx.

Les fichiers de cache / les fichiers "volatiles"

Que l'on soit sous Drupal ou Symfony, des fichiers de cache sont générés, ou des fichiers "données" son uploadés. Ces fichiers ne sont pas liés au développement de votre application et, sauf exception pour les fichiers uploadés suivant les cas, peuvent être perdus à tout moment sans impacter votre application. Inutile donc de s'embêter à les synchroniser, autant les laisser dans un volume de container interne à Docker.

Pas de synchronisation, utiliser le mécanisme interne de volumes de Docker

Même sous OSX, les volumes de Docker qui ne sont pas montés sur l'hôte n'ont pas ce problème de performances. Donc le mieux est de ne monter QUE ce qui vous est réellement nécessaire pour vos développements. Dans la partie précédente, nous avons parlé des fichiers générés. Ces fichiers n'ont aucune besoin d'être montés et sont générés en masse, donc autant les placer dans un volume non monté.

Le top du top serait de ne conserver que vos fichiers custom dans des volumes montés. Si vous n'avez pas besoin du code communautaire, inutile de vous embêter à le monter. Vous verrez la différence de performances.

L'exemple

Voici un fichier docker-compose.yml d'exemple commenté pour illustrer cet article dans le cas d'une configuration Drupal (issu de notre stack docker drupal) :

version: "3"

services:
php:
container_name: ${COMPOSE_PROJECT_NAME}_php
volumes:
# La partie web contient l'ensemble du code drupal de notre application. Il n'est pas utile
# de le synchroniser à la seconde car il n'y aura des modifications qu'à la mise à jour mais
# ces fichiers représentent un gros volume.
- ../../web:/var/www/html/web:rw,delegated
# Les paquets vendors n'ont pas besoin d'être synchronisé à la seconde car peu modifiés
# mais ils représentent un gros volume.
- ../../vendor:/var/www/html/vendor:rw,delegated
# On y stocke la configuration sous forme de fichiers. Beaucoup de fichiers générés que l'on
# souhaite versionner mais pas de nécessité de synchronisation immédiate.
- ../../config:/var/www/html/config:rw,delegated
# On monte ces fichiers par commodité pour pouvoir les modifier simplement et que leur modification
# soit prise en compte sans devoir copier un fichier ou relancer un container.
- ../conf/settings.php:/var/www/html/web/sites/default/settings.php:rw,delegated
- ../conf/settings.local.php:/var/www/html/web/sites/default/settings.local.php:rw,delegated
- ../conf/development.services.yml:/var/www/html/web/sites/development.services.yml:rw,delegated
- ../../composer.json:/var/www/html/composer.json:rw,delegated
- ../../composer.lock:/var/www/html/composer.lock:rw,delegated
- ./php/docker-php-upload.ini:/usr/local/etc/php/conf.d/docker-php-upload.ini
# Seuls ces trois répertoires représentent notre code custom et demandent plus de réactivité.
- ../../web/profiles/custom:/var/www/html/web/profiles/custom:rw,cached
- ../../web/modules/custom:/var/www/html/web/modules/custom:rw,cached
- ../../web/themes/custom:/var/www/html/web/themes/custom:rw,cached
# On ne synchronise pas les fichiers de cache et fichiers uploadés.
- drupal-files:/var/www/html/web/sites/default/files
depends_on:
- mysql

apache:
container_name: ${COMPOSE_PROJECT_NAME}_apache
volumes:
# Apache n'est pas censé écrire dans ce répertoire, on peut donc le passer en lecture seule.
- ../../:/var/www/html:ro,delegated
# On partage les fichiers avec le volume de fichier.
- drupal-files:/var/www/html/web/sites/default/files
depends_on:
- php

mysql:
container_name: ${COMPOSE_PROJECT_NAME}_mysql
build:
context: ./mysql
# # On ne monte surtout pas les volumes MYSQL pour des raisons de performances évidentes.
# volumes:
# - ./data/mysql:/var/lib/mysql:rw
# - ./entrypoint:/docker-entrypoint-initdb.d

volumes:
# Ce volume n'étant pas monté avec osx, il ne dégrade pas ses performances.
drupal-files:

Chez l'Équipe.tech, nous avons toujours travaillé sous OSX avec des Macbook Pro. Pendant de nombreuses années nous en étions très content. Plus simple pour le web que sous Microsoft Windows qui n'est pas adapté pour du développement PHP, plus propre et clé en main que Linux, et finition impeccable.

La majorité de notre expérience sur cet environnement s'est fait avant l'avènement de Docker, et surtout avant que les machines d'Apple ne soient compatibles avec Docker, quand ils n'utilisaient pas encore de processeurs Intel.

Lorsque nos machines (et leur processeurs) nous l'ont permis, nous nous sommes alors mis à Docker et ses promesses. Exit les Vagrant, Virtualbox, LXC et compagnie. Et là c'est la douche froide.

Il fallait auparavant utiliser boot2docker (souvenir douloureux), ça avait le mérite de fonctionner, mais on s'arrêtait là. Manque de stabilité, perfs désastreuses.

Puis est arrivé Docker Desktop (for mac). Côté perfs, ce n'est toujours pas ça mais on a gagné en stabilité.

Pourquoi mon application PHP (Symfony, Drupal etc) avec Docker sous OSX est si lente ?

Le gros problème sous OSX avec docker, c'est la façon dont est gérée l'écriture disque et la synchronisation entre les données du container et le système hôte (osx).

Partant de ce constat, Eugen Meyer a créé Docker Sync.

Docker sync

Cet outil promet d'améliorer drastiquement les performances de votre application sous Docker. Une fois que tout est en place, c'est vrai que cela fonctionne comme convenu. C'est bien plus rapide. Mais il y a un mais !

Pour gagner en rapidité, il faut laisser docker sync... synchroniser. Et là c'est le drame. Le processeur en prend pour son grade. C'est violent, ça chauffe, pour peu que beaucoup de fichiers soient modifiés (c'est quand même le but), il faut attendre un certain temps que ça se mette à jour. Et comme il est gourmand, c'est a son tour de dégrader les performances d'osx cette fois.

Docker sync doit forcément être lancé avant vos containers et pour peu que d'autres personnes de l'équipe ne soit pas sous osx, il nous faut une configuration différente pour gérer docker sync sur notre projet. On est loin de la promesse de plateforme d'environnement uniformisée...

Enfin, dans le cas où on passe d'un projet à l'autre, il faut veiller a bien configurer le docker sync pour ne pas se marcher dessus entre les différents projets et surtout si vous avez besoin de reconstruire entièrement le projet, il faut alors vider docker sync et recommencer l'indexation (prenez un café, allez faire un tour, ou montrez-vous patient).

La solution : Les volumes

Docker sync a donc rapidement été abandonné. Une solution à base de VM virtualbox sous linux pour gérer notre docker à été testée. Les perfs étaient bien meilleures mais devoir lancer une machine virtuelle pour lancer un docker, c'est loin d'être optimal et ça risque vite de déraper en inception... Sans parler qu'avec Virtualbox, on a tendance à se prendre un beau BSOD sans prévenir...

Le top du top : jouer avec les volumes.

Au risque de se répéter, le problème c'est la synchronisation des fichiers entre le container et osx. Il est vrai que c'est bien plus simple de faire un gros volume et de synchroniser tous les fichiers, sauf que c'est là où docker et osx ne sont pas contents.

On utilise donc deux choses :

On segmente notre projet en différents volumes. On écarte ce qui est du code custom que l'on a besoin de modifier : notre code; de ce qui ne nous appartient pas et ne doit de toute façon pas être modifié : les vendors par exemple.
On utilise les options de montage de docker : cached, delegated, ro, rw.

Concernant le premier point, si vous faites du Symfony (ou du Drupal ou tout autre solution opensource), une partie du code de votre projet est issue de la communauté. Celui-ci bouge rarement, et s'il bouge, vous pouvez vous permettre d'avoir un temps de latence un peu plus important pour que votre container se mette a jour (on ne parle que d'une poignée de secondes). Toute ce code peut donc être monté dans un volume avec l'option cached voir mieux : delegated.

Pour votre code custom qui ne doit plus représenter grand chose par rapport au volume total du projet, vous pouvez alors le monter avec l'option cached.

Rien qu'avec cette configuration, vous allez remarquer une belle amélioration. Il est important de se rappeler que si des fichiers sont beaucoup modifiés mais ne sont pas du fait de votre développement, ils ne doivent pas être synchronisés directement sur votre hôte osx.

Les fichiers de cache / les fichiers "volatiles"

Que l'on soit sous Drupal ou Symfony, des fichiers de cache sont générés, ou des fichiers "données" son uploadés. Ces fichiers ne sont pas liés au développement de votre application et, sauf exception pour les fichiers uploadés suivant les cas, peuvent être perdus à tout moment sans impacter votre application. Inutile donc de s'embêter à les synchroniser, autant les laisser dans un volume de container interne à Docker.

Pas de synchronisation, utiliser le mécanisme interne de volumes de Docker

Même sous OSX, les volumes de Docker qui ne sont pas montés sur l'hôte n'ont pas ce problème de performances. Donc le mieux est de ne monter QUE ce qui vous est réellement nécessaire pour vos développements. Dans la partie précédente, nous avons parlé des fichiers générés. Ces fichiers n'ont aucune besoin d'être montés et sont générés en masse, donc autant les placer dans un volume non monté.

Le top du top serait de ne conserver que vos fichiers custom dans des volumes montés. Si vous n'avez pas besoin du code communautaire, inutile de vous embêter à le monter. Vous verrez la différence de performances.

L'exemple

Voici un fichier docker-compose.yml d'exemple commenté pour illustrer cet article dans le cas d'une configuration Drupal (issu de notre stack docker drupal) :

version: "3"

services:
php:
container_name: ${COMPOSE_PROJECT_NAME}_php
volumes:
# La partie web contient l'ensemble du code drupal de notre application. Il n'est pas utile
# de le synchroniser à la seconde car il n'y aura des modifications qu'à la mise à jour mais
# ces fichiers représentent un gros volume.
- ../../web:/var/www/html/web:rw,delegated
# Les paquets vendors n'ont pas besoin d'être synchronisé à la seconde car peu modifiés
# mais ils représentent un gros volume.
- ../../vendor:/var/www/html/vendor:rw,delegated
# On y stocke la configuration sous forme de fichiers. Beaucoup de fichiers générés que l'on
# souhaite versionner mais pas de nécessité de synchronisation immédiate.
- ../../config:/var/www/html/config:rw,delegated
# On monte ces fichiers par commodité pour pouvoir les modifier simplement et que leur modification
# soit prise en compte sans devoir copier un fichier ou relancer un container.
- ../conf/settings.php:/var/www/html/web/sites/default/settings.php:rw,delegated
- ../conf/settings.local.php:/var/www/html/web/sites/default/settings.local.php:rw,delegated
- ../conf/development.services.yml:/var/www/html/web/sites/development.services.yml:rw,delegated
- ../../composer.json:/var/www/html/composer.json:rw,delegated
- ../../composer.lock:/var/www/html/composer.lock:rw,delegated
- ./php/docker-php-upload.ini:/usr/local/etc/php/conf.d/docker-php-upload.ini
# Seuls ces trois répertoires représentent notre code custom et demandent plus de réactivité.
- ../../web/profiles/custom:/var/www/html/web/profiles/custom:rw,cached
- ../../web/modules/custom:/var/www/html/web/modules/custom:rw,cached
- ../../web/themes/custom:/var/www/html/web/themes/custom:rw,cached
# On ne synchronise pas les fichiers de cache et fichiers uploadés.
- drupal-files:/var/www/html/web/sites/default/files
depends_on:
- mysql

apache:
container_name: ${COMPOSE_PROJECT_NAME}_apache
volumes:
# Apache n'est pas censé écrire dans ce répertoire, on peut donc le passer en lecture seule.
- ../../:/var/www/html:ro,delegated
# On partage les fichiers avec le volume de fichier.
- drupal-files:/var/www/html/web/sites/default/files
depends_on:
- php

mysql:
container_name: ${COMPOSE_PROJECT_NAME}_mysql
build:
context: ./mysql
# # On ne monte surtout pas les volumes MYSQL pour des raisons de performances évidentes.
# volumes:
# - ./data/mysql:/var/lib/mysql:rw
# - ./entrypoint:/docker-entrypoint-initdb.d

volumes:
# Ce volume n'étant pas monté avec osx, il ne dégrade pas ses performances.
drupal-files:

Sous drupal 8, les types d'entités, comme les noeuds, viennent avec leur classe pour gérer le contrôle d'accès (création / modification / visualisation / suppression).

Il est possible de surcharger ces classes pour personnaliser plus finement ce contrôle.

Nous allons ici surcharger le contrôle d'accès pour un type d'entité « shoutbox », mais c'est le même principe pour les nodes.

# mon_module.module
function mon_module_entity_type_alter(array &$entity_types) {
  $entity_types['shoutbox']->setHandlerClass('access', \Drupal\mon_module\Entity\AccessControlHandler\CustomShoutboxAccessControlHandler::class);
  // Note : si on avait voulu surcharger le controle d'accès aux noeuds : 
  //   $entity_types['node']->setHandlerClass('access', \Drupal\mon_module\Entity\AccessControlHandler\CustomNodeAccessControlHandler::class);
}

La classe en elle même, qui étant la classe de contrôle d'accès de base (définie dans l'annotation de notre type d'entité)

# mon_module/src/Entity/AccessControlHandler/CustomShoutboxAccessControlHandler.php
 
namespace Drupal\mon_module\Entity\AccessControlHandler;
 
use Drupal\Core\Access\AccessResult;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Session\AccountInterface;
use Drupal\shoutbox\Entity\AccessControlHandler\ShoutboxAccessControlHandler;
use Drupal\shoutbox\Entity\Shoutbox;
use Drupal\user\Entity\User;
 
class CustomShoutboxAccessControlHandler extends ShoutboxAccessControlHandler {
 
  protected function checkAccess(EntityInterface $entity, $operation, AccountInterface $account) {
    /** @var Shoutbox $entity */
    if($operation === 'view' && $this->testPerso()) {
      if (!$entity->isPublished()) {
        return AccessResult::allowedIfHasPermission($account, 'administer shoutbox');
      }
      if ($this->autreTest()) {
        return AccessResult::allowed();
      }
      return AccessResult::forbidden('Shoutbox privée');
    }
    return parent::checkAccess($entity, $operation, $account);
  }
 
}

Ici je ne fais un contrôle d'accès que sur l'opération « view » pour la visualisation, je délègue tout le reste à la classe mère.