feat(api-mailer): make sure that default mailer is present

webiny · Oct 25, 2022 · 3dfdd3e · 3dfdd3e
1 parent 260ba01
commit 3dfdd3e
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 12 deletions.
diff --git a/packages/api-mailer/__tests__/transporter.crud.test.ts b/packages/api-mailer/__tests__/transporter.crud.test.ts
@@ -172,4 +172,22 @@ describe("Mailer Transporter CRUD", () => {
             error: null
         });
     });
+
+    it("should use dummy transporter because of non-existing settings", async () => {
+        delete process.env.WEBINY_MAILER_HOST;
+        delete process.env.WEBINY_MAILER_USER;
+        delete process.env.WEBINY_MAILER_PASSWORD;
+        delete process.env.WEBINY_MAILER_REPLY_TO;
+        delete process.env.WEBINY_MAILER_FROM;
+
+        const context = await handle();
+
+        const result = await context.mailer.getTransport();
+
+        expect(result).toEqual({
+            name: "dummy-default",
+            send: expect.any(Function),
+            getAllSent: expect.any(Function)
+        });
+    });
 });
diff --git a/...ler/src/crud/mailer/onMailerBeforeSend.ts → ...c/crud/transport/onTransportBeforeSend.ts b/...ler/src/crud/mailer/onMailerBeforeSend.ts → ...c/crud/transport/onTransportBeforeSend.ts
diff --git a/packages/api-mailer/src/crud/transporter.crud.ts b/packages/api-mailer/src/crud/transporter.crud.ts
@@ -8,15 +8,15 @@ import {
     MailerTransporterContext
 } from "~/types";
 import { createTopic } from "@webiny/pubsub";
-import { attachOnTransportBeforeSend } from "~/crud/mailer/onMailerBeforeSend";
+import { attachOnTransportBeforeSend } from "~/crud/transport/onTransportBeforeSend";
 import { CreateTransportPlugin } from "~/plugins";
 import WebinyError from "@webiny/error";
 
 import { createValidation } from "./settings/validation";
 
 interface BuildMailerParams {
     plugins: CreateTransportPlugin[];
-    settings: TransportSettings;
+    settings: TransportSettings | null;
     context: MailerContext;
 }
 
@@ -117,10 +117,9 @@ export const createTransporterCrud = async (
         }
         if (!settings && !defaultSettings) {
             console.log(`There are no Mailer transport settings for tenant "${tenant}".`);
-            return null;
         }
         const transporter = await buildTransporter({
-            settings: (settings || defaultSettings) as TransportSettings,
+            settings: settings || defaultSettings,
             plugins,
             context
         });
@@ -141,8 +140,8 @@ export const createTransporterCrud = async (
                 return {
                     result: null,
                     error: {
-                        message: "There is no mailer available.",
-                        code: "NO_MAILER_DEFINED"
+                        message: "There is no transport available.",
+                        code: "NO_TRANSPORT_DEFINED"
                     }
                 };
             }

diff --git a/packages/api-mailer/src/index.ts b/packages/api-mailer/src/index.ts
@@ -34,9 +34,7 @@ export const createMailer = (): PluginCollection => {
          * Smtp mailer goes into the plugins after the dummy one because plugins are loaded in reverse.
          */
         createTransport(async params => {
-            const plugin = await createSmtpTransport({
-                ...params.settings
-            });
+            const plugin = await createSmtpTransport(params.settings);
             plugin.name = "smtp-default";
             return plugin;
         }),

diff --git a/packages/api-mailer/src/plugins/CreateTransportPlugin.ts b/packages/api-mailer/src/plugins/CreateTransportPlugin.ts
@@ -2,7 +2,7 @@ import { Plugin as BasePlugin } from "@webiny/plugins";
 import { Transport, MailerContext, TransportSettings } from "~/types";
 
 interface TransportParams {
-    settings: TransportSettings;
+    settings: TransportSettings | null;
     context: MailerContext;
 }
 

diff --git a/packages/api-mailer/src/transports/createSmtpTransport.ts b/packages/api-mailer/src/transports/createSmtpTransport.ts
@@ -13,8 +13,10 @@ export interface SmtpTransport extends Transport {
     transporter: Transporter<SMTPTransport.SentMessageInfo>;
 }
 
-export const createSmtpTransport = (config?: Partial<SmtpTransportConfig>): SmtpTransport => {
-    if (!config) {
+export const createSmtpTransport = (
+    config?: Partial<SmtpTransportConfig> | null
+): SmtpTransport => {
+    if (!config || typeof config !== "object" || Object.keys(config).length === 0) {
         throw new WebinyError("There is no configuration for the SMTP transport.");
     }