Kako ispraviti pogreške u aplikaciji Node.js pomoću VSCode, Dockera i vašeg terminala

U ovom ćemo članku ući u neke moćne alate koji će vam pomoći pronaći i ispraviti pogreške pomoću VSCode, Dockera i vašeg terminala. Također ćemo naučiti (i primijeniti u praksi) 6 načina za otklanjanje pogrešaka u aplikaciji Node.js.

Možete li pogoditi koji su 6 mogućih načina otklanjanja pogrešaka u aplikaciji Node.js? Jedna od najčešćih praksi u životu svakog programera uključuje brzo pronalaženje bugova i razumijevanje što se događa u njihovim aplikacijama.

Većina ovdje prikazanih primjera koristit će Node.js, ali možete ih koristiti i na svojim JavaScript front-end aplikacijama. Možete koristiti druge uređivače ili IDE-je poput Visual Studija ili Web Storma, ali u ovom postu koristit ću VSCode. Samo uzmi ono što naučiš ovdje i primijeni u odabranom uredniku.

Na kraju ovog posta naučit ćete kako pregledavati svoje aplikacije pomoću sljedećih alata:

  • Node.js čitanje-ispisivanje-ispis-petlja (REPL)
  • Preglednik
  • Lučki radnik
  • VSCode i lokalno okruženje
  • VSCode i Docker
  • VSCode i udaljeno okruženje

Zahtjevi

U sljedećim koracima izradit ćete web API pomoću Node.js i otkloniti pogreške u aplikaciji pomoću VSCode i Docker. Prije nego što započnete s kodiranjem, provjerite imate li na svom računaru sljedeće alate:

  • Lučki radnik
  • Node.js v14
  • VSCode

Uvod

Ako već neko vrijeme radite kao programer, možda znate da to nije kao u filmovima. U stvari, programeri bi trebali trošiti 80% svog posla razmišljajući i samo 20% pišući kôd.

Ali u stvarnosti, većina od tih 80% potroši se na rješavanje problema, ispravljanje programskih pogrešaka i pokušaj razumijevanja kako izbjeći daljnje probleme. Petkom navečer mogao bi izgledati kao gif ispod:

kodiranje za programere kad sve krene po zlu

Kad shvatim da se na mom poslu dogodilo nešto čudno, pokušam postaviti nekoliko pitanja, kao što ćete vidjeti u sljedećim sljedećim odjeljcima.

Je li riječ o pravopisnoj pogrešci?

U ovom je slučaju problem možda u nekoj funkciji ili varijabli koju pokušavam nazvati. Konzola će mi pokazati gdje je pogreška i kratki mogući razlog za uklanjanje pogreške kao što je prikazano na donjem ispisu:

Je li ovo ponašanje nešto što bi trebalo raditi s trenutnom implementacijom?

To može biti if izjava koja nije procijenila moje uvjete ili čak petlja koja bi se trebala zaustaviti nakon određenih interakcija, ali se ne zaustavlja.

Što se ovdje događa?

U ovom slučaju to bi mogla biti interna pogreška ili nešto što nikada prije nisam vidio. Stoga ga guglam kako bih shvatio što se dogodilo u mojoj aplikaciji.

Kao primjer, donja slika prikazuje internu pogrešku streama Node.js koja ne pokazuje što sam pogriješio u svom programu.

Otklanjanje pogrešaka u jezicima koji se temelje na skriptama

Obično programeri iz skriptnih jezika kao što su Ruby, Python ili JavaScript ne trebaju koristiti IDE-ove kao što su Visual Studio, WebStorm itd.

Umjesto toga, često se odlučuju za upotrebu laganih urednika kao što su Sublime Text, VSCode, VIM i drugi. Slika u nastavku prikazuje uobičajenu praksu pregledavanja i uklanjanja pogrešaka u aplikacijama. Ispisuju izjave kako bi provjerili stanja i vrijednosti aplikacije.

Početak rada

Praksa koju smo pogledali u prethodnom odjeljku nije toliko produktivna koliko bi mogla biti. Imena teksta možemo pomiješati s vrijednostima, ispisati netočne varijable i gubiti vrijeme na jednostavne greške ili pravopisne pogreške. U sljedećim odjeljcima pokazat ću vam druge načine za poboljšanje pretraživanja grešaka i provjeru valjanosti izjava.

Glavni je cilj ovdje pokazati koliko jednostavno može biti ispravljanje pogrešaka u aplikaciji. Korištenjem najčešćih alata moći ćete pregledati kod od jednostavnih naredbi terminala do udaljenih strojeva iz cijelog svijeta.

Izrada uzorka projekta

Prije nego što uđemo u koncepte otklanjanja pogrešaka, trebali biste stvoriti aplikaciju za inspekciju. Dakle, prvo stvorite web API koristeći izvorni Node.js 'HTTP modul. API bi trebao dobiti sva polja iz zahtjeva, zbrojiti sve vrijednosti iz njega, a zatim odgovoriti podnositelju zahtjeva s izračunatim rezultatima.

Odaberite praznu mapu na vašem stroju i krenimo s web API-jem.

Prvo stvorite Math.jsdatoteku koja će biti odgovorna za sažimanje svih polja iz JavaScript objekta:

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

Drugo, stvorite datoteku poslužitelja Node.js pomoću donjeg koda. Kopirajte vrijednost i izradite datoteku, a zatim je tamo zalijepite. Kasnije ću objasniti što se tamo događa.

Primijetite da je ovaj API API koji upravlja događajima i da će obrađivati ​​zahtjeve pomoću pristupa 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)) 

U redu, to može izgledati kao neobičan kod za jednostavni web API. Dopustite mi da objasnim što se događa.

Kao alternativa, ovaj se API temelji na Node.js Streams . Tako ćete čitati podatke na zahtjev iz zahtjeva za prihodom , obrađivati ​​ih i odgovarati na njih pomoću objekta odgovora .

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

Zaista cijenim vrijeme koje smo proveli zajedno. Nadam se da će ovaj sadržaj biti više od pukog teksta. Nadam se da će vas to učiniti boljim misliocem i također boljim programerom. Slijedite me na Twitteru i pogledajte moj osobni blog na kojem dijelim sav svoj dragocjeni sadržaj.

Vidimo se! ?