fix: add support for SendGrid categories and streamline SendGrid detection #2245

Gustolandia · 2024-12-21T01:55:26Z

This PR addresses the following improvements and fixes for the Firestore-Send-Email extension:

Enhancement: Increase in Payload Fields
Developers can now include categories.
Introduced a dynamic method for detecting SendGrid usage based on the SMTP_CONNECTION_URI.
Bug Fix: Categories Not Being Sent
The categories field was not properly passed to the SendGrid API in the previous implementation.
Modified the email preparation and transport logic to ensure that the categories field is passed as per SendGrid's requirements.
Refactored Code and Tests
Removed the unused nodemailer-sendgrid dependency to simplify the codebase and avoid confusion.
Updated helpers.ts and corresponding tests in helpers.test.ts to support the new dynamic SendGrid detection.
Added logs to indicate whether the email is being sent via SendGrid or the standard transport.
Changes:

Code Changes:
Updated src/index.ts to dynamically detect SendGrid and utilize the appropriate sending method.
Modified src/helpers.ts to add an isSendGrid function and streamline SMTP transport setup.
Updated src/types.ts to reflect the additional flexibility in payload fields.
Tests:
Refactored helpers.test.ts to test the new isSendGrid function.
Added additional test cases to validate the proper handling of various SMTP connection URIs.
Dependencies:
Removed nodemailer-sendgrid from package.json and package-lock.json.
How to Test:

Deploy the updated extension in a local Firebase project with the emulators enabled.
Use the following payload in the Firestore mail collection:

{
  "to": ["example@example.com"],
  "categories": ["Example_Category"],
  "message": {
    "subject": "Final Test for Categories",
    "text": "This is a test email to see if categories work.",
    "html": "<strong>This is a test email to see if categories work.</strong>"
  }
}

Verify:
The email is successfully sent.
The categories field is correctly registered in SendGrid.
Logs indicate whether the SendGrid or standard transport was used.

Linked Issues:

Resolves #2053
Reviewer Checklist:
Code adheres to the existing style and conventions.
New features are covered by unit tests.
Breaking changes are documented and communicated effectively.

firestore-send-email/functions/src/helpers.ts

firestore-send-email/functions/src/index.ts

firestore-send-email/functions/src/helpers.ts

cabljac

Generally looks good! a few comments about logs/deleting code comments to look at

firestore-send-email/functions/package.json

…ction (#2053)

pr-Mais · 2024-12-24T01:07:45Z

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

  });

-  test("return invalid smtpConnectionUri credentials with invalid seprator", () => {


We should keep this test

pr-Mais · 2024-12-24T01:08:36Z

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

@@ -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", () => {


why this test is removed?

pr-Mais · 2024-12-24T01:09:56Z

firestore-send-email/functions/src/index.ts

 }

 async function deliver(
  ref: admin.firestore.DocumentReference<QueuePayload>
 ): Promise<void> {
+  // Fetch the Firestore document


Suggested change

// Fetch the Firestore document

pr-Mais · 2024-12-24T01:11:59Z

firestore-send-email/functions/src/index.ts

+        msg: {
+          to: payload.to,
+          cc: payload.cc,
+          bcc: payload.bcc,
+          from: payload.from || config.defaultFrom,
+          replyTo: payload.replyTo || config.defaultReplyTo,
+          subject: payload.message?.subject,
+          text:
+            typeof payload.message?.text === "string"
+              ? payload.message?.text
+              : undefined,
+          html:
+            typeof payload.message?.html === "string"
+              ? payload.message?.html
+              : undefined,
+          categories: payload.categories,
+          headers: payload.headers,
+        },


assign the payload to a variable to avoid duplication

pr-Mais · 2024-12-24T01:12:28Z

firestore-send-email/functions/src/index.ts

-  // Wrapping in transaction to allow for automatic retries (#48)
+  // Update the Firestore document transactionally to allow retries


keep old comment as it's referencing an issue

pr-Mais · 2024-12-24T01:13:16Z

firestore-send-email/functions/src/types.ts

@@ -82,4 +82,14 @@ export interface QueuePayload {
  replyTo?: string;
  headers?: any;
  attachments: Attachment[];
+  categories?: string[];


is it needed here?

Gustolandia added type: bug Something isn't working invertase Assigned to external Invertase team extension: firestore-send-email Related to firestore-send-email extension labels Dec 21, 2024

Gustolandia requested review from dackers86, cabljac, CorieW and pr-Mais December 21, 2024 01:55

Gustolandia self-assigned this Dec 21, 2024

Gustolandia requested a review from a team as a code owner December 21, 2024 01:55

github-advanced-security bot found potential problems Dec 21, 2024

View reviewed changes

firestore-send-email/functions/src/helpers.ts Fixed Show resolved Hide resolved

Gustolandia force-pushed the @invertase/Extensions/firestore-send-email/2053 branch from dc52e35 to 10dccd8 Compare December 21, 2024 02:01

Gustolandia mentioned this pull request Dec 21, 2024

🐛 [firestore-send-email] Could not send category to sendGrid #2053

Open