@budibase/worker 3.11.1 → 3.12.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@budibase/worker",
   "email": "hi@budibase.com",
-  "version": "3.11.1",
+  "version": "3.12.0",
   "description": "Budibase background service",
   "main": "src/index.ts",
   "repository": {
@@ -69,6 +69,7 @@
     "koa-static": "5.0.0",
     "koa-useragent": "^4.1.0",
     "lodash": "4.17.21",
+    "marked": "^15.0.11",
     "node-fetch": "2.6.7",
     "nodemailer": "6.9.9",
     "passport-google-oauth": "2.0.0",
@@ -92,6 +93,7 @@
     "@types/server-destroy": "1.0.1",
     "@types/supertest": "2.0.14",
     "@types/uuid": "8.3.4",
+    "cheerio": "^1.0.0",
     "jest": "29.7.0",
     "maildev": "^2.2.1",
     "nock": "^13.5.4",
@@ -121,5 +123,5 @@
       }
     }
   },
-  "gitHead": "721e06c1447afa703270d0c1020ca792c23590b7"
+  "gitHead": "4d3f7719ab1ae02d3d01908b8a14a31a0c81445d"
 }

package/src/api/routes/global/tests/email.spec.ts

@@ -9,6 +9,7 @@ import {
   stopMailserver,
 } from "../../../../tests/mocks/email"
 import { objectStore } from "@budibase/backend-core"
+import * as cheerio from "cheerio"
 
 describe("/api/global/email", () => {
   const config = new TestConfiguration()
@@ -266,4 +267,118 @@ describe("/api/global/email", () => {
       `DTEND:${formatDate(endTime)}`
     )
   })
+
+  it("Should parse valid markdown content from automation steps into valid HTML.", async () => {
+    // Basic verification that the markdown is being processed.
+    const email = await captureEmail(mailserver, async () => {
+      const res = await config.api.emails.sendEmail({
+        email: "to@example.com",
+        subject: "Test",
+        userId: config.user!._id,
+        contents: `test@home.com [Call Me!](tel:1111111)`,
+        purpose: EmailTemplatePurpose.CUSTOM,
+      })
+      expect(res.message).toBeDefined()
+    })
+
+    const $ = cheerio.load(email.html)
+
+    // Verify the email body rendered
+    const emailBody = $("td.email-body").first()
+    expect(emailBody.length).toBe(1)
+
+    // Verify a valid link was generated and is queryable
+    const emailLink = $("a[href^='mailto:']").first()
+    expect(emailLink.length).toBe(1)
+    expect(emailLink.text()).toBe("test@home.com")
+
+    // Verify the markdown link has been built correctly
+    const phoneLink = $("a[href^='tel:']").first()
+    expect(phoneLink.length).toBe(1)
+    expect(phoneLink.text()).toBe("Call Me!")
+    expect(phoneLink.attr("href")).toBe("tel:1111111")
+  })
+
+  it("Should ignore invalid markdown content and return nothing", async () => {
+    // The only failure case for a parse with marked is 'undefined'
+    // It should be caught and resolve to nothing.
+    const email = await captureEmail(mailserver, async () => {
+      const res = await config.api.emails.sendEmail({
+        email: "to@example.com",
+        subject: "Test",
+        userId: config.user!._id,
+        contents: undefined,
+        purpose: EmailTemplatePurpose.CUSTOM,
+      })
+      expect(res.message).toBeDefined()
+    })
+
+    const $ = cheerio.load(email.html)
+    const emailBody = $("td.email-body").first()
+    expect(emailBody.length).toBe(1)
+
+    const bodyText = emailBody.text().trim()
+    expect(bodyText).toBe("")
+  })
+
+  it("Should render a mixture of content. Plain text, markdown and HTML", async () => {
+    // A more involved check to ensure all content types are still respected
+    const email = await captureEmail(mailserver, async () => {
+      const res = await config.api.emails.sendEmail({
+        email: "to@example.com",
+        subject: "Test",
+        userId: config.user!._id,
+        contents: `<div class="html-content"><strong>Some content</strong></div>
+
+# A heading
+ - This should be list entry 1
+ - This should be list entry 2
+
+Some plain text`,
+        purpose: EmailTemplatePurpose.CUSTOM,
+      })
+      expect(res.message).toBeDefined()
+    })
+
+    const $ = cheerio.load(email.html)
+    const emailBody = $("td.email-body").first()
+    expect(emailBody.length).toBe(1)
+
+    const divEle = emailBody.find("div.html-content").first()
+    expect(divEle.length).toBe(1)
+    expect(divEle.text()).toBe("Some content")
+
+    const heading = emailBody.find("h1").first()
+    expect(heading.length).toBe(1)
+    expect(heading.text()).toBe("A heading")
+
+    // Both list items rendered
+    const listEles = emailBody.find("ul li")
+    expect(listEles.length).toBe(2)
+
+    const plainText = emailBody.find("p")
+    expect(plainText.length).toBe(1)
+    expect(plainText.text()).toBe("Some plain text")
+  })
+
+  it("Should only parse markdown content for the CUSTOM email template used in automation steps", async () => {
+    const email = await captureEmail(mailserver, async () => {
+      const res = await config.api.emails.sendEmail({
+        email: "to@example.com",
+        subject: "Test",
+        userId: config.user!._id,
+        purpose: EmailTemplatePurpose.INVITATION,
+      })
+      expect(res.message).toBeDefined()
+    })
+
+    const $ = cheerio.load(email.html)
+    const emailBody = $("td.email-body").first()
+    expect(emailBody.length).toBe(1)
+
+    const heading = emailBody.find("h1").first()
+    expect(heading.length).toBe(1)
+    // The email should not be parsed as markdown.
+    expect(heading.text()).toBe("Hi, to@example.com!")
+  })
 })

package/src/api/routes/global/tests/roles.spec.ts

@@ -1,6 +1,11 @@
 import { structures, TestConfiguration } from "../../../../tests"
 import { context, db, roles } from "@budibase/backend-core"
-import { App, Database, BuiltinPermissionID } from "@budibase/types"
+import {
+  App,
+  Database,
+  BuiltinPermissionID,
+  WithoutDocMetadata,
+} from "@budibase/types"
 
 jest.mock("@budibase/backend-core", () => {
   const core = jest.requireActual("@budibase/backend-core")
@@ -30,7 +35,7 @@ async function addAppMetadata() {
   })
 }
 
-async function updateAppMetadata(update: Partial<Omit<App, "_id" | "_rev">>) {
+async function updateAppMetadata(update: Partial<WithoutDocMetadata<App>>) {
   const app = await appDb.get("app_metadata")
   await appDb.put({
     ...app,

package/src/api/routes/global/tests/scim.spec.ts

@@ -839,9 +839,8 @@ describe("scim", () => {
 
       it("creating an external group that conflicts an internal one syncs the existing group", async () => {
         const groupToSave = structures.userGroups.userGroup()
-        const { body: internalGroup } = await config.api.groups.saveGroup(
-          groupToSave
-        )
+        const { body: internalGroup } =
+          await config.api.groups.saveGroup(groupToSave)
 
         const scimGroupData = {
           externalId: structures.uuid(),

package/src/constants/templates/base.hbs

@@ -47,7 +47,7 @@
     body,
     td,
     th {
-      font-family: "Source Sans Pro", Helvetica, Arial, sans-serif;
+      font-family: "Source Sans 3", Helvetica, Arial, sans-serif;
     }
 
     h1 {

package/src/utilities/email.ts

@@ -12,6 +12,7 @@ import {
 import { configs, cache, objectStore, HTTPError } from "@budibase/backend-core"
 import ical from "ical-generator"
 import _ from "lodash"
+import { marked } from "marked"
 
 import nodemailer from "nodemailer"
 import SMTPTransport from "nodemailer/lib/smtp-transport"
@@ -97,7 +98,10 @@ async function buildEmail(
   }
   context = {
     ...context,
-    contents,
+    contents:
+      purpose === EmailTemplatePurpose.CUSTOM
+        ? marked.parse(contents || "")
+        : contents,
     email,
     name,
     user: user || {},