Kaip derinti „Node.js“ programą naudojant „VSCode“, „Docker“ ir jūsų terminalą

Šiame straipsnyje aptarsime keletą galingų įrankių, kurie padės rasti ir pašalinti klaidas naudojant „VSCode“, „Docker“ ir jūsų terminalą. Taip pat sužinosime (ir pritaikysime) 6 būdus derinti „Node.js“ programą.

Ar galite atspėti, kokie yra 6 galimi „Node.js“ programos derinimo būdai? Viena iš dažniausiai pasitaikančių praktikų kiekvieno kūrėjo gyvenime - greitai surasti klaidas ir suprasti, kas vyksta jų programose.

Daugumoje čia pateiktų pavyzdžių bus naudojamas „Node.js“, tačiau juos taip pat galėsite naudoti „JavaScript“ sąsajos programose. Galite naudoti kitus redaktorius ar IDE, pvz., „Visual Studio“ ar „Web Storm“, tačiau šiame įraše naudosiu VSCode. Tiesiog paimkite tai, ko išmokote čia, ir pritaikykite pasirinktame redaktoriuje.

Šio įrašo pabaigoje jūs sužinosite, kaip patikrinti savo programas naudojant šiuos įrankius:

  • „Node.js“ skaitymo, įvertinimo ir spausdinimo ciklas (REPL)
  • Naršyklė
  • Dokeris
  • VSCode ir vietinė aplinka
  • „VSCode“ ir „Docker“
  • VSCode ir nuotolinė aplinka

Reikalavimai

Atlikdami kitus veiksmus, naudodami „Node.js“ sukursite žiniatinklio API ir derinsite programą naudodami „VSCode“ ir „Docker“. Prieš pradėdami koduoti, įsitikinkite, kad jūsų kompiuteryje įdiegti šie įrankiai:

  • Dokeris
  • „Node.js“ v14
  • VSCode

Įvadas

Jei kurį laiką dirbote kūrėju, galite žinoti, kad ne taip, kaip yra filmuose. Iš tikrųjų kūrėjai turėtų praleisti 80% savo darbo mąstydami ir tik 20% rašydami kodą.

Tačiau iš tikrųjų didžioji dalis šių 80% išleidžiama problemoms spręsti, klaidoms taisyti ir bandyti suprasti, kaip išvengti tolesnių problemų. Penktadienio vakarai gali atrodyti kaip žemiau pateiktas gifas:

kūrėjo kodavimas, kai viskas negerai

Kai suprantu, kad mano darbe įvyko kažkas keisto, bandau užduoti keletą klausimų, kaip pamatysite tolesniuose tolesniuose skyriuose.

Ar tai buvo rašybos klaida?

Šiuo atveju problema gali būti dėl kokios nors funkcijos ar kintamojo, kurį bandau iškviesti. Pultas parodys, kur yra klaida, ir trumpą galimą klaidos išmetimo priežastį, kaip parodyta toliau pateiktame spaudinyje:

Ar toks elgesys turėtų veikti su dabartiniu įgyvendinimu?

Tai gali būti „ if“ teiginys, kuris neįvertino mano sąlygų, ar net ciklas, kuris turėtų sustoti po tam tikrų sąveikų, bet nesustoja.

Kas čia vyksta?

Šiuo atveju tai gali būti vidinė klaida ar dar niekad nematytas dalykas. Taigi aš jį google, norėdamas sužinoti, kas nutiko mano paraiškoje.

Pavyzdžiui, žemiau esančiame paveikslėlyje parodyta vidinė „Node.js“ srauto klaida, kuri nerodo to, ką aš padariau neteisingai savo programoje.

Derinimas scenarijais pagrįstomis kalbomis

Paprastai scenarijams pagrįstų kalbų, tokių kaip „Ruby“, „Python“ ar „JavaScript“, kūrėjams nereikia naudoti IDE, tokių kaip „Visual Studio“, „WebStorm“ ir pan.

Vietoj to, jie dažnai renkasi lengvus redaktorius, tokius kaip „Sublime Text“, „VSCode“, „VIM“ ir kt. Žemiau pateiktame paveikslėlyje parodyta įprasta programų tikrinimo ir „derinimo“ praktika. Jie atsispausdina pareiškimus, kad patikrintų programos būsenas ir reikšmes.

Darbo pradžia

Praktika, į kurią žiūrėjome ankstesniame skyriuje, nėra tokia produktyvi, kokia galėtų būti. Mes galime supainioti teksto pavadinimus su vertėmis, atsispausdinti neteisingus kintamuosius ir gaišti laiką paprastoms klaidoms ar rašybos klaidoms. Kitose skiltyse aš parodysiu kitus būdus, kaip pagerinti klaidų paiešką ir teiginių patvirtinimą.

Pagrindinis tikslas yra parodyti, kaip paprasta gali būti derinti programą. Naudodami dažniausiai naudojamus įrankius, galėsite patikrinti kodą nuo paprastų terminalo komandų iki nuotolinių mašinų iš viso pasaulio.

Kurti pavyzdinį projektą

Prieš pasinerdami į derinimo koncepcijas, turėtumėte sukurti apžiūrai skirtą programą. Taigi pirmiausia sukurkite žiniatinklio API naudodami vietinį „Node.js“ HTTP modulį. API turėtų gauti visus laukus iš užklausos, susumuoti visas jo vertes ir tada atsakyti užklausos pateikėjui su apskaičiuotais rezultatais.

Pasirinkite tuščią aplanką savo kompiuteryje ir pradėkime nuo žiniatinklio API.

Pirmiausia sukurkite Math.jsfailą, kuris bus atsakingas už visų „JavaScript“ objekto laukų sumavimą:

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

Antra, sukurkite „Node.js“ serverio failą naudodami žemiau esantį kodą. Nukopijuokite vertę ir sukurkite failą, tada įklijuokite jį ten. Vėliau paaiškinsiu, kas ten vyksta.

Atkreipkite dėmesį, kad ši API yra įvykių valdoma API ir ji apdoros užklausas naudodama „Node.js“ srautų metodą.

//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)) 

Gerai, tai gali atrodyti kaip neįprastas paprastos žiniatinklio API kodas. Leiskite man paaiškinti, kas vyksta.

Kaip alternatyva, ši API yra paremta „ Node.js“ srautais . Taigi perskaitysite duomenis pagal pareikalavimą iš pajamų užklausų , juos apdorosite ir atsakysite į juos naudodami atsakymo objektą.

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

Aš labai vertinu laiką, kurį praleidome kartu. Tikiuosi, kad šis turinys bus ne tik tekstas. Tikiuosi, kad tai padarys jus geresniu mąstytoju ir geresniu programuotoju. Sekite mane „Twitter“ ir peržiūrėkite asmeninį tinklaraštį, kuriame dalinuosi visu savo vertingu turiniu.

Iki! ?