Déboguer JavaScript

Kayce Basques

Sofia Emelianova

Ce tutoriel vous présente le workflow de base pour déboguer tout problème JavaScript dans DevTools. Lisez la suite ou regardez la version vidéo de ce tutoriel.

Reproduisez le bug.

Trouver une série d'actions qui reproduit systématiquement un bug est toujours la première étape du débogage.

1. Ouvrez cette démonstration dans un nouvel onglet.
2. Saisissez 5 dans la zone Numéro 1.
3. Saisissez 1 dans la zone Numéro 2.
4. Cliquez sur Ajouter le numéro 1 et le numéro 2. Le libellé sous le bouton indique 5 + 1 = 51. Le résultat devrait être 6. C'est le bug que vous allez corriger.

Dans cet exemple, le résultat de 5 + 1 est 51. Il devrait être de 6.

Se familiariser avec l'interface utilisateur du panneau "Sources"

Les outils de développement fournissent de nombreux outils différents pour différentes tâches, comme modifier le CSS, profiler les performances de chargement de la page et surveiller les requêtes réseau. Le panneau Sources vous permet de déboguer JavaScript.

1. Ouvrez les outils de développement, puis accédez au panneau Sources.

   

Le panneau Sources comporte trois sections:

1. Onglet Page avec l'arborescence des fichiers. Tous les fichiers demandés par la page sont listés ici.
2. Section Éditeur de code. Une fois que vous avez sélectionné un fichier dans l'onglet Page, son contenu s'affiche ici.

3. La section Débogueur. Divers outils permettant d'inspecter le code JavaScript de la page.

   Si la fenêtre des outils pour les développeurs est large, le débogueur se trouve par défaut à droite de l'éditeur de code. Dans ce cas, les onglets Champ d'application et Surveiller rejoignent les sections Points d'arrêt, Pile d'appels et d'autres en tant que sections réductibles.

Mettre le code en pause avec un point d'arrêt

Une méthode courante pour déboguer un problème de ce type consiste à insérer de nombreuses instructions console.log() dans le code afin d'inspecter les valeurs pendant l'exécution du script. Exemple :

function updateLabel() {
  var addend1 = getNumber1();
  console.log('addend1:', addend1);
  var addend2 = getNumber2();
  console.log('addend2:', addend2);
  var sum = addend1 + addend2;
  console.log('sum:', sum);
  label.textContent = addend1 + ' + ' + addend2 + ' = ' + sum;
}

La méthode console.log() peut faire l'affaire, mais les points d'arrêt peuvent accélérer le processus. Un point d'arrêt vous permet de suspendre votre code au milieu de son exécution et d'examiner toutes les valeurs à ce moment-là. Les points d'arrêt présentent plusieurs avantages par rapport à la méthode console.log():

• Avec console.log(), vous devez ouvrir manuellement le code source, rechercher le code approprié, insérer les instructions console.log(), puis actualiser la page pour afficher les messages dans la console. Avec les points d'arrêt, vous pouvez suspendre le code pertinent sans même savoir comment il est structuré.
• Dans vos instructions console.log(), vous devez spécifier explicitement chaque valeur que vous souhaitez inspecter. Avec les points d'arrêt, DevTools affiche les valeurs de toutes les variables à ce moment-là. Parfois, des variables affectent votre code sans que vous en soyez conscient.

En résumé, les points d'arrêt peuvent vous aider à trouver et à corriger les bugs plus rapidement que la méthode console.log().

Si vous prenez du recul et réfléchissez au fonctionnement de l'application, vous pouvez supposer que la somme incorrecte (5 + 1 = 51) est calculée dans l'écouteur d'événement click associé au bouton Ajouter le nombre 1 et le nombre 2. Par conséquent, vous souhaitez probablement suspendre le code au moment où l'écouteur click s'exécute. Les points d'arrêt de l'écouteur d'événements vous permettent de le faire:

1. Dans la section Débogueur, cliquez sur Points d'arrêt de l'écouteur d'événements pour développer la section. Les outils de développement affichent une liste de catégories d'événements extensibles, telles que Animation et Presse-papiers.
2. À côté de la catégorie d'événement Souris, cliquez sur arrow_right Développer. Les outils de développement affichent une liste d'événements de souris, tels que click et mousedown. Une case à cocher s'affiche à côté de chaque événement.

3. Cochez la case click (Cliquer). DevTools est désormais configuré pour se mettre automatiquement en pause lorsque n'importe quel écouteur d'événement click s'exécute.

   

4. Dans la démonstration, cliquez à nouveau sur Ajouter le numéro 1 et le numéro 2. DevTools met en pause la démonstration et met en surbrillance une ligne de code dans le panneau Sources. Les outils de développement doivent être suspendus sur cette ligne de code:

   function onClick() {
   

   Si vous êtes suspendu sur une autre ligne de code, appuyez sur Resume (Reprendre) Resume Script Execution (Reprendre l'exécution du script) jusqu'à ce que vous soyez suspendu sur la ligne appropriée.

Les points d'arrêt de l'écouteur d'événements ne sont qu'un des nombreux types de points d'arrêt disponibles dans DevTools. Il est utile d'explorer tous les types, car chacun d'eux vous aide à déboguer différents scénarios le plus rapidement possible. Consultez Mettre en pause votre code avec des points d'arrêt pour savoir quand et comment utiliser chaque type.

Examiner le code

Un script qui s'exécute dans le mauvais ordre est une cause courante de bugs. L'exécution pas à pas de votre code vous permet de suivre l'exécution de votre code, ligne par ligne, et de déterminer exactement où il s'exécute dans un ordre différent de celui que vous attendiez. Essayez maintenant :

1. Dans le panneau Sources de DevTools, cliquez sur step_into Passer à l'appel de fonction suivant pour suivre l'exécution de la fonction onClick(), une ligne à la fois. DevTools met en surbrillance la ligne de code suivante:

   if (inputsAreEmpty()) {
   

2. Cliquez sur step_over Passer l'appel de fonction suivant.

   DevTools exécute inputsAreEmpty() sans y entrer. Notez que DevTools saute quelques lignes de code. En effet, inputsAreEmpty() a renvoyé la valeur "false", de sorte que le bloc de code de l'instruction if ne s'est pas exécuté.

Voilà l'idée de base de l'exécution du code. Si vous examinez le code dans get-started.js, vous pouvez voir que le bug se trouve probablement dans la fonction updateLabel(). Plutôt que d'examiner chaque ligne de code, vous pouvez utiliser un autre type de point d'arrêt pour suspendre le code plus près de l'emplacement probable du bug.

Définir un point d'arrêt sur une ligne de code

Les points d'arrêt sur une ligne de code sont le type de point d'arrêt le plus courant. Lorsque vous avez une ligne de code spécifique sur laquelle vous souhaitez suspendre l'exécution, utilisez un point d'arrêt de ligne de code:

1. Examinez la dernière ligne de code de updateLabel():

   label.textContent = addend1 + ' + ' + addend2 + ' = ' + sum;
   

2. À gauche du code, vous pouvez voir le numéro de ligne de cette ligne de code spécifique, qui est 32. Cliquez sur 32. Les outils de développement affichent une icône bleue au-dessus de 32. Cela signifie qu'il existe un point d'arrêt sur cette ligne de code. DevTools s'arrête désormais toujours avant l'exécution de cette ligne de code.

3. Cliquez sur resume (Réactiver) Resume script execution (Reprendre l'exécution du script). Le script continue de s'exécuter jusqu'à la ligne 32. Sur les lignes 29, 30 et 31, les outils pour les développeurs affichent les valeurs de addend1, addend2 et sum en ligne à côté de leurs déclarations.

Dans cet exemple, DevTools s'arrête au point d'arrêt de la ligne de code sur la ligne 32.

Vérifier les valeurs des variables

Les valeurs de addend1, addend2 et sum semblent suspectes. Elles sont entourées de guillemets, ce qui signifie qu'elles sont des chaînes. Il s'agit d'une bonne hypothèse pour expliquer la cause du bug. Il est maintenant temps de recueillir plus d'informations. DevTools fournit de nombreux outils pour examiner les valeurs des variables.

Méthode 1: Examiner le champ d'application

Lorsque vous êtes arrêté sur une ligne de code, l'onglet Champ d'application indique les variables locales et globales définies à ce stade de l'exécution, ainsi que la valeur de chaque variable. Il affiche également les variables de fermeture, le cas échéant. Lorsque vous n'êtes pas arrêté sur une ligne de code, l'onglet Champ d'application est vide.

Double-cliquez sur la valeur d'une variable pour la modifier.

Méthode 2: Expressions de contrôle

L'onglet Surveiller vous permet de surveiller les valeurs des variables au fil du temps. Watch ne se limite pas aux variables. Vous pouvez stocker n'importe quelle expression JavaScript valide dans l'onglet Watch (Regarder).

Essayez maintenant :

1. Cliquez sur l'onglet Regarder.
2. Cliquez sur Ajouter Ajouter une expression de contrôle.
3. Tapez typeof sum.
4. Appuyez sur Entrée. Les outils de développement affichent typeof sum: "string". La valeur à droite du deux-points correspond au résultat de votre expression.

Cette capture d'écran montre l'onglet Watch (Regarder) (en bas à droite) après avoir créé l'expression de surveillance typeof sum.

Comme prévu, sum est évalué en tant que chaîne, alors qu'il devrait être un nombre. Vous avez maintenant confirmé que c'est la cause du bug.

Méthode 3: Console

En plus d'afficher les messages console.log(), vous pouvez également utiliser la console pour évaluer des instructions JavaScript arbitraires. En termes de débogage, vous pouvez utiliser la console pour tester les correctifs potentiels des bugs. Essayez maintenant :

1. Si le panneau de la console n'est pas ouvert, appuyez sur Échap pour l'ouvrir. Il s'ouvre en bas de la fenêtre "Outils de développement".
2. Dans la console, saisissez parseInt(addend1) + parseInt(addend2). Cette instruction fonctionne, car vous êtes arrêté sur une ligne de code où addend1 et addend2 sont en portée.
3. Appuyez sur Entrée. DevTools évalue l'instruction et affiche 6, qui est le résultat attendu de la démonstration.

Cette capture d'écran montre le panneau de la console après l'évaluation de parseInt(addend1) + parseInt(addend2).

Appliquer une correction

Vous avez trouvé un correctif pour le bug. Il ne vous reste plus qu'à tester votre correction en modifiant le code et en redémarrant la démonstration. Vous n'avez pas besoin de quitter DevTools pour appliquer le correctif. Vous pouvez modifier le code JavaScript directement dans l'interface utilisateur de DevTools. Essayez maintenant :

1. Cliquez sur resume (Réactiver) Resume script execution (Reprendre l'exécution du script).
2. Dans l'Éditeur de code, remplacez la ligne 31, var sum = addend1 + addend2, par var sum = parseInt(addend1) + parseInt(addend2).
3. Appuyez sur Commande+S (Mac) ou Ctrl+S (Windows, Linux) pour enregistrer la modification.
4. Cliquez sur label_off Désactiver les points d'arrêt. Il devient bleu pour indiquer qu'il est actif. Lorsque ce paramètre est défini, DevTools ignore tous les points d'arrêt que vous avez définis.
5. Essayez la démonstration avec différentes valeurs. La démo calcule désormais correctement.

Étapes suivantes

Ce tutoriel ne vous a montré que deux façons de définir des points d'arrêt. DevTools propose de nombreuses autres méthodes, y compris les suivantes:

• Points d'arrêt conditionnels qui ne sont déclenchés que lorsque la condition que vous fournissez est vraie.
• Points d'arrêt sur les exceptions interceptées ou non.
• Points d'arrêt XHR déclenchés lorsque l'URL demandée correspond à une sous-chaîne que vous fournissez.

Consultez Mettre en pause votre code à l'aide de points d'arrêt pour savoir quand et comment utiliser chaque type.

Certaines commandes de pas de code n'ont pas été expliquées dans ce tutoriel. Pour en savoir plus, consultez Ignorer une ligne de code.