La semaine derniĂšre je me suis rendue compte dâune erreur dans mon code. Cette erreur peu paraĂźtre petite au premier abord, pourtant elle est assez frĂ©quente et peut avoir de lourdes consĂ©quences sur votre plateforme. Je vais vous la prĂ©senter et vous montrer comment l'Ă©viter.
Au programme :
DĂ©tecter lâerreur
Les guard clauses
Bonjour et bienvenue sur la 6Úme édition de Ruby Biscuit.
Vous ĂȘtes maintenant 80 abonnĂ©s đ„ł Si vous nâĂȘtes pas dĂ©jĂ inscrit :
DĂ©tecter lâerreur
RĂ©cemment jâai implĂ©mentĂ© une fonctionnalitĂ© qui consistait Ă renseigner un code de parrainage valide afin de pouvoir accĂ©der Ă la page dâinscription.
La logique de ce parcours utilisateur est la suivante :
Un nouvel utilisateur doit renseigner le code parrain dâun utilisateur validĂ© sur la plateforme pour pouvoir accĂ©der au site.
Voici mon implémentation initiale de cette spécification :
Jâai créé mon controller Users::CooptationCodesController et dans la mĂ©thode #create, je rĂ©cupĂšre le code parrain fourni par l'utilisateur.
Sâil existe je redirige lâutilisateur Ă lâĂ©tape suivante, celle de lâinscription, sinon je lui affiche un message dâerreur et je le laisse sur le formulaire du code parrain.
Voici les tests qui accompagnaient ma nouvelle fonctionnalité :
Tout semblait fonctionner Ă merveille jusquâĂ ce quâun de mes collĂšgues me dise âIl se passe quoi si le paramĂštre âcodeâ est vide ? Tu devrais utiliser une guard clause pour Ă©viter ce genre de problĂšme.â
1Ăšre rĂ©action : âNon t'inquiĂšte, ce cas est dĂ©jĂ testĂ© !â
2Ăšme rĂ©action : ⊠Je vais peut ĂȘtre aller re-vĂ©rifier quand mĂȘme.
3Ăšme rĂ©action : MAIS POURQUOI MES TESTS FONCTIONNENT ALORS QUE MON CODE NâEST PAS BON ?
Ok je vous explique la situation :
Un utilisateur arrive sur la page du code de parrainage et soumet le formulaire sans avoir rempli le champ.
Que se passe t-il exactement ?
Mon params nâest pas nil, câest une string vide.
Voici ce quâil se passe dans ma condition
Câest un cas qui peut arriver si je modifie un utilisateur via un formulaire de mon site, en back-office par exemple, que je ne remplis pas son code utilisateur et que jâenregistre tous les paramĂštres comme attributs.
Exemple de params :
Nous avons donc deux soucis :
mon code est mauvais
mes tests sont biaisés
Je commence par changer nil par une string vide dans le contexte âgiven no paramsâ de mes tests pour tester la bonne donnĂ©e dans le cas dâun champ vide. Jâajoute un utilisateur avec une string vide pour le code de parrainage pour ĂȘtre sĂ»re dâen avoir un dans ma base de donnĂ©es de tests.
Je lance mes tests. Spoiler, je mâattends Ă ce que mes tests passent au rouge, que je sois redirigĂ© vers ma page dâinscription et que je nâai plus un statut HTTP 200 mais une 302 pour une redirection.
Maintenant mes tests mâassurent que mon utilisateur ne passera pas Ă lâĂ©tape dâinscription temps quâil nâaura pas renseignĂ© de code. Il ne nous reste plus quâa faire passer nos tests au vert.
Pour cela, je vais ajouter une guard clause dans ma méthode de controller.
Les guard clauses
Une guard clause est un retour prĂ©maturĂ© (ou early return) placĂ© en haut de votre mĂ©thode, qui empĂȘche votre code dâĂȘtre exĂ©cutĂ© si ce n'est pas nĂ©cessaire, en fonction de conditions que vous spĂ©cifiez. La plupart du temps ces conditions servent Ă vĂ©rifier le type de donnĂ©e reçu dans la mĂ©thode.
Je vous conseille cet article trÚs clair et concis pour plus de détails : https://anthonygharvey.com/guard-clauses-vs-nested-conditionals
Cette Ă©tape assurera que mon code ne sâexĂ©cute pas temps que le paramĂštre code est nil ou ââ.
Je relance mes tests
Tout est bon !
Les guard clauses vous permettront de refactoriser votre code en évitant des conditions à rallonge mais aussi de réduire sa complexité en offrant une meilleure lisibilité de ce que vos méthodes sont censées faire et recevoir.
Vous pouvez en ajouter plusieurs à la suite si besoin et adapter les erreurs retournées.
Pour découvrir des nouveaux tips Ruby on Rails tous les mercredis à 16h, ne cherche plus, tu es au bon endroit !
Rendez-vous la semaine prochaine đ
Mélanie













