Cómo depurar una aplicación Node.js con VSCode, Docker y su terminal

En este artículo, veremos algunas herramientas poderosas para ayudarlo a encontrar y corregir errores usando VSCode, Docker y su terminal. También aprenderemos (y pondremos en práctica) las 6 formas de depurar una aplicación Node.js.

¿Puedes adivinar cuáles son las 6 formas posibles de depurar una aplicación Node.js? Una de las prácticas más comunes en la vida de todo desarrollador consiste en encontrar errores rápidamente y comprender lo que sucede en sus aplicaciones.

La mayoría de los ejemplos que se muestran aquí usarán Node.js, pero también puede usarlos en sus aplicaciones de front-end de JavaScript. Puede usar otros editores o IDE como Visual Studio o Web Storm, pero en esta publicación usaré VSCode. Simplemente tome lo que aprenda aquí y aplíquelo en el editor que elija.

Al final de esta publicación, habrá aprendido cómo inspeccionar sus aplicaciones utilizando las siguientes herramientas:

  • Node.js Read-Eval-Print-Loop (REPL)
  • Navegador
  • Estibador
  • VSCode y entorno local
  • VSCode y Docker
  • VSCode y entorno remoto

Requisitos

En los siguientes pasos, creará una API web con Node.js y depurará su aplicación con VSCode y Docker. Antes de comenzar a codificar, asegúrese de tener las siguientes herramientas instaladas en su máquina:

  • Estibador
  • Node.js v14
  • VSCode

Introducción

Si ha trabajado como desarrollador durante un tiempo, es posible que sepa que no es como en las películas. De hecho, los desarrolladores deberían dedicar el 80% de su trabajo a pensar y solo el 20% a escribir código.

Pero en realidad, la mayor parte de ese 80% se gasta en resolver problemas, corregir errores y tratar de entender cómo evitar más problemas. Los viernes por la noche pueden verse como el siguiente gif:

codificación del desarrollador cuando todo sale mal

Cuando me doy cuenta de que ha ocurrido algo extraño en mi trabajo, trato de hacer algunas preguntas, como verá en las siguientes secciones.

¿Fue un error de ortografía?

En este caso, el problema puede estar relacionado con alguna función o variable que estoy intentando llamar. La consola me mostrará dónde está el error y una breve posible razón para generar el error, como se muestra en la impresión a continuación:

¿Es este comportamiento algo que debería funcionar con la implementación actual?

Podría ser una declaración if que no ha evaluado mis condiciones o incluso un bucle que debería detenerse después de ciertas interacciones, pero no se detiene.

¿Que esta pasando aqui?

En este caso, podría ser un error interno o algo que nunca antes había visto. Así que busco en Google para averiguar qué ha sucedido en mi aplicación.

Como ejemplo, la siguiente imagen muestra un error de transmisión interno de Node.js que no muestra lo que hice mal en mi programa.

Depurar lenguajes basados ​​en secuencias de comandos

Por lo general, los desarrolladores de lenguajes basados ​​en secuencias de comandos como Ruby, Python o JavaScript no necesitan utilizar IDE como Visual Studio, WebStorm, etc.

En cambio, a menudo optan por utilizar editores ligeros como Sublime Text, VSCode, VIM y otros. La siguiente imagen muestra una práctica común para inspeccionar y "depurar" aplicaciones. Imprimen declaraciones para verificar los estados y valores de la aplicación.

Empezando

La práctica que analizamos en la sección anterior no es tan productiva como podría ser. Podemos confundir nombres de texto con valores, imprimir variables incorrectas y perder tiempo en errores simples o errores ortográficos. En las siguientes secciones, le mostraré otras formas de mejorar su búsqueda de errores y validaciones de declaraciones.

El objetivo principal aquí es mostrar lo simple que puede ser depurar una aplicación. Al usar las herramientas más comunes, podrá inspeccionar el código desde simples comandos de terminal hasta máquinas remotas de todo el mundo.

Creando el proyecto de muestra

Antes de sumergirnos en los conceptos de depuración, debe crear una aplicación para inspeccionar. Entonces, primero, cree una API web utilizando el módulo HTTP nativo de Node.js. La API debe obtener todos los campos de la solicitud, sumar todos los valores de la misma y luego responder al solicitante con los resultados calculados.

Elija una carpeta vacía en su máquina y comencemos con la API web.

Primero, cree un Math.jsarchivo que será responsable de sumar todos los campos de un Objeto JavaScript:

//Math.js module.exports = { sum(...args) { return args.reduce( (prev, next) => Number(prev) + Number(next), 0 ) } } 

En segundo lugar, cree un archivo de servidor Node.js utilizando el siguiente código. Copie el valor y cree su archivo, luego péguelo allí. Voy a explicar lo que está sucediendo allí más tarde.

Tenga en cuenta que esta API es una API impulsada por eventos y manejará las solicitudes mediante el enfoque de Node.js Streams.

//server.js const Http = require('http') const PORT = 3000 const { promisify } = require('util') const { pipeline } = require('stream') const pipelineAsync = promisify(pipeline) const { sum } = require('./Math') let counter = 0 Http.createServer(async (req, res) => { try { await pipelineAsync( req, async function * (source) { source.setEncoding('utf8') for await (const body of source) { console.log(`[${++counter}] - request!`, body) const item = JSON.parse(body) const result = sum(...Object.values(item)) yield `Result: ${result}` } }, res ) } catch (error) { console.log('Error!!', error) } }) .listen(PORT, () => console.log('server running at', PORT)) 

Bien, eso puede parecer un código inusual para una API web simple. Déjame explicarte lo que está pasando.

Como alternativa, esta API se basa en Node.js Streams . Por lo tanto, leerá los datos a pedido de las solicitudes de ingresos , los procesará y responderá utilizando el objeto de respuesta .

On line (11) there is a pipeline function that will manage the event flow. If something goes wrong in any stream function, it will throw an exception and we'll handle errors on the catch statement from try/catch.

On line (6) we are importing the sum function from the Math module and then processing incoming data on line (19). Notice that on (19) there is an Object.valuesfunction which will spread all object values and return them as an array. For example, an object {v1: 10, v2: 20} will be parsed to [10, 20] .

Running

If you have a Unix based system you can use the cURL command, which is a native command to make Web requests. If you're working on the Windows Operating system, you can use Windows Subsystem for Linux or Git bash to execute Unix instructions.

Create a run.sh file with the following code. You'll create code to request your API. If you're familiar with Postman you can skip this file and execute from there.

curl -i \ -X POST \ -d '{"valor1": "120", "valor2": "10"}' \ //localhost:3000

Note that youneed to install Node.js version 14 or higher.

You'll need to open two terminal sessions. On mine, I spliced two terminals in my VSCode instance. On the left run node server.js and on the right run bash run.sh as follows:

Debugging using Node.js Read-Eval-Print-Loop (REPL)

Node.js can help you create the best application possible. REPL is a mechanism for debugging and inspecting Node.js applications from the terminal. When you add the inspect flag after the node command, the program will stop right on the first code line as shown below:

First, you'll write the debugger keyword right after the counter's console.log on line (17) and then execute node inspect server.js again.

Note that you can interact with the REPL APIby using the commands listed in the official documentation.

In the next image, you'll see a practical example of how REPL works using some of the following commands:

  1. list(100): shows the first 100 lines of code
  2. setBreakpoint(17): sets a breakpoint on the 17th line
  3. clearBreakpoint(17): removes a breakpoint on the 17th line
  4. exec body: evaluates the body variable and prints out its result
  5. cont: continues the program's execution

The image below shows in practice how it works:

I highly recommend that you try using the watch statement. As in the browser, you can watch statements on demand. In your REPL session write watch(counter) and then cont.

To test the watch you need to choose a breakpoint – use setBreakpoint(line) for it. As you run run.sh, the program will stop on your breakpoint and show the watchers. You may see the following result on your console:

Debugging using Chromium-based browsers

Debugging in the browser is more common than debugging from terminal sessions. Instead of stopping the code on the first line, the program will continue its execution right before its initialization.

Run node --inspect server.js  and then go to the browser. Open the DevTools menu (pressing F12 opens the DevToolson most browsers). Then the Node.js icon will appear. Click on it. Then, in the Sources section you can select the file you want to debug as shown in the image below:

Debugging in VSCode

Going back and forth to the browser isn't really that fun as long as you write code in an editor. The best experience is to run and debug code in the same place.

But it's not magic. You configure and specify which is the main file. Let's configure it following the steps below:

  1. You'll need to open the launch.json file. You can open it by pressing Ctrl + Shift + P or Command + Shift + P on macOS, then writing launch. Choose the Debug: Open launch.json option. Additionally, you can press F5 and it might open the file as well.
  2. In the next step of the wizard, click on the Node.js option.
  3. You may have seen a JSON file on the editor with the pre-configuration for debugging. Fill in the program field with your filename – this tells VSCode which is the main file. Notice that there is a ${workspaceFolder} symbol. I wrote it to specify that the file is in the current folder I'm working on:
{ "version": "0.2.0", "configurations": [ { "type": "node", "request": "launch", "name": "Launch Program", "skipFiles": [ "/**" ], "program": "${workspaceFolder}/server.js" } ] }

Almost there! Go to the source code on server.js and set a breakpoint on the 16th line by clicking on the left side of the code line indicator. Run it by pressing F5 and trigger the server.js using the run.sh, whichwill show the following output:

Debugging Docker-based applications

I personally love using Docker. It helps us stay as close as possible to the production environment while isolating dependencies in a receipt file.

If you want to use Docker you need to configure it in a Docker config file. Copy the code below, and create a new file beside the server.js and paste it in.

FROM node:14-alpine ADD . . CMD node --inspect=0.0.0.0 server.js

First, you'll need to execute the Docker build command on your folder to build the app running docker build -t app . . Second, you'll need to expose the debug port (9229) and the server port (3000) so either the browser or VSCode can watch it and attach a debugger statement.

docker run \ -p 3000:3000 \ -p 9229:9229 \ app

If you run the run.sh, file again, it should request the server which is running on Docker.

Debugging Docker apps on VSCode is not a tough task. You need to change the configuration to attach a debugger on a remote root. Replace your launch.json file with the code below:

{ "configurations": [ { "type": "node", "request": "attach", "name": "Docker: Attach to Node", "remoteRoot": "${workspaceFolder}", "localRoot": "${workspaceFolder}" } ] }

As long as your app is running on Docker and exposing the default debug port (9229) the configuration above will link the app to the current directory. Running F5 and triggering the app will have the same outcome as running locally.

Debugging remote code using VSCode

Remote debugging is exciting! You should keep in mind a few concepts before starting to code:

  1. What's is the IP Address of the target?
  2. How is the remote working directory set up?

I'll change my launch.json file and add the remote address. I have another PC at home which is connected to the same network. Its IP address is 192.168.15.12.

Also, I have the Windows Machine's working directory here: c://Users/Ana/Desktop/remote-vscode/.

The macOS is based on Unix systems so the folder structure is different than on my Windows machine. The directory structure mapping must change to /Users/Ana/Desktop/remote-vscode/.

{ "version": "0.2.0", "configurations": [ { "type": "node", "request": "attach", "name": "Attach to Remote", "address": "192.168.15.12", "port": 9229, "localRoot": "${workspaceFolder}", "remoteRoot": "/Users/Ana/Desktop/remote-vscode/", "trace": true, "sourceMaps": true, "skipFiles": [ "/**" ] } ] }

In this particular case, you'll need at least two different machines to test it. I made a short video showing how it works in practice below:

Stop using console.log for debugging!

My tip for you today is about being lazy for manual stuff. Learn one new shortcut or tool per day to improve productivity. Learn more about the tools you've been working on every day and it will help you spend more time thinking than coding.

In this post, you saw how VSCode can be a helpful tool for debugging apps. And VSCode was just an example. Use whatever is most comfortable for you. If you follow these tips, the sky is the ?

Thank you for reading

Realmente aprecio el tiempo que pasamos juntos. Espero que este contenido sea más que solo texto. Espero que te haya convertido en un mejor pensador y también en un mejor programador. Sígueme en Twitter y echa un vistazo a mi blog personal donde comparto todo mi contenido valioso.

¡Nos vemos! ?