Reproduire un bug à partir d’un journal : le guide du détective
Comment trouver le moment de l’échec dans un journal, réduire ce journal à l’essentiel, en tirer des étapes reproductibles et le partager en toute sécurité.
Un utilisateur écrit : « Ça a planté. Je ne sais pas comment. » Vous essayez les choses évidentes. Rien ne se passe. Le bug est réel, l’utilisateur est agacé, et le seul témoin est un fichier journal de plusieurs milliers de lignes.
Bonne nouvelle : un journal est un témoin qui ne peut pas mentir, seulement marmonner. Avec un peu de méthode, vous pouvez trouver le moment où les choses ont mal tourné, lire les indices autour, et en tirer des étapes qu’une autre personne peut suivre. Voici la méthode.
Première étape : fixez l’heure du crime
Commencez par une heure. Demandez à la personne qui a signalé le problème quand il s’est produit, ou servez-vous de l’horodatage du ticket, et cherchez dans le journal autour de ce moment. Repérez la première ligne de niveau avertissement ou erreur, pas seulement la plus bruyante. La première erreur est souvent la cause. Les erreurs suivantes sont fréquemment la réaction du programme aux dégâts.
Si vous avez un identifiant de requête, de session ou d’utilisateur, cherchez-le. Suivre un seul identifiant dans un journal transforme un mur de texte en une histoire unique, avec un début, un milieu et une fin.
Deuxième étape : lisez la pile d’appels depuis le haut
Une ligne d’exception vous donne le type et le message. Les appels listés en dessous vous indiquent où se trouvait le programme. Descendez jusqu’aux premiers appels qui appartiennent à votre propre code, car ce sont eux qui nomment le fichier et la ligne à examiner.
`` 12:04:13 ERROR TypeError: plan.period is undefined at applyPromo (pricing.ts:88) at updateTotal (cart.ts:41) at onPromoSubmit (checkout.ts:130) ``
Dans cet exemple, l’échec se situe dans applyPromo, appelée par le total du panier, lui-même appelé quand un code promo est soumis. Vous avez déjà un verbe pour votre première étape : appliquer un code promo à un panier.
Troisième étape : regardez ce qui précède immédiatement
Les lignes avant l’erreur montrent l’état dans lequel se trouvait le programme. Peut-être qu’un réglage a changé un instant plus tôt. Peut-être qu’une valeur a été chargée depuis un endroit qui ne l’avait pas. Dans l’exemple, le journal pourrait montrer, quelques lignes plus haut, le passage de la période de facturation de mensuelle à annuelle. C’est un indice sur l’entrée qui a mené à l’échec.
Notez les valeurs que vous voyez : le nom du forfait, le code saisi, le réglage modifié, l’ordre des actions. L’ordre compte. Un bug qui exige A puis B n’apparaîtra pas si vous faites B puis A.
Quatrième étape : transformez les indices en étapes
Vous en avez maintenant assez pour écrire quelque chose qu’une personne peut suivre.
- Écrivez les actions de l’utilisateur dans l’ordre où le journal les montre.
- Remplacez tout ce qui est propre à une personne par un équivalent qu’un testeur peut réutiliser, comme un compte de test.
- Gardez les valeurs qui semblent pertinentes, comme le code promo et le forfait. Laissez tomber le reste.
- Exécutez les étapes. Si la même erreur apparaît, vous tenez une reproduction. Sinon, changez une seule chose à la fois : le build, le type de compte, les données, l’ordre.
Changer une seule chose à la fois, c’est la partie qui paraît lente et qui est en réalité rapide. Changez trois choses, et une réussite ne vous apprend rien.
Cinquième étape : comptez la fréquence
Exécutez les étapes quelques fois et notez le résultat. Un échec qui apparaît à chaque fois oriente vers une erreur de logique. Un échec qui survient de temps en temps oriente souvent vers le timing, la charge, ou des données qui diffèrent d’un essai à l’autre. Indiquez la fréquence dans le rapport, car elle change le point de départ du développeur.
Sixième étape : réduisez le journal avant de le partager
Un journal joint à un ticket est lu par plus de monde que vous ne le pensez, et il peut contenir des choses qui n’ont rien à faire dans un outil de suivi.
- Gardez la partie utile. La ligne d’erreur, la pile d’appels et quelques lignes avant. Indiquez d’où provient l’extrait dans le fichier.
- Masquez les données personnelles. Adresses e-mail, noms et tout ce qui permet d’identifier une personne.
- Masquez les secrets. Jetons d’accès, clés d’API et mots de passe. Un jeton dans un ticket peut être lu par quiconque peut ouvrir le ticket.
- Vérifiez visuellement. Le masquage automatique aide, mais il se fait au mieux : regardez donc le résultat avant de le joindre.
Ce que doit contenir le ticket
Indiquez les étapes que vous avez trouvées, ce que vous attendiez, ce qui s’est passé, le build et la fréquence, et joignez l’extrait réduit. Un développeur qui lit cela peut reproduire le problème en quelques minutes au lieu de plusieurs heures. Si vous voulez une forme à suivre, le modèle de rapport de bug en détaille chaque partie.
La place de BugIt
Lire des journaux est une compétence utile, et c’est aussi une corvée quand le journal est long. Quand vous collez un journal dans BugIt, il garde la ligne d’erreur et la pile d’appels qui comptent, écarte le bruit autour, puis s’appuie sur ce qu’il a trouvé pour rédiger les étapes et l’environnement dans le brouillon. BugIt masque les données personnelles courantes, au mieux : vous relisez donc le brouillon avant son dépôt. Vous relisez chaque brouillon, et rien n’est écrit dans votre outil de suivi tant que vous n’avez pas tapé FILE IT.
Pour en savoir plus : bugit.dev et taskivator.com/bugit.
À retenir
Trouvez la première erreur, lisez la pile d’appels depuis le haut, regardez ce qui précède immédiatement, et écrivez les étapes dans l’ordre où le journal les montre. Changez une seule chose à la fois quand le bug ne se reproduit pas, notez sa fréquence, et réduisez et masquez le journal avant de le partager. Un journal est un témoin patient. Posez-lui les bonnes questions, et il vous dira comment reproduire le problème.