Обработка ошибок в Node.js

http://www.joyent.com/developers/node/design/errors
  • Перевод
  • Tutorial


Пост содержит перевод статьи «Error Handling in Node.js», которую подготовили сотрудники компании Joyent. Статья была опубликована 28 марта 2014 года на сайте компании. Dave Pacheco поясняет, что статья призвана устранить неурядицу среди разработчиков, касаемо лучших практик работы с ошибками в Node.js, а так же ответить на вопросы, которые часто возникают у начинающих разработчиков.

Обработка ошибок в Node.js


По мере освоения Node.js можно достаточно долго писать программы, не уделяя при этом должного внимания корректной обработке ошибок. Однако, разработка серьёзных проектов на Node.js требует осознанного подхода к этой проблеме.

У начинающих разработчиков часто возникают следующие вопросы:

  • Можно ли использовать throw, что бы вернуть ошибку из функции или следует вызывать callback-функцию передав объект ошибки в качестве аргумента? В каких случаях необходимо генерировать событие 'error' у объекта класса EventEmitter?
  • Нужно ли производить проверку аргументов переданных функции? Что, если в функцию переданы некорректные аргументы? Нужно ли в таком случае генерировать исключение или вызывать callback-функцию, передавая ей ошибку?
  • Возможно ли программно различать ошибки по типу, что бы приложение могло соответствующим образом обрабатывать ошибки согласно их типу (например, «Bad Request» или «Service Unavailable»)?
  • Как функция может наиболее информативно «сообщить» программе о возникновении ошибки, чтобы та могла корректно её обработать?
  • Нужно ли обрабатывать ошибки вызванные «багами» в программе?


Данная статья состоит из семи частей:

  1. Введение. О том, что читатель должен знать перед ознакомлением со статьей.
  2. Программные ошибки и ошибки программиста. Ознакомление с типами ошибок.
  3. Шаблоны написания функций. Основополагающие принципы написания функций, реализующих корректную работу с ошибками.
  4. Правила написания функций. Перечень указаний которым следует придерживаться при написании функций.
  5. Пример. Пример написания функции.
  6. Резюме. Краткое представление основных положений рассмотренных в статье.
  7. Приложение. Общепринятые имена полей объектов ошибок.


1. Введение


Предполагается, что читатель:

  • знаком с термином «исключение» в JavaScript, Java, Python, C++, или другом подобном языке и понимает принцип работы конструкции try/catch;
  • знаком с разработкой на Node.js и освоил принципы асинхронного программирования.

Читатель должен понимать, почему в представленном ниже коде не работает перехват исключений, несмотря на наличие конструкции try/catch.1
function myFunc(callback)
{
  /*
   * Пример некорректного перехвата исключений
   */
  try {
    doSomeAsyncOperation(function (err) {
      if (err) {
        throw (err);
      }
    });
  } catch (ex) {
    callback(ex);
  }
}

Читателю следует знать, что в Node.js существует 3 основных способа, которыми функция может вернуть ошибку:

  1. Бросание ошибки throw (генерирование исключения).
  2. Вызов callback-функции с объектом ошибки в качестве первого аргумента.
  3. Генерирование события 'error' у объекта класса EventEmitter.

Предполагается, что читатель не знаком с доменами в Node.js.

Читатель должен понимать разницу между ошибкой и исключением в JavaScript. Ошибка — это любой объект класса Error. Ошибка может быть создана конструктором класса и возвращена из функции либо брошена с помощью инструкции ThrowStatement. Когда объект ошибки брошен, возникает исключение. Далее приведён пример бросания ошибки (генерирование исключения):2

throw new Error('произошла ошибка');

Пример, где ошибка передаётся в callback-функцию:

callback(new Error('произошла ошибка'));

Второй вариант чаще встречается в Node.js, из-за асинхронности большинства выполняемых операций. Как правило, первый вариант используется лишь при десериализации данных (например, JSON.parse), при этом брошенное исключение перехватывается с помощью конструкции try/catch. Это отличает Node.js от Java или C++ и других языков, где приходится чаще работать с исключениями.


2. Программные ошибки и ошибки программиста


Ошибки можно условно разделить на два типа:3

  • Программные ошибки представляют собой конфликты, возникающие в ходе нормального функционирования программы. Они не являются «багами». Обычно, они не связаны напрямую с программой: системные ошибки (например, переполнение памяти), ошибки конфигураций (например, неверно указан адрес удалённого сервера), ошибки интернет-соединения или ошибки возникшие на удалённом сервере.
    Примеры программных ошибок:
    • пользователь ввёл некорректные данные,
    • истекло время ожидания ответа на запрос (request timeout),
    • сервер ответил на запрос ошибкой с кодом 500,
    • разрыв соединения,
    • израсходована выделенная память.

  • Ошибки программиста — это дефекты кода, приводящие к некорректной работе программы. Ошибки данного типа не могут быть правильно обработаны, так как сам факт их наличия говорит о некорректности написанного кода. Ошибки этого типа возможно устранить изменив код программы. К ошибкам программиста можно отнести:
    • попытку обратиться к какому-либо полю у значения undefined,
    • вызов асинхронной функции без callback-функции,
    • вызов функции с некорректными аргументами.


Разработчики используют термин «ошибка» для обоих типов ошибок, несмотря на их принципиальные различия. «Файл не найден» — программная ошибка, её возникновение может означать, что программе требуется создать искомый файл. Таким образом, возникновение этой ошибки не является некорректным поведением программы. Ошибки программиста, напротив, не предполагались разработчиком. Возможно, разработчик ошибся в имени переменной или неправильно описал проверку данных, введённых пользователем. Данный тип ошибок не поддается обработке.

Возможны случаи, когда по одной и той же причине возникают как программная ошибка, так и ошибка программиста. Предположим, HTTP-сервер производит попытку считать какое-либо поле у значения undefined, что является ошибкой программиста. В результате, сервер выходит из строя. Клиент, при этом, в качестве ответа на свой запрос получает ошибку ECONNRESET, обычно описываемую Node.js как: «socket hang-up». Для клиента, это программная ошибка и корректно написанная программа-клиент соответствующим образом обработает ошибку и продолжит работу.

Отсутствие обработчика программной ошибки является ошибкой программиста. Предположим, что программа-клиент, устанавливая соединение с сервером, сталкивается с ECONNREFUSED ошибкой, в результате, объект соединения генерирует событие 'error', но для данного события не зарегистрирована ни одна функция-обработчик, по этой причине программа выходит из строя. В данном случае, ошибка соединения является программной ошибкой, однако, отсутствие обработчика для события 'error' объекта соединения — ошибка программиста.

Важно понимать различия между ошибками программиста и программными ошибками. Поэтому, прежде чем продолжать чтение статьи, убедитесь, что вы разобрались в этих понятиях.

Обработка программных ошибок


Обработка программных ошибок, так же как и вопросы безопасности или производительности приложения, не относится к тому типу задач, которые могут быть решены внедрением какого-либо модуля — невозможно в одном месте исходного кода решить все проблемы связанные с обработкой ошибок. Для решения задачи обработки ошибок требуется децентрализованный подход. Для всех участков программы, где возможно возникновение ошибки (обращение к файловой системе, соединение с удалённым сервером, создание дочернего процесса и т.д.) необходимо предписать соответствующие сценарии обработки для каждого возможного типа ошибки. Значит, необходимо не только выделить проблемные участки, но и понять каких типов ошибки могут в них возникнуть.

В некоторых случаях приходится передавать объект ошибки из функции, в которой она возникла, через callback-функцию на уровень выше, а из него еще выше, таким образом ошибка «всплывает» до тех пор, пока не достигнет логического уровня приложения, который ответственен за обработку данного типа ошибок. На ответственном уровне программа может принять решение: запустить ли проблемную операцию повторно, сообщить ли об ошибке пользователю или записать информацию об ошибке в лог-файл и пр. Не следует всегда полагаться на эту схему и передавать ошибки более высоким уровням иерархии, так как callback-функции на высоких уровнях ничего не знают о том, в каком контексте возникла переданная им ошибка. В результате, может возникнуть ситуация, когда на выбранном логическом уровне будет сложно описать логику обработки, соответствующую возникшей ошибке.

Выделим возможные сценарии обработки ошибок:

  • Устранение ошибки. Иногда, возникшую ошибку можно устранить. Предположим, возникла ошибка ENOENT, при попытке записать информацию в лог-файл. Это может означать, что программа запущена впервые и лог-файл еще не создан. В таком случае, обработчик может устранить ошибку, создав искомый файл. Приведём более интересный пример: программе необходимо постоянно поддерживать соединение с определённым севером (например, с базой данных), но в ходе работы возник разрыв соединения. В этом случае обработчик ошибки может произвести переподключение к базе данных.
  • Информирование пользователя и прекращение обработки запроса. Если нельзя решить возникшую проблему, проще всего прервать работу текущей операции, и сообщить пользователю об ошибке. Данный сценарий применим в случаях, когда известно, что причина, по которой возникла ошибка, не исчезнет с течением времени. К примеру, если ошибка возникла при попытке десериализации JSON-данных, переданных клиентом, то нет смысла повторять попытку с этими же данными.
  • Повторение операции. В случае ошибок связанных с работой по сети может помочь повторный запуск операции. Предположим, программа в ответ на запрос к удалённому сервису получила в ответе ошибку 503 (Service Unavailable error), в таком случае, возможно, стоит повторить запрос спустя несколько секунд. Важно определить конечное число повторов, а так же, с какой периодичностью должны выполняться попытки. Но не следует всегда полагаться на данный сценарий. Предположим, пользователь выполнил запрос к некоторому сервису, которому для обработки запроса потребовалось обратиться к вашей программе, а ваша программа, в свою очередь, осуществляет запрос к еще одному сервису, который ответил ошибкой 503. В этом случае, лучшим решением будет не выполнять повторных попыток, а незамедлительно дать возможность обработать ошибку исходному сервису, с которым работает пользователь. Если каждый сервис, участвующий в цепочке запросов, будет производить повторные попытки, то пользователь будет ожидать ответ на свой запрос дольше чем, если бы их выполнял только исходный сервис.
  • Прекращение работы программы. Если произошла непредвиденная ситуация, появление которой невозможно при нормальном функционировании программы, следует записать информацию об ошибке в соответствующий лог-файл и прекратить работу. Данный сценарий может быть использован, если ваша программа израсходовала доступную память (однако, если ваша программа получила ошибку ENOMEM от дочернего процесса, то ошибку можно обработать и не прекращать работу программы). Так же, данный сценарий можно применить если у вашей программы нет прав доступа к необходимым для работы файлам.
  • Запись ошибки в лог-файл и продолжение работы. В некоторых случаях нет необходимости прекращать работу программы даже если возникшая ошибка неустранима. В пример можно привести ситуацию, когда ваша программа периодически обращается к группе удалённых сервисов через систему DNS, и один из сервисов «выпал» из DNS. В данной ситуации программа может продолжить работу с оставшимися сервисами. Но, тем не менее, необходимо записать об ошибке в лог-файл. (Для любого правила всегда есть исключения, если ошибка возникает тысячу раз в секунду, и вы не можете ничего с ней поделать, то не нужно каждый раз выполнять запись в лог, однако, стоит периодически производить логирвоание.)

Обработка ошибок программиста


Не существует правильного способа обрабатывать ошибки программиста. По определению, если возникла такая ошибка, то код программы некорректен. Устранить проблему можно лишь исправив код.

Есть программисты считающие, что в некоторых случаях можно восстанавливать программу после произошедшей ошибки таким образом, что текущая операция прерывается, но программа, тем не менее, продолжает работать и обрабатывать другие запросы. Так поступать не рекомендуется. Принимая во внимание то, что ошибка программиста вводит программу в нестабильное состояние, можете ли вы быть уверены в том, что возникшая ошибка не нарушит работу других запросов? Если запросы работают с одними и теми же сущностями (например, сервер, сокет, соединения с базой данных и т.д.), остаётся лишь надеется, что последующие запросы будут правильно обработаны.

Рассмотрим REST-сервис (реализованный, например, с помощью модуля restify). Предположим, что один из обработчиков запросов бросил исключение RefferenceError из-за того, что программист сделал опечатку в имени переменной. Если немедленно не прекратить работу сервиса, может возникнуть ряд проблем, которые бывает сложно отследить:

  • Если какая-то сущность в результате опечатки оказалась равна null или undefined, то последующие запросы, обратившись к ней, так же, бросят исключения и не будут обработаны.
  • Если функция, которая бросила исключение, работала с базой данных, может произойти утечка соединия. Каждый раз, когда подобная ошибка будет повторяться, число соединений, используя которые сервис может работать с базой данных, будет уменьшаться.
  • Более сложная ситуация может произойти, если в качестве базы данных используется postgres, и соединение осталось незакрытым в ходе выполнения транзакции. В этом случае, «повисшая» транзакция не даст очищать старые версии записей, которые для неё видны. Транзакция может оставаться открытой неделями. Размер, который таблица занимает в памяти, будет расти без ограничений, что приведёт к тому, что обработка последующих запросов будет замедляться.4 Конечно, данный пример достаточно специфичен и касается лишь postgres, однако, он отлично иллюстрирует, что опасно продолжать работу программы, которая пребывает в нестабильном состоянии.
  • Соединение к удалённому сервису может остаться с незакрытой сессией, вследствие чего, следующий запрос может быть обработан от лица не того пользователя.
  • Может остаться незакрытым сокет. По умолчанию Node.js закроет неактивный сокет через две минуты, но это поведение может быть переопределено, и если ошибка будет повторяться, то в итоге число возможных сокетов будет исчерпано. Если вы оставите конфигурации по умолчанию, отследить и исправить проблему будет тяжело, так как ошибка о неактивном сокете возникает с задержкой в две минуты.
  • Может возникнуть утечка памяти, которая приведёт к её переполнению и выходу программы из строя. Или еще хуже — утечка может усложнить процесс сборки мусора, из-за чего начнет страдать производительность программы. Обнаружить причину проблемы в таком случае будет особенно затруднительно.

Учитывая вышеперечисленное, в таких ситуациях лучшим решением будет прервать работу программы. Вы можете перезапускать свою программу, после того как она была прервана — такой подход позволит автоматически восстанавливать стабильную работу вашего сервиса после возникающих ошибок.
Единственный, но существенный, недостаток этого подхода заключается в том, что будут отключены все пользователи работавшие с сервисом в момент перезапуска. Имейте ввиду следующее:

  • Сбои вызванные ошибкой программиста вводят приложение в нестабильное состояние. Нужно стремиться к тому, чтобы таких ошибок не возникало, их устранение имеет наивысший приоритет.
  • После перезапуска запросы могут как выполняться корректно, так и снова привести к ошибке. Может случиться так, что запросы обрабатываются некорректно, но отследить проблему сложно.
  • В хорошо спроектированной системе, независимо от того вызвана ли ошибка проблемой с интернет-соединением или ошибка произошла в Node.js, программа-клиент должна уметь обрабатывать ошибки сервера (переподключаться, выполнять повторные запросы).

Если перезапуск программы происходит очень часто, то следует отлаживать код и устранять ошибки. Лучшим способом для отладки будет сохранение и анализ снимка ядра. Данный подход работает как в GNU/Linux-системах, так и в illumos-системах, и позволяет просмотреть не только последовательность функций, которые привели к ошибке, но и переданные им аргументы, а так же состояние других объектов, видимых через замыкания.


3. Шаблоны написания функций


Во-первых стоит отметить, что очень важно подробно документировать свои функции. Необходимо описывать, что возвращает функция, какие аргументы принимает и какие ошибки могут возникнуть в процессе выполнения функции. Если не определить типы возможных ошибок и не сформулировать, что они означают, то вы не сможете правильно написать обработчик.


Throw, callback или EventEmitter?


Существует три основных способа вернуть ошибку из функции:

  1. throw возвращает ошибку синхронно. Это значит, что исключение возникнет в том же контексте, в котором функция была вызвана. Если используется try/catch, то исключение будет поймано. В противном случае — программа выйдет из строя (если, конечно, исключение не отловит домен или обработчик события 'uncaughtException' глобального объекта process, такой вариант будет рассмотрен далее).
  2. Вызов callback-функции с объектом ошибки в качестве первого аргумента является наиболее часто используемым способом вернуть ошибку из асинхронной функции. Общепринятым шаблоном вызова callback-функции является вызов вида callback(err, results), где только один из аргументов может принимать значения отличные от null.
  3. В более сложных случаях функция может генерировать событие 'error' объекта класса EventEmitter, тогда ошибка будет обработана, если зарегистрирован обработчик для события 'error'. Данный вариант используется если:
    • производится комплексная операция, которая возвращает несколько результатов или ошибок. Примером может быть извлечение записей из базы данных. Функция возвращает объект класса EventEmitter и вызывает событие 'row' — при извлечении каждой записи, "end" — когда все записи извлечены и 'error' — если возникает ошибка.
    • объект представляет собой сложный автомат, производящий множество асинхронных операций. В пример можно привести сокет, вызывающий события 'connect', 'end', 'timeout', 'drain' и 'close'. При возникновении ошибки, объект будет генерировать событие 'error'. Используя данный подход важно понимать, в каких ситуациях может возникать ошибка, могут ли при этом возникать и другие события и в каком порядке они возникают.


Использование callback-функций и генерирование событий относятся к асинхронным способам возврата ошибок. Если производится асинхронная операция, то реализуется один из этих способов, но никогда не используются сразу оба.

Итак, когда же использовать throw, а когда использовать callback-функции или события? Это зависит от двух факторов:

  • типа ошибки (ошибка программиста или программная ошибка),
  • типа функции в которой возникла ошибка (асинхронная или синхронная).

Программные ошибки характерны в большей мере для асинхронных функций. Асинхронные функции принимают в качестве аргумента callback-функцию, при возникновении ошибки она вызвается с объектом ошибки в качестве аргумента. Такой подход отлично себя зарекомендовал и широко применяется. В качестве примера можно ознакомиться с Node.js модулем fs. Событийный подход так же используется, но уже в более сложных случаях.

Программные ошибки в синхронных функциях могут возникать, как правило, если функция работает с данными, введёнными пользователем (например JSON.parse). В таких функциях при возникновении ошибки бросается исключение, реже – объект ошибки возвращается оператором return.

Если в функции хотя бы одна из возможных ошибок асинхронна, то все возможные ошибки должны возвращаться из функции используя асинхронный подход. Даже если ошибка возникла в том же контексте, в котором была вызвана функция, объект ошибки следует вернуть асинхронно.

Есть важное правило: для возврата ошибок в одной и той же функции может быть реализован либо синхронный, либо асинхронный подход, но никогда и тот и другой вместе. Тогда, чтобы принимать у функции ошибку, нужно будет использовать либо callback-функцию (или функцию-обработчик события 'error'), либо конструкцию try/catch, но никогда и то и другое. В документации к функции следует указывать, какой из способов к ней применим.

Проверка входных аргументов как правило позволяет, предупредить многие ошибки, которые совершают программисты. Часто случается, что при вызове асинхронной функции, ей забывают передать callback-функцию, в результате, чтобы понять где возникает ошибка, разработчику приходится, как минимум, просмотреть стек вызванных функций. Поэтому, если функция асинхронна, то в первую очередь, важно проверять передана ли callback-функция. Если не передана, то необходимо генерировать исключение. Кроме того, в начале функции следует проверять типы переданных ей аргументов, и так же генерировать исключение, если если они некорректны.

Напомним, что ошибки программиста не являются частью нормального процесса работы программы. Они не должны отлавливаться и обрабатываться. Поэтому данные рекомендации о немедленном бросании исключений при ошибках программиста не противоречат сформулированному выше правилу о том, что одна и та же функция не должна реализовывать как синхронный так и асинхронный подход для возврата ошибок.

Рассмотренные рекомендации представлены в таблице:

Пример функции Тип функции Ошибка Тип ошибки Как возвращать Как обрабатывать
fs.stat асинхронная файл не найден программная callback функция-обработчик
JSON.parse синхронная ошибка ввода программная throw try/catch
fs.stat асинхронная отсутствует обязательный аргумент ошибка программиста throw не обрабатывается
(прекращение работы)

В первой записи представлен наиболее часто встречаемый пример — асинхронная функция. Во второй строке – пример для синхронной функции, такой вариант встречается реже. В третей строке — ошибка программиста, желательно, чтобы подобные случаи имели место лишь в процессе разработки программы.


Ошибка ввода: ошибка программиста или программная ошибка?


Как различать ошибки программиста от программных ошибок? Вам решать, какие данные переданные функции являются корректными, а какие – нет. Если в функцию переданы аргументы не отвечающие поставленным вами требованиям, то это ошибка программиста. Если же аргументы корректны, но функция в данный момент не может с ними работать, то это программная ошибка.

Вам предстоит решать с какой строгостью производить проверку аргументов. Представим некую функцию connect, котороя принимает IP-адрес и callback-функцию в качестве аргументов. Предположим, что был произведён вызов этой функции с аргументом отличающимся по формату от IP-адреса, например: «bob». Рассмотрим что может произойти в таком случае:

  • Если вы строго производите проверку, соответствует ли формат введённой строки формату IPv4 адреса, то ваша функция бросит исключение на этапе проверки аргументов. Такой сценарий является наиболее приемлимым.
  • Если же вы проверяете лишь тип аргументов, то возникнет асинхронная ошибка о том, что невозможно подключиться к IP-адресу «bob».

Оба варианта удовлетворяют рассмотренным рекомендациям и вам решать насколько строго производить проверку. Функция Date.parse, например, принимает аргументы различных форматов, но на то есть причины. Всё же, для большинства функций рекомендуется строго проверять переданные аргументы. Чем более расплывчаты критерии проверки аргументов, тем более затруднительным становится процесс отладки кода. Как правило, чем строже проверка – тем лучше. И даже если в будущих версиях программы вы вдруг смягчите критерии проверки внутри какой-то функции, то вы не рискуете сломать ваш код.

Если переданное значение не удовлетворяет требованиям (например, undefined или строка имеет неверный формат), то функция должна сообщать о том, что переданное значение некорректно и прекращать работу программы. Прекращая работу программы, сообщив о некорректных аргументах, вы упрощаете процесс отладки кода себе и другим программистам.


Домены и process.on('uncaughtException')


Программные ошибки всегда могут быть отловлены по определённому механизму: через try/catch, в callback-функции или обработчиком события 'error'. Домены и событие глобального объекта process 'uncaughtException' часто используются для перестраховки от непредвиденных ошибок, которые мог допустить программист. Учитывая рассмотренные выше положения, данный подход настоятельно не рекомендуется.


4. Правила написания функций


При написании функций придерживайтесь следующих правил:

  1. Пишите подробную документацию
    Это самое важное правило. Документация к функции должна содержать информацию:
    • о том с какими аргументами работает функция;
    • о том каких типов должны быть аргументы;
    • о любых дополнительных ограничениях, которые накладываются на вид аргументов (пример: IP-адрес должен иметь корректный формат).

    Если какое-то из установленных правил не выполняется, то функция должа немедленно бросать исключение.
    Так же следует документировать:
    • какие программные ошибки могут возникнуть в ходе выполнения функции (включая имена ошибок),
    • как обрабатывать возможные ошибки (отлавливать через try/catch или использовать асинхронные подходы),
    • описание результата выполнения функции.

  2. Используйте объекты класса Error (или подклассов) для всех ошибок.
    Все ваши ошибки должны быть объектами класса Error или классов, которые являются его наследниками. Используйте поля name и message, поле stack так же должно корректно работать.

  3. Расширяйте объект ошибки полями, которые описывают подробности ошибки.
    Если в функцию был передан некорректный аргумент, задайте в объекте ошибки поля propertyName и propertyValue. Для ошибок подключения к удалённому серверу расширяйте объект ошибки полем remoteIp, чтобы указать к какому адресу не удалось подключиться. При возникновении системной ошибки включайте в объект ошибки поле syscall, поясняющее, какой системный вызов не был обработан, так же включите поле errno , содержащее информацию о типе системной ошибки. В приложении к статье описаны рекомендуемые имена полей.

    Ошибка обязательно должна содержать корректные поля:
    • name: используется обработчиками для дифференциации ошибок по типу.
    • message: текст описывающий возникшую проблему. Текст должен быть коротким, но достаточно ёмким, что бы можно было понять суть проблемы.
    • stack: никогда не изменяйте объект стэка вызовов. V8 производит построение этого объекта только тогда, когда к нему производится обращение и процесс построения достаточно ресурсоёмкий, обращение к этому полю существенно снижает производительность программы.


    Ошибка должна содержать достаточно информации, чтобы обработчик мог на её основе сформировать своё сообщение об ошибке, не используя при этом поле message исходной ошибки. Возможно обработчику потребуется формировать ошибку из нескольких, чтобы выводить их в форме таблицы конечному пользователю.

  4. Если ошибка возвращается с низкого уровня вложенности функций, то следует оборачивать её.
    В начале статьи упоминалось, что возможна ситуация, когда приходится возвращать ошибку из функции, в которой она возникла через callback-функцию на уровень выше, а затем еще выше, до тех пор пока она не достигнет логического уровня приложения, который ответственен за обработку данного типа ошибок. В таких случаях рекомендуется производить обёртку ошибки по мере её «всплытия». Обёрткой функции называется расширение исходного объекта ошибки информацией о логическом уровне через который она была передана. Модуль verror позволяет реализовать такой механизм.
    Рассмотрим некую функцию fetchConfig, извлекающую настройки из удалённой базы данных. Вызов fetchConfig выполняется при старте работы сервиса. Алгоритм работы функции описан ниже.

        1. Извлечение настроек
          1.1 Соединение с базой данных
            1.1.1 Получение адреса через систему DNS
            1.1.2 Создание TCP соединения с сервером базы данных
            1.1.3 Аутентификация на сервере базы данных
          1.2. Выполнение запроса к базе данных
          1.3. Обработка результата запроса
          1.4. Настройка сервиса
        2. Запуск работы сервиса
        

    Предположим, что в пункте 1.1.2 возникла ошибка. Если передавать ошибку в контекст из которого была вызвана функция fetchConfig не оборачивая её, то сообщение об ошибке будет иметь вид:

    myserver: Error: connect ECONNREFUSED
    

    Пользы от такого сообщения мало.
    Далее представлено сообщение о той же ошибке, но с применением обёртки:

    myserver: failed to start up: failed to load configuration: failed to connect to
    database server: failed to connect to 127.0.0.1 port 1234: connect ECONNREFUSED
    

    Если не выполнять обёртку на некоторых уровнях, то можно получить более лаконичное сообщение:

    myserver: failed to load configuration: connection refused from database at
    127.0.0.1 port 1234.
    

    Однако, как правило, избыток информации — лучше чем дефицит.

    Есть несколько нюансов о которых нужно знать, если вы решили оборачивать свои ошибки:

    • Старайтесь не изменять поля начального обьекта ошибки, обработчику может потребоваться информация об исходной ошибке.
    • Поле name ошибки при обёртке можно изменять, чтобы оно больше соответствовало контексту. Однако, нет необходимости это делать, если у объекта ошибки есть иные поля, по которым обработчик может распознать её тип.
    • Поле message при обёртке тоже может быть изменено, но не следует при этом менять message исходного объекта. Не производите никаких действий с полем stack, как уже упоминалось выше, V8 формирует объект stack, только при обращении к нему и это достаточно ресурсоёмкий процесс, который может привести к существенному снижению производительности вашей программы.

    В Joyent мы используем модуль verror для обёртки ошибок, так как он имеет минималистичный синтаксис. На момент написания статьи в модуле не реализованы некоторые из рассмотренных рекомендаций, однако он будет дорабатываться.



5. Пример


Рассмотрим в качестве примера функцию, которая создаёт TCP соединение по указанному IPv4 адресу.

/*
 * Функция создаёт TCP соединение по указанному IPv4 адресу.  Аргументы:
 *
 *    ip4addr        строка адреса формата IPv4;
 *
 *    tcpPort        натуральное число, TCP порт;
 *
 *    timeout        натуральное число, время в миллисекундах, в течение которого
 *                   необходимо ждать ответа от удалённого сервера;
 *
 *    callback       функция вызываемая после завершения операции,
 *                   если операция завершилась успешно, происходит 
 *                   вызов вида callback(null, socket), где socket это
 *                   объект класса net.Socket, если возникла ошибка,
 *                   выполняется вызов вида callback(err).
 *
 * В функции могут возникнуть ошибки следующих типов:
 *
 *    SystemError    Для "connection refused", "host unreachable" и других
 *                   ошибок, возвращаемых системным вызовом connect(2). Для
 *                   данного типа ошибок поле errno объекта err будет содержать
 *                   соответствующее ошибке символьное представление.
 *
 *    TimeoutError   Данный тип ошибок возникает при истечении 
 *                   времени ожидания timeout.
 *
 * Все возвращаемые объекты ошибок имеют поля "remoteIp" и "remotePort".
 * После возникновении ошибки, сокеты, которые были открыты функцией, будут закрыты.
 */
function connect(ip4addr, tcpPort, timeout, callback)
{
  assert.equal(typeof (ip4addr), 'string',
      "аргумент 'ip4addr' должен быть строкового типа");
  assert.ok(net.isIPv4(ip4addr),
      "аргумент 'ip4addr' должен содержать IPv4 адрес");
  assert.equal(typeof (tcpPort), 'number',
      "аргумент 'tcpPort' должен быть числового типа");
  assert.ok(!isNaN(tcpPort) && tcpPort > 0 && tcpPort < 65536,
      "аргумент 'tcpPort' должен быть натуральным числом в диапазоне от 1 до 65535");
  assert.equal(typeof (timeout), 'number',
      "аргумент 'timeout' должен быть числового типа");
  assert.ok(!isNaN(timeout) && timeout > 0,
      "аргумент 'timeout' должен быть натуральным числом");
  assert.equal(typeof (callback), 'function');

  /* код функции */
}

Этот пример достаточно примитивен, но он иллюстрирует многие из рассмотренных рекомендаций:

  • Аргументы, их типы, и предъявляемые к ним требования подробно документированы.
  • Функция проверяет переданные ей аргументы и бросает исключение, если аргументы не удовлетворяют критериям.
  • Документированы типы возможных ошибок, а так же поля, которые они содержат.
  • Указан способ, которым функция возвращает ошибки.
  • Возвращаемые ошибки имеют поля «remoteIp» и «remotePort», что позволит обработчику на основе этой информации формировать сообщение ошибки.
  • Документировано состояние соединений после возникновения ошибки: «после возникновении ошибки, сокеты которые были открыты функцией, будут закрыты».

Может показаться, что в представленном примере проделано много лишней работы, однако, десять минут потраченные на опиание документации могут сэкономить несколько часов вам или другим разработчикам.


6. Резюме


  • Различайте ошибки программиста и программные ошибки.
  • Програмные ошибки могут и должны обрабатываться, тогда как ошибки программиста не могут быть корректно обработаны. Не следует продолжать работу программы в случае возникновения ошибок программиста, так как дальнейшее поведение программы непредсказуемо.
  • Для возврата ошибок в функции может быть реализован синхронный подход (например, throw) или асинхронный подход (callback-функция или событие), но нельзя реализовывать оба подхода в одной функции. Тогда, при использовании функции, чтобы обрабатывать возникающие в ней ошибки, нужно будет применять либо callback-функции, либо конструкцию try/catch, но никогда и то и другое.
  • При написании функций подробно документируйте аргументы, их типы, предъявляемые к ним требования, а так же типы возможных ошибок и то, как функция возвращает ошибки (синхронно, используя throw, или асинхронно, используя callback-функцию или событийный подход).
  • Возвращаемая ошибка должна быть объектом класса Error или класса-наследника. Расширяйте объект ошибки новыми полями, чтобы включить в объект необходимую информацию об ошибке. По возможности используйте общепринятые имена полей, представленные в приложении.


7. Приложение: общепринятые имена полей ошибок


Настоятельно рекомендуется для расширения объектов ошибок использовать приведённые в таблице имена полей. Представленные имена используются в стандартных модулях Node.js, следует пользоваться ими в обработчиках ошибок, а так же при формировании сообщений об ошибках.
Имя поля объекта ошибки Значение поля
localHostname локальное DNS-имя (например, то, по которому принимаются соединения)
localIp локальный IP-адрес (например, тот, по которому принимаются соединения)
localPort локальный TCP порт (например, тот, по которому принимаются соединения)
remoteHostname DNS-имя удалённого сервера (например, сервера, с которым устанавливается соединение)
remoteIp IP-адрес удалённого сервера (например, сервера, с которым устанавливается соединение)
remotePort порт удалённого сервера (например, сервера, с которым устанавливается соединение)
path путь к файлу, директории иди сокет межпроцессного взаимодействия (IPC-сокет) (например, путь к файлу, который необходимо считать)
srcpath путь используемый в качестве источника (например, для копирования фала)
dstpath путь назначения (например, для копирования фала)
hostname DNS имя (например, то, которое используется для попытки получить IP-адрес)
ip IP-адрес (например, тот, для которого производится попытка получить DNS-имя)
propertyName имя свойста объекта или имя аргумента (например, в ошибке, возникшей при проверке аргументов переданных в функцию)
propertyValue значение поля объекта (например, в ошибке, возникшей при проверке аргументов переданных в функцию)
syscall имя невыполненного системного вызова
errno символьное представление errno (например, "ENOENT")



1 Начинающие разработчики часто допускают подобную ошибку. В данном примере try/catch и вызов функции бросающей исключение выполнятся в разных контекстах из-за асинхронности функции doSomeAsyncOperation, поэтому исключение не будет поймано.
2 В JavaScript throw может работать со значениями и других типов, но рекомендуется использовать именно объекты класса Error. Если в ThrowStatement использовать другие значения, то будет невозможно получить стэк вызовов, который привел к ошибке, что усложнит отладку кода.
3 Данные понятия возникли задолго до появления Node.js. В Java аналогом можно считать проверяемые и непроверяемые исключения. В C для работы с ошибками программиста предусмотрены утверждения.
4 Приведённый пример может показаться слишком предметным, это потому, что он не вымышлен, мы действительно сталкивались с этой проблемой, это было неприятно.
Поделиться публикацией
Ой, у вас баннер убежал!

Ну. И что?
Реклама
Комментарии 11
    +6
    Стиль изложения — инструкция по технике безопасности
      +5
      Старался подбирать наиболее чёткие формулировки. Считаю это важным при написании учебных текстов, тем более технических.
        +5
        Ну в общем это она и есть.
        0
        Слишком формализировано
          +1
          И ни слова о Domain-ах.
            0
            Авторы же пишут, что домены — зло. А вообще в 0.11 node.js в режиме harmony генераторы работают, и там для всего try-catch можно использовать.
              0
              Да, тема доменов действительно очень плохо раскрыта в статье.
              Но авторы не пишут, что домены — зло. Мысль была в том, что не надо их использовать для предотвращения падения процесса после возникновения непойманных исключений, а так же не нужно их использовать для отлова исключений вызванных программными ошибками, так как для этого есть другие механизмы.
              Домены — не зло, если их использовать для локализации непойманных исключений возникших вследствие бага. При кластеризации, например, с помощью доменов можно определять в каком из воркеров возникло непойманное исключение и перезапускать лишь его. Втаком случае один воркер выпадет на время, но остальные воркеры продолжат обрабатывать запросы. Чтобы восполнить пробел статьи можно почитать документацию, там достаточно подробно описано для чего их можно использовать, а для чего их использовать не рекомендуется.
            0
            Возникла пара вопросов:
            1. Привык к красивым xml-комментариям из .net, которые потом позволяют и внешнюю документацию генерировать, и intellisence показывать. Поэтому, комментарий к функции connect в посте выглядит для меня диковато. Есть ли какой-то стандарт (или общепринятые решения) описания документации к функциям / переменным / модулям для Node.JS?

            2. При возвращении callback ошибки в качестве параметра тоже принято передавать объект Error, как и выбросе исключения? Я верно понял?
              0
              По поводу 1: автор использует что-то очень похожее на en.wikipedia.org/wiki/JSDoc в целом в JS мире так и принято — использовать что-то издалека напоминающее JSDoc :)
                0
                По поводу 2: да, верно.
                  0
                  1. Могу посоветовать github.com/nodeca/ndoc.

                Только полноправные пользователи могут оставлять комментарии. Войдите, пожалуйста.

                Самое читаемое