Як налагодити програму Node.js за допомогою VSCode, Docker та вашого терміналу

У цій статті ми розглянемо кілька потужних інструментів, які допоможуть вам знайти та виправити помилки за допомогою VSCode, Docker та вашого терміналу. Ми також вивчимо (і застосуємо на практиці) 6 способів налагодження програми Node.js.

Чи можете ви здогадатися, які 6 можливих способів налагодження програми Node.js? Одна з найпоширеніших практик у житті кожного розробника полягає у швидкому пошуку помилок та розумінні того, що відбувається в їх додатках.

Більшість прикладів, показаних тут, використовуватимуть Node.js, але ви також можете використовувати їх у своїх інтерфейсних програмах JavaScript. Ви можете використовувати інші редактори або IDE, такі як Visual Studio або Web Storm, але в цій публікації я буду використовувати VSCode. Просто візьміть те, що ви дізнаєтесь тут, і застосуйте у вибраному редакторі.

Наприкінці цього допису ви дізнаєтесь, як перевіряти свої програми, використовуючи такі інструменти:

  • Node.js Read-Eval-Print-Loop (REPL)
  • Браузер
  • Докер
  • VSCode і локальне середовище
  • VSCode & Docker
  • VSCode і віддалене середовище

Вимоги

На наступних кроках ви створите веб-API за допомогою Node.js та налагодите свою програму за допомогою VSCode та Docker. Перед початком кодування переконайтеся, що на вашому комп'ютері встановлені такі інструменти:

  • Докер
  • Node.js v14
  • VSCode

Вступ

Якщо ви деякий час працювали розробником, ви могли б знати, що це не так, як у фільмах. Насправді розробники повинні витратити 80% своєї роботи на роздуми і лише 20% на написання коду.

Але насправді більшість із цих 80% витрачається на вирішення проблем, виправлення помилок та спроби зрозуміти, як уникнути подальших проблем. В п’ятницю ввечері може виглядати gif нижче:

кодування розробника, коли все йде не так

Коли я усвідомлюю, що на моїй роботі сталося щось дивне, я намагаюся задати кілька запитань, як ви побачите в наступних наступних розділах.

Це була орфографічна помилка?

У цьому випадку проблема може бути в якійсь функції або змінній, яку я намагаюся викликати. Консоль покаже мені, де знаходиться помилка, та коротку можливу причину виникнення помилки, як показано на роздруківці нижче:

Чи є ця поведінка чимось, що повинно працювати у поточній реалізації?

Це може бути оператор if , який не оцінив мої умови, або навіть цикл, який повинен зупинитися після певних взаємодій, але не зупиняється.

Що тут відбувається?

У цьому випадку це може бути внутрішня помилка або щось таке, чого я ніколи раніше не бачив. Тож я гуглюю, щоб з’ясувати, що сталося з моєю програмою.

Як приклад, на малюнку нижче показано внутрішню помилку потоку Node.js, яка не показує, що я зробив неправильно у своїй програмі.

Налагодження мов на основі сценаріїв

Зазвичай розробникам мов на основі сценаріїв, таких як Ruby, Python або JavaScript, не потрібно використовувати середовища розробки, такі як Visual Studio, WebStorm тощо.

Натомість вони часто обирають використовувати легкі редактори, такі як Sublime Text, VSCode, VIM та інші. На зображенні нижче показано загальну практику перевірки та "налагодження" програм. Вони роздруковують оператори для перевірки стану програми та значень.

Починаємо

Практика, яку ми розглядали в попередньому розділі, не така продуктивна, як могла б бути. Ми можемо переплутати імена тексту зі значеннями, роздрукувати неправильні змінні та витратити час на прості помилки чи орфографічні помилки. У наступних розділах я покажу вам інші способи покращення пошуку помилок та перевірки виписки.

Основна мета тут - показати, наскільки просто може бути налагодження програми. Використовуючи найпоширеніші інструменти, ви зможете перевіряти код від простих команд терміналів до віддалених машин з усього світу.

Створення зразкового проекту

Перш ніж ми заглибимося в концепції налагодження, вам слід створити програму для перевірки. Отже, спочатку створіть веб-API, використовуючи рідний HTTP-модуль Node.js '. API повинен отримати всі поля із запиту, підсумувати всі значення з нього, а потім відповісти запитувачеві з обчисленими результатами.

Виберіть порожню папку на своєму комп'ютері і давайте почнемо з веб-API.

Спочатку створіть Math.jsфайл, який відповідатиме за підсумовування всіх полів з об’єкта JavaScript:

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

По-друге, створіть файл сервера Node.js, використовуючи код нижче. Скопіюйте значення та створіть файл, а потім вставте його туди. Я збираюся пояснити, що там відбувається пізніше.

Зверніть увагу, що цей API - це API, керований подіями, і він буде обробляти запити, використовуючи підхід 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)) 

Добре, це може виглядати як незвичний код для простого веб-API. Дозвольте пояснити, що відбувається.

В якості альтернативи, цей API базується на Node.js Streams . Тож ви будете читати дані на вимогу із запитів на доходи , обробляти їх та відповідати на них за допомогою об’єкта відповіді .

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

Я дуже ціную час, який ми провели разом. Сподіваюсь, цей вміст буде не лише текстовим. Сподіваюся, це зробить вас кращим мислителем, а також кращим програмістом. Слідуйте за мною у Twitter та перегляньте мій особистий блог, де я ділюсь усім своїм цінним вмістом.

Побачимось! ?