@budibase/worker 2.1.38 → 2.1.40-alpha.0

package/src/tests/api/users.ts

@@ -3,16 +3,16 @@ import {
   BulkUserRequest,
   InviteUsersRequest,
   User,
+  CreateAdminUserRequest,
 } from "@budibase/types"
+import * as structures from "../structures"
+import { generator } from "@budibase/backend-core/tests"
 import TestConfiguration from "../TestConfiguration"
+import { TestAPI, TestAPIOpts } from "./base"
 
-export class UserAPI {
-  config: TestConfiguration
-  request: any
-
+export class UserAPI extends TestAPI {
   constructor(config: TestConfiguration) {
-    this.config = config
-    this.request = config.request
+    super(config)
   }
 
   // INVITE
@@ -91,6 +91,30 @@ export class UserAPI {
 
   // USER
 
+  createAdminUser = async (
+    request?: CreateAdminUserRequest,
+    opts?: TestAPIOpts
+  ) => {
+    if (!request) {
+      request = {
+        email: structures.email(),
+        password: generator.string(),
+        tenantId: structures.uuid(),
+      }
+    }
+    const res = await this.request
+      .post(`/api/global/users/init`)
+      .send(request)
+      .set(this.config.internalAPIHeaders())
+      .expect("Content-Type", /json/)
+      .expect(opts?.status ? opts.status : 200)
+
+    return {
+      ...request,
+      userId: res.body._id,
+    }
+  }
+
   saveUser = (user: User, status?: number) => {
     return this.request
       .post(`/api/global/users`)
@@ -107,4 +131,12 @@ export class UserAPI {
       .expect("Content-Type", /json/)
       .expect(status ? status : 200)
   }
+
+  getUser = (userId: string, opts?: TestAPIOpts) => {
+    return this.request
+      .get(`/api/global/users/${userId}`)
+      .set(opts?.headers ? opts.headers : this.config.defaultHeaders())
+      .expect("Content-Type", /json/)
+      .expect(opts?.status ? opts.status : 200)
+  }
 }

package/src/tests/controllers.ts

@@ -0,0 +1,5 @@
+export * as email from "../api/controllers/global/email"
+export * as workspaces from "../api/controllers/global/workspaces"
+export * as config from "../api/controllers/global/configs"
+export * as templates from "../api/controllers/global/templates"
+export * as users from "../api/controllers/global/users"

package/src/tests/index.ts

@@ -1,10 +1,14 @@
+import mocks from "./mocks"
+import { generator } from "@budibase/backend-core/tests"
 import TestConfiguration from "./TestConfiguration"
 import structures from "./structures"
-import mocks from "./mocks"
 import API from "./api"
+import { v4 as uuid } from "uuid"
 
 const pkg = {
   structures,
+  generator,
+  uuid,
   TENANT_1: structures.TENANT_1,
   mocks,
   TestConfiguration,

package/{scripts/jestSetup.js → src/tests/jestSetup.ts}

@@ -1,12 +1,21 @@
-const env = require("../src/environment")
+import env from "../environment"
 
-env._set("SELF_HOSTED", "1")
+env._set("SELF_HOSTED", "0")
 env._set("NODE_ENV", "jest")
 env._set("JWT_SECRET", "test-jwtsecret")
 env._set("LOG_LEVEL", "silent")
 env._set("MULTI_TENANCY", true)
+env._set("MINIO_URL", "http://localhost")
+env._set("MINIO_ACCESS_KEY", "test")
+env._set("MINIO_SECRET_KEY", "test")
+env._set("PLATFORM_URL", "http://localhost:10000")
+env._set("INTERNAL_API_KEY", "test")
+env._set("DISABLE_ACCOUNT_PORTAL", false)
 
-const { mocks } = require("@budibase/backend-core/tests")
+import { mocks } from "@budibase/backend-core/tests"
+
+// must explicitly enable fetch mock
+mocks.fetch.enable()
 
 // mock all dates to 2020-01-01T00:00:00.000Z
 // use tk.reset() to use real dates in individual tests

package/src/tests/structures/{configs.js → configs.ts}

@@ -1,9 +1,9 @@
-const { Configs } = require("../../constants")
+const { Config } = require("../../constants")
 const { utils } = require("@budibase/backend-core")
 
-exports.oidc = conf => {
+export function oidc(conf?: any) {
   return {
-    type: Configs.OIDC,
+    type: Config.OIDC,
     config: {
       configs: [
         {
@@ -21,9 +21,9 @@ exports.oidc = conf => {
   }
 }
 
-exports.google = conf => {
+export function google(conf?: any) {
   return {
-    type: Configs.GOOGLE,
+    type: Config.GOOGLE,
     config: {
       clientID: "clientId",
       clientSecret: "clientSecret",
@@ -33,9 +33,9 @@ exports.google = conf => {
   }
 }
 
-exports.smtp = conf => {
+export function smtp(conf?: any) {
   return {
-    type: Configs.SMTP,
+    type: Config.SMTP,
     config: {
       port: 12345,
       host: "smtptesthost.com",
@@ -47,9 +47,9 @@ exports.smtp = conf => {
   }
 }
 
-exports.smtpEthereal = () => {
+export function smtpEthereal() {
   return {
-    type: Configs.SMTP,
+    type: Config.SMTP,
     config: {
       port: 587,
       host: "smtp.ethereal.email",
@@ -63,9 +63,9 @@ exports.smtpEthereal = () => {
   }
 }
 
-exports.settings = conf => {
+export function settings(conf?: any) {
   return {
-    type: Configs.SETTINGS,
+    type: Config.SETTINGS,
     config: {
       platformUrl: "http://localhost:10000",
       logoUrl: "",

package/src/tests/structures/index.ts

@@ -1,16 +1,18 @@
-import configs from "./configs"
+import { structures } from "@budibase/backend-core/tests"
+import * as configs from "./configs"
 import * as users from "./users"
 import * as groups from "./groups"
-import * as accounts from "./accounts"
+import { v4 as uuid } from "uuid"
 
 const TENANT_ID = "default"
 const TENANT_1 = "tenant1"
 const CSRF_TOKEN = "e3727778-7af0-4226-b5eb-f43cbe60a306"
 
 const pkg = {
+  ...structures,
+  uuid,
   configs,
   users,
-  accounts,
   TENANT_ID,
   TENANT_1,
   CSRF_TOKEN,

package/src/tests/structures/users.ts

@@ -5,6 +5,7 @@ import { v4 as uuid } from "uuid"
 export const newEmail = () => {
   return `${uuid()}@test.com`
 }
+
 export const user = (userProps?: any): User => {
   return {
     email: newEmail(),

package/src/utilities/appService.ts

@@ -0,0 +1,32 @@
+import fetch from "node-fetch"
+import { constants, tenancy } from "@budibase/backend-core"
+import { checkSlashesInUrl } from "../utilities"
+import env from "../environment"
+
+async function makeAppRequest(url: string, method: string, body: any) {
+  if (env.isTest()) {
+    return
+  }
+  const request: any = { headers: {} }
+  request.headers[constants.Header.API_KEY] = env.INTERNAL_API_KEY
+  if (tenancy.isTenantIdSet()) {
+    request.headers[constants.Header.TENANT_ID] = tenancy.getTenantId()
+  }
+  if (body) {
+    request.headers["Content-Type"] = "application/json"
+    request.body = JSON.stringify(body)
+  }
+  request.method = method
+  return fetch(checkSlashesInUrl(env.APPS_URL + url), request)
+}
+
+export async function syncUserInApps(userId: string) {
+  const response = await makeAppRequest(
+    `/api/users/metadata/sync/${userId}`,
+    "POST",
+    {}
+  )
+  if (response && response.status !== 200) {
+    throw "Unable to sync user."
+  }
+}

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

@@ -1,15 +1,33 @@
+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")
-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")
+
+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 TEST_MODE = false
-const TYPE = TemplateTypes.EMAIL
+const TYPE = TemplateType.EMAIL
 
 const FULL_EMAIL_PURPOSES = [
   EmailTemplatePurpose.INVITATION,
@@ -18,8 +36,8 @@ const FULL_EMAIL_PURPOSES = [
   EmailTemplatePurpose.CUSTOM,
 ]
 
-function createSMTPTransport(config) {
-  let options
+function createSMTPTransport(config: any) {
+  let options: any
   let secure = config.secure
   // default it if not specified
   if (secure == null) {
@@ -52,10 +70,15 @@ function createSMTPTransport(config) {
   return nodemailer.createTransport(options)
 }
 
-async function getLinkCode(purpose, email, user, info = null) {
+async function getLinkCode(
+  purpose: EmailTemplatePurpose,
+  email: string,
+  user: User,
+  info: any = 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:
@@ -72,7 +95,12 @@ async function getLinkCode(purpose, email, user, info = null) {
  * @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, email, context, { user, contents } = {}) {
+async function buildEmail(
+  purpose: EmailTemplatePurpose,
+  email: string,
+  context: any,
+  { user, contents }: any = {}
+) {
   // this isn't a full email
   if (FULL_EMAIL_PURPOSES.indexOf(purpose) === -1) {
     throw `Unable to build an email of type ${purpose}`
@@ -113,15 +141,19 @@ async function buildEmail(purpose, email, context, { user, contents } = {}) {
  * @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, workspaceId = null, automation) {
-  const params = {
-    type: Configs.SMTP,
+async function getSmtpConfiguration(
+  db: Database,
+  workspaceId?: string,
+  automation?: boolean
+) {
+  const params: any = {
+    type: Config.SMTP,
   }
   if (workspaceId) {
     params.workspace = workspaceId
   }
 
-  const customConfig = await getScopedConfig(db, params)
+  const customConfig = await dbCore.getScopedConfig(db, params)
 
   if (customConfig) {
     return customConfig
@@ -146,12 +178,12 @@ async function getSmtpConfiguration(db, workspaceId = null, automation) {
  * 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.
  */
-exports.isEmailConfigured = async (workspaceId = null) => {
+export async function isEmailConfigured(workspaceId?: string) {
   // when "testing" or smtp fallback is enabled simply return true
   if (TEST_MODE || env.SMTP_FALLBACK_ENABLED) {
     return true
   }
-  const db = getGlobalDB()
+  const db = tenancy.getGlobalDB()
   const config = await getSmtpConfiguration(db, workspaceId)
   return config != null
 }
@@ -161,48 +193,49 @@ exports.isEmailConfigured = async (workspaceId = null) => {
  * 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 {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.
+ * @param {object} opts The options for sending the email.
  * @return {Promise<object>} returns details about the attempt to send email, e.g. if it is successful; based on
  * nodemailer response.
  */
-exports.sendEmail = async (
-  email,
-  purpose,
-  { workspaceId, user, from, contents, subject, info, cc, bcc, automation } = {}
-) => {
-  const db = getGlobalDB()
-  let config = (await getSmtpConfiguration(db, workspaceId, automation)) || {}
+export async function sendEmail(
+  email: string,
+  purpose: EmailTemplatePurpose,
+  opts: SendEmailOpts
+) {
+  const db = tenancy.getGlobalDB()
+  let config =
+    (await getSmtpConfiguration(db, opts?.workspaceId, opts?.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, user, info)
-  const context = await getSettingsTemplateContext(purpose, code)
+  const code = await getLinkCode(purpose, email, opts.user, opts?.info)
+  let context
+  if (code) {
+    context = await getSettingsTemplateContext(purpose, code)
+  }
 
-  let message = {
-    from: from || config.from,
+  let message: any = {
+    from: opts?.from || config.from,
     html: await buildEmail(purpose, email, context, {
-      user,
-      contents,
+      user: opts?.user,
+      contents: opts?.contents,
     }),
   }
 
   message = {
     ...message,
     to: email,
-    cc: cc,
-    bcc: bcc,
+    cc: opts?.cc,
+    bcc: opts?.bcc,
   }
 
-  if (subject || config.subject) {
-    message.subject = await processString(subject || config.subject, context)
+  if (opts?.subject || config.subject) {
+    message.subject = await processString(
+      opts?.subject || config.subject,
+      context
+    )
   }
   const response = await transport.sendMail(message)
   if (TEST_MODE) {
@@ -216,7 +249,7 @@ exports.sendEmail = async (
  * @param {object} config an SMTP configuration - this is based on the nodemailer API.
  * @return {Promise<boolean>} returns true if the configuration is valid.
  */
-exports.verifyConfig = async config => {
+export async function verifyConfig(config: any) {
   const transport = createSMTPTransport(config)
   await transport.verify()
 }

package/src/utilities/fileSystem.ts

@@ -0,0 +1,5 @@
+import { readFileSync } from "fs"
+
+export function readStaticFile(path: string) {
+  return readFileSync(path, "utf-8")
+}

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

@@ -4,6 +4,6 @@
  * @param {string} url The URL to test and remove any extra double slashes.
  * @return {string} The updated url.
  */
-exports.checkSlashesInUrl = url => {
+export function checkSlashesInUrl(url: string) {
   return url.replace(/(https?:\/\/)|(\/)+/g, "$1$2")
 }

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

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

package/src/utilities/templates.ts

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

package/src/utilities/users.ts

@@ -0,0 +1,16 @@
+import { tenancy, db as dbCore } from "@budibase/backend-core"
+
+export async function checkAnyUserExists() {
+  try {
+    const db = tenancy.getGlobalDB()
+    const users = await db.allDocs(
+      dbCore.getGlobalUserParams(null, {
+        include_docs: true,
+        limit: 1,
+      })
+    )
+    return users && users.rows.length >= 1
+  } catch (err) {
+    throw new Error("Unable to retrieve user list")
+  }
+}

package/tsconfig.build.json

@@ -3,7 +3,6 @@
     "target": "es6",
     "module": "commonjs",
     "lib": ["es2020"],
-    "allowJs": true,
     "strict": true,
     "noImplicitAny": true,
     "esModuleInterop": true,
@@ -20,7 +19,7 @@
     "node_modules",
     "dist",
     "src/tests",
-    "**/*.spec.ts",
-    "**/*.spec.js"
+    "**/*.spec.js",
+    "**/*.spec.ts"
   ]
 }