Send mails in chunks (#1509)

* Send mails to groups in chunks * Send mails to all members in chunks * Inline variable * Use const * Deduplicate recipients in chunked delivery * Remove unnecessary test setup * Use async/await * Ensure correct handling of duplicated recipients * Allow to take sender from Message * fix after merge * solution for the member question * final adaptions --------- Co-authored-by: leider <derleider@web.de>
softwerkskammer · Dec 8, 2024 · 4539ccd · 4539ccd
1 parent d3f2db2
commit 4539ccd
Show file tree

Hide file tree

Showing 7 changed files with 411 additions and 42 deletions.
diff --git a/config-examples/mailsender-config.json b/config-examples/mailsender-config.json
@@ -10,5 +10,6 @@
   "sender-name": "Softwerkskammer Benachrichtigungen",
   "sender-address": "info@my-domain.org",
   "include-footer": false,
-  "doNotSendMails": "insert email address here for local development as replacement for receivers"
+  "doNotSendMails": "insert email address here for local development as replacement for receivers",
+  "maxMailSendingChunkSize": 3
 }
diff --git a/softwerkskammer/lib/commons/statusmessage.js b/softwerkskammer/lib/commons/statusmessage.js
@@ -38,4 +38,8 @@ module.exports = {
   successMessage: function successMessage(title, text, additionalArguments) {
     return statusMessage("alert-success", title, text, additionalArguments);
   },
+
+  isErrorMessage: function isErrorMessage(statusmessage) {
+    return statusmessage.contents().type === "alert-danger";
+  },
 };
diff --git a/softwerkskammer/lib/mailsender/mailsenderService.js b/softwerkskammer/lib/mailsender/mailsenderService.js
@@ -1,6 +1,7 @@
 "use strict";
 const { DateTime } = require("luxon");
 const conf = require("simple-configure");
+const R = require("ramda");
 const logger = require("winston").loggers.get("application");
 
 const groupsService = require("../groups/groupsService");
@@ -16,6 +17,7 @@ const Group = require("../groups/group");
 const misc = require("../commons/misc");
 
 const mailtransport = require("./mailtransport");
+const statusmessage = require("../commons/statusmessage");
 
 async function sendMail(message, type) {
   return mailtransport.sendMail(message, type, conf.get("sender-address"), conf.get("include-footer"));
@@ -37,10 +39,40 @@ function activityMarkdown(activity, language) {
   return markdown;
 }
 
+function createChunkedSendingReportMessage(statusmessages, subject, message) {
+  const isError = R.any(statusmessage.isErrorMessage, statusmessages);
+  const markdown = isError
+    ? `Fehler: ${statusmessages.map((s) => s.contents().additionalArguments.err).join(" ")}`
+    : "E-Mails erfolgreich versendet";
+
+  return message.cloneWithBody({
+    subject: `${isError ? "ERROR" : "SUCCESS"} ${subject}`,
+    markdown,
+    sendCopyToSelf: true,
+  });
+}
+
+async function sendMailInChunks(maxMailSendingChunkSize, allMembers, message, type) {
+  const membersInChunks = R.splitEvery(maxMailSendingChunkSize, allMembers);
+
+  try {
+    const statusmessages = await Promise.all(
+      membersInChunks.map((bccs) => {
+        message.setBccToMemberAddresses(bccs);
+        return sendMail(message, type);
+      }),
+    );
+    const resultMessage = createChunkedSendingReportMessage(statusmessages, `Report "${message.subject}"`, message);
+    await sendMail(resultMessage, type);
+  } catch (err) {
+    logger.error(err);
+  }
+}
+
 module.exports = {
   activityMarkdown,
 
-  dataForShowingMessageForActivity: async function (activityURL, language) {
+  dataForShowingMessageForActivity: async function dataForShowingMessageForActivity(activityURL, language) {
     const [activity, groups] = [
       activitiesService.getActivityWithGroupAndParticipants(activityURL),
       groupstore.allGroups(),
@@ -105,7 +137,11 @@ module.exports = {
       }
       try {
         groups.forEach(groupsAndMembersService.addMembersToGroup);
-        message.setBccToGroupMemberAddresses(groups);
+        const allMembers = R.uniqBy(
+          (member) => member.email(),
+          groups.flatMap((group) => group.members),
+        );
+
         let activity;
         try {
           activity = activitystore.getActivity(activityURL);
@@ -115,7 +151,17 @@ module.exports = {
         if (activity) {
           message.setIcal(icalService.activityAsICal(activity).toString());
         }
-        return sendMail(message, type);
+
+        const maxMailSendingChunkSize = conf.get("maxMailSendingChunkSize");
+        if (allMembers.length > maxMailSendingChunkSize) {
+          // noinspection ES6MissingAwait - we explicitly don't want to wait because that could cause timeouts
+          sendMailInChunks(maxMailSendingChunkSize, allMembers, message, type);
+
+          return mailtransport.statusmessageForSuccess(type);
+        } else {
+          message.setBccToMemberAddresses(allMembers);
+          return sendMail(message, type);
+        }
       } catch (err1) {
         return mailtransport.statusmessageForError(type, err1);
       }
@@ -142,8 +188,11 @@ module.exports = {
   sendMailToAllMembers: async function sendMailToAllMembers(message) {
     const type = "$t(mailsender.notification)";
     const members = memberstore.allMembers();
-    message.setBccToMemberAddresses(members);
-    return sendMail(message, type);
+
+    // noinspection ES6MissingAwait - we explicitly don't want to wait because that could cause timeouts
+    sendMailInChunks(conf.get("maxMailSendingChunkSize"), members, message, type);
+
+    return mailtransport.statusmessageForSuccess(type);
   },
 
   sendMagicLinkToMember: async function sendMagicLinkToMember(member, token) {

diff --git a/softwerkskammer/lib/mailsender/message.js b/softwerkskammer/lib/mailsender/message.js
@@ -23,6 +23,14 @@ class Message {
     return this;
   }
 
+  cloneWithBody(body) {
+    const fakeMember = {
+      displayName: () => this.senderName,
+      email: () => this.senderAddress,
+    };
+    return new Message(body, fakeMember);
+  }
+
   setTo(toAddresses) {
     this.to = toAddresses;
   }