@budibase/worker 2.1.32-alpha.8 → 2.1.33

package/src/utilities/appService.js

@@ -1,5 +1,5 @@
 const fetch = require("node-fetch")
-const { Header } = require("@budibase/backend-core/constants")
+const { Headers } = require("@budibase/backend-core/constants")
 const { getTenantId, isTenantIdSet } = require("@budibase/backend-core/tenancy")
 const { checkSlashesInUrl } = require("../utilities")
 const env = require("../environment")
@@ -9,9 +9,9 @@ async function makeAppRequest(url, method, body) {
     return
   }
   const request = { headers: {} }
-  request.headers[Header.API_KEY] = env.INTERNAL_API_KEY
+  request.headers[Headers.API_KEY] = env.INTERNAL_API_KEY
   if (isTenantIdSet()) {
-    request.headers[Header.TENANT_ID] = getTenantId()
+    request.headers[Headers.TENANT_ID] = getTenantId()
   }
   if (body) {
     request.headers["Content-Type"] = "application/json"

package/src/utilities/{email.ts → email.js}

@@ -1,33 +1,15 @@
-import env from "../environment"
-import { EmailTemplatePurpose, TemplateType, Config } from "../constants"
-import { getTemplateByPurpose } from "../constants/templates"
-import { getSettingsTemplateContext } from "./templates"
-import { processString } from "@budibase/string-templates"
-import { getResetPasswordCode, getInviteCode } from "./redis"
-import { User, Database } from "@budibase/types"
-import { tenancy, db as dbCore } from "@budibase/backend-core"
 const nodemailer = require("nodemailer")
-
-type SendEmailOpts = {
-  // workspaceId If finer grain controls being used then this will lookup config for workspace.
-  workspaceId?: string
-  // user If sending to an existing user the object can be provided, this is used in the context.
-  user: User
-  // from If sending from an address that is not what is configured in the SMTP config.
-  from?: string
-  // contents If sending a custom email then can supply contents which will be added to it.
-  contents?: string
-  // subject A custom subject can be specified if the config one is not desired.
-  subject?: string
-  // info Pass in a structure of information to be stored alongside the invitation.
-  info?: any
-  cc?: boolean
-  bcc?: boolean
-  automation?: boolean
-}
+const env = require("../environment")
+const { getScopedConfig } = require("@budibase/backend-core/db")
+const { EmailTemplatePurpose, TemplateTypes, Configs } = require("../constants")
+const { getTemplateByPurpose } = require("../constants/templates")
+const { getSettingsTemplateContext } = require("./templates")
+const { processString } = require("@budibase/string-templates")
+const { getResetPasswordCode, getInviteCode } = require("../utilities/redis")
+const { getGlobalDB } = require("@budibase/backend-core/tenancy")
 
 const TEST_MODE = false
-const TYPE = TemplateType.EMAIL
+const TYPE = TemplateTypes.EMAIL
 
 const FULL_EMAIL_PURPOSES = [
   EmailTemplatePurpose.INVITATION,
@@ -36,8 +18,8 @@ const FULL_EMAIL_PURPOSES = [
   EmailTemplatePurpose.CUSTOM,
 ]
 
-function createSMTPTransport(config: any) {
-  let options: any
+function createSMTPTransport(config) {
+  let options
   let secure = config.secure
   // default it if not specified
   if (secure == null) {
@@ -70,15 +52,10 @@ function createSMTPTransport(config: any) {
   return nodemailer.createTransport(options)
 }
 
-async function getLinkCode(
-  purpose: EmailTemplatePurpose,
-  email: string,
-  user: User,
-  info: any = null
-) {
+async function getLinkCode(purpose, email, user, info = null) {
   switch (purpose) {
     case EmailTemplatePurpose.PASSWORD_RECOVERY:
-      return getResetPasswordCode(user._id!, info)
+      return getResetPasswordCode(user._id, info)
     case EmailTemplatePurpose.INVITATION:
       return getInviteCode(email, info)
     default:
@@ -95,12 +72,7 @@ async function getLinkCode(
  * @param {string|null} contents if using a custom template can supply contents for context.
  * @return {Promise<string>} returns the built email HTML if all provided parameters were valid.
  */
-async function buildEmail(
-  purpose: EmailTemplatePurpose,
-  email: string,
-  context: any,
-  { user, contents }: any = {}
-) {
+async function buildEmail(purpose, email, context, { user, contents } = {}) {
   // this isn't a full email
   if (FULL_EMAIL_PURPOSES.indexOf(purpose) === -1) {
     throw `Unable to build an email of type ${purpose}`
@@ -141,19 +113,15 @@ async function buildEmail(
  * @param {boolean|null} automation Whether or not the configuration is being fetched for an email automation.
  * @return {Promise<object|null>} returns the SMTP configuration if it exists
  */
-async function getSmtpConfiguration(
-  db: Database,
-  workspaceId?: string,
-  automation?: boolean
-) {
-  const params: any = {
-    type: Config.SMTP,
+async function getSmtpConfiguration(db, workspaceId = null, automation) {
+  const params = {
+    type: Configs.SMTP,
   }
   if (workspaceId) {
     params.workspace = workspaceId
   }
 
-  const customConfig = await dbCore.getScopedConfig(db, params)
+  const customConfig = await getScopedConfig(db, params)
 
   if (customConfig) {
     return customConfig
@@ -178,12 +146,12 @@ async function getSmtpConfiguration(
  * Checks if a SMTP config exists based on passed in parameters.
  * @return {Promise<boolean>} returns true if there is a configuration that can be used.
  */
-export async function isEmailConfigured(workspaceId?: string) {
+exports.isEmailConfigured = async (workspaceId = null) => {
   // when "testing" or smtp fallback is enabled simply return true
   if (TEST_MODE || env.SMTP_FALLBACK_ENABLED) {
     return true
   }
-  const db = tenancy.getGlobalDB()
+  const db = getGlobalDB()
   const config = await getSmtpConfiguration(db, workspaceId)
   return config != null
 }
@@ -193,49 +161,48 @@ export async function isEmailConfigured(workspaceId?: string) {
  * send an email using it.
  * @param {string} email The email address to send to.
  * @param {string} purpose The purpose of the email being sent (e.g. reset password).
- * @param {object} opts The options for sending the email.
+ * @param {string|undefined} workspaceId If finer grain controls being used then this will lookup config for workspace.
+ * @param {object|undefined} user If sending to an existing user the object can be provided, this is used in the context.
+ * @param {string|undefined} from If sending from an address that is not what is configured in the SMTP config.
+ * @param {string|undefined} contents If sending a custom email then can supply contents which will be added to it.
+ * @param {string|undefined} subject A custom subject can be specified if the config one is not desired.
+ * @param {object|undefined} info Pass in a structure of information to be stored alongside the invitation.
+ * @param {boolean|undefined} disableFallback Prevent email being sent from SMTP fallback to avoid spam.
  * @return {Promise<object>} returns details about the attempt to send email, e.g. if it is successful; based on
  * nodemailer response.
  */
-export async function sendEmail(
-  email: string,
-  purpose: EmailTemplatePurpose,
-  opts: SendEmailOpts
-) {
-  const db = tenancy.getGlobalDB()
-  let config =
-    (await getSmtpConfiguration(db, opts?.workspaceId, opts?.automation)) || {}
+exports.sendEmail = async (
+  email,
+  purpose,
+  { workspaceId, user, from, contents, subject, info, cc, bcc, automation } = {}
+) => {
+  const db = getGlobalDB()
+  let config = (await getSmtpConfiguration(db, workspaceId, automation)) || {}
   if (Object.keys(config).length === 0 && !TEST_MODE) {
     throw "Unable to find SMTP configuration."
   }
   const transport = createSMTPTransport(config)
   // if there is a link code needed this will retrieve it
-  const code = await getLinkCode(purpose, email, opts.user, opts?.info)
-  let context
-  if (code) {
-    context = await getSettingsTemplateContext(purpose, code)
-  }
+  const code = await getLinkCode(purpose, email, user, info)
+  const context = await getSettingsTemplateContext(purpose, code)
 
-  let message: any = {
-    from: opts?.from || config.from,
+  let message = {
+    from: from || config.from,
     html: await buildEmail(purpose, email, context, {
-      user: opts?.user,
-      contents: opts?.contents,
+      user,
+      contents,
     }),
   }
 
   message = {
     ...message,
     to: email,
-    cc: opts?.cc,
-    bcc: opts?.bcc,
+    cc: cc,
+    bcc: bcc,
   }
 
-  if (opts?.subject || config.subject) {
-    message.subject = await processString(
-      opts?.subject || config.subject,
-      context
-    )
+  if (subject || config.subject) {
+    message.subject = await processString(subject || config.subject, context)
   }
   const response = await transport.sendMail(message)
   if (TEST_MODE) {
@@ -249,7 +216,7 @@ export async function sendEmail(
  * @param {object} config an SMTP configuration - this is based on the nodemailer API.
  * @return {Promise<boolean>} returns true if the configuration is valid.
  */
-export async function verifyConfig(config: any) {
+exports.verifyConfig = async config => {
   const transport = createSMTPTransport(config)
   await transport.verify()
 }

package/src/utilities/{redis.ts → redis.js}

@@ -1,35 +1,36 @@
-import { redis, utils } from "@budibase/backend-core"
+const { Client, utils } = require("@budibase/backend-core/redis")
+const { newid } = require("@budibase/backend-core/utils")
 
-function getExpirySecondsForDB(db: string) {
+function getExpirySecondsForDB(db) {
   switch (db) {
-    case redis.utils.Databases.PW_RESETS:
+    case utils.Databases.PW_RESETS:
       // a hour
       return 3600
-    case redis.utils.Databases.INVITATIONS:
+    case utils.Databases.INVITATIONS:
       // a day
       return 86400
   }
 }
 
-let pwResetClient: any, invitationClient: any
+let pwResetClient, invitationClient
 
-function getClient(db: string) {
+function getClient(db) {
   switch (db) {
-    case redis.utils.Databases.PW_RESETS:
+    case utils.Databases.PW_RESETS:
       return pwResetClient
-    case redis.utils.Databases.INVITATIONS:
+    case utils.Databases.INVITATIONS:
       return invitationClient
   }
 }
 
-async function writeACode(db: string, value: any) {
+async function writeACode(db, value) {
   const client = await getClient(db)
-  const code = utils.newid()
+  const code = newid()
   await client.store(code, value, getExpirySecondsForDB(db))
   return code
 }
 
-async function getACode(db: string, code: string, deleteCode = true) {
+async function getACode(db, code, deleteCode = true) {
   const client = await getClient(db)
   const value = await client.get(code)
   if (!value) {
@@ -41,9 +42,9 @@ async function getACode(db: string, code: string, deleteCode = true) {
   return value
 }
 
-export async function init() {
-  pwResetClient = new redis.Client(redis.utils.Databases.PW_RESETS)
-  invitationClient = new redis.Client(redis.utils.Databases.INVITATIONS)
+exports.init = async () => {
+  pwResetClient = new Client(utils.Databases.PW_RESETS)
+  invitationClient = new Client(utils.Databases.INVITATIONS)
   await pwResetClient.init()
   await invitationClient.init()
 }
@@ -51,7 +52,7 @@ export async function init() {
 /**
  * make sure redis connection is closed.
  */
-export async function shutdown() {
+exports.shutdown = async () => {
   if (pwResetClient) await pwResetClient.finish()
   if (invitationClient) await invitationClient.finish()
   console.log("Redis shutdown")
@@ -64,8 +65,8 @@ export async function shutdown() {
  * @param {object} info Info about the user/the reset process.
  * @return {Promise<string>} returns the code that was stored to redis.
  */
-export async function getResetPasswordCode(userId: string, info: any) {
-  return writeACode(redis.utils.Databases.PW_RESETS, { userId, info })
+exports.getResetPasswordCode = async (userId, info) => {
+  return writeACode(utils.Databases.PW_RESETS, { userId, info })
 }
 
 /**
@@ -74,12 +75,9 @@ export async function getResetPasswordCode(userId: string, info: any) {
  * @param {boolean} deleteCode If the code is used/finished with this will delete it - defaults to true.
  * @return {Promise<string>} returns the user ID if it is found
  */
-export async function checkResetPasswordCode(
-  resetCode: string,
-  deleteCode = true
-) {
+exports.checkResetPasswordCode = async (resetCode, deleteCode = true) => {
   try {
-    return getACode(redis.utils.Databases.PW_RESETS, resetCode, deleteCode)
+    return getACode(utils.Databases.PW_RESETS, resetCode, deleteCode)
   } catch (err) {
     throw "Provided information is not valid, cannot reset password - please try again."
   }
@@ -91,8 +89,8 @@ export async function checkResetPasswordCode(
  * @param {object|null} info Information to be carried along with the invitation.
  * @return {Promise<string>} returns the code that was stored to redis.
  */
-export async function getInviteCode(email: string, info: any) {
-  return writeACode(redis.utils.Databases.INVITATIONS, { email, info })
+exports.getInviteCode = async (email, info) => {
+  return writeACode(utils.Databases.INVITATIONS, { email, info })
 }
 
 /**
@@ -101,12 +99,9 @@ export async function getInviteCode(email: string, info: any) {
  * @param {boolean} deleteCode whether or not the code should be deleted after retrieval - defaults to true.
  * @return {Promise<object>} If the code is valid then an email address will be returned.
  */
-export async function checkInviteCode(
-  inviteCode: string,
-  deleteCode: boolean = true
-) {
+exports.checkInviteCode = async (inviteCode, deleteCode = true) => {
   try {
-    return getACode(redis.utils.Databases.INVITATIONS, inviteCode, deleteCode)
+    return getACode(utils.Databases.INVITATIONS, inviteCode, deleteCode)
   } catch (err) {
     throw "Invitation is not valid or has expired, please request a new one."
   }

package/src/utilities/templates.js

@@ -0,0 +1,49 @@
+const { getScopedConfig } = require("@budibase/backend-core/db")
+const {
+  Configs,
+  InternalTemplateBindings,
+  LOGO_URL,
+  EmailTemplatePurpose,
+} = require("../constants")
+const { checkSlashesInUrl } = require("./index")
+const {
+  getGlobalDB,
+  addTenantToUrl,
+} = require("@budibase/backend-core/tenancy")
+const BASE_COMPANY = "Budibase"
+
+exports.getSettingsTemplateContext = async (purpose, code = null) => {
+  const db = getGlobalDB()
+  // TODO: use more granular settings in the future if required
+  let settings = (await getScopedConfig(db, { type: Configs.SETTINGS })) || {}
+  const URL = settings.platformUrl
+  const context = {
+    [InternalTemplateBindings.LOGO_URL]:
+      checkSlashesInUrl(`${URL}/${settings.logoUrl}`) || LOGO_URL,
+    [InternalTemplateBindings.PLATFORM_URL]: URL,
+    [InternalTemplateBindings.COMPANY]: settings.company || BASE_COMPANY,
+    [InternalTemplateBindings.DOCS_URL]:
+      settings.docsUrl || "https://docs.budibase.com/",
+    [InternalTemplateBindings.LOGIN_URL]: checkSlashesInUrl(
+      addTenantToUrl(`${URL}/login`)
+    ),
+    [InternalTemplateBindings.CURRENT_DATE]: new Date().toISOString(),
+    [InternalTemplateBindings.CURRENT_YEAR]: new Date().getFullYear(),
+  }
+  // attach purpose specific context
+  switch (purpose) {
+    case EmailTemplatePurpose.PASSWORD_RECOVERY:
+      context[InternalTemplateBindings.RESET_CODE] = code
+      context[InternalTemplateBindings.RESET_URL] = checkSlashesInUrl(
+        addTenantToUrl(`${URL}/builder/auth/reset?code=${code}`)
+      )
+      break
+    case EmailTemplatePurpose.INVITATION:
+      context[InternalTemplateBindings.INVITE_CODE] = code
+      context[InternalTemplateBindings.INVITE_URL] = checkSlashesInUrl(
+        addTenantToUrl(`${URL}/builder/invite?code=${code}`)
+      )
+      break
+  }
+  return context
+}

package/tsconfig.build.json

@@ -20,7 +20,7 @@
     "node_modules",
     "dist",
     "src/tests",
-    "**/*.spec.js",
-    "**/*.spec.ts"
+    "**/*.spec.ts",
+    "**/*.spec.js"
   ]
 }

package/tsconfig.json

@@ -8,8 +8,7 @@
     "paths": {
       "@budibase/types": ["../types/src"],
       "@budibase/backend-core": ["../backend-core/src"],
-      "@budibase/backend-core/*": ["../backend-core/*"],
-      "@budibase/pro": ["../../../budibase-pro/packages/pro/src"]
+      "@budibase/backend-core/*": ["../backend-core/*"]
     }
   },
   "ts-node": {
@@ -18,7 +17,6 @@
   "references": [
     { "path": "../types" },
     { "path": "../backend-core" },
-    { "path": "../../../budibase-pro/packages/pro" }
   ],
   "include": [
     "src/**/*",

package/__mocks__/aws-sdk.ts

@@ -1,15 +0,0 @@
-const mockS3 = {
-  headBucket: jest.fn().mockReturnThis(),
-  deleteObject: jest.fn().mockReturnThis(),
-  deleteObjects: jest.fn().mockReturnThis(),
-  createBucket: jest.fn().mockReturnThis(),
-  listObjects: jest.fn().mockReturnThis(),
-  promise: jest.fn().mockReturnThis(),
-  catch: jest.fn(),
-}
-
-const AWS = {
-  S3: jest.fn(() => mockS3),
-}
-
-export default AWS

package/__mocks__/oauth.ts

@@ -1,57 +0,0 @@
-import * as jwt from "jsonwebtoken"
-
-const mockOAuth2 = {
-  getOAuthAccessToken: (code: string, p: any, cb: any) => {
-    const err = null
-    const accessToken = "access_token"
-    const refreshToken = "refresh_token"
-
-    const exp = new Date()
-    exp.setDate(exp.getDate() + 1)
-
-    const iat = new Date()
-    iat.setDate(iat.getDate() - 1)
-
-    const claims = {
-      iss: "test",
-      sub: "sub",
-      aud: "clientId",
-      exp: exp.getTime() / 1000,
-      iat: iat.getTime() / 1000,
-      email: "oauth@example.com",
-    }
-
-    const idToken = jwt.sign(claims, "secret")
-
-    const params = {
-      id_token: idToken,
-    }
-    return cb(err, accessToken, refreshToken, params)
-  },
-  _request: (
-    method: string,
-    url: string,
-    headers: any,
-    postBody: any,
-    accessToken: string,
-    cb: any
-  ) => {
-    const err = null
-    const body = {
-      sub: "sub",
-      user_id: "userId",
-      name: "OAuth",
-      family_name: "2",
-      given_name: "OAuth",
-      middle_name: "",
-    }
-    const res = {}
-    return cb(err, JSON.stringify(body), res)
-  },
-}
-
-const oauth = {
-  OAuth2: jest.fn(() => mockOAuth2),
-}
-
-export = oauth