feat: Add support for sendgrid and logger notification providers (#7290)

* feat: Add support for sendgrid and logger notification providers * fix: changes based on PR review
2024-05-11 17:40:03 +02:00
parent 1a68f4602c
commit 79758c46b6
24 changed files with 631 additions and 1 deletions
@@ -0,0 +1,70 @@
+import { SendgridNotificationService } from "../../src/services/sendgrid"
+jest.setTimeout(100000)
+
+// Note: This test hits the sendgrid service, and it is mainly meant to be run manually after setting all the envvars below.
+// We could also setup a sink email service to test this automatically, but it is not necessary for the time being.
+describe.skip("Sendgrid notification provider", () => {
+  let sendgridService: SendgridNotificationService
+  let emailTemplate = ""
+  let to = ""
+  beforeAll(() => {
+    sendgridService = new SendgridNotificationService(
+      {
+        logger: console as any,
+      },
+      {
+        api_key: process.env.SENDGRID_TEST_API_KEY ?? "",
+        from: process.env.SENDGRID_TEST_FROM ?? "",
+      }
+    )
+
+    emailTemplate = process.env.SENDGRID_TEST_TEMPLATE ?? ""
+    to = process.env.SENDGRID_TEST_TO ?? ""
+  })
+
+  it("sends an email with the specified template", async () => {
+    const resp = await sendgridService.send({
+      to,
+      channel: "email",
+      template: emailTemplate,
+      data: {
+        username: "john-doe",
+      },
+    })
+
+    expect(resp).toEqual({})
+  })
+
+  it("throws an exception if the template does not exist", async () => {
+    const error = await sendgridService
+      .send({
+        to,
+        channel: "email",
+        template: "unknown-template",
+        data: {
+          username: "john-doe",
+        },
+      })
+      .catch((e) => e)
+
+    expect(error.message).toEqual(
+      "Failed to send email: 400 - The template_id must be a valid GUID, you provided 'unknown-template'."
+    )
+  })
+  it("throws an exception if the to email is not valid", async () => {
+    const error = await sendgridService
+      .send({
+        to: "not-email",
+        channel: "email",
+        template: emailTemplate,
+        data: {
+          username: "john-doe",
+        },
+      })
+      .catch((e) => e)
+
+    expect(error.message).toEqual(
+      "Failed to send email: 400 - Does not contain a valid address."
+    )
+  })
+})