Accueil / Blog / Métier / 2020 / Drupal & Gatsby : retour d'expérimentation

Drupal & Gatsby : retour d'expérimentation

Par Simon Mellerin — publié 01/09/2020, édité le 10/12/2020
Gatsby est une solution montante pour créer des sites statiques. Voyons dans quelle mesure il est possible de l'utiliser avec Drupal.
Drupal & Gatsby : retour d'expérimentation

Drupal + Gatsby = <3 ?

Gatsby est une solution permettant de créer simplement des sites statiques à partir de React. Elle permet entre autre d'intégrer du contenu à un site statique à partir de sources de données. Nous allons voir dans cet article dans quelle mesure il est possible de se servir d'un Drupal pour jouer le rôle de cette source de données.

L’intérêt d'une telle architecture est multiple :

  • On profite de la puissance de Drupal :
    • On définit des types de contenu et on organise ses contenus autour de taxonomies et menus
    • On bénéficie de son back-office pour contribuer facilement (workflow, gestion des médias...)
  • Mais aussi de la puissance de Gatsby :
    • Le site statique généré est très rapide
    • On améliore grandement la sécurité : l'accès au back-office Drupal est protégé, le visiteur lamba n'a accès qu'à des fichiers statiques, ce qui réduit la pression des mises à jour Drupal en cas de faille de sécurité notamment

Gatsby fournit un plugin officiel pour récupérer des contenus depuis Drupal. Ce module permet de requêter en GraphQL les données exposées par le module JSON:API de Drupal (et par JSON:API extra qui est fortement conseillé).

On peut déjà faire quelques remarques :

  • Un site construit avec Gatsby hérite automatiquement des limitations de JSON:API
  • JSON:API est, depuis peu, inclus dans le core de Drupal : c'est donc plutôt une solution pérenne
  • JSON:API extra est d'ores et déjà disponible sur Drupal 9, il n'y a pas de soucis à se faire pour le futur

Pour cette expérimentation, j'ai repris l'exemple fourni par Gatsby qui utilise le site démo Umami de Drupal.

Accéder aux contenus de Drupal

Les Nœuds et Taxonomies

L'exemple fourni est très simple (presque trop ?), il ne fait que requêter des nœuds, mais cela fonctionne bien. Le GraphQL est pratique : une interface (GraphiQL) est disponible pour construire/tester ses requêtes, on peut découvrir les différents types de contenu et leurs différents champs. Le développeur front n'a pas besoin de maîtriser Drupal, de plus l'API est autodocumentée.

Aperçu de GraphiQL

Il n'y a pas, ici, de limitation particulière, les taxonomies peuvent être exploitées de la même manière, ce qui ne présente aucune difficulté à venir.

Les Menus

Je disais au paragraphe précédent que l'exemple fourni était presque trop simple, il n'essaye pas, par exemple, de récupérer des menus : ils sont renseignés en dur dans les templates React. Les menus sont une fonctionnalité essentielle pour rendre les contributeurs un minimum autonomes, j'ai donc commencé par essayer de voir comment les atteindre.

Mauvaise surprise : ce n'est pas si évident ! Disons-le, ce n'est pas vraiment la faute de Gatsby, ni celle de JSON:API, mais plutôt de Drupal.

En fait, pour récupérer les liens de menus via JSON:API, il faut donner les droits Administration des menus aux utilisateurs anonymes. C'est loin d'être anodin - ce droit donne par exemple la possibilité de créer/modifier/supprimer les menus du site - et ce n'est donc absolument pas souhaitable ! La communauté travaille activement sur ce problème et un patch est déjà disponible.

Une fois que l'on a accès à ces liens de menu depuis Gatsby, on se rend compte qu'il n'y a pas de moyen simple de les obtenir rangés dans une belle arborescence, il faut la reconstruire soi-même. Un module React semble proposer de le faire pour nous : gatsby-drupal-menus, mais je ne l'ai pas encore testé.

On voit ici qu'il n'est pas encore simple, pour un Drupal découplé, de tirer profit des menus. On finit par y arriver, mais il faudra compter sur un peu de développement.

Les Blocs

Je n'avais jamais encore vraiment testé la réalisation d'un Drupal découplé. Ce qui est perturbant est qu'il faut garder à l'esprit que tout ce qui concerne le thème dans Drupal n'est, de fait, plus disponible. On peut, par exemple, considérer que tout ce qui ce trouve dans un fichier .theme ne sera pas disponible du côté Gatsby. Il faut aussi dire au revoir aux régions et au placement automatique des blocs !

Il faudra donc ruser pour replacer correctement ses blocs sur les différentes pages, on pourra se référer à cet exemple bien documenté. Le plus pertinent est à mon avis d'oublier complètement le système de thème de Drupal, et de réfléchir de manière radicalement différente pour réaliser la disposition des différents éléments du site.

Les blocs sont accessibles via JSON:API, mais on ne récupère pas pas le bloc rendu - on vous a dit qu'il fallait oublier le thème, donc aucun rendu n'est réalisé ! - mais seulement les valeurs des différents champs. Ça limite donc l'utilisation d'un certain nombre d'entre eux. Mais, par exemple, on pourra utiliser tous les blocs personnalisés déclarés via la back-office.

Mon avis est mitigé sur le cas des blocs, on perd la puissance du thème Drupal pour leur placement : il faudra une certaine dose de réflexion pour repenser les différents cas d'utilisation. Mais après tout, si on souhaite découpler son site, c'est bien pour s'affranchir de la partie front de Drupal, non ?

Les Vues

Je sais que certains sont très adeptes des vues, et bien désolé, mais à priori, il n'est pas possible de les utiliser facilement avec Gatsby. Cependant, au vu des possibilités offertes par le GraphQL pour faire des requêtes (conditions sur les champs des contenus, pagination...) je ne pense pas que Views soit indispensable pour réaliser un front-office.

L'utilisation est donc à priori compliquée, mais finalement, se passer de Views est-ce vraiment si grave ? ;)

Le cycle de publication

À la différence d'un Drupal classique, ici, l'étape de génération du site statique rend la publication de contenu pseudo-temps réel.

L'arrivée d'un contenu jusqu'au visiteur final se fera en 2 grandes étapes :

  • Les contributeurs contribuent via le BO de Drupal sur un serveur à l'accès restreint
  • Le site statique est regénéré par Gatsby à partir des données contribuées, puis déployé sur le serveur de production

La contribution

Le contributeur ne verra pas de différences avec un Drupal classique, il ne sera pas perdu, et pour cause : son interface est le back-office classique de Drupal.

La seule question qui peut poser problème est l'aperçu du rendu final du contenu. C'est une fonctionnalité quasi-indispensable, on peut difficilement imaginer un contributeur remplir un WYSIWYG, quelques champs et prier pour que le rendu soit comme il l'imaginait une fois qu'il est publié ! Dans notre cas, le rendu du contenu sera fait par React qui n'est a priori pas disponible côté Drupal. Et après tout, c'est l'idée du découplage. Heureusement, un module Drupal permet de reproduire le contenu tel qu'il sera publié : Gatsby Live Preview. Ce module n'est par contre pas encore disponible pour Drupal 9 et est en version alpha sur Drupal 8, je n'ai pas eu le temps de le tester.

Aperçu de Gatsby Live Preview

La génération du site statique

Le site étant statique, à la différence d'un Drupal classique, l'appui sur le bouton 'Publier' d'un contenu n'aura pas pour effet de le rendre immédiatement disponible au public. Pour ça, il faudra d'abord le regénérer (c'est le boulot de Gatsby).

On a 3 possibilités pour déclencher cette génération :

  • Périodiquement
  • Manuellement, via le BO de Drupal ou une autre interface
  • Sur certaines actions (publication/dépublication, modification de menu...)

Les deux premières options ne posent pas de problème. La troisième par contre implique de créer un lien entre Drupal et Gatsby. La bonne nouvelle est que c'est l'une des fonctionnalités du module Gatbsy Live Preview. Ça semble être uniquement pour la publication de contenu, mais moyennant l'implémentation de deux ou trois hooks, j'imagine qu'il ne sera pas trop compliqué de généraliser ce comportement à d'autres actions (modification de taxonomie, création d'un lien de menu...)

Avant que la génération du site ne devienne lente il faudra avoir atteint un certain volume de contenu. Mais lorsque cela arrivera, sachez que Gatsby fournit la possibilité de faire de la génération incrémentale, ce qui devrait alléger considérablement la regénération du site.

Mettre en place ce genre d'architecture ne devrait pas être trop compliqué. La plus grande difficulté sera sans doute la pédagogie à mettre en œuvre auprès des contributeurs pour leur expliquer le léger temps de latence entre la publication du contenu côté Drupal et son apparition effective sur le site : c'est là l'un des points faibles majeurs pour ce type de solution.

Pour conclure

Une fois le problème de menu résolu, je pense que tout est aujourd'hui réuni pour faire un site Drupal découplé et le couplage avec Gatsby semble très prometteur.

En résumé avec le couple Drupal/Gatsby :

  • Ce que l'on peut faire facilement : la récupération des nœuds/taxonomies/blocs/médias via des jolies requêtes GraphQL
  • Ce qui demande un peu de contournement : les accès aux menus et le placement des blocs
  • Ce qu'il n'est pas possible de faire : l'utilisation de vues
  • Ce qui peut être frustrant : le temps entre la publication côté Drupal et l'apparition du contenu sur le site

C'était une des premières remarques de l'article, et on le voit ici, la plus grosse limitation n'est pas du fait de Gatsby, mais bien des possibilités offertes par Drupal et sa JSON:API. L'utilisation d'un Drupal headless couplé avec une application JS ayant le vent en poupe, cette limitation sera rapidement être levée : c'est notamment sur la feuille de route de Drupal 10 et de son futur Javascript menu component !

Le composant Menu Javascript est l'un des objectifs de Drupal 10
ABONNEZ-VOUS À LA NEWSLETTER !
Voir aussi
Varnish et Drupal 9 : le vidage de cache ciblé Varnish et Drupal 9 : le vidage de cache ciblé 31/12/2020

La mise en place d'un cache de pages anonymes Varnish devant un Drupal 9 permet une mise en place ...

Varnish et Drupal : gérer un cache anonyme étendu Varnish et Drupal : gérer un cache anonyme étendu 14/03/2018

Le rôle d'un Reverse Proxy Cache Varnish dans une architecture Web (type Drupal).

Sortie de Drupal 9 : préparez-vous ! Sortie de Drupal 9 : préparez-vous ! 28/05/2020

Dans quelques jours, le 3 juin 2020, aura lieu la sortie de Drupal 9 en version stable. À quels ...

Mon Top 30 des modules Drupal 8 Mon Top 30 des modules Drupal 8 16/02/2019

Transcription d'une conférence donnée au Drupalcamp Paris 2019

Makina Corpus lance une nouvelle offre pour sécuriser les projets Drupal des ESN Makina Corpus lance une nouvelle offre pour sécuriser les projets Drupal des ESN 18/02/2019

Formations et accompagnement pour sécuriser les projets Drupal