fix: add support for SendGrid categories and streamline SendGrid dete…

…ction (#2053)
firebase · Dec 23, 2024 · 4a91d62 · 4a91d62
1 parent ed34bd6
commit 4a91d62
Show file tree

Hide file tree

Showing 7 changed files with 1,073 additions and 757 deletions.
diff --git a/firestore-send-email/functions/__tests__/helpers.test.ts b/firestore-send-email/functions/__tests__/helpers.test.ts
@@ -1,7 +1,7 @@
 import Mail = require("nodemailer/lib/mailer");
 const { logger } = require("firebase-functions");
 
-import { setSmtpCredentials } from "../src/helpers";
+import { setSmtpCredentials, isSendGrid } from "../src/helpers";
 import { Config } from "../src/types";
 
 const consoleLogSpy = jest.spyOn(logger, "warn").mockImplementation();
@@ -11,7 +11,7 @@ const regex = new RegExp(
   "^(smtp[s]*://(.*?(:[^:@]*)?@)?[^:@]+:[0-9]+(\\?[^ ]*)?)$"
 );
 
-describe("set server credentials helper function", () => {
+describe("setSmtpCredentials function", () => {
   test("return smtpServerDomain credentials with new password", () => {
     const config: Config = {
       smtpConnectionUri:
@@ -32,26 +32,7 @@ describe("set server credentials helper function", () => {
     expect(regex.test(config.smtpConnectionUri)).toBe(true);
   });
 
-  test("return smtpServerDomain credentials with new password (old deleted)", () => {
-    const config: Config = {
-      smtpConnectionUri: "smtps://fakeemail@gmail.com@smtp.gmail.com:465",
-      smtpPassword: "sec#:@ret-password",
-      location: "",
-      mailCollection: "",
-      defaultFrom: "",
-    };
-    const credentials = setSmtpCredentials(config);
-    expect(credentials).toBeInstanceOf(Mail);
-    expect(credentials.options.port).toBe(465);
-    expect(credentials.options.host).toBe("smtp.gmail.com");
-    expect(credentials.options.auth.pass).toBe(config.smtpPassword);
-    expect(credentials.options.secure).toBe(true);
-
-    // The regex should match the smtpConnectionUri, it should be valid
-    expect(regex.test(config.smtpConnectionUri)).toBe(true);
-  });
-
-  test("return smtpConnectionUri credentials with old password", () => {
+  test("return smtpServerDomain credentials with old password", () => {
     const config: Config = {
       smtpConnectionUri:
         "smtps://fakeemail@gmail.com:secret-password@smtp.gmail.com:465",
@@ -130,7 +111,7 @@ describe("set server credentials helper function", () => {
     expect(regex.test(config.smtpConnectionUri)).toBe(true);
   });
 
-  test("return valid smtpConnectionUri credentials with special chars in password config", () => {
+  test("return valid smtpConnectionUri credentials with valid special chars in password", () => {
     const config: Config = {
       smtpConnectionUri:
         "smtp://fakeemail@gmail.com@smtp.gmail.com:465?pool=true&service=gmail",
@@ -153,30 +134,7 @@ describe("set server credentials helper function", () => {
     expect(regex.test(config.smtpConnectionUri)).toBe(true);
   });
 
-  test("return valid smtpConnectionUri credentials with valid special chars in connectionUri password", () => {
-    const config: Config = {
-      smtpConnectionUri:
-        "smtp://fakeemail@gmail.com:4,hdhuNTbv9zMrP4&7&7%*3@smtp.gmail.com:465?pool=true&service=gmail",
-      location: "",
-      mailCollection: "",
-      defaultFrom: "",
-    };
-    const credentials = setSmtpCredentials(config);
-
-    expect(credentials).toBeInstanceOf(Mail);
-    expect(credentials.options.port).toBe(465);
-    expect(credentials.options.host).toBe("smtp.gmail.com");
-    expect(credentials.options.auth.user).toBe("fakeemail@gmail.com");
-    expect(credentials.options.auth.pass).toBe("4,hdhuNTbv9zMrP4&7&7%*3");
-    expect(credentials.options.secure).toBe(false);
-    expect(credentials.options.pool).toBe(true);
-    expect(credentials.options.service).toBe("gmail");
-
-    // The regex should match the smtpConnectionUri, it should be valid
-    expect(regex.test(config.smtpConnectionUri)).toBe(true);
-  });
-
-  test("return invalid smtpConnectionUri credentials with invalid special chars in connectionUri password", () => {
+  test("throw error for invalid smtpConnectionUri", () => {
     const config: Config = {
       smtpConnectionUri:
         "smtp://fakeemail@gmail.com:4,h?dhuNTbv9zMrP4&7&7%*3@smtp.gmail.com:465?pool=true&service=gmail",
@@ -185,48 +143,52 @@ describe("set server credentials helper function", () => {
       defaultFrom: "",
     };
 
-    // Expect an error to be thrown
     expect(() => setSmtpCredentials(config)).toThrow(Error);
-
     expect(consoleLogSpy).toBeCalledWith(
       "Invalid URI: please reconfigure with a valid SMTP connection URI"
     );
   });
-  test("return valid smtpConnectionUri credentials with correct seprator", () => {
+});
+
+describe("isSendGrid function", () => {
+  test("return true for SendGrid SMTP URI", () => {
     const config: Config = {
-      smtpConnectionUri:
-        "smtp://fakeemail@gmail.com:4,h?dhuNTbv9zMrP4&7&7%*3@smtp.gmail.com:465?pool=true&service=gmail",
+      smtpConnectionUri: "smtps://apikey@smtp.sendgrid.net:465",
       location: "",
       mailCollection: "",
       defaultFrom: "",
     };
 
-    expect(regex.test(config.smtpConnectionUri)).toBe(true);
+    expect(isSendGrid(config)).toBe(true);
   });
 
-  test("return invalid smtpConnectionUri credentials with invalid seprator", () => {
+  test("return false for non-SendGrid SMTP URI", () => {
     const config: Config = {
       smtpConnectionUri:
-        "smtp://fakeemail@gmail.com:4,h?dhuNTbv9zMrP4&7&7%*3:smtp.gmail.com:465?pool=true&service=gmail",
+        "smtps://fakeemail@gmail.com:secret-password@smtp.gmail.com:465",
       location: "",
       mailCollection: "",
       defaultFrom: "",
     };
 
-    expect(regex.test(config.smtpConnectionUri)).toBe(false);
+    expect(isSendGrid(config)).toBe(false);
   });
+});
 
-  /* Test removed due to the new SendGrid transporter logic - see setSendGridTransport()
-  test("return a SendGrid transporter if the host is smtp.sendgrid.net", () => {
-    const config: Config = {
-      smtpConnectionUri: "smtps://apikey@smtp.sendgrid.net:465",
-      location: "",
-      mailCollection: "",
-      defaultFrom: "",
-    };
-
-    const credentials = setSmtpCredentials(config);
-    expect(credentials.transporter.name === "nodemailer-sendgrid").toBe(true);
-  });
-  */
+test("correctly detects SendGrid SMTP URI", () => {
+  const config: Config = {
+    smtpConnectionUri: "smtps://apikey@smtp.sendgrid.net:465",
+    location: "",
+    mailCollection: "",
+    defaultFrom: "",
+  };
+  expect(isSendGrid(config)).toBe(true);
+
+  const invalidConfig: Config = {
+    smtpConnectionUri: "smtps://apikey@fake-sendgrid.net:465",
+    location: "",
+    mailCollection: "",
+    defaultFrom: "",
+  };
+  expect(isSendGrid(invalidConfig)).toBe(false);
 });