@budibase/worker 2.23.11 → 2.23.12

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@budibase/worker",
   "email": "hi@budibase.com",
-  "version": "2.23.11",
+  "version": "2.23.12",
   "description": "Budibase background service",
   "main": "src/index.ts",
   "repository": {
@@ -37,10 +37,10 @@
   "author": "Budibase",
   "license": "GPL-3.0",
   "dependencies": {
-    "@budibase/backend-core": "2.23.11",
-    "@budibase/pro": "2.23.11",
-    "@budibase/string-templates": "2.23.11",
-    "@budibase/types": "2.23.11",
+    "@budibase/backend-core": "2.23.12",
+    "@budibase/pro": "2.23.12",
+    "@budibase/string-templates": "2.23.12",
+    "@budibase/types": "2.23.12",
     "@koa/router": "8.0.8",
     "@techpass/passport-openidconnect": "0.3.2",
     "@types/global-agent": "2.1.1",
@@ -108,5 +108,5 @@
       }
     }
   },
-  "gitHead": "ec1634d42c00cb3cb86228f75d68251f42d1f05d"
+  "gitHead": "35dcb2465a0a116c4a6169a01b6154990747627a"
 }

package/src/api/controllers/global/email.ts

@@ -15,6 +15,7 @@ export async function sendEmail(ctx: BBContext) {
     bcc,
     automation,
     invite,
+    attachments,
   } = ctx.request.body
   let user: any
   if (userId) {
@@ -31,6 +32,7 @@ export async function sendEmail(ctx: BBContext) {
     bcc,
     automation,
     invite,
+    attachments,
   })
   ctx.body = {
     ...response,

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

@@ -1,10 +1,16 @@
 jest.unmock("node-fetch")
+jest.unmock("aws-sdk")
 import { TestConfiguration } from "../../../../tests"
 import { EmailTemplatePurpose } from "../../../../constants"
+import { objectStoreTestProviders } from "@budibase/backend-core/tests"
+import { objectStore } from "@budibase/backend-core"
+import tk from "timekeeper"
+import { EmailAttachment } from "@budibase/types"
 
-const nodemailer = require("nodemailer")
 const fetch = require("node-fetch")
 
+const nodemailer = require("nodemailer")
+
 // for the real email tests give them a long time to try complete/fail
 jest.setTimeout(30000)
 
@@ -12,14 +18,20 @@ describe("/api/global/email", () => {
   const config = new TestConfiguration()
 
   beforeAll(async () => {
+    tk.reset()
+    await objectStoreTestProviders.minio.start()
     await config.beforeAll()
   })
 
   afterAll(async () => {
+    await objectStoreTestProviders.minio.stop()
     await config.afterAll()
   })
 
-  async function sendRealEmail(purpose: string) {
+  async function sendRealEmail(
+    purpose: string,
+    attachments?: EmailAttachment[]
+  ) {
     let response, text
     try {
       const timeout = () =>
@@ -35,8 +47,14 @@ describe("/api/global/email", () => {
         )
       await Promise.race([config.saveEtherealSmtpConfig(), timeout()])
       await Promise.race([config.saveSettingsConfig(), timeout()])
-
-      const res = await config.api.emails.sendEmail(purpose).timeout(20000)
+      let res
+      if (attachments) {
+        res = await config.api.emails
+          .sendEmail(purpose, attachments)
+          .timeout(20000)
+      } else {
+        res = await config.api.emails.sendEmail(purpose).timeout(20000)
+      }
       // ethereal hiccup, can't test right now
       if (res.status >= 300) {
         return
@@ -80,4 +98,25 @@ describe("/api/global/email", () => {
   it("should be able to send a password recovery email", async () => {
     await sendRealEmail(EmailTemplatePurpose.PASSWORD_RECOVERY)
   })
+
+  it("should be able to send an email with attachments", async () => {
+    let bucket = "testbucket"
+    let filename = "test.txt"
+    await objectStore.upload({
+      bucket,
+      filename,
+      body: Buffer.from("test data"),
+    })
+    let presignedUrl = await objectStore.getPresignedUrl(
+      bucket,
+      filename,
+      60000
+    )
+
+    let attachmentObject = {
+      url: presignedUrl,
+      filename,
+    }
+    await sendRealEmail(EmailTemplatePurpose.WELCOME, [attachmentObject])
+  })
 })

package/src/tests/api/email.ts

@@ -1,3 +1,4 @@
+import { EmailAttachment } from "@budibase/types"
 import TestConfiguration from "../TestConfiguration"
 import { TestAPI } from "./base"
 
@@ -6,11 +7,12 @@ export class EmailAPI extends TestAPI {
     super(config)
   }
 
-  sendEmail = (purpose: string) => {
+  sendEmail = (purpose: string, attachments?: EmailAttachment[]) => {
     return this.request
       .post(`/api/global/email/send`)
       .send({
         email: "test@example.com",
+        attachments,
         purpose,
         tenantId: this.config.getTenantId(),
         userId: this.config.user?._id!,

package/src/tests/jestEnv.ts

@@ -4,8 +4,8 @@ process.env.JWT_SECRET = "test-jwtsecret"
 process.env.LOG_LEVEL = process.env.LOG_LEVEL || "error"
 process.env.MULTI_TENANCY = "1"
 process.env.MINIO_URL = "http://localhost"
-process.env.MINIO_ACCESS_KEY = "test"
-process.env.MINIO_SECRET_KEY = "test"
+process.env.MINIO_ACCESS_KEY = "budibase"
+process.env.MINIO_SECRET_KEY = "budibase"
 process.env.PLATFORM_URL = "http://localhost:10000"
 process.env.INTERNAL_API_KEY = "tet"
 process.env.DISABLE_ACCOUNT_PORTAL = "0"

package/src/tests/structures/configs.ts

@@ -62,8 +62,8 @@ export function smtpEthereal(): SMTPConfig {
       from: "testfrom@example.com",
       secure: false,
       auth: {
-        user: "wyatt.zulauf29@ethereal.email",
-        pass: "tEwDtHBWWxusVWAPfa",
+        user: "mortimer.leuschke@ethereal.email",
+        pass: "5hSjsPbzRv7gEUsfzx",
       },
       connectionTimeout: 1000, // must be less than the jest default of 5000
     },

package/src/utilities/email.ts

@@ -4,8 +4,10 @@ import { getTemplateByPurpose, EmailTemplates } from "../constants/templates"
 import { getSettingsTemplateContext } from "./templates"
 import { processString } from "@budibase/string-templates"
 import { User, SendEmailOpts, SMTPInnerConfig } from "@budibase/types"
-import { configs, cache } from "@budibase/backend-core"
+import { configs, cache, objectStore } from "@budibase/backend-core"
 import ical from "ical-generator"
+import fetch from "node-fetch"
+import path from "path"
 
 const nodemailer = require("nodemailer")
 
@@ -162,6 +164,42 @@ export async function sendEmail(
       contents: opts?.contents,
     }),
   }
+  if (opts?.attachments) {
+    const attachments = await Promise.all(
+      opts.attachments?.map(async attachment => {
+        const isFullyFormedUrl =
+          attachment.url.startsWith("http://") ||
+          attachment.url.startsWith("https://")
+        if (isFullyFormedUrl) {
+          const response = await fetch(attachment.url)
+          if (!response.ok) {
+            throw new Error(`unexpected response ${response.statusText}`)
+          }
+          const fallbackFilename = path.basename(
+            new URL(attachment.url).pathname
+          )
+          return {
+            filename: attachment.filename || fallbackFilename,
+            content: response?.body,
+          }
+        } else {
+          const url = attachment.url
+          const result = objectStore.extractBucketAndPath(url)
+          if (result === null) {
+            throw new Error("Invalid signed URL")
+          }
+          const { bucket, path } = result
+          const readStream = await objectStore.getReadStream(bucket, path)
+          const fallbackFilename = path.split("/").pop() || ""
+          return {
+            filename: attachment.filename || fallbackFilename,
+            content: readStream,
+          }
+        }
+      })
+    )
+    message = { ...message, attachments }
+  }
 
   message = {
     ...message,