Feat: Only send for drafts

Author: ksambhi

email/mailmerge/src/pipelines/send.spec.ts

@@ -123,6 +123,45 @@ describe("sendEmails", () => {
         expect(mockMailer.sendMail).toHaveBeenCalledTimes(1);
     });
 
+    it("should send no emails if only send 0", async () => {
+        const mergeResults: MergeResultWithMetadata<unknown>[] = [
+            {
+                record: { field1: "value1" },
+                /// @ts-expect-error: Mocking previews
+                previews: ["preview"],
+                engineInfo: { name: "testEngine", options: {} },
+                email: { to: ["[email protected]"], subject: "Test Subject", cc: [], bcc: [] },
+                attachmentPaths: [],
+            },
+            {
+                record: { field1: "value2" },
+                /// @ts-expect-error: Mocking previews
+                previews: ["preview"],
+                engineInfo: { name: "testEngine", options: {} },
+                email: { to: ["[email protected]"], subject: "Test Subject 2", cc: [], bcc: [] },
+                attachmentPaths: [],
+            },
+        ];
+        (mockStorageBackend.loadMergeResults as jest.Mock).mockReturnValue(mergeResults);
+
+        const enginesMap = {
+            testEngine: mockEngineConstructor,
+        };
+
+        await sendEmails(
+            mockStorageBackend,
+            mockMailer,
+            '"From" <[email protected]>',
+            enginesMap,
+            true,
+            {
+                onlySend: 0,
+            },
+        );
+
+        expect(mockMailer.sendMail).toHaveBeenCalledTimes(0);
+    });
+
     it("should skip records with invalid engine", async () => {
         const mergeResults: MergeResultWithMetadata<unknown>[] = [
             {

email/mailmerge/src/pipelines/send.ts

@@ -44,6 +44,11 @@ export async function sendEmails(
 ) {
     logger.info(`Sending mail merge results...`);
 
+    if (options?.onlySend === 0) {
+        logger.warn(`onlySend is set to 0, so no emails will be sent.`);
+        return;
+    }
+
     // 1: Load data
     logger.info("Loading merge results...");
     const results = storageBackend.loadMergeResults();

email/mailmerge/src/pipelines/uploadDrafts.ts

@@ -9,6 +9,13 @@ import { EmailUploader } from "../graph/index.js";
 import { EmailString } from "../util/index.js";
 import { StorageBackend, MergeResultWithMetadata } from "./storage";
 
+interface UploadDraftsOptions {
+    /** Time to sleep between sending emails to prevent hitting rate limits */
+    sleepBetween?: number;
+    /** Only send this many emails (i.e. the first X emails) */
+    onlySend?: number;
+}
+
 /**
  * Upload mail merge results to drafts of an inbox using the Microsoft graph API
  *
@@ -28,12 +35,21 @@ export async function uploadDrafts(
     storageBackend: StorageBackend,
     enginesMap: Record<string, TemplateEngineConstructor> = ENGINES_MAP,
     disablePrompt = false,
-    sleepBetween = 0,
+    options: UploadDraftsOptions = {
+        sleepBetween: 0,
+    },
     entraTenantId = process.env["MS_ENTRA_TENANT_ID"],
     entraClientId = process.env["MS_ENTRA_CLIENT_ID"],
     expectedEmail = "[email protected]",
     logger = createLogger("docsoc"),
 ) {
+    const { sleepBetween = 0, onlySend } = options;
+
+    if (onlySend === 0) {
+        logger.warn(`onlySend is set to 0, so no emails will be sent.`);
+        return;
+    }
+
     logger.info(`Uploading previews to drafts...`);
     // 1: Load data
     logger.info("Loading merge results...");
@@ -139,6 +155,12 @@ export async function uploadDrafts(
             options,
         );
 
+        // Only send check
+        if (onlySend && sent >= onlySend) {
+            logger.warn(`Only sending ${onlySend} emails as requested.`);
+            break;
+        }
+
         if (sleepBetween > 0) {
             logger.warn(`Sleeping for ${sleepBetween} seconds to prevent hitting rate limits...`);
             await new Promise((resolve) => setTimeout(resolve, sleepBetween * 1000));