Débogage d’un Asset compute Worker

Les objets Worker Asset compute peuvent être débogués de plusieurs façons, depuis des instructions de journal de débogage simples, jusqu’au code VS joint en tant que débogueur distant, jusqu’à l’extraction des journaux pour les activations dans Adobe I/O Runtime initiée à partir d’AEM en tant que Cloud Service.

Journalisation

La forme la plus élémentaire de débogage des objets Worker Asset compute utilise les instructions console.log(..) traditionnelles dans le code du programme de travail. L’objet JavaScript console est un objet global implicite. Il n’est donc pas nécessaire de l’importer ni de l’exiger, car il est toujours présent dans tous les contextes.

Ces instructions de journal peuvent être examinées différemment selon la manière dont le programme de travail d’Asset compute est exécuté :

• À partir de aio app run, consigne l’impression en sortie standard et les journaux d’activation de l’outil de développement
  
• À partir de aio app test, consigne l’impression sur /build/test-results/test-worker/test.log
  
• À l’aide de wskdebug, consigne les instructions imprimées dans la console de débogage du code VS (Vue > Console de débogage), en standard
  
• À l’aide de aio app logs, les instructions du journal sont imprimées dans la sortie du journal d’activation.

Débogage à distance via le débogueur joint

Le module npm wskdebug prend en charge l’association d’un débogueur aux objets Worker Asset compute, notamment la possibilité de définir des points d’arrêt dans VS Code et de parcourir le code.

Clic publicitaire de débogage d’un objet Worker Asset compute à l’aide de wskdebug (pas d’audio)

1. Vérifiez que les modules npm wskdebug et ngrok et npm sont installés.

2. Vérifiez que Docker Desktop et les images Docker prises en charge sont installés et en cours d’exécution.

3. Fermez toutes les instances principales de l’outil de développement.

4. Déployez le code le plus récent à l’aide de aio app deploy et enregistrez le nom de l’action déployée (nom entre [...]). Elle sera utilisée pour mettre à jour launch.json à l’étape 8.

   ℹ Info: Deploying package [wkndAemAssetCompute-0.0.1]...
   

5. Démarrez une nouvelle instance de l’outil de développement d’Asset compute à l’aide de la commande npx adobe-asset-compute devtool

6. Dans VS Code, appuyez sur l’icône Débogage dans le volet de navigation de gauche.

   • Si vous y êtes invité, appuyez sur créer un fichier launch.json > Node.js pour créer un fichier launch.json.
   • Sinon, appuyez sur l’icône Engrenage à droite du menu déroulant Lancer le programme pour ouvrir la balise launch.json existante dans l’éditeur.

7. Ajoutez la configuration d’objet JSON suivante au tableau configurations :

   {
       "type": "pwa-node",
       "request": "launch",
       "name": "wskdebug",
       "attachSimplePort": 0,
       "runtimeExecutable": "wskdebug",
       "args": [
           "wkndAemAssetCompute-0.0.1/__secured_worker",  // Version must match your Asset Compute worker's version
           "${workspaceFolder}/actions/worker/index.js",  // Points to your worker
           "-l",
           "--ngrok"
       ],
       "localRoot": "${workspaceFolder}",
       "remoteRoot": "/code",
       "outputCapture": "std",
       "timeout": 30000
   }
   

8. Sélectionnez le nouveau wskdebug dans la liste déroulante.

9. Appuyez sur le bouton vert Exécuter à gauche de la liste déroulante wskdebug .

10. Ouvrez /actions/worker/index.js et appuyez à gauche des numéros de ligne pour ajouter les points de rupture 1. Accédez à la fenêtre du navigateur Web de l’outil de développement Asset compute ouverte à l’étape 6.

11. Appuyez sur le bouton Exécuter pour exécuter le programme de travail.

12. Revenez au code VS, à /actions/worker/index.js et parcourez le code.

13. Pour quitter l’outil de développement débogage, appuyez sur Ctrl-C dans le terminal qui a exécuté la commande npx adobe-asset-compute devtool à l’étape 6.

Accès aux journaux à partir de Adobe I/O Runtime

AEM en tant que Cloud Service exploite les objets Worker d’Asset compute via les profils de traitement en les appelant directement dans Adobe I/O Runtime. Comme ces appels n’impliquent pas de développement local, leurs exécutions ne peuvent pas être déboguées à l’aide d’outils locaux tels que l’outil de développement d’Asset compute ou wskdebug. Au lieu de cela, l’interface de ligne de commande de l’Adobe I/O peut être utilisée pour récupérer les journaux du programme de travail exécuté dans un espace de travail particulier de Adobe I/O Runtime.

1. Vérifiez que les variables d’environnement spécifiques à l’espace de travail sont définies via AIO_runtime_namespace et AIO_runtime_auth, en fonction de l’espace de travail nécessitant un débogage.

2. Sur la ligne de commande, exécutez aio app logs

   • Si l’espace de travail génère un trafic important, développez le nombre de journaux d’activation à l’aide de l’indicateur --limit :

     $ aio app logs --limit=25

3. Les journaux d’activation les plus récents (jusqu’aux --limit fournis) seront renvoyés comme sortie de la commande pour révision.

   

Résolution des problèmes

• Debugger ne se joint pas
• Points d’arrêt en pause
• Débogueur de code VS non joint
• Débogueur VS Code attaché après le début de l’exécution du programme de travail
• Le traitement expire lors du débogage
• Impossible d’arrêter le processus de débogage