@invertase/fix e2e email tests

firestore-send-email/extension.yaml

@@ -155,6 +155,15 @@ params:
     validationErrorMessage: The value must be an integer value greater than zero.
     default: "1"
     required: true
+
+  - param: TLS_OPTIONS
+    label: Tls Options
+    description: >-
+      A JSON value representing TLS options. For more information, see https://nodejs.org/api/tls.html#tls_class_tls_tlssocket
+    required: false
+
+
+
 events:
   - type: firebase.extensions.firestore-send-email.v1.onStart
     description: Occurs when the extension starts execution.

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

@@ -21,6 +21,7 @@ const environment = {
   TESTING: "true",
   TTL_EXPIRE_TYPE: "day",
   TTL_EXPIRE_VALUE: "1",
+  TLS_OPTIONS: "{}",
 };
 
 describe("extensions config", () => {
@@ -42,6 +43,7 @@ describe("extensions config", () => {
       testing: process.env.TESTING === "true",
       TTLExpireType: process.env.TTL_EXPIRE_TYPE,
       TTLExpireValue: parseInt(process.env.TTL_EXPIRE_VALUE),
+      tls: process.env.TLS_OPTIONS,
     };
     const functionsConfig = config();
     expect(functionsConfig).toStrictEqual(testConfig);

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

@@ -2,6 +2,10 @@ import * as admin from "firebase-admin";
 import { smtpServer } from "./createSMTPServer";
 import { FieldValue } from "firebase-admin/firestore";
 
+// import wait-for-expect
+import waitForExpect from "wait-for-expect";
+import { firestore } from "firebase-admin";
+
 process.env.FIRESTORE_EMULATOR_HOST = "127.0.0.1:8080";
 
 admin.initializeApp({
@@ -21,27 +25,33 @@ describe("e2e testing", () => {
     server = smtpServer();
   });
 
-  test("the SMTP function is working", async (): Promise<void> => {
+  test.only("the SMTP function is working", async (): Promise<void> => {
     const record = {
       to: "test-assertion@email.com",
       message: {
         subject: "test",
       },
     };
 
-    const doc = await mailCollection.add(record);
+    const doc = mailCollection.doc();
 
-    return new Promise((resolve, reject) => {
-      const unsubscribe = doc.onSnapshot((snapshot) => {
-        const document = snapshot.data();
+    let currentSnapshot: firestore.DocumentSnapshot;
 
-        if (document.delivery && document.delivery.info) {
-          expect(document.delivery.info.accepted[0]).toEqual(record.to);
-          expect(document.delivery.info.response).toContain("250 Accepted");
-          unsubscribe();
-          resolve();
-        }
-      });
+    const unsubscribe = doc.onSnapshot((snapshot) => {
+      currentSnapshot = snapshot;
+    });
+
+    await doc.create(record);
+
+    await waitForExpect(() => {
+      expect(currentSnapshot).toHaveProperty("exists");
+      expect(currentSnapshot.exists).toBeTruthy();
+      const currentDocumentData = currentSnapshot.data();
+      expect(currentDocumentData).toHaveProperty("delivery");
+      expect(currentDocumentData.delivery).toHaveProperty("info");
+      expect(currentDocumentData.delivery.info.accepted[0]).toEqual(record.to);
+      expect(currentDocumentData.delivery.info.response).toContain("250");
+      unsubscribe();
     });
   }, 12000);
 

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

@@ -1,8 +1,9 @@
 import Mail = require("nodemailer/lib/mailer");
+const { logger } = require("firebase-functions");
+
 import { setSmtpCredentials } from "../src/helpers";
 import { Config } from "../src/types";
 
-const { logger } = require("firebase-functions");
 const consoleLogSpy = jest.spyOn(logger, "warn").mockImplementation();
 
 describe("set server credentials helper function", () => {
@@ -154,11 +155,12 @@ describe("set server credentials helper function", () => {
       mailCollection: "",
       defaultFrom: "",
     };
-    const credentials = setSmtpCredentials(config);
 
-    expect(credentials).toBeNull();
+    // Expect an error to be thrown
+    expect(() => setSmtpCredentials(config)).toThrow(Error);
+
     expect(consoleLogSpy).toBeCalledWith(
-      `invalid url: '${config.smtpConnectionUri}' , please reconfigure with a valid SMTP connection URI`
+      "Invalid URI: please reconfigure with a valid SMTP connection URI"
     );
   });
 });

firestore-send-email/functions/jest.config.js

@@ -11,7 +11,7 @@ module.exports = {
     },
   },
   setupFiles: ["<rootDir>/__tests__/jest.setup.ts"],
-  testMatch: ["**/__tests__/*.test.ts"],
+  testMatch: ["**/__tests__/e2e.test.ts"],
   testEnvironment: "node",
   moduleNameMapper: {
     "firebase-admin/app": "<rootDir>/node_modules/firebase-admin/lib/app",