Symfony Level Up #7

La newsletter pour performer en Symfony 🚀

Symfony 7.2 est là !

Salut collègue développeuse / développeur,

Ça fait un moment depuis le niveau 6 ! J’ai testé pas mal de choses (sortie de Symfony 7.2 oblige) et donc produit un peu moins de contenu. J’ai également effectué ma première contribution à Symfony ce qui m’a pris quelques soirées 😅 (mais je te raconte tout ça un peu plus loin).

Nous voici à la 7ème newsletter avec plus de 370 inscrites et inscrits à ce jour ! Merci encore pour ton soutien 🙏

Si tu veux m'aider à faire décoller encore ce nombre 🚀, n'hésite pas à partager avec tes collègues qui comme toi, souhaitent performer en Symfony.

Et si tu n’es pas encore abonné(e) et que tu ne veux pas rater les prochaines éditions, clique sans plus tarder sur le bouton ci-dessous.

---

Les nouveautés de Symfony 7.2

Je ne vais pas faire la liste de toutes les nouveauté de cette nouvelle version, tu trouveras cela sur le blog officiel, notamment dans cet article qui prend le temps de recenser toutes les nouveautés.

J’ai trouvé cela plus intéressant de sélectionner 3-4 points à développer et à mettre en pratique dans de courtes vidéos

Nouvelles contraintes Week et WordCount

De nouvelles contraintes font leur apparition, notamment Week et WordCount qui permettent respectivement

• de s’assurer qu’une valeur correspond à une semaine et que celle-ci se trouve entre deux semaines définies (exemple entre la 40ème et la 51ème de 2024)

• de contraindre le nombre de mot d’un texte (min et/ou max), ce qui peut venir en complément d’une contrainte Length qui se contente de compter le nombre de caractère et non le nombre de mots.

Desktop Notifications (et finishedIndicator pour le Progress Indicator).

Dans cette autre vidéo, je prend le cas d’une commande symfony qui serait un peu longue à s’exécuter, et comment mieux suivre sa progression grâce à ces 2 nouveautés :

• ajout d’une barre de progression à l’aide du Progress Indicator (Symfony 7.2 ajoute la possibilité de changer l’icône quand c’est fini)

• notification de bureau (Desktop Notification) pour alerter de la fin de la commande (ajout au composant Notifier)

PasswordStrength constraint

Une autre nouveauté intéressante est l’ajout d’un estimateur de complexité sur les mots de passe. Il était jusqu’alors possible de contraindre qu’un mot de passe ait un certain niveau donné de complexité, mais pas de connaitre ce niveau (notamment si celui-ci n’était pas suffisamment élevé). C’est chose corrigée maintenant grâce à la méthode estimateStrength() de PasswordStrengthValidator.

Pour illustrer cette dernière, j’ai codé via un Live component, un système pour indiquer en direct la complexité du mot de passe en train d’être saisi, vous trouverez tout cela dans cette dernière vidéo :

Nouvelle gestion du token CSRF

On notera également un nouveau système de token pour éviter les failles CSRF. Le token n’est plus géré par une session, mais via un cookie et un script JS. Je ne fais pas ici de vidéo car le mécanisme n’est pas réellement visible, cependant ce changement important est activé par défaut, et s’il y a toujours un champ hidden dans les formulaires, celui-ci ne contient plus de token mais une valeur de type

<input type="hidden" id="product__token" name="product_token]" data-controller="csrf-protection" autocomplete="off" value="csrf-token">

Nouveauté de Symfony UX

Les nouveautés dans Symfony ne s’arrêtent pas là, car il y a également du nouveau côté Symfony UX.

Tout d’abord dans le nouveau composant UX-Map, la plus grosse nouveauté est le support de cette map au sein d’un LiveComponent, ce qui n’était pas possible jusqu’alors ! Il faudra ajouter un use ComponentWithMapTrait à la classe de LiveComponent. Cette ajout offre de formidable perspective pour dynamiser des cartes au sein de Symfony.

Autre nouveauté dans UX-Map, le support de Polyline en plus de Polygone, ce qui permettra d’ajouter une ligne sur une carte (utilie pour dessiner un itinéraire par exemple, je te prépare très bientôt un ensemble de vidéos sur ce sujet).

Pourquoi je te parle de cette dernière fonctionnalité ? C’est par ce que j’en suis l’auteur, et c’est ma toute 1ere contribution à Symfony ! Plus de détail dans la partie suivante si te veux un retour d’expérience à ce sujet.

Retour d’expérience : j’ai fait ma première PR Symfony 🤭

J’utilise Symfony depuis sa version 2, plus de 10ans maintenant. Et pourtant, pourtant… je n’avais jamais contribué. Pourquoi ?

Pour être transparent, je crois tout simplement que c’est intimidant, à plusieurs niveaux :

• Peur de la complexité : on a beau savoir utiliser Symfony, y contribuer ce n’est pas la même histoire. En tant que dev, on n’a finalement assez peu l’occasion de se plonger dans les entrailles de la bête. Alors oui de temps en temps, on parcours quelques fichiers, mais de là à se poser, comprendre comment ça fonctionne au point de pouvoir apporter une modification, c’est une autre paire de manche.

  Est-ce que c’est vraiment aussi compliqué qu’on le pense ? Sans doute pas, mais ça demande un certain investissement.

• Peur de l’écosystème : faire sa modification c’est une chose, mais Symfony c’est un framework qui a de nombreuses règles et bonnes pratiques. Il faut valider de nombreux checks pour que la PR passe (tests, linters, etc) et ce n’est pas toujours évident de comprendre toute cette configuration en local. Et il faut que ça passe les relectures par de vrais humains, et là on passe au point suivant.

• Peur de passer pour un mauvais développeur : on retrouve notre bon vieux pote, le syndrome de l’imposteur… et si je n’y arrive pas, si je me plante, si on refuse ma PR ? Le tout publiquement visible par la communauté… C’est peut-être moins long et moins risqué de faire une issue et attendre que quelqu’un de meilleur, de plus légitime le fasse (peut-être) un jour à ma place.

Alors pourquoi je me suis lancé ? La curiosité peut-être, mais pour être tout à fait honnête et pragmatique, je dirais, le besoin de cette fonctionnalité rapidement, tout simplement.
Mais laisse moi replacer un peu le contexte. Je décide de lancer une nouvelle série de vidéos pour ma chaîne Youtube, pour présenter comment faire un système d’itinéraire, en se basant sur UX-Map et des API (adresse.data.gouv et OSRM). Donc je veux 2 champs texte dans lesquels je vais pouvoir chercher des adresses, les suggestions d’adresse vont apparaitre.

Exemple de recherche d’itinéraire sur OpenStreetMap

Je sélectionne sur une adresse pour avoir le point de départ (le marqueur apparait sur la carte), puis la même chose pour l’arrivée (un second marqueur). Du classique dans le fonctionnement, mais en utilisant un max de Symfony UX. Ça me demande déjà pas mal de temps, mais j’arrive à obtenir ce que je veux.

Ensuite je passe à l’utilisation d’OSRM pour calculer l’itinéraire, là encore pas mal d’essais et j’obtiens enfin un JSON de retour avec une série de coordonnées correspondant au chemin précis à suivre, c’est ce qui est appelé une polyline (une ligne formée de X coordonnées, qui permet de superposer un trait sur la carte pour indiquer la route à suivre).

Et là, après déjà plusieurs heures d’investissement, arrivé à la toute dernière étape… je me rends compte qu’UX map (qui est un composant super récent) ne permet pas encore des Polylines, seulement des polygones… tout mon projet tombe à l’eau 😭
Alors je regarde un peu comment tout ça est fichu, et je me rend compte que dans Leaflet (la librairie qui gère le rendu de carte) y a une bien une classe Polyline en plus de Polygon, qui fonctionne quasiment pareil (en gros le polygone va “fermer” la polyline en rejoignant le point de départ et d’arrivée, et gérer le remplissage de la forme). Or, dans le code d’UX map, y a bien la classe Polygone 🤔.

Alors je teste quelque chose, comme ça vite fait. Je duplique la classe et je la renomme en Polyline. Puis je cherche toutes les occurrences de polygon dans le dossier vendor, je les duplique et renomme en polyline. Et au bout de pas mal de copier/coller, miracle, j’arrive à afficher ma polyline, ça fonctionne youpi ! Mais mince, je viens juste de faire des modifications dans vendor, donc aucun intérêt… Pourtant la fonctionnalité est intéressante et j’en ai besoin rapidement… voilà je me décide à contribuer et commence le parcours du combattant.

Je regarde comment contribuer à Symfony UX, je fork le repo, et je me met à refaire des copier/coller depuis mon vendor de projet vers le code de Symfony. Et là encore après un peu de temps, j’arrive à faire fonctionne ma polyline, youpi j’ai fini… ou pas !

Je me rend vite compte que je n’ai fais mes modifs que pour Leaflet… or UX map gère aussi Google Map… Si je ne push que pour Leaflet, ça ne passera jamais… Donc me voilà à regarder comment ça fonctionne sur l’API Google Map (que je n’utilise jamais), et à adapter encore Polygon en Polyline. Je duplique tout (sans trop réfléchir) et… une fois encore ça fini par fonctionner !!!

Alors tout content, je push ma 1ère PR et là… je déchante ! J’ai l’habitude d’utiliser Github Action en entreprise, la CI qui lance un linter, des tests, quelques checks… Mais là Symfony UX c’est plus de 60 checks, et vraiment beaucoup de fail ❌

Par contre, j’ai été impressionné de la rapidité des mainteneurs (merci kocal et smnandre). J’ai tout de suite des retours encourageants et bienveillants sur la PR. Bon, remotivé, je me dis qu’il n’y a que quelques tests à vérifier…. Mais la structure du repo de Symfony UX est particulière, c’est un monorepo qui contient tous les sous-projets, et les “bridge” pour Leaflet et Google map sont eux même sur d’autre repository en lecture seule. Bref c’est pas facile à suivre. De ce fait, la configuration pour lancer les builds, les tests etc, n’est pas “classique”, c’est sans doute là que j’ai le plus galérer (et le fait que ne fasse pas de Typescript ça n’aide pas). Bref, je me retrouve à essayer de comprendre tant bien que mal comment tout ça fonctionne, car ni les tests JS, ni les tests PHP ne passent. Mais je n’arrive pas à les lancer correctement chez moi. Au bout d’un long moment (où j’ai songé plusieurs fois à jeter l’éponge) je demande de l’aide et j’ai rapidement des retours qui m’aident petit à petit à mieux comprendre l’environnement.

Les jours passent, les croix rouges diminuent et enfin, à un moment, tout passe enfin au vert ✅… reste seulement quelques conflits. Car c’est là aussi la beauté d’un projet opensource de cette ampleur : il est très actif donc il faut très régulièrement rebase son code (avec potentiellement beaucoup de conflits) Et une fois ce dernier rebase effectué, bien entendu les tests ne passaient à nouveau plus… 🤯 encore du temps, encore des aller retours, du rouge sur Github Action dont je ne comprends pas l’origine… mais je m’accroche.

Simon André qui maintient le repo et dont vous pouvez lire l’interview dans le précédent niveau, m’a gentiment proposé son aide car il me restait un tout dernier test qui ne passait pas et je ne comprenais pas… mais mystère il l’a relancé, c’est passé, il m’a renvoyé un mail pour me dire. Je retourne sur la page des PR et là sueur froide, ma PR a disparue 😱 mais non, je vérifie, fébrile, il a mergé, youpi !!!

Au final, une sacrée aventure. J’ai juste ajouté quelques lignes à ce projet, mais j’ai l’impression d’avoir soulevé une montagne tellement j’ai galéré avec la CI. Au final 2 semaines 1/2 pour passer une simple PR, c’était éprouvant.

Alors est-ce que je voudrais recommencer ? Oui je pense, car même si c’est dur de ne pas réussir aussi vite que l’on voudrait, ça montre que la persévérance, qu’accepter de demander de l’aide, ça permet de réussir au final, et ça ça n’a pas de prix.

Quelques jours après (j’espère y avoir contribué un peu par mes remarques 😛), j’ai vu qu’une PR avait été faite pour étoffer la documentation qui explique comment contribuer :-) Ce projet est impressionnant (comme beaucoup d’autres projets Open-source) car il y a très peu de mainteneurs par rapport au nombre d’utilisateurs. Mais ils sont réactifs, à l’écoute, bienveillants, prêt à aider. Ça m’a vraiment motivé et même si la contribution reste très minime, je suis fier d’avoir réussi à aller jusqu’au bout (et de partager ce retour d’expérience avec toi !) Alors la contribution à Symfony ? Oui, je recommande !

---

Conclusion

Je préfère poster moins souvent, mais privilégier le contenu que je trouve intéressant. Et ce nouveau level me semble finalement bien complet :-)

Pour ma part, je termine ma mission actuelle et serai disponible à partir de Janvier. Alors si ton entreprise cherche à booster son équipe avec un freelance expérimenté, c’est le moment ou jamais de me contacter, directement sur mon Linkedin ou sur levelup@sylvainblondeau.dev

Si cette newsletter t'a plu, n’hésite pas à repartager et en parler autour de toi.

À très bientôt pour le prochain niveau ;-)