Автоматически генерируемые ошибки JavaScript – почему они происходят

Первый шаг к пониманию ошибок JavaScript – разобраться, откуда они берутся. Большинство ошибок JavaScript, встречающихся в природе, автоматически генерируются самим движком JavaScript. Существует множество типов ошибок, но, как правило, все они относятся к одному из трех классов.

TypeError

Один из наиболее распространенных классов ошибок. Такая ошибка возникает, когда некоторое значение относится не к тому типу, к которому должно относиться. Часто это возникает, когда код вызывает как функцию некоторую сущность, функцией не являющуюся. Это может быть неопределенное (“undefined”) или какое-нибудь другое значение.

window.foo()
  // => TypeError: window.foo это не функция
[].length
  // => 0
[].length()
  // => TypeError: array.length это не функция

Еще один распространенный случай, в котором возникает TypeError – при попытке обратиться к свойству неопределенного значения.

window.foo.bar
  // => TypeError: Невозможно прочитать свойство 'bar' у undefined

SyntaxError

Эти ошибки возникают, когда движок JavaScript разбирает скрипт и встречает синтаксически неверный код. Если в файле JavaScript содержится синтаксическая ошибка, то никакой код из него не выполнится.

 console.log('hello')
    notValid(

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

ReferenceError

Такие ошибки возникают, когда код ссылается на значение, отсутствующее в актуальной области видимости. Например:

console.log(somethingMadeUp)
  // => ReferenceError: somethingMadeUp не определено

Выбрасывание ошибок вручную

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

Простейший способ вручную спровоцировать ошибку – при помощи оператора throw:

throw 'Invalid input';

В таком случае автоматически создается экземпляр объекта Error с сообщением “Invalid input”, но экземпляр ошибки также можно создать вручную и передавать его в коде.

let error = new Error('Invalid input')
  // позже
throw error;

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

function sayName(name) {
  if(typeof name !== 'string') {
    throw new Error('name must be a string, received:' + typeof name);
  }
}

Перехват ошибок в блоке try/catch

Если вы знаете, что конкретный блок кода устроен рискованно и может выбрасывать ошибку, то эту ошибку можно обернуть в блок try/catch.

try {
  someCrashyFunction()
} catch(error) {
  //  может быть, отобразить это пользователю
  // и сообщить об ошибке разработчику
  Bugsnag.notify(error);
}

Блоки try/catch также можно вкладывать друг в друга. Как только ошибка будет обработана, желательно передать ее выше по стеку вызовов, чтобы там она могла быть выброшена повторно.

try {
  someCrashyFunction()
} catch(error) {
  // Обработать ошибку здесь:
  // ...
  // а затем передать вверх по цепочке
  throw error;
}

Давайте включим глобальную обработку ошибок и выловим их все

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

Как устроена глобальная обработка ошибок

Чтобы выловить и обработать все ошибки JavaScript, которые могут возникнуть в браузерном сеансе, можно прибегнуть к обработчику событий window.onerror. Так можно задать глобальный обработчик для всех необработанных ошибок, которые могли бы всплыть в коде. Именно такое событие применяется в библиотеке Bugsnag для сообщения о неотловленных ошибках в браузерных JavaScript-приложениях.

В среде Node нет объекта window, поэтому аналогичный функционал связан с использованием process.on('unhandledException, callback).

Глобальная обработка ошибок не может заменить детализированного контроля, который достигается при помощи операторов try/catch. Глобальная обработка ошибок применяется только для подстраховки в качестве средства от тех исключений, которые проскользнут через передовые линии защиты. Устраивая обработку ошибок ближе к источнику потенциальной проблемы, мы, пожалуй, будем лучше представлять, как справиться с ошибкой и как восстановиться после нее еще до того, как пользователь заметит проблему. А если ошибка и проползет через какую-нибудь щель, то мы можем спокойно рассчитывать на то, что глобальный обработчик ошибок все равно предъявит нам возникшие проблемы.

Неисправные промисы

С появлением ES2015 промисы в JavaScript получили поддержку на уровне сущностей первого класса, и это позволило значительно повысить ясность асинхронного кода. Один недостаток промисов заключается в том, что они часто проглатывают ошибки, возникающие у них в методе.then(). Если в этом методе будет сгенерирована ошибка, то она никогда не всплывет на уровень глобального обработчика ошибок.

fetch('https://my-api.endpoint')
.then((response) => {
  response.thisMethodDoesNotExist() // эта ошибка будет поглощена

  doSomethingElse() // этот код никогда не будет выполнен
})

Вот почему рекомендуется всегда добавлять оператор catch во все цепочки промисов, так, чтобы могли быть обработаны любые ошибки.

fetch('https://my-api.endpoint')
  .then((response) => {
      response.thisMethodDoesNotExist()
    doSomethingElse() // этот код никогда не будет выполнен
  })
  .catch((error) => {
    console.error(error)
    // # => response.thisMethodDoesNotExist это не функция
    Bugsnag.notify(error)
    // показать ошибку пользователю
  });

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

window.addEventListener("unhandledrejection", (event) => {
  console.error(event.reason);
  // здесь сообщаем об ошибке
});

Теперь любой отказавший промис, у которого нет явного обработчика catch, спровоцирует событие unhandledrejection.

Свойства ошибки

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

   let error = new Error('This is my message')
    console.log(error.message)
    // => это мое сообщение

По умолчанию ошибка имеет то же имя, что и функция конструктора. Поэтому, когда ошибка создается при помощи новой Error('oh no!') или throw('oh no!'), она называется “Error”. Если создать ошибку при помощи новой TypeError('oh no!'), то она будет называться “TypeError”. Имя ошибки можно переопределить, просто установив другое имя.

   let myError = new Error('some message');
    myError.name = 'ValidationError';
    throw myError;

Здесь мы переименовали ошибку в ValidationError, и, например, в дашборде Bugsnag это будет отражено. Но некоторые браузеры (напр., Chrome), все равно будут выводить в консоль просто “Error”. Чтобы справиться с этой проблемой, можно применять пользовательские классы ошибок, о которых мы поговорим ниже в этой статье.

Стектрейсы

Свойство Error.prototype.stack содержит стектрейс ошибки. Стректрейс хранится вместе с ошибкой в виде обычной последовательности символов, где разделителем между всеми функциями в стеке служат символы перехода на новую строку.

Важно отметить, что структура стектрейса зависит от того, где была инициализирована ошибка, а не где она выброшена. Таким образом, если ошибка создается в functionA и возвращается от нее, а затем выбрасывается в functionB, то на вершине стектрейса будет functionA.
Вполне вероятно, что вы минифицируете ваш код JavaScript. В таком случае строки в стектрейсе не будут совпадать со строками в оригинальном файле с исходным кодом. Чтобы найти оригинальный исходный код, используются специальные карты исходников, по которым стектрейс можно отыскать и «перевести». Об этом рассказано в статье the Anatomy of source maps.

Создание пользовательских типов ошибок

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

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

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

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

class ValidationError extends Error {
  constructor(field, reason) {
    super(reason);
    this.field = field;
    this.reason = reason;
    // следующая строка важна, так как сообщает, что конструктор ValidationError
    // не входит в состав результирующего стектрейса
    Error.captureStackTrace(this, ValidationError);
  }

 // также в этом классе можно определить пользовательские методы
  prettyMessage() {
     return `ValidationError: [${this.fields}] reason: ${this.reason}`;
     // исключение: "ValidationError: [age] причина: должно быть числом"
  }
}

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

app.use(function errorHandler (error, req, res, next) {
 if (error instance of ValidationError) {
   // выдать в ответ код 400 и включить важные детали об ошибке 
   return res.status(400).json({
      type: error.name,
      message: error.prettyMessage(),
      field: error.field,
    });
  } else {
    // Это ошибка другого рода, пусть с ней разберется обработчик ошибок, заданный по умолчанию 
    next(error)
  }
})

Хотя в этом примере и используется промежуточное ПО из Express.js, подобный подход применим и в других разновидностях приложений JavaScript, с использованием обычного try/catch.

try {
  submitForm();
} catch (error) {
  if (error instanceof ValidationError) {
    // показать ошибку пользователю
    displayErrorMessage(error.prettyMessage());
  } else {
    // передать ее обработчику ошибок, заданному по умолчанию
    throw error;
  }
}

Без пользовательских классов ошибок специализированная обработка ошибок в таком стиле была бы гораздо сложнее. Требовалось бы идти на уловки, например, сравнивать сообщение об ошибке с каким-нибудь собственноручно написанным свойством. К счастью, такое сравнение с применением классов ошибок протекает гораздо более явно.

Заключение

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

P.S.

На сайте издательства продолжается осенняя распродажа.