Cron Jobs en Node.js

Los cron jobs son tareas programadas que se ejecutan automáticamente en el servidor en intervalos de tiempo predefinidos. En Node.js, hay varias bibliotecas disponibles para programar cron jobs, una de las más populares es node-cron.

Instalación de node-cron

Para usar 'node-cron', primero necesitas instalarlo. Puedes hacerlo usando npm (Node Package Manager):

mkdir node-cron-tutorial
cd node-cron-tutorial
npm init -y
npm install --save node-cron

Configuración de node-cron

Para programar un cron job, necesitas importar la biblioteca 'node-cron' y usar el método 'schedule'. Aquí hay un ejemplo básico, crea un archivo index.js en la raiz del proyecto:

import cron from 'node-cron'

cron.schedule('*/1 * * * *', () => {
  console.log('Tarea ejecutada cada minuto');
});

En este ejemplo, el cron job se ejecutará cada minuto.

En cuanto a los astericos dentro del metodo schedule estos son usados como un formato para establecer tiempo, el primer campo es para los minutos, el segundo para las horas, el tercero para los días del mes, el cuarto para los meses y el último para los días de la semana.

Los asteriscos en la sintaxis de cron representan "cualquier valor" o "siempre". El string '*/1 * * * *' que se pasa al método schedule se conoce como una expresión cron, y define la programación de la tarea. Cada campo de la expresión cron puede tener un valor específico, un rango de valores, varios valores separados por comas o un asterisco, que significa "cualquier valor".

Aquí está el detalle de lo que cada campo representa en la expresión cron:

• *: segundos (0 - 59, este es Opcional)

• *: minuto (0 - 59)

• *: hora (0 - 23)

• *: día del mes (1 - 31)

• *: mes (1 - 12)

• *: día de la semana (0 - 7) (domingo=0 o 7)

El ejemplo '*/1 * * * *' ejecutará la tarea cada minuto de cada hora de cada día del mes de cada mes y de cada día de la semana. En otras palabras, se ejecuta cada minuto.

Entendiendo la expresión cron

La cadena '*/1 * * * *' que se pasa al método schedule se llama expresión cron. Cada campo en la expresión cron puede tener:

• Un valor específico: por ejemplo, 5 * * * * ejecutaría la tarea en el minuto 5 de cada hora.
• Un rango de valores: por ejemplo, 1-5 * * * * ejecutaría la tarea cada minuto entre el minuto 1 y el minuto 5 de cada hora.
• Varios valores separados por comas: por ejemplo, 1,15 * * * * ejecutaría la tarea en el minuto 1 y el minuto 15 de cada hora.
• Un asterisco, que significa "cualquier valor".

El ejemplo '*/1 * * * *' ejecutará la tarea cada minuto de cada hora de cada día del mes, de cada mes y de cada día de la semana. En otras palabras, se ejecuta cada minuto.

Consideraciones importantes al trabajar con cron jobs

Estas son algunas de las consideraciones más importantes a tener en cuenta al trabajar con cron jobs en Node.js. La comprensión de estos problemas te ayudará a crear cron jobs más robustos y confiables.

1. Idempotencia: Tu cron job debe ser idempotente, es decir, debería poder ejecutarse múltiples veces sin cambiar el resultado después de la ejecución inicial. Esto es importante porque los cron jobs pueden fallar o ser reiniciados, y no quieres que esto cause duplicación de datos o dejes tu sistema en un estado no deseado.

2. Errores y excepciones: Asegúrate de manejar adecuadamente los errores y las excepciones. Si tu cron job falla, necesitas saberlo. Puedes manejar esto con una combinación de try/catch y la logging de errores.

3. Rendimiento y sobrecarga del sistema: Ten en cuenta el impacto en el rendimiento del sistema. Si tu cron job es intensivo en términos de recursos, podría ralentizar tu aplicación. Podrías necesitar ajustar la frecuencia de tu cron job, o tal vez necesites escalar tu infraestructura.

4. Pruebas: Los cron jobs pueden ser difíciles de probar porque se ejecutan en intervalos de tiempo y pueden depender del estado del sistema. Considera usar herramientas de pruebas unitarias y de integración, y piensa en cómo puedes aislar tu cron job para probarlo.

5. Zona horaria: Por defecto, los cron jobs en Node.js se ejecutan en la zona horaria del servidor. Si necesitas programar un cron job para una zona horaria específica, debes tenerlo en cuenta. La librería node-cron permite establecer la zona horaria para un cron job.

6. Persistencia: Si tu servidor se cae o se reinicia, los cron jobs programados se perderán. Podrías necesitar una forma de almacenar tus cron jobs programados de manera persistente. Considera almacenar la programación de tus cron jobs en una base de datos o en otro lugar persistente.

7. Bloqueo: Si tu cron job tarda más tiempo en ejecutarse que el intervalo de tiempo en que está programado para ejecutarse nuevamente, puedes terminar con múltiples instancias del mismo cron job ejecutándose simultáneamente. Esto puede ser problemático, por lo que es posible que debas implementar algún tipo de bloqueo para evitar que esto suceda.

Ejemplo Práctico: Cron job que escribe un mensaje cada minuto

Este cron job se ejecutará una vez cada minuto, y cada vez que se ejecute, escribirá el momento actual en la consola. Dentro de un cron Job puedes ejecutar cualquier porcion de codigo, por ejemplo en el siguiente ejemplo,

import cron from "node-cron";

cron.schedule('*/1 * * * *', () => {
  let now = new Date();
  console.log(`Cron Job ejecutado en: ${now}`);
});

Este es un cron job simple pero demuestra cómo puedes programar tareas para que se ejecuten a intervalos regulares en Node.js.

Envio de Correo programado

Podemos hacer un ejemplo donde un cron job envíe un correo electrónico de recordatorio cada día a las 8 a.m. Usaremos NodeMailer para enviar el correo electrónico y node-cron para programar la tarea.

Primero, debes instalar las dependencias:

npm install --save node-cron nodemailer

Luego crearemos un archivo cron-mail.js con el siguiente código:

import nodemailer from "nodemailer";
import cron from "node-cron";

// user: [email protected]
// pass: pD5AeFAwAeuRw9TQqp
// nodemailer.createTestAccount()
//     .then((account) => {
//         console.log(account)
//     });

let transporter = nodemailer.createTransport({
  host: "smtp.ethereal.email",
  port: 587,
  secure: false,
  auth: {
    user: "[email protected]",
    pass: "pD5AeFAwAeuRw9TQqp",
  },
});

let mailOptions = {
  from: "[email protected]",
  to: "[email protected]",
  subject: "Recordatorio automático",
  text: "Este es un recordatorio automático enviado a las 10:50 pm",
};

cron.schedule(
  "50 22 * * *",
  async () => {
    try {
      const info = await transporter.sendMail(mailOptions);
      console.log("Mensaje enviado: %s", info.messageId);
      const previewURL = nodemailer.getTestMessageUrl(info);
      console.log("URL de vista previa: %s", previewURL);
    } catch (error) {
      console.log(error);
    }
  },
  {
    timezone: "America/Bogota",
  }
);

En este código, debes reemplazar 'tucorreo@gmail.com' y 'tucontraseña' con la dirección de correo electrónico y la contraseña de la cuenta de Gmail desde la que se enviará el correo electrónico. Asimismo, 'destinatario@gmail.com' debe reemplazarse con la dirección de correo electrónico del destinatario.

Este es un cron job más avanzado y muestra cómo puedes usar node-cron junto con otras bibliotecas para realizar tareas más complejas.

Nota de seguridad: No es seguro ni recomendable almacenar contraseñas de texto plano en tu código. En un entorno de producción, deberías usar variables de entorno u otra forma segura de almacenar las credenciales.

Backups con Node Cron

podemos crear otro ejemplo más complejo. En este caso, vamos a realizar una tarea de respaldo de una base de datos MongoDB cada domingo a las 2 a.m. Usaremos mongodump para la operación de respaldo y node-cron para programar la tarea.

const cron = require('node-cron');
const { exec } = require('child_process');

cron.schedule('0 2 * * 0', () => {
  exec('mongodump --out /ruta/del/respaldo', (error, stdout, stderr) => {
    if (error) {
      console.log(`Error: ${error.message}`);
      return;
    }
    if (stderr) {
      console.log(`stderr: ${stderr}`);
      return;
    }
    console.log(`stdout: ${stdout}`);
  });
}, {
  timezone: "America/Mexico_City"
});

En este código, debes reemplazar /ruta/del/respaldo con la ruta del directorio donde quieres que se almacenen los respaldos.

Este cron job se ejecutará cada domingo a las 2 a.m. (hora de la Ciudad de México) y realizará un respaldo de tu base de datos MongoDB. Para probar este cron job, simplemente ejecuta el script en Node.js:

Recuerda reemplazar nombreDelArchivo.js con el nombre de tu archivo.

Este es un ejemplo avanzado que muestra cómo puedes usar node-cron para realizar tareas importantes de mantenimiento del sistema.

Nota importante: Este ejemplo asume que tienes MongoDB instalado y que mongodump está en tu PATH. Además, este script no incluye autenticación; si tu base de datos requiere autenticación, necesitarás incluir las opciones apropiadas en el comando mongodump. Consulta la documentación de MongoDB para obtener más detalles

Ejemplos de el formato Cron

1. 0 0 * * *: Este cron job se ejecutará a las 12:00 AM (medianoche) todos los días.
2. 30 18 * * *: Este cron job se ejecutará a las 6:30 PM todos los días.
3. 0 0 * * 0: Este cron job se ejecutará a las 12:00 AM (medianoche) todos los domingos.
4. 0 0 1 * *: Este cron job se ejecutará a las 12:00 AM el primer día de cada mes.
5. 0 0 1 1 *: Este cron job se ejecutará a las 12:00 AM el primer día de enero de cada año.
6. */15 * * * *: Este cron job se ejecutará cada 15 minutos.
7. 0 9-17 * * *: Este cron job se ejecutará en el minuto 0 de cada hora desde las 9 a.m. hasta las 5 p.m. (inclusive), todos los días.
8. 0 0,12 * * *: Este cron job se ejecutará dos veces al día, a las 12:00 AM y a las 12:00 PM.

Estos ejemplos deberían darte una buena idea de cómo funcionan las expresiones cron y cómo puedes usarlas para programar cron jobs en diferentes momentos e intervalos.

Conclusión

En fin, las tareas programadas o cron jobs en Node.js son una herramienta muy util y flexible para ejecutar tareas de fondo en una aplicación. Los cron jobs pueden usarse para todo, desde enviar correos electrónicos hasta realizar respaldos de la base de datos y mucho más.

La biblioteca node-cron facilita la programación de cron jobs en Node.js, proporcionando una sintaxis sencilla y permitiendo una fácil configuración de la frecuencia de las tareas. Sin embargo, como hemos discutido, hay varias consideraciones importantes a tener en cuenta al trabajar con cron jobs, como el manejo de errores, la idempotencia, la zona horaria, y el impacto en el rendimiento del sistema.

Al dominar las técnicas y conceptos que hemos discutido en este artículo, podrás aprovechar al máximo los cron jobs en tus propias aplicaciones de Node.js. Ya sea que estés enviando correos electrónicos de recordatorio, realizando tareas de mantenimiento regulares, o incluso administrando tareas complejas de procesamiento de datos, los cron jobs pueden ser una herramienta invaluable en tu caja de herramientas de desarrollo.

De momento estos son algunos ejemplos básicos pero lo mejor es probarlo en tus propias aplicaciones web.