Отладчик

Node.js включает утилиту отладки вне процесса, доступную через инспектор V8 и встроенный клиент отладки. Чтобы использовать её, запустите Node.js с аргументом inspect и далее укажите путь к скрипту, который нужно отладить; появится подсказка, указывающая на успешный запуск отладчика:

$ node inspect myscript.js
< Debugger listening on ws://127.0.0.1:9229/80e7a814-7cd3-49fb-921a-2e02228cd5ba
< For help, see: https://nodejs.org/en/docs/inspector
< Debugger attached.
Break on start in myscript.js:1
> 1 (function (exports, require, module, __filename, __dirname) { global.x = 5;
  2 setTimeout(() => {
  3   console.log('world');
debug>

Клиент отладки Node.js не является полноценным отладчиком, но простые шаги и проверка возможны.

Вставка оператора debugger; в исходный код скрипта включит точку останова в этом месте кода:

// myscript.js
global.x = 5;
setTimeout(() => {
  debugger;
  console.log('world');
}, 1000);
console.log('hello');

После запуска отладчика произойдёт остановка на 3-й строке:

$ node inspect myscript.js
< Debugger listening on ws://127.0.0.1:9229/80e7a814-7cd3-49fb-921a-2e02228cd5ba
< For help, see: https://nodejs.org/en/docs/inspector
< Debugger attached.
Break on start in myscript.js:1
> 1 (function (exports, require, module, __filename, __dirname) { global.x = 5;
  2 setTimeout(() => {
  3   debugger;
debug> cont
< hello
break in myscript.js:3
  1 (function (exports, require, module, __filename, __dirname) { global.x = 5;
  2 setTimeout(() => {
> 3   debugger;
  4   console.log('world');
  5 }, 1000);
debug> next
break in myscript.js:4
  2 setTimeout(() => {
  3   debugger;
> 4   console.log('world');
  5 }, 1000);
  6 console.log('hello');
debug> repl
Press Ctrl + C to leave debug repl
> x
5
> 2 + 2
4
debug> next
< world
break in myscript.js:5
  3   debugger;
  4   console.log('world');
> 5 }, 1000);
  6 console.log('hello');
  7
debug> .exit

Команда next позволяет удалённо оценивать код. Команда 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
• clearBreakpoint('script.js', 1), cb(...): Удалить точку останова в script.js на строке 1

Также можно установить точку останова в файле (модуле), который ещё не загружен:

$ node inspect main.js
< Debugger listening on ws://127.0.0.1:9229/4e3db158-9791-4274-8909-914f7facf3bd
< For help, see: https://nodejs.org/en/docs/inspector
< Debugger attached.
Break on start in main.js:1
> 1 (function (exports, require, module, __filename, __dirname) { 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>

Информация

• backtrace, bt: Вывести стек вызовов текущей рамки выполнения
• list(5): Вывести исходный код скриптов с контекстом 5 строк (5 строк перед и после)
• watch(expr): Добавить выражение в список наблюдаемых
• unwatch(expr): Удалить выражение из списка наблюдаемых
• watchers: Вывести список всех наблюдаемых и их значений (автоматически отображается на каждой точке останова)
• repl: Открыть REPL отладчика для вычисления в контексте отлаживаемого скрипта
• exec expr: Выполнить выражение в контексте отлаживаемого скрипта

Управление выполнением

• run: Запустить скрипт (автоматически выполняется при запуске отладчика)
• restart: Перезапустить скрипт
• kill: Прервать скрипт

Разное

• scripts: Вывести список всех загруженных скриптов
• version: Отобразить версию V8

Расширенное использование

Интеграция инспектора V8 для Node.js

Интеграция инспектора V8 позволяет подключать Chrome DevTools к экземплярам Node.js для отладки и профилирования. Она использует протокол Chrome DevTools.

Инспектор V8 можно включить, передав флаг --inspect при запуске приложения Node.js. Также можно указать пользовательский порт с этим флагом, например, --inspect=9222 позволит принимать подключения DevTools на порту 9222.

Чтобы прервать выполнение на первой строке кода приложения, передайте флаг --inspect-brk вместо --inspect.

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

(В приведённом выше примере UUID dc9010dd-f8b8-4ac5-a510-c1a114ec7d29 в конце URL генерируется динамически, он отличается в разных сеансах отладки.)

Если браузер Chrome старше версии 66.0.3345.0, используйте inspector.html вместо js_app.html в указанном выше URL.

Chrome DevTools пока не поддерживает отладку потоков-работников. Для их отладки можно использовать ndb.