デバッガー | Node.js v21.7.2 ドキュメント

デバッガー#

Node.js には、コマンドラインデバッグユーティリティが含まれています。Node.js デバッガークライアントは、フル機能のデバッガーではありませんが、簡単なステップ実行と検査が可能です。

これを使用するには、Node.js を inspect 引数と、デバッグするスクリプトへのパスを続けて起動します。

$ node inspect myscript.js
< Debugger listening on ws://127.0.0.1:9229/621111f9-ffcb-4e82-b718-48a145fa5db8
< For help, see: https://node.dokyumento.jp/en/docs/inspector
<
connecting to 127.0.0.1:9229 ... ok
< Debugger attached.
<
 ok
Break on start in myscript.js:2
  1 // myscript.js
> 2 global.x = 5;
  3 setTimeout(() => {
  4   debugger;
debug>

デバッガーは、最初の実行可能行で自動的に中断します。代わりに、最初のブレークポイント( debugger ステートメントで指定)まで実行するには、NODE_INSPECT_RESUME_ON_START 環境変数を 1 に設定します。

$ cat myscript.js
// myscript.js
global.x = 5;
setTimeout(() => {
  debugger;
  console.log('world');
}, 1000);
console.log('hello');
$ NODE_INSPECT_RESUME_ON_START=1 node inspect myscript.js
< Debugger listening on ws://127.0.0.1:9229/f1ed133e-7876-495b-83ae-c32c6fc319c2
< For help, see: https://node.dokyumento.jp/en/docs/inspector
<
connecting to 127.0.0.1:9229 ... ok
< Debugger attached.
<
< hello
<
break in myscript.js:4
  2 global.x = 5;
  3 setTimeout(() => {
> 4   debugger;
  5   console.log('world');
  6 }, 1000);
debug> next
break in myscript.js:5
  3 setTimeout(() => {
  4   debugger;
> 5   console.log('world');
  6 }, 1000);
  7 console.log('hello');
debug> repl
Press Ctrl+C to leave debug repl
> x
5
> 2 + 2
4
debug> next
< world
<
break in myscript.js:6
  4   debugger;
  5   console.log('world');
> 6 }, 1000);
  7 console.log('hello');
  8
debug> .exit
$

repl コマンドを使用すると、コードをリモートで評価できます。next コマンドは次の行にステップ実行します。利用可能なその他のコマンドを表示するには、help と入力してください。

コマンドを入力せずに enter を押すと、前のデバッガーコマンドが繰り返されます。

ウォッチャー#

デバッグ中に式と変数の値を監視することができます。すべてのブレークポイントで、ウォッチャーリストの各式が現在のコンテキストで評価され、ブレークポイントのソースコードリストの直前に表示されます。

式の監視を開始するには、watch('my_expression') と入力します。watchers コマンドはアクティブなウォッチャーを出力します。ウォッチャーを削除するには、unwatch('my_expression') と入力します。

コマンドリファレンス#

ステップ実行#

cont, c: 実行を継続
next, n: 次へステップ
step, s: ステップイン
out, o: ステップアウト
pause: 実行中のコードを一時停止 (開発者ツールのポーズボタンのようなもの)

ブレークポイント#

setBreakpoint(), sb(): 現在の行にブレークポイントを設定
setBreakpoint(line), sb(line): 特定の行にブレークポイントを設定
setBreakpoint('fn()'), sb(...): 関数の本体の最初のステートメントにブレークポイントを設定
setBreakpoint('script.js', 1), sb(...): script.js の最初の行にブレークポイントを設定
setBreakpoint('script.js', 1, 'num < 4'), sb(...): num < 4 が true と評価される場合にのみ中断する script.js の最初の行に条件付きブレークポイントを設定
clearBreakpoint('script.js', 1), cb(...): script.js の1行目のブレークポイントをクリア

まだロードされていないファイル（モジュール）にブレークポイントを設定することも可能です。

$ node inspect main.js
< Debugger listening on ws://127.0.0.1:9229/48a5b28a-550c-471b-b5e1-d13dd7165df9
< For help, see: https://node.dokyumento.jp/en/docs/inspector
<
connecting to 127.0.0.1:9229 ... ok
< Debugger attached.
<
Break on start in main.js:1
> 1 const mod = require('./mod.js');
  2 mod.hello();
  3 mod.hello();
debug> setBreakpoint('mod.js', 22)
Warning: script 'mod.js' was not loaded yet.
debug> c
break in mod.js:22
 20 // USE OR OTHER DEALINGS IN THE SOFTWARE.
 21
>22 exports.hello = function() {
 23   return 'hello from module';
 24 };
debug>

指定された式が true と評価される場合にのみ中断する条件付きブレークポイントを設定することも可能です。

$ node inspect main.js
< Debugger listening on ws://127.0.0.1:9229/ce24daa8-3816-44d4-b8ab-8273c8a66d35
< For help, see: https://node.dokyumento.jp/en/docs/inspector
<
connecting to 127.0.0.1:9229 ... ok
< Debugger attached.
Break on start in main.js:7
  5 }
  6
> 7 addOne(10);
  8 addOne(-1);
  9
debug> setBreakpoint('main.js', 4, 'num < 0')
  1 'use strict';
  2
  3 function addOne(num) {
> 4   return num + 1;
  5 }
  6
  7 addOne(10);
  8 addOne(-1);
  9
debug> cont
break in main.js:4
  2
  3 function addOne(num) {
> 4   return num + 1;
  5 }
  6
debug> exec('num')
-1
debug>

情報#

backtrace, bt: 現在の実行フレームのバックトレースを出力
list(5): 5 行のコンテキスト (前後 5 行) でスクリプトのソースコードを一覧表示
watch(expr): ウォッチリストに式を追加
unwatch(expr): ウォッチリストから式を削除
unwatch(index): ウォッチリストから特定のインデックスにある式を削除
watchers: すべてのウォッチャーとその値を一覧表示 (各ブレークポイントで自動的に一覧表示)
repl: デバッグスクリプトのコンテキストで評価するためのデバッガーの repl を開く
exec expr, p expr: デバッグスクリプトのコンテキストで式を実行し、その値を出力
profile: CPU プロファイリングセッションを開始
profileEnd: 現在の CPU プロファイリングセッションを停止
profiles: 完了したすべての CPU プロファイリングセッションを一覧表示
profiles[n].save(filepath = 'node.cpuprofile'): CPU プロファイリングセッションを JSON としてディスクに保存
takeHeapSnapshot(filepath = 'node.heapsnapshot'): ヒープスナップショットを取得し、JSON としてディスクに保存

実行制御#

run: スクリプトを実行 (デバッガーの起動時に自動的に実行)
restart: スクリプトを再起動
kill: スクリプトを強制終了

その他#

scripts: ロードされたすべてのスクリプトを一覧表示
version: V8 のバージョンを表示

高度な使用法#

Node.js の V8 インスペクター統合#

V8 インスペクター統合により、デバッグとプロファイリングのために Chrome DevTools を Node.js インスタンスにアタッチできます。Chrome DevTools プロトコルを使用しています。

V8 インスペクターは、Node.js アプリケーションの起動時に --inspect フラグを渡すことで有効にできます。また、このフラグでカスタムポートを指定することもできます。例えば、--inspect=9222 はポート 9222 で DevTools 接続を受け入れます。

アプリケーションコードの最初の行で中断するには、--inspect の代わりに --inspect-brk フラグを渡します。

$ node --inspect index.js
Debugger listening on ws://127.0.0.1:9229/dc9010dd-f8b8-4ac5-a510-c1a114ec7d29
For help, see: https://node.dokyumento.jp/en/docs/inspector

(上記の例では、URL の末尾にある UUID dc9010dd-f8b8-4ac5-a510-c1a114ec7d29 は動的に生成され、デバッグセッションごとに異なります。)

Chrome ブラウザが 66.0.3345.0 より古い場合は、上記の URL の js_app.html の代わりに inspector.html を使用してください。

Chrome DevTools は、まだワーカースレッドのデバッグをサポートしていません。ndb を使用してデバッグできます。