Отладчик

Node.js включает утилиту отладки вне процесса, доступную через V8 Inspector и встроенный клиент отладки. Для использования, запустите 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

Команда 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
• 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 - Открыть интерактивную среду отладчика для оценки в контексте скрипта отладки
• exec expr - Выполнить выражение в контексте скрипта отладки

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

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

Разное

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

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

Интеграция V8 Inspector для Node.js

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

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

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

$ node --inspect index.js
Debugger listening on 127.0.0.1:9229.
To start debugging, open the following URL in Chrome:
    chrome-devtools://devtools/bundled/js_app.html?experiments=true&v8only=true&ws=127.0.0.1:9229/dc9010dd-f8b8-4ac5-a510-c1a114ec7d29

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

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