@budibase/worker 2.4.41 → 2.4.42-alpha.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@budibase/worker",
   "email": "hi@budibase.com",
-  "version": "2.4.41",
+  "version": "2.4.42-alpha.0",
   "description": "Budibase background service",
   "main": "src/index.ts",
   "repository": {
@@ -36,10 +36,10 @@
   "author": "Budibase",
   "license": "GPL-3.0",
   "dependencies": {
-    "@budibase/backend-core": "^2.4.41",
+    "@budibase/backend-core": "2.4.42-alpha.0",
     "@budibase/pro": "2.4.40",
-    "@budibase/string-templates": "^2.4.41",
-    "@budibase/types": "^2.4.41",
+    "@budibase/string-templates": "2.4.42-alpha.0",
+    "@budibase/types": "2.4.42-alpha.0",
     "@koa/router": "8.0.8",
     "@sentry/node": "6.17.7",
     "@techpass/passport-openidconnect": "0.3.2",
@@ -101,5 +101,5 @@
     "typescript": "4.7.3",
     "update-dotenv": "1.1.1"
   },
-  "gitHead": "70af1866b81511c67e5f3b407507fc6f416d8786"
+  "gitHead": "b31f1ba51b6d82958938a9acc7f8bf1ccef104ac"
 }

package/scripts/test.sh

@@ -3,10 +3,10 @@
 if [[ -n $CI ]]
 then
   # --runInBand performs better in ci where resources are limited
-  echo "jest --coverage --runInBand"
-  jest --coverage --runInBand
+  echo "jest --coverage --runInBand --forceExit"
+  jest --coverage --runInBand --forceExit
 else
   # --maxWorkers performs better in development
   echo "jest --coverage --maxWorkers=2"
   jest --coverage --maxWorkers=2
-fi
+fi

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

@@ -11,6 +11,7 @@ import {
   tenancy,
 } from "@budibase/backend-core"
 import { checkAnyUserExists } from "../../../utilities/users"
+import { getLicensedConfig } from "../../../utilities/configs"
 import {
   Config,
   ConfigType,
@@ -211,6 +212,38 @@ export async function save(ctx: UserCtx<Config>) {
     ctx.throw(400, err)
   }
 
+  // Ignore branding changes if the license does not permit it
+  // Favicon and Logo Url are excluded.
+  try {
+    const brandingEnabled = await pro.features.isBrandingEnabled()
+    if (existingConfig?.config && !brandingEnabled) {
+      const {
+        emailBrandingEnabled,
+        testimonialsEnabled,
+        platformTitle,
+        metaDescription,
+        loginHeading,
+        loginButton,
+        metaImageUrl,
+        metaTitle,
+      } = existingConfig.config
+
+      body.config = {
+        ...body.config,
+        emailBrandingEnabled,
+        testimonialsEnabled,
+        platformTitle,
+        metaDescription,
+        loginHeading,
+        loginButton,
+        metaImageUrl,
+        metaTitle,
+      }
+    }
+  } catch (e) {
+    console.error("There was an issue retrieving the license", e)
+  }
+
   try {
     body._id = configs.generateConfigID(type)
     const response = await configs.save(body)
@@ -276,6 +309,9 @@ export async function publicSettings(
     // settings
     const configDoc = await configs.getSettingsConfigDoc()
     const config = configDoc.config
+
+    const branding = await pro.branding.getBrandingConfig(config)
+
     // enrich the logo url - empty url means deleted
     if (config.logoUrl && config.logoUrl !== "") {
       config.logoUrl = objectStore.getGlobalFileUrl(
@@ -285,6 +321,15 @@ export async function publicSettings(
       )
     }
 
+    if (branding.faviconUrl && branding.faviconUrl !== "") {
+      // @ts-ignore
+      config.faviconUrl = objectStore.getGlobalFileUrl(
+        "settings",
+        "faviconUrl",
+        branding.faviconUrl
+      )
+    }
+
     // google
     const googleConfig = await configs.getGoogleConfig()
     const preActivated = googleConfig && googleConfig.activated == null
@@ -305,6 +350,7 @@ export async function publicSettings(
       _rev: configDoc._rev,
       config: {
         ...config,
+        ...branding,
         google,
         oidc,
         isSSOEnforced,

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

@@ -3,7 +3,6 @@ import {
   getInviteCodes,
   updateInviteCode,
 } from "../../../utilities/redis"
-// import sdk from "../../../sdk"
 import * as userSdk from "../../../sdk/users"
 import env from "../../../environment"
 import {
@@ -26,11 +25,11 @@ import {
 import {
   accounts,
   cache,
-  errors,
   events,
   migrations,
   tenancy,
   platform,
+  ErrorCode,
 } from "@budibase/backend-core"
 import { checkAnyUserExists } from "../../../utilities/users"
 import { isEmailConfigured } from "../../../utilities/email"
@@ -421,7 +420,7 @@ export const inviteAccept = async (
       email: user.email,
     }
   } catch (err: any) {
-    if (err.code === errors.codes.USAGE_LIMIT_EXCEEDED) {
+    if (err.code === ErrorCode.USAGE_LIMIT_EXCEEDED) {
       // explicitly re-throw limit exceeded errors
       ctx.throw(400, err)
     }

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

@@ -286,6 +286,7 @@ describe("configs", () => {
         type: "settings",
         config: {
           company: "Budibase",
+          emailBrandingEnabled: true,
           logoUrl: "",
           analyticsEnabled: false,
           google: false,
@@ -294,6 +295,7 @@ describe("configs", () => {
           oidc: false,
           oidcCallbackUrl: `http://localhost:10000/api/global/auth/${config.tenantId}/oidc/callback`,
           platformUrl: "http://localhost:10000",
+          testimonialsEnabled: true,
         },
       }
       delete body._rev

package/src/constants/index.ts

@@ -20,6 +20,7 @@ export enum TemplateType {
 }
 
 export enum EmailTemplatePurpose {
+  CORE = "core",
   BASE = "base",
   PASSWORD_RECOVERY = "password_recovery",
   INVITATION = "invitation",

package/src/constants/templates/core.hbs

@@ -0,0 +1,33 @@
+{{#if enableEmailBranding}}
+  <tr>
+    <td cellpadding="0" cellspacing="0">
+      <table
+        align="center"
+        width="570"
+        cellpadding="0"
+        cellspacing="0"
+        role="presentation"
+      >
+        <tbody>
+          <tr>
+            <td
+              style="padding:0 35px; padding-top: 15px;"
+              cellpadding="0"
+              cellspacing="0"
+            >
+              <img
+                width="32px"
+                style="margin-right:16px; vertical-align: middle;"
+                alt="Budibase Logo"
+                src="https://i.imgur.com/Xhdt1YP.png"
+              />
+              <strong style="vertical-align: middle; font-size: 1.1em">
+                Budibase
+              </strong>
+            </td>
+          </tr>
+        </tbody>
+      </table>
+    </td>
+  </tr>
+{{/if}}

package/src/constants/templates/index.ts

@@ -21,6 +21,7 @@ export const EmailTemplates = {
     join(__dirname, "welcome.hbs")
   ),
   [EmailTemplatePurpose.CUSTOM]: readStaticFile(join(__dirname, "custom.hbs")),
+  [EmailTemplatePurpose.CORE]: readStaticFile(join(__dirname, "core.hbs")),
 }
 
 export function addBaseTemplates(templates: Template[], type?: string) {

package/src/index.ts

@@ -21,6 +21,7 @@ import {
   middleware,
   queue,
   env as coreEnv,
+  timers,
 } from "@budibase/backend-core"
 db.init()
 import Koa from "koa"
@@ -91,6 +92,7 @@ server.on("close", async () => {
   }
   shuttingDown = true
   console.log("Server Closed")
+  timers.cleanup()
   await redis.shutdown()
   await events.shutdown()
   await queue.shutdown()

package/src/tests/TestConfiguration.ts

@@ -106,6 +106,8 @@ class TestConfiguration {
   async afterAll() {
     if (this.server) {
       await this.server.close()
+    } else {
+      await require("../index").default.close()
     }
   }
 

package/src/tests/jestEnv.ts

@@ -10,3 +10,4 @@ process.env.MINIO_SECRET_KEY = "test"
 process.env.PLATFORM_URL = "http://localhost:10000"
 process.env.INTERNAL_API_KEY = "tet"
 process.env.DISABLE_ACCOUNT_PORTAL = "0"
+process.env.REDIS_PASSWORD = "budibase"

package/src/tests/jestSetup.ts

@@ -2,7 +2,7 @@ import "./logging"
 
 import { mocks, testContainerUtils } from "@budibase/backend-core/tests"
 import env from "../environment"
-import { env as coreEnv } from "@budibase/backend-core"
+import { env as coreEnv, timers } from "@budibase/backend-core"
 
 // must explicitly enable fetch mock
 mocks.fetch.enable()
@@ -21,3 +21,7 @@ if (!process.env.CI) {
 }
 
 testContainerUtils.setupEnv(env, coreEnv)
+
+afterAll(() => {
+  timers.cleanup()
+})

package/src/utilities/configs.ts

@@ -0,0 +1,27 @@
+import * as pro from "@budibase/pro"
+
+export async function getLicensedConfig() {
+  let licensedConfig: object = {}
+  const defaults = {
+    emailBrandingEnabled: true,
+    testimonialsEnabled: true,
+    platformTitle: undefined,
+    metaDescription: undefined,
+    loginHeading: undefined,
+    loginButton: undefined,
+    metaImageUrl: undefined,
+    metaTitle: undefined,
+  }
+
+  try {
+    // License/Feature Checks
+    const enabled = await pro.features.isBrandingEnabled()
+    if (!enabled) {
+      licensedConfig = { ...defaults }
+    }
+  } catch (e) {
+    licensedConfig = { ...defaults }
+    console.info("Could not retrieve license", e)
+  }
+  return licensedConfig
+}

package/src/utilities/email.ts

@@ -1,6 +1,6 @@
 import env from "../environment"
 import { EmailTemplatePurpose, TemplateType } from "../constants"
-import { getTemplateByPurpose } from "../constants/templates"
+import { getTemplateByPurpose, EmailTemplates } from "../constants/templates"
 import { getSettingsTemplateContext } from "./templates"
 import { processString } from "@budibase/string-templates"
 import { getResetPasswordCode, getInviteCode } from "./redis"
@@ -109,11 +109,16 @@ async function buildEmail(
     getTemplateByPurpose(TYPE, EmailTemplatePurpose.BASE),
     getTemplateByPurpose(TYPE, purpose),
   ])
-  if (!base || !body) {
+
+  // Change from branding to core
+  let core = EmailTemplates[EmailTemplatePurpose.CORE]
+
+  if (!base || !body || !core) {
     throw "Unable to build email, missing base components"
   }
   base = base.contents
   body = body.contents
+
   let name = user ? user.name : undefined
   if (user && !name && user.firstName) {
     name = user.lastName ? `${user.firstName} ${user.lastName}` : user.firstName
@@ -126,8 +131,12 @@ async function buildEmail(
     user: user || {},
   }
 
-  body = await processString(body, context)
-  // this should now be the complete email HTML
+  // Prepend the core template
+  const fullBody = core + body
+
+  body = await processString(fullBody, context)
+
+  // this should now be the core email HTML
   return processString(base, {
     ...context,
     body,

package/src/utilities/templates.ts

@@ -1,17 +1,22 @@
 import { tenancy, configs } from "@budibase/backend-core"
+import { SettingsInnerConfig } from "@budibase/types"
 import {
   InternalTemplateBinding,
   LOGO_URL,
   EmailTemplatePurpose,
 } from "../constants"
 import { checkSlashesInUrl } from "./index"
+import { getLicensedConfig } from "./configs"
+
 const BASE_COMPANY = "Budibase"
+import * as pro from "@budibase/pro"
 
 export async function getSettingsTemplateContext(
   purpose: EmailTemplatePurpose,
   code?: string | null
 ) {
-  let settings = await configs.getSettingsConfig()
+  const settings = await configs.getSettingsConfig()
+  const branding = await pro.branding.getBrandingConfig(settings)
   const URL = settings.platformUrl
   const context: any = {
     [InternalTemplateBinding.LOGO_URL]:
@@ -25,6 +30,9 @@ export async function getSettingsTemplateContext(
     [InternalTemplateBinding.CURRENT_DATE]: new Date().toISOString(),
     [InternalTemplateBinding.CURRENT_YEAR]: new Date().getFullYear(),
   }
+
+  context["enableEmailBranding"] = branding.emailBrandingEnabled === true
+
   // attach purpose specific context
   switch (purpose) {
     case EmailTemplatePurpose.PASSWORD_RECOVERY: