@budibase/worker 3.13.10 → 3.13.11

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@budibase/worker",
   "email": "hi@budibase.com",
-  "version": "3.13.10",
+  "version": "3.13.11",
   "description": "Budibase background service",
   "main": "src/index.ts",
   "repository": {
@@ -68,7 +68,8 @@
     "pouchdb": "7.3.0",
     "pouchdb-all-dbs": "1.1.1",
     "server-destroy": "1.0.1",
-    "uuid": "^8.3.2"
+    "uuid": "^8.3.2",
+    "yaml": "^2.8.0"
   },
   "devDependencies": {
     "@jest/types": "^29.6.3",
@@ -113,5 +114,5 @@
       }
     }
   },
-  "gitHead": "9d6b86cc387bd1e3cc4ec8f3a1c7f8f3a94d1205"
+  "gitHead": "48114cd1183da82668db193e89c7dd708e1eb5fa"
 }

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

@@ -1,10 +1,15 @@
+import { v4 } from "uuid"
 import {
   TemplateMetadata,
   TemplateBindings,
   GLOBAL_OWNER,
 } from "../../../constants"
-import { getTemplateByID, getTemplates } from "../../../constants/templates"
-import { tenancy, db as dbCore } from "@budibase/backend-core"
+import {
+  addBaseTemplates,
+  getTemplateByID,
+  getTemplates,
+} from "../../../constants/templates"
+import { tenancy, db as dbCore, objectStore } from "@budibase/backend-core"
 import {
   DeleteGlobalTemplateResponse,
   FetchGlobalTemplateByOwnerIDResponse,
@@ -17,7 +22,12 @@ import {
   GlobalTemplateBinding,
   GlobalTemplateDefinition,
   UserCtx,
+  Ctx,
+  EmailTemplatePurpose,
 } from "@budibase/types"
+import { join } from "path"
+import fs from "fs"
+import yaml from "yaml"
 
 export async function save(
   ctx: UserCtx<SaveGlobalTemplateRequest, SaveGlobalTemplateResponse>
@@ -93,3 +103,58 @@ export async function destroy(
   await db.remove(ctx.params.id, ctx.params.rev)
   ctx.body = { message: `Template ${ctx.params.id} deleted.` }
 }
+
+function templatesToYaml(
+  templates: Array<{ contents: string; purpose: string }>
+): string {
+  const doc = new yaml.Document()
+
+  // Build the template object
+  const templatesObj: Record<string, yaml.Scalar> = {}
+  templates.forEach(template => {
+    const scalar = new yaml.Scalar(template.contents)
+    scalar.type = "BLOCK_LITERAL"
+    templatesObj[template.purpose] = scalar
+  })
+
+  // Set the document contents
+  doc.contents = doc.createNode({ templates: templatesObj })
+
+  return doc.toString()
+}
+
+export async function exportTemplates(ctx: Ctx) {
+  const { params } = ctx
+
+  // Limited to email for now
+  if (params.type === "email") {
+    // default|custom
+    const { type = "default" } = ctx.request?.body || {}
+
+    // Load either original or customised templates
+    const allTemplates =
+      type === "custom" ? await getTemplates() : addBaseTemplates([], "email")
+
+    const filtered = allTemplates.filter(
+      ({ purpose }) => purpose !== EmailTemplatePurpose.CORE
+    )
+    // Outline all the type keys
+    const header = `# Template types: ${filtered.map(t => t.purpose).join(", ")} :) \n\n`
+    const yamlContent = templatesToYaml(filtered)
+    try {
+      // Combine header and content
+      const finalYaml = header + yamlContent
+      ctx.attachment(
+        `${type === "custom" ? "bb_email_templates" : "bb_default_email_templates"}.yaml`
+      )
+      const path = join(objectStore.budibaseTempDir(), v4())
+      fs.writeFileSync(path, finalYaml)
+      ctx.body = fs.createReadStream(path)
+    } catch (err: any) {
+      ctx.throw(
+        err.status,
+        `Could not download email templates: ${err.message}`
+      )
+    }
+  }
+}

package/src/api/routes/global/templates.ts

@@ -33,6 +33,7 @@ router
   .get("/api/global/template/:type", controller.fetchByType)
   .get("/api/global/template/:ownerId", controller.fetchByOwner)
   .get("/api/global/template/:id", controller.find)
+  .post("/api/global/template/:type/export", controller.exportTemplates)
   .delete("/api/global/template/:id/:rev", adminOnly, controller.destroy)
 
 export default router

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

@@ -1,6 +1,9 @@
 import { TemplateMetadata, TemplateType } from "../../../../constants"
 import { TestConfiguration } from "../../../../tests"
-import { EmailTemplatePurpose } from "@budibase/types"
+import { EmailTemplatePurpose, Template } from "@budibase/types"
+import { addBaseTemplates } from "../../../../constants/templates"
+import { tenancy } from "@budibase/backend-core"
+import yaml from "yaml"
 
 // TODO
 
@@ -101,4 +104,91 @@ describe("/api/global/template", () => {
       ).toBeDefined()
     })
   })
+
+  describe("POST /api/global/template/:type/export - emails", () => {
+    let templates: Template[] = []
+
+    beforeAll(async () => {
+      addBaseTemplates(templates, "email")
+
+      // Core is not an updatable template and should never be included
+      templates = templates.filter(t => t.purpose !== EmailTemplatePurpose.CORE)
+
+      await config.beforeAll()
+
+      const templateResp = await config.api.templates.getTemplate()
+      const templateDocs = templateResp.body.filter((t: Template) => t._id)
+
+      // Purge all docs from the previous test blocks
+      await config.doInTenant(async () => {
+        const db = tenancy.getGlobalDB()
+        await db.bulkRemove(templateDocs)
+      })
+    })
+
+    it("should export all default email templates as yaml", async () => {
+      const resp = await config.api.templates.exportTemplates()
+
+      expect(resp.type).toBe("text/yaml")
+
+      const doc = yaml.parse(resp.text)
+
+      // Confirm the export file name
+      const disposition = resp.header["content-disposition"]
+      expect(disposition).toContain("bb_default_email_templates")
+
+      // All templates type should be present and match the hbs contents.
+      const processedTemplates = templates.filter(t => {
+        const yamlTemplateContents = doc.templates[t.purpose]
+        return t.contents === yamlTemplateContents
+      })
+
+      expect(processedTemplates.length).toBe(templates.length)
+    })
+
+    it("should export user edited email templates", async () => {
+      const customContent = "<div>hello</div>"
+
+      // Alter one of the templates. This creates 1 couch doc, for the custom type
+      // All the rest will still contain content from the static hbs files
+      await config.api.templates.saveTemplate({
+        purpose: EmailTemplatePurpose.CUSTOM,
+        contents: customContent,
+        type: "email",
+      })
+
+      const resp = await config.api.templates.exportTemplates({
+        data: {
+          type: "custom",
+        },
+      })
+
+      expect(resp.type).toBe("text/yaml")
+
+      const doc = yaml.parse(resp.text)
+
+      const disposition = resp.header["content-disposition"]
+      expect(disposition).toContain("bb_email_templates.yaml")
+
+      // All templates should be present and match both the static and custom contents
+      const processedTemplates = templates.filter(t => {
+        const yamlTemplateContents = doc.templates[t.purpose]
+        // Check the custom contents has been updated
+        if (t.purpose === EmailTemplatePurpose.CUSTOM) {
+          return yamlTemplateContents === customContent
+        }
+        return t.contents === yamlTemplateContents
+      })
+
+      expect(processedTemplates.length).toBe(templates.length)
+    })
+
+    it("should ignore non-email requests", async () => {
+      // Only email templates are supported.
+      await config.api.templates.exportTemplates(
+        { type: "something" },
+        { status: 404 }
+      )
+    })
+  })
 })

package/src/constants/templates/index.ts

@@ -1,8 +1,9 @@
 import { readStaticFile } from "../../utilities/fileSystem"
 import { TemplateType, TemplatePurpose, GLOBAL_OWNER } from "../index"
 import { join } from "path"
-import { db as dbCore, tenancy } from "@budibase/backend-core"
+import { db as dbCore, tenancy, context } from "@budibase/backend-core"
 import { Template, EmailTemplatePurpose } from "@budibase/types"
+import yaml from "yaml"
 
 export const EmailTemplates = {
   [EmailTemplatePurpose.PASSWORD_RECOVERY]: readStaticFile(
@@ -19,6 +20,78 @@ export const EmailTemplates = {
   [EmailTemplatePurpose.CORE]: readStaticFile(join(__dirname, "core.hbs")),
 }
 
+export const removeWhitespaceBetweenTags = (content: string) => {
+  return content.replace(/>\s+</g, "><").replace(/\s+/g, " ").trim()
+}
+
+export async function loadTemplateConfig(pathTo: string) {
+  let templateConfig: Record<string, string>
+
+  try {
+    console.log("Loading email templates:", pathTo)
+    const config = readStaticFile(pathTo)
+    const parsed = yaml.parse(config)
+
+    if (!parsed || !parsed.templates) {
+      console.log(`No email templates found: ${pathTo}`)
+      return
+    }
+
+    // Remove core as it contains licensed content
+    // Unlikely, but just to be certain
+    const { core, ...rest } = parsed.templates
+    templateConfig = rest
+  } catch (e: any) {
+    console.log("There was a problem parsing email templates: ", e.message)
+    return
+  }
+
+  await context.doInTenant(tenancy.getTenantId(), async () => {
+    try {
+      const templates = await getTemplates({ type: "email" })
+
+      const updates: Template[] = templates.reduce(
+        (acc: Template[], template: Template) => {
+          const config = templateConfig[template.purpose]
+          if (config) {
+            // Need to normalise the text spacing for comparison
+            const configContent = removeWhitespaceBetweenTags(config)
+            const templateContent = removeWhitespaceBetweenTags(
+              template.contents
+            )
+
+            // If the template is exactly the same, ignore it.
+            if (configContent === templateContent) return acc
+            const owner = template.ownerId || GLOBAL_OWNER
+            // Create/Update template docs
+            acc.push({
+              ...template,
+              contents: config,
+              ...(!template._id
+                ? { _id: dbCore.generateTemplateID(owner) }
+                : {}),
+              ownerId: owner,
+            })
+          }
+          return acc
+        },
+        []
+      )
+
+      if (updates.length) {
+        const updateList = updates.map(u => u.purpose)
+        const db = tenancy.getGlobalDB()
+        await db.bulkDocs(updates)
+        console.log(`Email templates updated: ${updateList.join(",")}`)
+      } else {
+        console.log(`Email templates unchanged`)
+      }
+    } catch (e: any) {
+      console.log("Error persisting email templates", e.message)
+    }
+  })
+}
+
 export function addBaseTemplates(templates: Template[], type?: string) {
   let purposeList
   switch (type) {

package/src/constants/templates/tests/email_templates.yaml

@@ -0,0 +1,523 @@
+# Template types: base, password_recovery, invitation, welcome, custom :)
+
+templates:
+  base: |-
+    <!-- Based on templates: https://github.com/wildbit/postmark-templates/blob/master/templates/plain -->
+    <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+    <html xmlns="http://www.w3.org/1999/xhtml">
+    <head>
+      <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+      <meta name="x-apple-disable-message-reformatting" />
+      <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+      <meta name="color-scheme" content="light dark" />
+      <meta name="supported-color-schemes" content="light dark" />
+      <title></title>
+      <style type="text/css" rel="stylesheet" media="all">
+        @import url('https://fonts.googleapis.com/css2?family=Source+Sans+Pro&display=swap');
+
+        body {
+          width: 100% !important;
+          height: 100%;
+          margin: 0;
+          -webkit-text-size-adjust: none;
+        }
+
+        a {
+          color: #6E56FF !important;
+        }
+
+        a img {
+          border: none;
+        }
+
+        td {
+          word-break: break-word;
+        }
+
+        .preheader {
+          display: none !important;
+          visibility: hidden;
+          mso-hide: all;
+          font-size: 1px;
+          line-height: 1px;
+          max-height: 0;
+          max-width: 0;
+          opacity: 0;
+          overflow: hidden;
+        }
+
+        /* Type ------------------------------ */
+
+        body,
+        td,
+        th {
+          font-family: "Source Sans 3", Helvetica, Arial, sans-serif;
+        }
+
+        h1 {
+          margin-top: 0;
+          color: #333333;
+          font-size: 22px;
+          font-weight: bold;
+          text-align: left;
+        }
+
+        h2 {
+          margin-top: 0;
+          color: #333333;
+          font-size: 16px;
+          font-weight: bold;
+          text-align: left;
+        }
+
+        h3 {
+          margin-top: 0;
+          color: #333333;
+          font-size: 14px;
+          font-weight: bold;
+          text-align: left;
+        }
+
+        td,
+        th {
+          font-size: 16px;
+        }
+
+        p,
+        ul,
+        ol,
+        blockquote {
+          margin: .4em 0 1.1875em;
+          font-size: 16px;
+          line-height: 1.625;
+        }
+
+        p.sub {
+          font-size: 13px;
+        }
+
+        /* Utilities ------------------------------ */
+
+        .align-right {
+          text-align: right;
+        }
+
+        .align-left {
+          text-align: left;
+        }
+
+        .align-center {
+          text-align: center;
+        }
+
+        /* Buttons ------------------------------ */
+
+        .button {
+          background-color: #6E56FF;
+          border-top: 10px solid #6E56FF;
+          border-right: 18px solid #6E56FF;
+          border-bottom: 10px solid #6E56FF;
+          border-left: 18px solid #6E56FF;
+          display: inline-block;
+          color: #FFF !important;
+          text-decoration: none !important;
+          border-radius: 3px;
+          box-shadow: 0 2px 3px rgba(0, 0, 0, 0.16);
+          -webkit-text-size-adjust: none;
+          box-sizing: border-box;
+        }
+
+        .button--green {
+          background-color: #22BC66;
+          border-top: 10px solid #22BC66;
+          border-right: 18px solid #22BC66;
+          border-bottom: 10px solid #22BC66;
+          border-left: 18px solid #22BC66;
+        }
+
+        .button--red {
+          background-color: #FF6136;
+          border-top: 10px solid #FF6136;
+          border-right: 18px solid #FF6136;
+          border-bottom: 10px solid #FF6136;
+          border-left: 18px solid #FF6136;
+        }
+
+        @media only screen and (max-width: 500px) {
+          .button {
+            width: 100% !important;
+            text-align: center !important;
+          }
+        }
+
+        /* Attribute list ------------------------------ */
+
+        .attributes {
+          margin: 0 0 21px;
+        }
+
+        .attributes_content {
+          background-color: #F4F4F7;
+          padding: 16px;
+        }
+
+        .attributes_item {
+          padding: 0;
+        }
+
+        /* Related Items ------------------------------ */
+
+        .related {
+          width: 100%;
+          margin: 0;
+          padding: 25px 0 0 0;
+          -premailer-width: 100%;
+          -premailer-cellpadding: 0;
+          -premailer-cellspacing: 0;
+        }
+
+        .related_item {
+          padding: 10px 0;
+          color: #CBCCCF;
+          font-size: 15px;
+          line-height: 18px;
+        }
+
+        .related_item-title {
+          display: block;
+          margin: .5em 0 0;
+        }
+
+        .related_item-thumb {
+          display: block;
+          padding-bottom: 10px;
+        }
+
+        .related_heading {
+          border-top: 1px solid #CBCCCF;
+          text-align: center;
+          padding: 25px 0 10px;
+        }
+
+        /* Discount Code ------------------------------ */
+
+        .discount {
+          width: 100%;
+          margin: 0;
+          padding: 24px;
+          -premailer-width: 100%;
+          -premailer-cellpadding: 0;
+          -premailer-cellspacing: 0;
+          background-color: #F4F4F7;
+          border: 2px dashed #CBCCCF;
+        }
+
+        .discount_heading {
+          text-align: center;
+        }
+
+        .discount_body {
+          text-align: center;
+          font-size: 15px;
+        }
+
+        /* Social Icons ------------------------------ */
+
+        .social {
+          width: auto;
+        }
+
+        .social td {
+          padding: 0;
+          width: auto;
+        }
+
+        .social_icon {
+          height: 20px;
+          margin: 0 8px 10px 8px;
+          padding: 0;
+        }
+
+        /* Data table ------------------------------ */
+
+        .purchase {
+          width: 100%;
+          margin: 0;
+          padding: 35px 0;
+          -premailer-width: 100%;
+          -premailer-cellpadding: 0;
+          -premailer-cellspacing: 0;
+        }
+
+        .purchase_content {
+          width: 100%;
+          margin: 0;
+          padding: 25px 0 0 0;
+          -premailer-width: 100%;
+          -premailer-cellpadding: 0;
+          -premailer-cellspacing: 0;
+        }
+
+        .purchase_item {
+          padding: 10px 0;
+          color: #51545E;
+          font-size: 15px;
+          line-height: 18px;
+        }
+
+        .purchase_heading {
+          padding-bottom: 8px;
+          border-bottom: 1px solid #EAEAEC;
+        }
+
+        .purchase_heading p {
+          margin: 0;
+          color: #85878E;
+          font-size: 12px;
+        }
+
+        .purchase_footer {
+          padding-top: 15px;
+          border-top: 1px solid #EAEAEC;
+        }
+
+        .purchase_total {
+          margin: 0;
+          text-align: right;
+          font-weight: bold;
+          color: #333333;
+        }
+
+        .purchase_total--label {
+          padding: 0 15px 0 0;
+        }
+
+        body {
+          background-color: #FFF;
+          color: #333;
+        }
+
+        p {
+          color: #333;
+        }
+
+        .email-wrapper {
+          width: 100%;
+          margin: 0;
+          padding: 0;
+          -premailer-width: 100%;
+          -premailer-cellpadding: 0;
+          -premailer-cellspacing: 0;
+        }
+
+        .email-content {
+          width: 100%;
+          margin: 0;
+          padding: 0;
+          -premailer-width: 100%;
+          -premailer-cellpadding: 0;
+          -premailer-cellspacing: 0;
+        }
+
+        /* Masthead ----------------------- */
+
+        .email-masthead {
+          padding: 25px 0;
+          text-align: center;
+        }
+
+        .email-masthead_logo {
+          width: 94px;
+        }
+
+        .email-masthead_name {
+          font-size: 16px;
+          font-weight: bold;
+          color: #A8AAAF;
+          text-decoration: none;
+          text-shadow: 0 1px 0 white;
+        }
+
+        /* Body ------------------------------ */
+
+        .email-body {
+          width: 100%;
+          margin: 0;
+          padding: 0;
+          -premailer-width: 100%;
+          -premailer-cellpadding: 0;
+          -premailer-cellspacing: 0;
+        }
+
+        .email-body_inner {
+          width: 570px;
+          margin: 0 auto;
+          padding: 0;
+          -premailer-width: 570px;
+          -premailer-cellpadding: 0;
+          -premailer-cellspacing: 0;
+        }
+
+        .email-footer {
+          width: 570px;
+          margin: 0 auto;
+          padding: 0;
+          -premailer-width: 570px;
+          -premailer-cellpadding: 0;
+          -premailer-cellspacing: 0;
+          text-align: center;
+        }
+
+        .email-footer p {
+          color: #A8AAAF;
+        }
+
+        .body-action {
+          width: 100%;
+          margin: 30px auto;
+          padding: 0;
+          -premailer-width: 100%;
+          -premailer-cellpadding: 0;
+          -premailer-cellspacing: 0;
+          text-align: center;
+        }
+
+        .body-sub {
+          margin-top: 25px;
+          padding-top: 25px;
+          border-top: 1px solid #EAEAEC;
+        }
+
+        .content-cell {
+          padding: 35px;
+        }
+
+        /*Media Queries ------------------------------ */
+
+        @media only screen and (max-width: 600px) {
+          .email-body_inner,
+          .email-footer {
+            width: 100% !important;
+          }
+        }
+
+        @media (prefers-color-scheme: dark) {
+          body {
+            background-color: #333333 !important;
+            color: #FFF !important;
+          }
+
+          p,
+          ul,
+          ol,
+          blockquote,
+          h1,
+          h2,
+          h3,
+          span,
+          .purchase_item {
+            color: #FFF !important;
+          }
+
+          .attributes_content,
+          .discount {
+            background-color: #222 !important;
+          }
+
+          .email-masthead_name {
+            text-shadow: none !important;
+          }
+        }
+
+        :root {
+          color-scheme: light dark;
+          supported-color-schemes: light dark;
+        }
+      </style>
+      <!--[if mso]>
+      <style type="text/css">
+        .f-fallback  {
+          font-family: Arial, sans-serif;
+        }
+      </style>
+      <![endif]-->
+    </head>
+    <body>
+    <table class="email-wrapper" width="100%" cellpadding="0" cellspacing="0" role="presentation">
+      <tr>
+        <td align="center">
+          <table class="email-content" width="100%" cellpadding="0" cellspacing="0" role="presentation">
+            <tr>
+              <td class="email-masthead">
+                <a href="{{ platformUrl }}" class="f-fallback email-masthead_name">
+                  {{ company }}
+                </a>
+              </td>
+            </tr>
+            {{ body }}
+            <tr>
+              <table class="email-footer" align="center" width="570" cellpadding="0" cellspacing="0" role="presentation">
+                <tr>
+                  <td class="content-cell" align="center">
+                    <p class="f-fallback sub align-center">&copy; {{ currentYear }} {{ company }}. All rights reserved.</p>
+                  </td>
+                </tr>
+              </table>
+            </tr>
+          </table>
+        </td>
+      </tr>
+    </table>
+    </body>
+    </html>
+  password_recovery: |-
+    <!-- Based on template: https://github.com/wildbit/postmark-templates/blob/master/templates/plain/password-reset/content.html -->
+    <tr>
+      <td class="email-body" width="570" cellpadding="0" cellspacing="0">
+        <table class="email-body_inner" align="center" width="570" cellpadding="0" cellspacing="0" role="presentation">
+          <!-- Body content -->
+          <tr>
+            <td class="content-cell">
+              <div class="f-fallback">
+                <h1>Hi {{#if name}}{{ name }}{{else}}{{ email }}{{/if}},</h1>
+                <p>You recently requested to reset your password for your {{ company }} account in your Budibase platform. Use the button below to reset it. <strong>This password reset is only valid for the next 24 hours.</strong></p>
+                <!-- Action -->
+                <table class="body-action" align="center" width="100%" cellpadding="0" cellspacing="0" role="presentation">
+                  <tr>
+                    <td align="center">
+                      <table width="100%" border="0" cellspacing="0" cellpadding="0" role="presentation">
+                        <tr>
+                          <td align="center">
+                            <a href="{{ resetUrl }}" class="f-fallback button button--green" target="_blank">Reset your password</a>
+                          </td>
+                        </tr>
+                      </table>
+                    </td>
+                  </tr>
+                </table>
+                {{#if request}}
+                  <p>For security, this request was received from a {{ request.os }} device.</p>
+                {{/if}}
+                <p>If you did not request a password reset, please ignore this email or contact support if you have questions.</p>
+                <p>Thanks,
+                  <br>The {{ company }} Team</p>
+                <!-- Sub copy -->
+                <table class="body-sub" role="presentation">
+                  <tr>
+                    <td>
+                      <p class="f-fallback sub">If you’re having trouble with the button above, copy and paste the URL below into your web browser.</p>
+                      <p class="f-fallback sub">{{ resetUrl }}</p>
+                    </td>
+                  </tr>
+                </table>
+              </div>
+            </td>
+          </tr>
+        </table>
+      </td>
+    </tr>
+  welcome: "<div>welcome altered</div>"
+  custom: |-
+    <div>altered</div>
+  core: |-
+    I shouldn't be here

package/src/constants/templates/tests/email_templates_invalid.yaml

@@ -0,0 +1,4 @@
+templates:
+  test: "open quote
+  base: |-
+    <div>Invalid structure</div>

package/src/constants/templates/tests/templates.spec.ts

@@ -0,0 +1,174 @@
+import { TestConfiguration } from "../../../tests"
+import { addBaseTemplates, loadTemplateConfig } from ".."
+import { EmailTemplatePurpose, type Template } from "@budibase/types"
+import { join } from "path"
+
+describe("Loading yaml email templates", () => {
+  const config = new TestConfiguration()
+  let consoleSpy: jest.SpyInstance
+  let templates: Template[] = []
+
+  beforeEach(() => {
+    consoleSpy = jest.spyOn(console, "log").mockImplementation(() => {})
+  })
+
+  beforeAll(async () => {
+    addBaseTemplates(templates, "email")
+    // Core is not an updatable template and should never be included
+    templates = templates.filter(t => t.purpose !== EmailTemplatePurpose.CORE)
+
+    await config.beforeAll()
+  })
+
+  afterAll(async () => {
+    await config.afterAll()
+  })
+
+  it("should ignore an invalid path", async () => {
+    const testPath = join(__dirname, `./email_templates_wrong_path.yaml`)
+
+    await config.doInTenant(async () => {
+      loadTemplateConfig(testPath)
+    })
+
+    expect(consoleSpy).toHaveBeenCalledTimes(2)
+
+    // Confirm the error is relayed
+    expect(consoleSpy).toHaveBeenCalledWith(
+      "There was a problem parsing email templates: ",
+      expect.stringContaining("no such file")
+    )
+
+    consoleSpy.mockRestore()
+  })
+
+  it("should ignore empty contents", async () => {
+    // Valid path but its empty.
+    const testPath = join(__dirname, `./email_templates_empty.yaml`)
+
+    await config.doInTenant(async () => {
+      await loadTemplateConfig(testPath)
+    })
+
+    expect(consoleSpy).toHaveBeenCalledTimes(2)
+    expect(consoleSpy).toHaveBeenCalledWith(
+      `No email templates found: ${testPath}`
+    )
+
+    consoleSpy.mockRestore()
+  })
+
+  it("should detect and ignore invalid yaml content", async () => {
+    const testPath = join(__dirname, `./email_templates_invalid.yaml`)
+
+    await config.doInTenant(async () => {
+      await loadTemplateConfig(testPath)
+    })
+
+    expect(consoleSpy).toHaveBeenCalledTimes(2)
+    // Confirm the error is relayed - there is an unclosed string in the test doc
+    expect(consoleSpy).toHaveBeenCalledWith(
+      "There was a problem parsing email templates: ",
+      expect.stringContaining("Missing closing")
+    )
+    consoleSpy.mockRestore()
+  })
+
+  it("should process valid yaml content", async () => {
+    // welcome and custom modified, invitation was excluded
+    const testPath = join(__dirname, `./email_templates.yaml`)
+
+    const templatesBeforeResp = await config.api.templates.getTemplate()
+    const templatesBefore = templatesBeforeResp.body.reduce(
+      (acc: Record<string, any>, t: any) => {
+        if (t.purpose === EmailTemplatePurpose.CORE) return acc
+        acc[t.purpose] ??= t
+        return acc
+      },
+      {}
+    )
+
+    await config.doInTenant(async () => {
+      await loadTemplateConfig(testPath)
+    })
+
+    const templatesUpdatedResp = await config.api.templates.getTemplate()
+    const templatesUpdated = templatesUpdatedResp.body.filter(
+      (t: any) => t.purpose !== EmailTemplatePurpose.CORE
+    )
+
+    expect(templatesUpdated.length).toBe(templates.length)
+
+    // Confirm the changes have been applied and the templates are persisted
+    const processedTemplates = templatesUpdated.filter((t: any) => {
+      if (
+        (t._id &&
+          t.purpose === EmailTemplatePurpose.CUSTOM &&
+          t.contents === "<div>altered</div>") ||
+        (t._id &&
+          t.purpose === EmailTemplatePurpose.WELCOME &&
+          t.contents === "<div>welcome altered</div>")
+      ) {
+        return true
+      }
+      // All others are the same.
+      return templatesBefore[t.purpose].contents === t.contents
+    })
+
+    expect(processedTemplates.length).toBe(templates.length)
+
+    // Should notify that the two templates that didn't match were in actually persisted.
+    expect(consoleSpy).toHaveBeenCalledTimes(2)
+    expect(consoleSpy).toHaveBeenCalledWith(
+      `Email templates updated: welcome,custom`
+    )
+
+    consoleSpy.mockRestore()
+  })
+
+  it("should only update template docs when the contents has changed", async () => {
+    // welcome and custom modified, invitation was excluded
+    const testPath = join(__dirname, `./email_templates.yaml`)
+
+    const templatesBeforeResp = await config.api.templates.getTemplate()
+    const templatesBefore = templatesBeforeResp.body.reduce(
+      (acc: Record<string, any>, t: any) => {
+        if (t.purpose === EmailTemplatePurpose.CORE) return acc
+        acc[t.purpose] ??= t
+        return acc
+      },
+      {}
+    )
+
+    // Update the templates. welcome and custom are persisted to couch
+    await config.doInTenant(async () => {
+      await loadTemplateConfig(testPath)
+    })
+    consoleSpy.mockReset()
+
+    // Run the update again. Simulating a restart of the worker.
+    await config.doInTenant(async () => {
+      await loadTemplateConfig(testPath)
+    })
+
+    const templatesUpdatedResp = await config.api.templates.getTemplate()
+    const templatesUpdated = templatesUpdatedResp.body.filter(
+      (t: any) => t.purpose !== EmailTemplatePurpose.CORE
+    )
+
+    expect(templatesUpdated.length).toBe(templates.length)
+
+    const processedTemplates = templatesUpdated.filter((t: any) => {
+      // All content unchanged
+      return templatesBefore[t.purpose].contents === t.contents
+    })
+
+    expect(processedTemplates.length).toBe(templates.length)
+
+    expect(consoleSpy).toHaveBeenCalledTimes(2)
+    // Should confirm that on reprocessing, the templates were not persisted
+    expect(consoleSpy).toHaveBeenCalledWith(`Email templates unchanged`)
+
+    consoleSpy.mockRestore()
+  })
+})

package/src/environment.ts

@@ -67,6 +67,7 @@ const environment = {
   ENCRYPTED_TEST_PUBLIC_API_KEY: process.env.ENCRYPTED_TEST_PUBLIC_API_KEY,
   SESSION_EXPIRY_SECONDS: process.env.SESSION_EXPIRY_SECONDS,
   TOP_LEVEL_PATH: TOP_LEVEL_PATH,
+  EMAIL_TEMPLATE_PATH: process.env.EMAIL_TEMPLATE_PATH,
   /**
    * Mock the email service in use - links to ethereal hosted emails are logged instead.
    */

package/src/index.ts

@@ -21,6 +21,7 @@ import {
   features,
 } from "@budibase/backend-core"
 import RedisStore from "koa-redis"
+import { loadTemplateConfig } from "./constants/templates"
 
 db.init()
 import koaBody from "koa-body"
@@ -131,6 +132,11 @@ export default server.listen(parseInt(env.PORT || "4002"), async () => {
   await initPro()
   await redis.clients.init()
   features.init()
+
+  if (env.EMAIL_TEMPLATE_PATH) {
+    await loadTemplateConfig(env.EMAIL_TEMPLATE_PATH)
+  }
+
   cache.docWritethrough.init()
   // configure events to use the pro audit log write
   // can't integrate directly into backend-core due to cyclic issues

package/src/tests/api/templates.ts

@@ -22,4 +22,16 @@ export class TemplatesAPI extends TestAPI {
       .set(opts?.headers ? opts.headers : this.config.defaultHeaders())
       .expect(opts?.status ? opts.status : 200)
   }
+
+  exportTemplates = (
+    req?: { type?: string; data?: any },
+    opts?: TestAPIOpts
+  ) => {
+    const { type = "email", data } = req || {}
+    return this.request
+      .post(`/api/global/template/${type}/export`)
+      .send(data)
+      .set(opts?.headers ? opts.headers : this.config.defaultHeaders())
+      .expect(opts?.status ? opts.status : 200)
+  }
 }