https://github.com/sofyansetiawan/tips-debugging-nodejs
Notes for Nodejs Debugger and using VSCode debugger
https://github.com/sofyansetiawan/tips-debugging-nodejs
debugging debugging-tool nodejs
Last synced: 2 months ago
JSON representation
Notes for Nodejs Debugger and using VSCode debugger
- Host: GitHub
- URL: https://github.com/sofyansetiawan/tips-debugging-nodejs
- Owner: sofyansetiawan
- Created: 2020-10-26T08:55:46.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-07-26T13:19:39.000Z (almost 4 years ago)
- Last Synced: 2025-01-10T22:23:07.089Z (4 months ago)
- Topics: debugging, debugging-tool, nodejs
- Homepage:
- Size: 262 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
## Tips Debugging Node.js
Debugging adalah proses untuk menemukan bagian code mana yang tidak jalan lalu diperbaiki.
Debugging membantu pendekatan untuk step by step review code.
Debugging sederhana dengan memperhatikan syntax, proses, variable dan perubahan nilai secara perlahan lahan
Alat untuk debugging bisa `Chrome Devtools`, `Node Debugger` atau ketika di jalankan di Node.JS (dengan `console.log()` )
Umumnya error ada 3 bentuk:
1. Syntax error membuat program tidak jalan (Code editor sekarang sudah bisa mendeteksi adanya error syntax)
2. Runtime error ketika kode gagal eksekusi atau behaviour tidak sesuai (Runtime error ketika dijalankan)
3. Semantic logic tidak sesuai dengan sesuai keinginan (Sematic logic tidak ditemukan di code editor tapi ketika program yang kita jalankan tidak sesuai output)
### Notes untuk error yang sering dialami
- Untuk menghentikan infinite loop di terminal, tekan CTRL + C / Cmd + C
- Error bisa berupa crash, running forever atau salah output
- Infinite loop bisa memakan memory sampai habis atau memory environment
- `console.log()` biasa ditujukan ketika ingin melakukan test untuk nilai dan proses. Diletakkan di point strategis untuk melihat output perubahan nilai di sesi proses tertentu
- Jika kita ingin menjalankan debugging di Devtool atau NodeJS sebaiknya `console.clear();` dulu sebelum `console.log()` agar kita membersihkan log sebelum menjalankan proses lagi
- Jika ingin tahu type data variabel atau struktur data menggunakan `typeof`. Misal `console.log(typeof variabel1);` atau `if(typeof variabel1 === 'string')`. Makanya harus di cek tipe datanya agar tidak salah perhitungan dan salah saat argumen
- Tipe data immutable: Boolean, Null, Undefined, Number, String, and Symbol (ES6) and one type for mutable items: Object
- Selalu teliti dalam penulisan pengejaan, terlebih variabel. Jadi sebelum masuk ke baris berikutnya coba review baris tersebut. Dan gunakan autocomplete di text editor
- Tips nya gunakan penamaan variabel yang mewakili nilai proses, familiar dan seragam (camelCase). Karena variabel dan function itu case-sensitive
- Kesalahan sintaksis sering kurang penutup function, parenthesis dan kode bersarang
- Ketika bertemu string tanpa ES6 Literal dan ada bentrok dengan quote ' atau ", gunakan escape character backslash \. Misal \' \" \n
- Perhatikan "falsy" values: false, 0, "" (an empty string), NaN, undefined, and null dalam kondisi dan loop
- Strict Equality (`===`): cek nilai dan tipe datanya
- Jika kita melakukan assignment di dalam if maka nilai dari variabel akan berubah dan bisa jadi menjadi true
- **Off by one errors** (sometimes called **OBOE**) mengakses index di string/array. Index selalu lebih rendah dari length. Jika index sama dengan length maka undefined.
- Inisialisasi variabel di dalam looping maka akan inisialisasi ulang setiap loop dan mereset nilainya dan dianggap variabel baru. Ini hanya berguna untuk temp dalam 1 loop misalnya ditampung oleh variabel lain. (Bisa menyebabkan infinite loop)
- Maka harus dipikirkan apakah variabel harus di inisialisasi ulang ditaruh di dalam loop atau diluar.
- Infinite loop bisa terjadi ketika ada kondisi yang mengubah kondisi menjadi selalu true. Loop tak terbatas bisa crash di browser, crash di memory komputer dan kekacuan eksekusi program lain. Pastikan selalu ada kondisi untuk keluar dari loop.
- Umumnya terjadi pergeseran nilai variabel (bisa juga counter) ke arah yang salah atau mereset variabel di setiap proses loop
- Ketika memanggil function tidak menggunakan parenthesis, maka dia tidak menggunakan argument. Bahkan tidak mengembalikan return undefined
- Tempatkan argument urutannya tepat agak tidak terjadi error type data maka bisa saya runtime error
------
## Debugging dengan Node Debugger
Debugging dengan terminal itu untuk membantu tracing semantic logic error. Dia tidak untuk mendeteksi syntax dan runtime error. Karena syntax dan runtime error otomatis akan ditangkap oleh node.
**Selalu lihat di Dokumentasi**
- https://nodejs.org/api/debugger.html
Menjalankan debugger node.js:
`node inspect .js`
Di inspector node.js terdapat `watcher` (pengamat expression)
### `debugger;`
- Tulis di kode debugger; sebagai breakpoint (seperti break;) agar watcher inspeksi berhenti dibaris tersebut untuk melihat perubahan nilai terakhir yang di dapat oleh variabel yang diamati. Ketika watcher tidak menemukan breakpoint, maka otomatis watcher akan mengambil line 1.
### n atau next
- Agar menuju ke stamement berikutnya (Step Next) yang bisa di baca oleh watcher. Jika ada statement seperti variabel / object / invoke function (blok function tidak di watch, kecuali jika sudah step-in) maka jika tidak ada watcher maka akan ke loader.js
### c atau cont
- Untuk menuju ke debugger, jika ada debugger lagi maka akan menuju debugger berikutnya. Jika tidak ada debugger maka tidak menjalankan apa-apa kecuali invoke. Maka akan memunculkan pada step debugger tersebut perubahan nilai akan terlihat.
### .exit
- Untuk keluar dari mode debugger dan watcher dihapus
### r atau restart
- Untuk kembali menjalankan debugger tanpa menghapus watcher
### watch('expression')
- Untuk menambahkan watcher. Masukkan statement seperti inisialiasi variabel, invoke function, object, pemanggilan variabel, assingment nilai ke variabel, dsb.
### watchers
- Untuk mendapatkan list semua watchers dan nilai saat itu dan mendapat index watchers
### watchers[index]
- Untuk dapatkan nilai watcher saat itu, hanya salah satu lalu untuk keluar di CTRL+C
### unwatch('expression')
- Untuk menghapus sebuah watcher untuk expression tertentu sehingga tidak lagi diperiksa atau ditracing
### repl
- Untuk melakukan standalone testing terhadap expression (variabel) yang tidak di watcher / eksperimen terhadap nilai saat itu tersebut dengan nilai nilai lain dalam sebuah expression. Untuk keluar dari repl CTRL + C
### s atau step
- (Step-in) untuk melakukan pemeriksaan watcher ke dalam scope function walaupun belum diinvoke. Jadi secara terus menerus memeriksa proses di function sebagai unit testing sampai masing masing function sudah sesuai logic nya dan step masuk ke dalam loop
### o atau out
- (Step-out) untuk keluar dari watch yang memeriksa ke dalam function untuk keluar dari blok function untuk meriksa blok global dan bisa step-in lagi untuk memeriksa function lain.
### exec('expression')
- Untuk menampilkan output expression yang tidak di watch dengan nilai saat itu. Berbeda dengan repl karena kita tidak bisa masuk ke mode experiment. Hanya untuk output.
### sb() atau setBreakpoint()
- Untuk membuat breakpoint pada baris yang sedang diperiksa tanpa menulis debugger; di script kita.
### sb(line) atau setBreakpoint(line)
- Untuk membuat breakpoint pada baris tertentu tanpa menulis debugger; di script kita.
### sb('namafunction()') atau setBreakpoint('namafunction()')
- Untuk membuat breakpoint pada statement pertama di function tersebut tanpa menulis debugger; di script kita.
### sb('namafile.js', 123) atau setBreakpoint('namafile.js', 123)
- Untuk membuat breakpoint pada script.js di baris tertentu tanpa menulis debugger; di script kita. Perintah ini ketika cont maka debugger keluar dari file saat ini dan menuju ke file tersebut
### list(10)
- Untuk menampilkan preview 10 baris sesudah dan sebelum breakpoint dari script yang di debug
### kill
- Untuk mengakhiri debugger dan watcher sehingga keluar dari sesi debugging
------
## Debugging dengan VSCode
1. Klik breakpoint pada baris tertentu di VSCode atau ketikkan debugger di kode sesuai bagian yang diperiksa (biasanya diletakkan di condition atau loop)
2. Buka sebuah file javascript di VSCode atau F5
3. Klik tab `Run and Debug`
4. Pilih `Environment` - `Node.js`
5. Di bagian Tab `variables` terdapat list expression yang bisa diperiksa
6. Masukkan variabel atau expression yang diperiksa watcher di Tab `Watch`
7. Klik tombol next / step-in / step-out untuk step memeriksa expression yang selalu berhenti di code `debugger`
