@budibase/worker 2.1.45 → 2.1.46-alpha.0

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"
   ]
 }

package/tsconfig.json

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

package/src/api/controllers/global/roles.js

@@ -1,68 +0,0 @@
-const { getAllRoles } = require("@budibase/backend-core/roles")
-const {
-  getAllApps,
-  getProdAppID,
-  getDevAppID,
-  DocumentType,
-} = require("@budibase/backend-core/db")
-const { doInAppContext, getAppDB } = require("@budibase/backend-core/context")
-const { user: userCache } = require("@budibase/backend-core/cache")
-const { getGlobalDB } = require("@budibase/backend-core/tenancy")
-const { allUsers } = require("../../../sdk/users")
-
-exports.fetch = async ctx => {
-  const tenantId = ctx.user.tenantId
-  // always use the dev apps as they'll be most up to date (true)
-  const apps = await getAllApps({ tenantId, all: true })
-  const promises = []
-  for (let app of apps) {
-    // use dev app IDs
-    promises.push(getAllRoles(app.appId))
-  }
-  const roles = await Promise.all(promises)
-  const response = {}
-  for (let app of apps) {
-    const deployedAppId = getProdAppID(app.appId)
-    response[deployedAppId] = {
-      roles: roles.shift(),
-      name: app.name,
-      version: app.version,
-      url: app.url,
-    }
-  }
-  ctx.body = response
-}
-
-exports.find = async ctx => {
-  const appId = ctx.params.appId
-  await doInAppContext(getDevAppID(appId), async () => {
-    const db = getAppDB()
-    const app = await db.get(DocumentType.APP_METADATA)
-    ctx.body = {
-      roles: await getAllRoles(),
-      name: app.name,
-      version: app.version,
-      url: app.url,
-    }
-  })
-}
-
-exports.removeAppRole = async ctx => {
-  const { appId } = ctx.params
-  const db = getGlobalDB()
-  const users = await allUsers(ctx)
-  const bulk = []
-  const cacheInvalidations = []
-  for (let user of users) {
-    if (user.roles[appId]) {
-      cacheInvalidations.push(userCache.invalidateUser(user._id))
-      delete user.roles[appId]
-      bulk.push(user)
-    }
-  }
-  await db.bulkDocs(bulk)
-  await Promise.all(cacheInvalidations)
-  ctx.body = {
-    message: "App role removed from all users",
-  }
-}

package/src/api/routes/global/roles.js

@@ -1,12 +0,0 @@
-const Router = require("@koa/router")
-const controller = require("../../controllers/global/roles")
-const { builderOrAdmin } = require("@budibase/backend-core/auth")
-
-const router = new Router()
-
-router
-  .get("/api/global/roles", builderOrAdmin, controller.fetch)
-  .get("/api/global/roles/:appId", builderOrAdmin, controller.find)
-  .delete("/api/global/roles/:appId", builderOrAdmin, controller.removeAppRole)
-
-module.exports = router

package/src/api/routes/system/environment.js

@@ -1,8 +0,0 @@
-const Router = require("@koa/router")
-const controller = require("../../controllers/system/environment")
-
-const router = new Router()
-
-router.get("/api/system/environment", controller.fetch)
-
-module.exports = router

package/src/api/routes/system/status.js

@@ -1,8 +0,0 @@
-const Router = require("@koa/router")
-const controller = require("../../controllers/system/status")
-
-const router = new Router()
-
-router.get("/api/system/status", controller.fetch)
-
-module.exports = router

package/src/api/routes/system/tenants.js

@@ -1,12 +0,0 @@
-const Router = require("@koa/router")
-const controller = require("../../controllers/system/tenants")
-const { adminOnly } = require("@budibase/backend-core/auth")
-
-const router = new Router()
-
-router
-  .get("/api/system/tenants/:tenantId/exists", controller.exists)
-  .get("/api/system/tenants", adminOnly, controller.fetch)
-  .delete("/api/system/tenants/:tenantId", adminOnly, controller.delete)
-
-module.exports = router

package/src/db/index.js

@@ -1,11 +0,0 @@
-const core = require("@budibase/backend-core")
-const env = require("../environment")
-
-exports.init = () => {
-  const dbConfig = {}
-  if (env.isTest() && !env.COUCH_DB_URL) {
-    dbConfig.inMemory = true
-    dbConfig.allDbs = true
-  }
-  core.init({ db: dbConfig })
-}

package/src/tests/controllers.js

@@ -1,7 +0,0 @@
-module.exports = {
-  email: require("../api/controllers/global/email"),
-  workspaces: require("../api/controllers/global/workspaces"),
-  config: require("../api/controllers/global/configs"),
-  templates: require("../api/controllers/global/templates"),
-  users: require("../api/controllers/global/users"),
-}

package/src/tests/structures/accounts.ts

@@ -1,24 +0,0 @@
-import { Account, AuthType, Hosting, CloudAccount } from "@budibase/types"
-import { v4 as uuid } from "uuid"
-import { utils } from "@budibase/backend-core"
-
-export const account = (): Account => {
-  return {
-    email: `${uuid()}@test.com`,
-    tenantId: utils.newid(),
-    hosting: Hosting.SELF,
-    authType: AuthType.SSO,
-    accountId: uuid(),
-    createdAt: Date.now(),
-    verified: true,
-    verificationSent: true,
-    tier: "FREE",
-  }
-}
-
-export const cloudAccount = (): CloudAccount => {
-  return {
-    ...account(),
-    budibaseUserId: uuid(),
-  }
-}

package/src/utilities/appService.js

@@ -1,33 +0,0 @@
-const fetch = require("node-fetch")
-const { Headers } = require("@budibase/backend-core/constants")
-const { getTenantId, isTenantIdSet } = require("@budibase/backend-core/tenancy")
-const { checkSlashesInUrl } = require("../utilities")
-const env = require("../environment")
-
-async function makeAppRequest(url, method, body) {
-  if (env.isTest()) {
-    return
-  }
-  const request = { headers: {} }
-  request.headers[Headers.API_KEY] = env.INTERNAL_API_KEY
-  if (isTenantIdSet()) {
-    request.headers[Headers.TENANT_ID] = 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)
-}
-
-exports.syncUserInApps = async userId => {
-  const response = await makeAppRequest(
-    `/api/users/metadata/sync/${userId}`,
-    "POST",
-    {}
-  )
-  if (response && response.status !== 200) {
-    throw "Unable to sync user."
-  }
-}

package/src/utilities/fileSystem.js

@@ -1,5 +0,0 @@
-const { readFileSync } = require("fs")
-
-exports.readStaticFile = path => {
-  return readFileSync(path, "utf-8")
-}

package/src/utilities/templates.js

@@ -1,49 +0,0 @@
-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/src/utilities/users.js

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