Reintentar la ejecución de funciones asíncronas

Este documento describe cómo puedes solicitar funciones asíncronas en segundo plano (no HTTPS) para volver a ejecutarlas en caso de error.

Semántica de los reintentos

Cloud Functions proporciona la ejecución al menos una vez de una función controlada por eventos para cada evento emitido por una fuente de eventos. De forma predeterminada, si la invocación de una función termina con un error, esta no se vuelve a invocar y se descarta el evento. Cuando habilitas los reintentos en una función controlada por eventos, Cloud Functions volverá a intentar la invocación de una función con errores hasta que se complete correctamente o venza el período de reintento.

En el caso de las funciones de 2a gen., el período de reintento vence después de 24 horas. En el caso de las funciones de 1ª gen., después de 7 días. Cloud Functions vuelve a intentar las funciones controladas por eventos recién creadas con una estrategia de retirada exponencial, con una retirada creciente de entre 10 y 600 segundos. Esta política se aplica a las funciones nuevas la primera vez que las implementas. No se aplica de forma retroactiva a las funciones existentes que se implementaron por primera vez antes de que se aplicaran los cambios descritos en esta nota de la versión, incluso si vuelves a implementar las funciones.

Cuando los reintentos no están habilitados para una función, que es la configuración predeterminada, la función siempre informa que se ejecutó de forma correcta y pueden aparecer códigos de respuesta 200 OK en sus registros. Esto ocurre incluso si se produjo un error en la función. Para saber con exactitud cuando se produzca un error en la función, asegúrate de informar los errores de forma adecuada.

Por qué no se completan las funciones controladas por eventos

En ocasiones poco comunes, es posible que una función se cierre de forma prematura debido a un error interno y, según la configuración predeterminada, podría volver a ejecutarse la función, automáticamente o no.

Por lo general, es posible que una función controlada por eventos no se complete correctamente debido a errores generados en el código de la función. Estos son algunos de los motivos por los que puede ocurrir:

• La función contiene un error y el tiempo de ejecución muestra una excepción.
• La función no puede alcanzar el extremo del servicio o se agota el tiempo de espera mientras intenta hacerlo.
• La función muestra una excepción de forma intencional (p. ej., cuando falla la validación de un parámetro).
• Una función de Node.js muestra una promesa rechazada o pasa un valor que no es null a una devolución de llamada.

En cualquiera de estos casos, la función deja de ejecutarse de forma predeterminada y el evento se descarta. Para volver a ejecutar la función cuando ocurre un error, puedes configurar la propiedad "reintentar en caso de error" para cambiar la política de intentos reiterados predeterminada. Esto hace que se vuelva a ejecutar el evento reiteradamente hasta que la función se complete de manera correcta o venza el tiempo de espera del reintento.

Advertencia: La configuración “reintentar en caso de error” hace que se intente ejecutar la función reiteradamente hasta que se realice de manera correcta o hasta que se agote el período máximo de reintentos, lo que puede tardar varios días. Si el problema se debe a un error o a cualquier otro tipo de falla permanente, es posible que la función quede atrapada en un bucle de intentos reiterados. Únicamente debes usar esta configuración cuando abordes fallas temporales (como un extremo inestable o tiempos de espera intermitentes), y solo después de probar el código bajo presión sin esta propiedad configurada. Si la función se estanca en un bucle de intentos reiterados, debes volver a implementarla o borrarla para finalizar la ejecución.

Habilita o inhabilita los reintentos

Configura los reintentos desde la consola

Si creas una función nueva, sigue estos pasos:

1. En la pantalla Crear función, en Activador, elige el tipo de evento que actuará como activador de tu función.
2. Selecciona la casilla de verificación Reintentar en caso de error para habilitar los reintentos.

Si actualizas una función existente, haz lo siguiente:

1. En la página Cloud Functions Descripción general, click haz clic en el nombre de la función que estás actualizando para abrir la pantalla Detalles de la función y, luego, elige Editar en la barra de menú para mostrar el panel Activar.
2. Selecciona o borra la casilla de verificación Reintentar en caso de error para habilitar o inhabilitar los reintentos.

Configura los reintentos desde el código de tu función

Con Cloud Functions for Firebase, puedes habilitar los reintentos en el código para una función. Para hacerlo en una función en segundo plano, como functions.foo.onBar(myHandler);, usa runWith y configura una política de fallas de la siguiente manera:

functions.runWith({failurePolicy: true}).foo.onBar(myHandler);

Si se configura true como se muestra, se establece una función para reintentar en caso de error.

Prácticas recomendadas

Esta sección describe las recomendaciones para usar los intentos reiterados.

Usa los intentos reiterados para administrar errores temporales

Dado que la función se vuelve a intentar de manera reiterada hasta que se ejecute correctamente, las fallas permanentes, como los errores, se deben eliminar del código mediante pruebas antes de habilitar los intentos reiterados. Lo mejor es usar estos intentos para administrar fallas intermitentes o temporales con una alta probabilidad de resolverse en un intento reiterado, como un extremo de servicio o un tiempo de espera inestables.

Configura una condición de finalización para evitar los bucles infinitos de reintentos

Se recomienda que protejas la función contra bucles continuos cuando uses los reintentos. Para esto, puedes incluir una condición de finalización bien definida antes de que la función comience a procesarse. Ten en cuenta que esta técnica solo tiene éxito si la función se inicia de manera correcta y es capaz de evaluar la condición de finalización.

Un enfoque simple y eficaz consiste en descartar eventos con marcas de tiempo anteriores a una hora determinada. Esto ayuda a evitar las ejecuciones excesivas cuando las fallas son persistentes o duran más de lo esperado.

Por ejemplo, este fragmento de código descarta todos los eventos que superen los 10 segundos:

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;
}

Usa catch con promesas

Si tu función tiene habilitados los reintentos, cualquier error no administrado activará un reintento. Asegúrate de que tu código capture cualquier error que no debería dar como resultado un reintento.

Este es un ejemplo de lo que se debe hacer:

return doFooAsync().catch((err) => {
    if (isFatal(err)) {
        console.error(`Fatal error ${err}`);
    }
    return Promise.reject(err);
});

Haz idempotentes las funciones controladas por eventos que se pueden reintentar

Las funciones controladas por eventos que se pueden reintentar deben ser idempotentes. A continuación, te mostramos algunos lineamientos generales para hacer que tales funciones sean idempotentes:

• Muchas API externas (como Stripe) te permiten proporcionar una clave de idempotencia como parámetro. Si usas una API de este tipo, debes usar el ID de evento como la clave de idempotencia.
• La idempotencia funciona bien con la entrega "al menos una vez", ya que permite que los intentos reiterados sean seguros. Por lo tanto, una recomendación general para escribir un código confiable es combinar la idempotencia con los intentos reiterados.
• Asegúrate de que tu código sea idempotente de forma interna. Por ejemplo
  :
  • Asegúrate de que puedan ocurrir mutaciones más de una vez sin que cambie el resultado.
  • Consulta el estado de la base de datos en una transacción antes de mutar el estado.
  • Asegúrate de que todos los efectos secundarios sean idempotentes en sí.
• Debes imponer una verificación transaccional fuera de la función y que sea independiente del código. Por ejemplo, conserva el estado en algún lugar que registre si ya se procesó un ID de evento determinado.
• Administra las llamadas de función duplicadas fuera de banda. Por ejemplo, implementa un proceso de limpieza independiente que borre las llamadas duplicadas a funciones.

Configura la política de reintentos

Según las necesidades de tu función, puedes configurar la política de reintento directamente. Esto te permitirá configurar cualquier combinación de las siguientes acciones:

• Acortar el período de reintento de 7 días a tan solo 10 minutos.
• Cambiar el tiempo de retirada mínimo y máximo para la estrategia de reintento de retirada exponencial.
• Cambiar la estrategia de reintento para volver a intentar de inmediato.
• Configurar un tema de mensajes no entregados.
• Establecer una cantidad máxima y mínima de intentos de entrega.

Para configurar la política de reintentos, haz lo siguiente:

1. Escribe una función de HTTP
2. Usa la API de Pub/Sub para crear una suscripción a Pub/Sub y especificar la URL de la función como objetivo.

Consulta la documentación de Pub/Sub sobre el manejo de fallas para obtener más información sobre cómo configurar Pub/Sub directamente.