add mail with resend on success and/or failure

Author: feerglas

.env.example

@@ -8,4 +8,8 @@ OVH_OS_IMAGES_BACKUP_CONTAINER_ENDPOINT=
 
 # OVH MongoDB
 DATABASE_NAME=
-DATABASE_URI=replicaSet=
+DATABASE_URI=
+
+# Resend
+RESEND_KEY=
+MAIL_TO=

config.ts

@@ -2,4 +2,6 @@ export default {
   blobBackupBucketPrefix: 'blob-backup',
   dbBackupBucketPrefix: 'db-backup',
   keepAmountOfBackups: 4,
+  sendMailOnFailure: true,
+  sendMailOnSuccess: true,
 }

cron-jobs/backups-cleanup.ts

@@ -6,8 +6,9 @@
 import { S3Helper } from '../helpers/s3.ts';
 import config from '../config.ts';
 import { sortBucketsNewestFirst } from '../helpers/date.ts';
+import mail from '../helpers/mail.ts';
 
-const cleanUpBucketsWithPrefix = async (prefix, allBuckets, s3Helper) => {
+const cleanUpBucketsWithPrefix = async (prefix, allBuckets, s3Helper): Promise<[String?]> => {
   /*
   // If run as cron-job on vercel, make sure that only cron-jobs can execute
   // the script.
@@ -26,20 +27,39 @@ const cleanUpBucketsWithPrefix = async (prefix, allBuckets, s3Helper) => {
   for (const bucketToDelete of bucketsToDelete) {
     await s3Helper.deleteBucket(bucketToDelete.Name);
   }
+
+  if (bucketsToDelete.length === 0) {
+    return [];
+  }
+
+  return [bucketsToDelete.map((bucket) => bucket.Name)]; 
 }
 
 const main = async () => {
   try {
     const s3Helper = new S3Helper();
     const buckets = await s3Helper.getAllBuckets();
 
-    await cleanUpBucketsWithPrefix(config.blobBackupBucketPrefix, buckets, s3Helper);
-    await cleanUpBucketsWithPrefix(config.dbBackupBucketPrefix, buckets, s3Helper);
+    const deletedBlobBuckets = await cleanUpBucketsWithPrefix(config.blobBackupBucketPrefix, buckets, s3Helper);
+    const deletedDbBuckets = await cleanUpBucketsWithPrefix(config.dbBackupBucketPrefix, buckets, s3Helper);
+
+    const mailMessage = `Deleted ${deletedBlobBuckets.length} blob buckets and ${deletedDbBuckets.length} db buckets.<br><br>Deleted blob buckets: ${deletedBlobBuckets.join('<br>')}<br><br>Deleted db buckets: ${deletedDbBuckets.join('<br>')}`
+    await mail(
+      '--> Backups cleanup success',
+      mailMessage,
+      false,
+    );
 
     console.log('--> Backups cleanup done');
-    
+
 
   } catch (error) {
+    await mail(
+      '--> Backups cleanup failure',
+      error,
+      true,
+    );
+
     console.log(error);
   }
 }

cron-jobs/blob-backup.ts

@@ -1,15 +1,12 @@
 // Ideally executed as cron-job.
 
-// todo:
-// - integrity check: after backup, count objects in blob and in backup
-// - log amount of objects
-
 import { Readable } from 'node:stream';
 import { ReadableStream } from 'node:stream/web';
 import * as blobHelpers from '../helpers/blob.ts';
 import { S3Helper } from '../helpers/s3.ts';
 import { dateString } from '../helpers/date.ts';
 import config from '../config.ts';
+import mail from '../helpers/mail.ts';
 
 const main = async () => {
   /*
@@ -45,9 +42,30 @@ const main = async () => {
       })
     );
 
-    console.log('-->> Backup done: Vercel Blob data to OVH S3');
+    // integrity check
+    const bucketItemsCount = await s3Helper.listObjectsOfBucket(bucketName);
+
+    if (bucketItemsCount.length !== blobs.length) {
+      throw new Error(`Blob Backup failure during integrity check. Vercel blob has ${blobs.length} objects, but the backup contains ${bucketItemsCount.length}`);
+    }
+
+    const mailMessage = `Successfully backed up ${blobs.length} items from Vercel Blob to OVH S3`;
+
+    await mail(
+      '--> Backup done: Vercel Blob data to OVH S3',
+      mailMessage,
+      false,
+    );
+
+    console.log(mailMessage);
 
   } catch (error) {
+    await mail(
+      '--> Backup failure: Vercel Blob data to OVH S3',
+      error,
+      true,
+    );
+
     console.log(error);
   }
 }

cron-jobs/db-backup.ts

@@ -5,6 +5,7 @@ import { S3Helper } from '../helpers/s3.ts';
 import { DbHelper } from '../helpers/db.ts';
 import { dateString } from '../helpers/date.ts';
 import config from '../config.ts';
+import mail from '../helpers/mail.ts';
 
 dotenv.config();
 
@@ -30,26 +31,40 @@ const main = async () => {
     await s3Helper.createBucket(bucketName);
 
     if (!process.env.DATABASE_NAME) {
-      console.log('Aborting. DATABASE_NAME is not defined in env.');
-      
-      return;
+      throw new Error('Aborting. DATABASE_NAME is not defined in env.');
     }
 
     const collections = await dbHelper.getCollections(process.env.DATABASE_NAME);
+    let collectionBackupCount = 0;
 
     for (const collection of collections) {
       const { collectionName } = collection;
 
       if (!collectionName.startsWith('system.')) {
+        collectionBackupCount++;
         const results = await collection.find({}).toArray();
 
         await s3Helper.addObject(bucketName, `${collectionName}.json`, JSON.stringify(results));
       }
     }
 
-    console.log('-->> Backup done: DB on OVH to OVH S3');
+    const mailMessage = `Successfully backed up ${collectionBackupCount} colletions from MongoDb to OVH S3`;
+
+    await mail(
+      '-->> Backup done: DB on OVH to OVH S3',
+      mailMessage,
+      false,
+    );
+
+    console.log(mailMessage);
 
   } catch (error) {
+    await mail(
+      '--> Backup failure: DB on OVH to OVH S3',
+      error,
+      true,
+    );
+
     console.log(error);
   } finally {
     dbHelper.getClient().close();

helpers/mail.ts

@@ -0,0 +1,42 @@
+import { Resend } from 'resend';
+import dotenv from 'dotenv';
+import config from '../config.ts';
+
+dotenv.config();
+
+export default async (subject: string, message: string, failure: boolean): Promise<void> => {
+
+  if (!process.env.RESEND_KEY || !process.env.MAIL_TO) {
+    return;
+  }
+
+  if (failure) {
+    if (!config.sendMailOnFailure) {
+      return;
+    }
+  } else {
+    if (!config.sendMailOnSuccess) {
+      return;
+    }
+  }
+
+  const messageContent = typeof message === 'object'
+    ? JSON.stringify(message)
+    : message;
+
+  try {
+    const resend = new Resend(process.env.RESEND_KEY);
+
+    await resend.emails.send({
+      from: '[email protected]',
+      to: process.env.MAIL_TO,
+      subject,
+      html: messageContent,
+    });
+  } catch (err) {
+    console.log('Error sending mail');
+    
+    console.log(err);
+    
+  }
+}