Merge pull request #1817 from firebase/fix/send-email-url-validate

firestore-send-email/extension.yaml

@@ -69,7 +69,7 @@ params:
        `smtps://username@gmail.com:password@smtp.gmail.com:465`. (username and password)
     type: string
     example: smtps://username@smtp.hostname.com:465
-    validationRegex: ^(smtp[s]*://.*?:[0-9]+.*$)
+    validationRegex: ^(smtp[s]*://(.*?(:[^:@]*)?@)?[^:@]+:[0-9]+(\\?[^ ]*)?)$
     validationErrorMessage: Invalid SMTP connection URI. Must be in the form `smtp(s)://username:password@hostname:port` or `smtp(s)://username@hostname:port`.
     required: true
 

firestore-send-email/functions/__tests__/helpers.test.ts

@@ -5,8 +5,13 @@ import { Config } from "../src/types";
 const { logger } = require("firebase-functions");
 const consoleLogSpy = jest.spyOn(logger, "warn").mockImplementation();
 
+// This is a regex to validate the smtpConnectionUri in extension.yaml
+const regex = new RegExp(
+  "^(smtp[s]*://(.*?(:[^:@]*)?@)?[^:@]+:[0-9]+(\\?[^ ]*)?)$"
+);
+
 describe("set server credentials helper function", () => {
-  test(" return smtpServerDomain credentials with new password", () => {
+  test("return smtpServerDomain credentials with new password", () => {
     const config: Config = {
       smtpConnectionUri:
         "smtps://fakeemail@gmail.com:secret-password@smtp.gmail.com:465",
@@ -21,6 +26,9 @@ describe("set server credentials helper function", () => {
     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 smtpServerDomain credentials with new password (old deleted)", () => {
@@ -37,6 +45,9 @@ describe("set server credentials helper function", () => {
     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", () => {
@@ -54,6 +65,9 @@ describe("set server credentials helper function", () => {
     expect(credentials.options.auth.user).toBe("fakeemail@gmail.com");
     expect(credentials.options.auth.pass).toBe("secret-password");
     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 without any password", () => {
@@ -70,6 +84,9 @@ describe("set server credentials helper function", () => {
     expect(credentials.options.auth.user).toBe("fakeemail@gmail.com");
     expect(credentials.options.auth.pass).toBe("");
     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 without any password and username", () => {
@@ -85,6 +102,9 @@ describe("set server credentials helper function", () => {
     expect(credentials.options.host).toBe("smtp.gmail.com");
     expect(credentials.options.auth).toBe(undefined);
     expect(credentials.options.secure).toBe(false);
+
+    // The regex should match the smtpConnectionUri, it should be valid
+    expect(regex.test(config.smtpConnectionUri)).toBe(true);
   });
 
   test("return smtpConnectionUri credentials with query params", () => {
@@ -104,6 +124,9 @@ describe("set server credentials helper function", () => {
     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 valid smtpConnectionUri credentials with special chars in password config", () => {
@@ -124,6 +147,9 @@ describe("set server credentials helper function", () => {
     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 valid smtpConnectionUri credentials with valid special chars in connectionUri password", () => {
@@ -144,6 +170,9 @@ describe("set server credentials helper function", () => {
     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", () => {
@@ -161,4 +190,27 @@ describe("set server credentials helper function", () => {
       `invalid url: '${config.smtpConnectionUri}' , please reconfigure with a valid SMTP connection URI`
     );
   });
+  test("return valid smtpConnectionUri credentials with correct seprator", () => {
+    const config: Config = {
+      smtpConnectionUri:
+        "smtp://fakeemail@gmail.com:4,h?dhuNTbv9zMrP4&7&7%*3@smtp.gmail.com:465?pool=true&service=gmail",
+      location: "",
+      mailCollection: "",
+      defaultFrom: "",
+    };
+
+    expect(regex.test(config.smtpConnectionUri)).toBe(true);
+  });
+
+  test("return invalid smtpConnectionUri credentials with invalid seprator", () => {
+    const config: Config = {
+      smtpConnectionUri:
+        "smtp://fakeemail@gmail.com:4,h?dhuNTbv9zMrP4&7&7%*3:smtp.gmail.com:465?pool=true&service=gmail",
+      location: "",
+      mailCollection: "",
+      defaultFrom: "",
+    };
+
+    expect(regex.test(config.smtpConnectionUri)).toBe(false);
+  });
 });