В этом документе описывается, как можно запросить асинхронные (не HTTPS) фоновые функции для повторной попытки в случае сбоя.
Почему функции, управляемые событиями, не выполняются
В редких случаях функция может завершиться преждевременно из-за внутренней ошибки. По умолчанию функция может быть автоматически перезапущена, а может и нет.
Чаще всего функция, управляемая событиями, не может успешно завершиться из-за ошибок, возникающих в самом коде функции. Это может произойти по следующим причинам:
- Функция содержит ошибку, и среда выполнения выдает исключение.
- Функция не может связаться с конечной точкой сервиса или время ожидания истекает при попытке сделать это.
- Функция намеренно вызывает исключение (например, когда параметр не проходит проверку).
- Функция Node.js возвращает отклоненный объект Promise или передает обратный вызов со значением, отличным от
null.
В любом из этих случаев функция прекратит выполнение и вернет ошибку. Триггеры событий, создающие сообщения, имеют политики повторных попыток, которые вы можете настроить в соответствии с потребностями вашей функции.
Семантика повторных попыток
Cloud Functions обеспечивает по крайней мере однократное выполнение функции, управляемой событиями, для каждого события, созданного источником событий. По умолчанию, если вызов функции завершается ошибкой, функция не вызывается снова и событие отбрасывается. Если вы включите повторные попытки для функции, управляемой событиями, Cloud Functions будет повторять неудачный вызов функции, пока он не завершится успешно или пока не истечет окно повтора.
Если повторные попытки не включены (по умолчанию), функция всегда сообщает об успешном выполнении, а в ее журналах могут появляться коды ответа 200 OK. Это происходит, даже если функция обнаружила ошибку. Чтобы было понятно, когда в функции возникает ошибка, обязательно настройте отчеты об ошибках.
Настройте повторные попытки в коде функции
В Cloud Functions for Firebase можно включить повторные попытки в коде функции. Для этого в случае фонового события, например создания нового документа Firestore, задайте для параметра failurePolicy (первое поколение) или retry (второе поколение) значение true:
первое поколение
exports.docCreated = functions
.runWith({
// retry on failure
failurePolicy: true,
})
.firestore.document("my-collection/{docId}")
.onCreate((change, context) => {
/* ... */
});
второго поколения
const { onDocumentCreated } = require("firebase-functions/firestore");
exports.docCreated = onDocumentCreated(
{
// retry on failure
retry: true,
},
"my-collection/{docId}",
(event) => {
/* ... */
},
);
Настройка true, как показано на рисунке, настраивает функцию для повторной попытки в случае сбоя.
Период повторных попыток
Для функций второго поколения это окно повторных попыток истекает через 24 часа. Для функций первого поколения срок действия составляет семь дней. Cloud Functions повторяет попытки выполнить новые функции, управляемые событиями, используя стратегию экспоненциальной выдержки с увеличением задержки от 10 до 600 секунд. Это правило применяется к новым функциям при их первом развертывании. Оно не применяется задним числом к существующим функциям, которые были впервые развернуты до вступления в силу изменений, описанных в этом примечании к выпуску, даже если вы повторно развернете эти функции.Рекомендации
В этом разделе описаны рекомендации по использованию повторных попыток.
Используйте повторные попытки для обработки временных ошибок
Поскольку функция будет выполняться непрерывно до успешного завершения, перед включением повторных попыток необходимо устранить из кода постоянные ошибки, например баги, с помощью тестирования. Повторные попытки лучше всего использовать для обработки периодических или временных сбоев, которые с высокой вероятностью будут устранены при повторной попытке, например, нестабильной конечной точки службы или тайм-аута.
Задайте условие завершения, чтобы избежать бесконечных циклов повторных попыток.
Рекомендуется защитить вашу функцию от непрерывного цикла при использовании повторных попыток. Для этого нужно включить четко определенное условие завершения до того, как функция начнет обработку. Обратите внимание, что этот метод работает только в том случае, если ваша функция запускается успешно и может оценить конечное условие.
Простой, но эффективный подход – отбрасывать события с временными метками старше определенного времени. Это позволяет избежать чрезмерного количества выполнений, когда сбои являются постоянными или длятся дольше, чем ожидалось.
Например, этот фрагмент кода удаляет все события, которые произошли более 10 секунд назад:
const eventAgeMs = Date.now() - Date.parse(event.timestamp);
const eventMaxAgeMs = 10000;
if (eventAgeMs > eventMaxAgeMs) {
console.log(`Dropping event ${event} with age[ms]: ${eventAgeMs}`);
callback();
return;
}
Использование catch с объектами Promise
Если для функции включены повторные попытки, любая необработанная ошибка приведет к повторной попытке. Убедитесь, что ваш код фиксирует все ошибки, которые не должны приводить к повторной попытке.
Вот пример того, что нужно сделать:
return doFooAsync().catch((err) => {
if (isFatal(err)) {
console.error(`Fatal error ${err}`);
}
return Promise.reject(err);
});
Как сделать идемпотентными функции, управляемые событиями, с возможностью повторной попытки
Функции, управляемые событиями, которые можно повторить, должны быть идемпотентными. Вот несколько общих рекомендаций по созданию такой функции:
- Многие внешние API (например, Stripe) позволяют указывать ключ идемпотентности в качестве параметра. Если вы используете такой API, то в качестве ключа идемпотентности следует использовать идентификатор события.
- Идемпотентность хорошо работает с доставкой по крайней мере один раз, поскольку она делает безопасной повторную попытку. Поэтому общая рекомендация по написанию надежного кода – сочетать идемпотентность с повторными попытками.
- Убедитесь, что ваш код внутренне идемпотентен. Примеры:
- Убедитесь, что мутации могут происходить несколько раз без изменения результата.
- Запросите состояние базы данных в транзакции, прежде чем изменять его.
- Убедитесь, что все побочные эффекты сами по себе идемпотентны.
- Добавьте проверку транзакций вне функции, независимо от кода. Например, сохраняйте состояние, в котором записано, что данный идентификатор события уже обработан.
- Обрабатывайте повторяющиеся вызовы функций вне диапазона. Например, можно настроить отдельный процесс, который будет удалять дублирующиеся вызовы функций.
Настройте правила повторных попыток
В зависимости от потребностей вашей функции вы можете настроить политику повторных попыток напрямую. Это позволит вам настроить любую комбинацию следующих параметров:
- Сократите период повторных попыток с 7 дней до 10 минут.
- Измените минимальное и максимальное время задержки для стратегии повторных попыток с экспоненциальной выдержкой.
- Измените стратегию повторных попыток на немедленную.
- Настройте тему недоставленных сообщений.
- Укажите максимальное и минимальное количество попыток доставки.
Чтобы настроить правила повторных попыток, выполните следующие действия:
- Напишите HTTP-функцию.
- Используйте Pub/Sub API, чтобы создать подписку Pub/Sub, указав URL функции в качестве цели.
Дополнительную информацию о настройке Pub/Sub можно найти в документации по обработке сбоев в Pub/Sub.