JS Code Coverage Debug

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 4 minutes de lecture
  • L’application JS Code Coverage Debug permet aux administrateurs et aux développeurs d’applications de consigner les scripts déclenchés au cours d’une session utilisateur, puis d’examiner les lignes de code exécutées par le système.

    Les utilisateurs disposant du rôle js_coverage_debugger peuvent déboguer des scripts sans avoir à définir de points d’arrêt ou à examiner les messages de débogage à l’écran. Au lieu de cela, le système enregistre les données d’utilisation de script dans la table Couverture du code JavaScript [sys_js_code_coverage]. Chaque enregistrement de couverture de code JavaScript contient :
    • Session utilisateur qui a appelé le script.
    • Enregistrement de script que le système a appelé Identifié par table, sys_id et champ de script.
    • Enregistrement de script que le système appelé a identifié par type et par nom.
    • Transaction qui a appelé le script.
    • Heure de début de la transaction.
    • Contenu du champ de script mis en surbrillance pour indiquer les lignes exécutées par le système.
    Figure 1. Mise en surbrillance de la couverture d’exemple de code
    Mise en surbrillance de la couverture d’exemple de code

    Mise en surbrillance de la couverture du Code JS

    L’application Couverture du code JS met en surbrillance les champs de script pour indiquer si le système a exécuté ou ignoré chaque ligne.

    Figure 2. Mise en surbrillance d’un exemple de code
    Mise en surbrillance d’un exemple de code

    La couleur du surlignage indique comment le système a évalué la ligne de code.

    Tableau 1. Signification de la mise en surbrillance du code
    Couleur de surlignage Signification
    Vert Il s’agit d’une ligne de code exécutable que le système a exécutée pendant la session.
    Rouge Il s’agit d’une ligne de code exécutable que le système a ignorée pour une raison quelconque. Le système a peut-être ignoré une ligne de code exécutable parce que les conditions de script nécessaires n’étaient pas remplies ou parce que la fonction de script n’a jamais été appelée. Vous pouvez utiliser l’option Débogueur de script pour déterminer pourquoi le système a ignoré la ligne de code exécutable.
    Gris Il s’agit d’une ligne de code non exécutable telle qu’un espace blanc, un commentaire de code ou une partie d’une expression répartie sur plusieurs lignes qui ne peut pas s’exécuter seule.

    Les administrateurs et les développeurs d’applications peuvent utiliser ces informations pour effectuer des activités de débogage plus ciblées, telles que l’utilisation de la commande pour déterminer pourquoi les conditions de Débogueur de script script ne sont pas remplies.

    Activer JS Code Coverage Debug

    Vous pouvez activer le module d’extension JS Code Coverage Debug (com.glide.js.coverage) si vous disposez du rôle administrateur.

    Avant de commencer

    Rôle requis : admin

    Procédure

    1. Accédez à la Tout > Applications système > Toutes les applications disponibles > Tout.
    2. Trouvez le module d'extension à l'aide des critères de filtre et de la barre de recherche.

      Vous pouvez rechercher le module d'extension par son nom ou son ID. Si vous ne trouvez pas le module d'extension souhaité, vous devrez peut-être le demander au personnel ServiceNow.

    3. Cliquez sur Installer, puis sur Activer dans la boîte de dialogue Activer le module d'extension.
      Remarque :
      Lorsque Séparation de domaine et l'administrateur délégué sont activés dans une instance, l'utilisateur administratif doit être dans le domaine global. Sinon, l'erreur suivante s'affiche : L'installation de l'application n'est pas disponible, car une autre opération est en cours d'exécution : activation du module d'extension pour <plugin name>.

    Que faire ensuite

    Pour afficher les composants que le module d’extension a installés, actualisez le formulaire du module d’extension et sélectionnez la liste connexe Fichiers de module d’extension .

    Déboguer avec JS Code Coverage Debug

    Permet JS Code Coverage Debug d’enregistrer une session utilisateur, puis d’examiner les scripts et les lignes de code exécutés par le système.

    Avant de commencer

    Rôle requis : admin ou js_coverage_debugger

    Procédure

    1. Accédez à la Tous > Débogage de la couverture du Code JS > Activer la couverture.
      Le système consigne les scripts et les lignes de code exécutés par le système, et affiche les messages de débogage de session dans l’espace de noms Couverture du code JS.
      Déboguer avec une couverture de code
    2. Accédez à la table ou à la page dont vous souhaitez tester la logique.
      Par exemple, accédez à Incident > Créer.
    3. Déclenchez le ou les scripts que vous souhaitez tester.
      Par exemple, créez un incident avec un élément CI associé pour tester plusieurs règles métier.
    4. Lorsque vous avez terminé le test, accédez à Débogage de la couverture du Code JS > Désactiver la couverture.
      Le système arrête de consigner l’exécution du script et des lignes de code.
    5. Accédez à la Débogage de la couverture du Code JS > Données de couverture.
      Le système affiche la liste des données de couverture associées à la session utilisateur actuelle.
      Exemple de code JavaScript Enregistrements de couverture
    6. Sélectionnez le script ou la transaction que vous souhaitez examiner.
      Tableau 2. Champs de couverture du code JavaScript
      Champ Description
      Nom du script Affiche le script exécuté par nom de table, valeur de sys_id et champ de script.
      Référence de script Affiche le script exécuté par type de script et par nom.
      Nom de la transaction Affiche la transaction qui a appelé le script par ID de thread et URI.
      Par exemple, sélectionnez la règle métier Référence de script : événements d’incident.
      Le système affiche l’enregistrement JS Code Coverage Debug .
      Section de débogage de la couverture du code JS
    7. Examinez le champ Script pour déterminer les lignes de code exécutées par le système.
      Par exemple, la règle métier a ajouté l’événement incident.insert à la file d’attente d’événements.

    Résultats

    Vous déterminez les lignes de code exécutées par le système.

    Que faire ensuite

    Utilisez les informations sur la couverture du code pour effectuer des activités de débogage plus ciblées, telles que la définition de points d’arrêt et l’examen des valeurs des variables avec le Débogueur de scriptfichier .