added some tsdoc, improved mail send error management

google · Dec 16, 2024 · 6990f3e · 6990f3e
1 parent f05b4ff
commit 6990f3e
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 18 deletions.
diff --git a/functions/src/common/mail-service.ts b/functions/src/common/mail-service.ts
@@ -72,23 +72,15 @@ export class MailService {
       },
     });
 
-    await new Promise<void>((resolve, reject) => {
-      this.transporter_.sendMail(
-        {from: this.sender_, ...email, html: safeHtml},
-        (error: Error | any, _: any) => {
-          if (error) {
-            // 501 and 550 are errors from the mail server: email address not found
-            if (error.responseCode === 501 || error.responseCode === 550) {
-              reject(new Error(error.response));
-            } else {
-              reject(error);
-            }
-          } else {
-            resolve();
-          }
-        }
-      );
-    });
+    try {
+      await this.transporter_.sendMail({
+        from: this.sender_,
+        ...email,
+        html: safeHtml,
+      });
+    } catch (err) {
+      console.error(err);
+    }
   }
 
   /**

diff --git a/functions/src/on-create-loi.ts b/functions/src/on-create-loi.ts
@@ -34,6 +34,13 @@ type PropertyGenerator = {
   url: string;
 };
 
+/**
+ * Handles the creation of a Location of Interest (LOI) document in Firestore.
+ * This function is triggered by a Cloud Function on Firestore document creation.
+ *
+ * @param snapshot The QueryDocumentSnapshot object containing the created LOI data.
+ * @param context The EventContext object provided by the Cloud Functions framework.
+ */
 export async function onCreateLoiHandler(
   snapshot: QueryDocumentSnapshot,
   context: EventContext

diff --git a/functions/src/on-create-passlist-entry.ts b/functions/src/on-create-passlist-entry.ts
@@ -20,6 +20,13 @@ import {getDatastore, getMailService} from './common/context';
 import {MailServiceEmail} from './common/mail-service';
 import {stringFormat} from './common/utils';
 
+/**
+ * Handles the creation of a passlist entry.
+ * This function is triggered by a Cloud Function on Firestore document creation.
+ *
+ * @param _ The QueryDocumentSnapshot object (unused in this function).
+ * @param context The EventContext object provided by the Cloud Functions framework.
+ */
 export async function onCreatePasslistEntryHandler(
   _: QueryDocumentSnapshot,
   context: EventContext
@@ -31,7 +38,7 @@ export async function onCreatePasslistEntryHandler(
   const template = await db.fetchMailTemplate('passlisted');
 
   if (!template) {
-    console.error('Template not found in /config/mail/templates/passlisted');
+    console.debug('Template not found in /config/mail/templates/passlisted');
     return;
   }