Как да отстраните грешки в приложение 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 , който не е оценил условията ми или дори цикъл, който трябва да спре след определени взаимодействия, но не спира.

Какво става тук?

В този случай това може да е вътрешна грешка или нещо, което никога досега не съм виждал. Затова го потърся в Google, за да разбера какво се е случило в моето приложение.

Като пример, изображението по-долу показва вътрешна грешка в потока Node.js, която не показва какво съм сгрешил в програмата си.

Отстраняване на грешки базирани на скриптове езици

Обикновено разработчиците от базирани на скриптове езици като Ruby, Python или JavaScript не трябва да използват IDE като 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 и разгледайте личния ми блог, където споделям цялото си ценно съдържание.

Ще се видим! ?