Signet 1.1.0

Lorsque j’ai commencé les tests de compatibilité de mes extensions avec la première bêta de Retraceur 4.0.0, je ne m’attendais pas à devoir publier une nouvelle version de Signet. Pourtant, ces essais ont rapidement mis en évidence une anomalie qui empêchait le bloc de fonctionner correctement dans ce nouveau contexte.

Cette version 1.1.0 est donc avant tout une version de maintenance. Mais, comme c’est souvent le cas lorsqu’on prend le temps d’analyser un problème jusqu’à son origine, elle a également permis d’améliorer Retraceur lui-même.

Un problème révélé par Retraceur 4.0.0-beta1

Le développement de Retraceur 4.0.0 introduit plusieurs évolutions internes destinées à préparer les prochaines fonctionnalités du projet.

En testant les éventuels impacts de la première bêta de Retraceur 4.0.0 sur le comportement de Signet, j’ai constaté que les blocs insérés dans les articles avant cette évolution généraient systématiquement une erreur dans l’éditeur de blocs. Même si un clic sur le bouton de réparation permettait de corriger la difficulté, il fallait que j’investigue pour comprendre ce qui clochait et trouver une solution durable.

Après plusieurs investigations, j’ai identifié l’origine du problème et mis en place la correction correspondante dans Signet. Si vous souhaitez suivre le détail de cette investigation, vous pouvez consulter l’issue Signet #5 qui retrace l’analyse et la correction de cette anomalie.

Cette correction permet à Signet de retrouver un fonctionnement normal avec Retraceur 4.0.0 tout en restant compatible avec les versions précédentes.

Une anomalie plus ancienne mise au jour

En poursuivant mes tests, j’ai découvert que Signet ne parvenait jamais à récupérer la description des articles publiés sur ce blog.

Or, depuis la version 3.0.0, Retraceur embarque sa propre API OpenGraph afin de fournir des métadonnées normalisées aux applications qui souhaitent présenter un aperçu d’une page.

Signet exploite naturellement cette API lorsqu’elle est disponible afin de pouvoir s’appuyer sur la balise <meta property="og:description"> pour obtenir cette fameuse description. Mon analyse m’a permis de découvrir qu’une anomalie héritée du code de WordPress^® empêchait la REST API de Retraceur d’exposer correctement cette information.

La correction apportée à Retraceur permet désormais de récupérer correctement cette description. Elle profite donc non seulement à Signet, mais également à toutes les applications qui s’appuient sur la REST API de Retraceur pour consulter les métadonnées OpenGraph.

La correction apportée à Retraceur est documentée dans l’issue Retraceur #232, qui détaille l’origine de cette anomalie ainsi que sa résolution.

Installer Signet

Après avoir téléchargé l’archive signet.zip du bloc depuis la page GitHub de sa version 1.1.0, il s’agit de la charger sur votre site à l’aide de l’interface d’administration de vos blocs.

Une illustration de l’intérêt des tests

Ce travail illustre parfaitement l’intérêt de tester régulièrement ses extensions et ses blocs sur les pré-versions de Retraceur.

D’une part, cela permet aux développeurs d’extensions et de blocs de vérifier que leur code reste compatible avec les évolutions du cadre dans lequel il s’exécute.

D’autre part, une anomalie observée dans une extension (ou un bloc) n’est pas toujours causée par cette dernière. Elle peut révéler une difficulté plus profonde au sein même de Retraceur. Dans ce cas, la résolution ne relève plus uniquement du développeur de l’extension mais également des mainteneurs du cœur.

C’est l’un des grands intérêts d’un projet open source : chacun peut signaler une anomalie, analyser sa cause réelle et proposer une correction. Au-delà de résoudre un problème local, cette démarche contribue à améliorer la qualité et la robustesse de Retraceur dans son ensemble.

Comme toujours, les anomalies, suggestions et contributions sont les bienvenues sur les dépôts GitHub des projets.

Crédits de la photo en une : Angèle Kamp sur Unsplash

NB : La marque WordPress^® est la propriété intellectuelle de la Fondation WordPress. L’utilisation du nom WordPress^® dans cet article est uniquement à des fins d’identification et n’implique pas une approbation de la part de la Fondation WordPress.