@budibase/server 2.1.41 → 2.1.43-alpha.0

package/src/api/controllers/deploy/{Deployment.js → Deployment.ts}

@@ -1,15 +1,20 @@
-const newid = require("../../../db/newid")
-const { getAppId } = require("@budibase/backend-core/context")
+import newid from "../../../db/newid"
+import { context } from "@budibase/backend-core"
 
 /**
  * This is used to pass around information about the deployment that is occurring
  */
-class Deployment {
+export default class Deployment {
+  _id: string
+  verification: any
+  status?: string
+  err?: any
+
   constructor(id = null) {
     this._id = id || newid()
   }
 
-  setVerification(verification) {
+  setVerification(verification: any) {
     if (!verification) {
       return
     }
@@ -20,14 +25,14 @@ class Deployment {
     return this.verification
   }
 
-  setStatus(status, err = null) {
+  setStatus(status: string, err?: any) {
     this.status = status
     if (err) {
       this.err = err
     }
   }
 
-  fromJSON(json) {
+  fromJSON(json: any) {
     if (json.verification) {
       this.setVerification(json.verification)
     }
@@ -37,9 +42,9 @@ class Deployment {
   }
 
   getJSON() {
-    const obj = {
+    const obj: any = {
       _id: this._id,
-      appId: getAppId(),
+      appId: context.getAppId(),
       status: this.status,
     }
     if (this.err) {
@@ -51,5 +56,3 @@ class Deployment {
     return obj
   }
 }
-
-module.exports = Deployment

package/src/api/controllers/deploy/index.ts

@@ -1,23 +1,11 @@
 import Deployment from "./Deployment"
-import {
-  getDevelopmentAppID,
-  getProdAppID,
-  Replication,
-} from "@budibase/backend-core/db"
+import { context, db as dbCore, events, cache } from "@budibase/backend-core"
 import { DocumentType, getAutomationParams } from "../../../db/utils"
 import {
   clearMetadata,
   disableAllCrons,
   enableCronTrigger,
 } from "../../../automations/utils"
-import { app as appCache } from "@budibase/backend-core/cache"
-import {
-  getAppDB,
-  getAppId,
-  getDevAppDB,
-  getProdAppDB,
-} from "@budibase/backend-core/context"
-import { events } from "@budibase/backend-core"
 import { backups } from "@budibase/pro"
 import { AppBackupTrigger } from "@budibase/types"
 
@@ -49,7 +37,7 @@ async function checkAllDeployments(deployments: any) {
 
 async function storeDeploymentHistory(deployment: any) {
   const deploymentJSON = deployment.getJSON()
-  const db = getAppDB()
+  const db = context.getAppDB()
 
   let deploymentDoc
   try {
@@ -77,7 +65,7 @@ async function storeDeploymentHistory(deployment: any) {
 }
 
 async function initDeployedApp(prodAppId: any) {
-  const db = getProdAppDB()
+  const db = context.getProdAppDB()
   console.log("Reading automation docs")
   const automations = (
     await db.allDocs(
@@ -103,9 +91,9 @@ async function initDeployedApp(prodAppId: any) {
 async function deployApp(deployment: any, userId: string) {
   let replication
   try {
-    const appId = getAppId()
-    const devAppId = getDevelopmentAppID(appId)
-    const productionAppId = getProdAppID(appId)
+    const appId = context.getAppId()!
+    const devAppId = dbCore.getDevelopmentAppID(appId)
+    const productionAppId = dbCore.getProdAppID(appId)
 
     // don't try this if feature isn't allowed, will error
     if (await backups.isEnabled()) {
@@ -122,8 +110,8 @@ async function deployApp(deployment: any, userId: string) {
       source: devAppId,
       target: productionAppId,
     }
-    replication = new Replication(config)
-    const devDb = getDevAppDB()
+    replication = new dbCore.Replication(config)
+    const devDb = context.getDevAppDB()
     console.log("Compacting development DB")
     await devDb.compact()
     console.log("Replication object created")
@@ -131,7 +119,7 @@ async function deployApp(deployment: any, userId: string) {
     console.log("replication complete.. replacing app meta doc")
     // app metadata is excluded as it is likely to be in conflict
     // replicate the app metadata document manually
-    const db = getProdAppDB()
+    const db = context.getProdAppDB()
     const appDoc = await devDb.get(DocumentType.APP_METADATA)
     try {
       const prodAppDoc = await db.get(DocumentType.APP_METADATA)
@@ -147,7 +135,7 @@ async function deployApp(deployment: any, userId: string) {
     // remove automation errors if they exist
     delete appDoc.automationErrors
     await db.put(appDoc)
-    await appCache.invalidateAppMetadata(productionAppId)
+    await cache.app.invalidateAppMetadata(productionAppId)
     console.log("New app doc written successfully.")
     await initDeployedApp(productionAppId)
     console.log("Deployed app initialised, setting deployment to successful")
@@ -170,7 +158,7 @@ async function deployApp(deployment: any, userId: string) {
 
 export async function fetchDeployments(ctx: any) {
   try {
-    const db = getAppDB()
+    const db = context.getAppDB()
     const deploymentDoc = await db.get(DocumentType.DEPLOYMENTS)
     const { updated, deployments } = await checkAllDeployments(deploymentDoc)
     if (updated) {
@@ -184,7 +172,7 @@ export async function fetchDeployments(ctx: any) {
 
 export async function deploymentProgress(ctx: any) {
   try {
-    const db = getAppDB()
+    const db = context.getAppDB()
     const deploymentDoc = await db.get(DocumentType.DEPLOYMENTS)
     ctx.body = deploymentDoc[ctx.params.deploymentId]
   } catch (err) {
@@ -197,7 +185,7 @@ export async function deploymentProgress(ctx: any) {
 
 const isFirstDeploy = async () => {
   try {
-    const db = getProdAppDB()
+    const db = context.getProdAppDB()
     await db.get(DocumentType.APP_METADATA)
   } catch (e: any) {
     if (e.status === 404) {

package/src/api/controllers/{dev.js → dev.ts}

@@ -1,29 +1,23 @@
-const fetch = require("node-fetch")
-const env = require("../../environment")
-const { checkSlashesInUrl } = require("../../utilities")
-const { request } = require("../../utilities/workerRequests")
-const { clearLock } = require("../../utilities/redis")
-const { Replication, getProdAppID } = require("@budibase/backend-core/db")
-const { DocumentType } = require("../../db/utils")
-const { app: appCache } = require("@budibase/backend-core/cache")
-const { getProdAppDB, getAppDB } = require("@budibase/backend-core/context")
-const { events } = require("@budibase/backend-core")
+import fetch from "node-fetch"
+import env from "../../environment"
+import { checkSlashesInUrl } from "../../utilities"
+import { request } from "../../utilities/workerRequests"
+import { clearLock as redisClearLock } from "../../utilities/redis"
+import { DocumentType } from "../../db/utils"
+import { context } from "@budibase/backend-core"
+import { events, db as dbCore, cache } from "@budibase/backend-core"
 
-async function redirect(ctx, method, path = "global") {
+async function redirect(ctx: any, method: string, path: string = "global") {
   const { devPath } = ctx.params
   const queryString = ctx.originalUrl.split("?")[1] || ""
   const response = await fetch(
     checkSlashesInUrl(
       `${env.WORKER_URL}/api/${path}/${devPath}?${queryString}`
     ),
-    request(
-      ctx,
-      {
-        method,
-        body: ctx.request.body,
-      },
-      true
-    )
+    request(ctx, {
+      method,
+      body: ctx.request.body,
+    })
   )
   if (response.status !== 200) {
     const err = await response.text()
@@ -46,28 +40,28 @@ async function redirect(ctx, method, path = "global") {
   ctx.cookies
 }
 
-exports.buildRedirectGet = path => {
-  return async ctx => {
+export function buildRedirectGet(path: string) {
+  return async (ctx: any) => {
     await redirect(ctx, "GET", path)
   }
 }
 
-exports.buildRedirectPost = path => {
-  return async ctx => {
+export function buildRedirectPost(path: string) {
+  return async (ctx: any) => {
     await redirect(ctx, "POST", path)
   }
 }
 
-exports.buildRedirectDelete = path => {
-  return async ctx => {
+export function buildRedirectDelete(path: string) {
+  return async (ctx: any) => {
     await redirect(ctx, "DELETE", path)
   }
 }
 
-exports.clearLock = async ctx => {
+export async function clearLock(ctx: any) {
   const { appId } = ctx.params
   try {
-    await clearLock(appId, ctx.user)
+    await redisClearLock(appId, ctx.user)
   } catch (err) {
     ctx.throw(400, `Unable to remove lock. ${err}`)
   }
@@ -76,16 +70,16 @@ exports.clearLock = async ctx => {
   }
 }
 
-exports.revert = async ctx => {
+export async function revert(ctx: any) {
   const { appId } = ctx.params
-  const productionAppId = getProdAppID(appId)
+  const productionAppId = dbCore.getProdAppID(appId)
 
   // App must have been deployed first
   try {
-    const db = getProdAppDB({ skip_setup: true })
-    const info = await db.info()
-    if (info.error) {
-      throw info.error
+    const db = context.getProdAppDB({ skip_setup: true })
+    const exists = await db.exists()
+    if (!exists) {
+      throw new Error("App must be deployed to be reverted.")
     }
     const deploymentDoc = await db.get(DocumentType.DEPLOYMENTS)
     if (
@@ -98,7 +92,7 @@ exports.revert = async ctx => {
     return ctx.throw(400, "App has not yet been deployed")
   }
 
-  const replication = new Replication({
+  const replication = new dbCore.Replication({
     source: productionAppId,
     target: appId,
   })
@@ -109,12 +103,12 @@ exports.revert = async ctx => {
     }
 
     // update appID in reverted app to be dev version again
-    const db = getAppDB()
+    const db = context.getAppDB()
     const appDoc = await db.get(DocumentType.APP_METADATA)
     appDoc.appId = appId
     appDoc.instance._id = appId
     await db.put(appDoc)
-    await appCache.invalidateAppMetadata(appId)
+    await cache.app.invalidateAppMetadata(appId)
     ctx.body = {
       message: "Reverted changes successfully.",
     }
@@ -126,7 +120,7 @@ exports.revert = async ctx => {
   }
 }
 
-exports.getBudibaseVersion = async ctx => {
+export async function getBudibaseVersion(ctx: any) {
   const version = require("../../../package.json").version
   ctx.body = {
     version,

package/src/api/controllers/integration.ts

@@ -0,0 +1,13 @@
+import { getDefinitions } from "../../integrations"
+import { BBContext } from "@budibase/types"
+
+export async function fetch(ctx: BBContext) {
+  ctx.status = 200
+  ctx.body = await getDefinitions()
+}
+
+export async function find(ctx: BBContext) {
+  const defs = await getDefinitions()
+  ctx.status = 200
+  ctx.body = defs[ctx.params.type]
+}

package/src/api/controllers/{layout.js → layout.ts}

@@ -1,10 +1,10 @@
-const { EMPTY_LAYOUT } = require("../../constants/layouts")
-const { generateLayoutID, getScreenParams } = require("../../db/utils")
-const { getAppDB } = require("@budibase/backend-core/context")
-const { events } = require("@budibase/backend-core")
+import { EMPTY_LAYOUT } from "../../constants/layouts"
+import { generateLayoutID, getScreenParams } from "../../db/utils"
+import { events, context } from "@budibase/backend-core"
+import { BBContext } from "@budibase/types"
 
-exports.save = async function (ctx) {
-  const db = getAppDB()
+export async function save(ctx: BBContext) {
+  const db = context.getAppDB()
   let layout = ctx.request.body
 
   if (!layout.props) {
@@ -24,8 +24,8 @@ exports.save = async function (ctx) {
   ctx.status = 200
 }
 
-exports.destroy = async function (ctx) {
-  const db = getAppDB()
+export async function destroy(ctx: BBContext) {
+  const db = context.getAppDB()
   const layoutId = ctx.params.layoutId,
     layoutRev = ctx.params.layoutRev
 

package/src/api/controllers/{metadata.js → metadata.ts}

@@ -1,15 +1,16 @@
-const { MetadataTypes } = require("../../constants")
-const { generateMetadataID } = require("../../db/utils")
-const { saveEntityMetadata, deleteEntityMetadata } = require("../../utilities")
-const { getAppDB } = require("@budibase/backend-core/context")
+import { MetadataTypes } from "../../constants"
+import { generateMetadataID } from "../../db/utils"
+import { saveEntityMetadata, deleteEntityMetadata } from "../../utilities"
+import { context } from "@budibase/backend-core"
+import { BBContext } from "@budibase/types"
 
-exports.getTypes = async ctx => {
+export async function getTypes(ctx: BBContext) {
   ctx.body = {
     types: MetadataTypes,
   }
 }
 
-exports.saveMetadata = async ctx => {
+export async function saveMetadata(ctx: BBContext) {
   const { type, entityId } = ctx.params
   if (type === MetadataTypes.AUTOMATION_TEST_HISTORY) {
     ctx.throw(400, "Cannot save automation history type")
@@ -17,7 +18,7 @@ exports.saveMetadata = async ctx => {
   ctx.body = await saveEntityMetadata(type, entityId, ctx.request.body)
 }
 
-exports.deleteMetadata = async ctx => {
+export async function deleteMetadata(ctx: BBContext) {
   const { type, entityId } = ctx.params
   await deleteEntityMetadata(type, entityId)
   ctx.body = {
@@ -25,13 +26,13 @@ exports.deleteMetadata = async ctx => {
   }
 }
 
-exports.getMetadata = async ctx => {
+export async function getMetadata(ctx: BBContext) {
   const { type, entityId } = ctx.params
-  const db = getAppDB()
+  const db = context.getAppDB()
   const id = generateMetadataID(type, entityId)
   try {
     ctx.body = await db.get(id)
-  } catch (err) {
+  } catch (err: any) {
     if (err.status === 404) {
       ctx.body = {}
     } else {

package/src/api/controllers/migrations.ts

@@ -0,0 +1,14 @@
+import { migrate as migrationImpl, MIGRATIONS } from "../../migrations"
+import { BBContext } from "@budibase/types"
+
+export async function migrate(ctx: BBContext) {
+  const options = ctx.request.body
+  // don't await as can take a while, just return
+  migrationImpl(options)
+  ctx.status = 200
+}
+
+export async function fetchDefinitions(ctx: BBContext) {
+  ctx.body = MIGRATIONS
+  ctx.status = 200
+}

package/src/api/controllers/{permission.js → permission.ts}

@@ -1,18 +1,11 @@
-const { getBuiltinPermissions } = require("@budibase/backend-core/permissions")
-const {
-  isBuiltin,
-  getDBRoleID,
-  getExternalRoleID,
-  getBuiltinRoles,
-  checkForRoleResourceArray,
-} = require("@budibase/backend-core/roles")
-const { getRoleParams } = require("../../db/utils")
-const {
+import { permissions, roles, context } from "@budibase/backend-core"
+import { getRoleParams } from "../../db/utils"
+import {
   CURRENTLY_SUPPORTED_LEVELS,
   getBasePermissions,
-} = require("../../utilities/security")
-const { removeFromArray } = require("../../utilities")
-const { getAppDB } = require("@budibase/backend-core/context")
+} from "../../utilities/security"
+import { removeFromArray } from "../../utilities"
+import { BBContext, Database, Role } from "@budibase/types"
 
 const PermissionUpdateType = {
   REMOVE: "remove",
@@ -22,7 +15,7 @@ const PermissionUpdateType = {
 const SUPPORTED_LEVELS = CURRENTLY_SUPPORTED_LEVELS
 
 // utility function to stop this repetition - permissions always stored under roles
-async function getAllDBRoles(db) {
+async function getAllDBRoles(db: Database) {
   const body = await db.allDocs(
     getRoleParams(null, {
       include_docs: true,
@@ -32,21 +25,25 @@ async function getAllDBRoles(db) {
 }
 
 async function updatePermissionOnRole(
-  appId,
-  { roleId, resourceId, level },
-  updateType
+  appId: string,
+  {
+    roleId,
+    resourceId,
+    level,
+  }: { roleId: string; resourceId: string; level: string },
+  updateType: string
 ) {
-  const db = getAppDB()
+  const db = context.getAppDB()
   const remove = updateType === PermissionUpdateType.REMOVE
-  const isABuiltin = isBuiltin(roleId)
-  const dbRoleId = getDBRoleID(roleId)
+  const isABuiltin = roles.isBuiltin(roleId)
+  const dbRoleId = roles.getDBRoleID(roleId)
   const dbRoles = await getAllDBRoles(db)
   const docUpdates = []
 
   // the permission is for a built in, make sure it exists
   if (isABuiltin && !dbRoles.some(role => role._id === dbRoleId)) {
-    const builtin = getBuiltinRoles()[roleId]
-    builtin._id = getDBRoleID(builtin._id)
+    const builtin = roles.getBuiltinRoles()[roleId]
+    builtin._id = roles.getDBRoleID(builtin._id)
     dbRoles.push(builtin)
   }
 
@@ -90,41 +87,44 @@ async function updatePermissionOnRole(
   }
 
   const response = await db.bulkDocs(docUpdates)
-  return response.map(resp => {
-    resp._id = getExternalRoleID(resp.id)
+  return response.map((resp: any) => {
+    resp._id = roles.getExternalRoleID(resp.id)
     delete resp.id
     return resp
   })
 }
 
-exports.fetchBuiltin = function (ctx) {
-  ctx.body = Object.values(getBuiltinPermissions())
+export function fetchBuiltin(ctx: BBContext) {
+  ctx.body = Object.values(permissions.getBuiltinPermissions())
 }
 
-exports.fetchLevels = function (ctx) {
+export function fetchLevels(ctx: BBContext) {
   // for now only provide the read/write perms externally
   ctx.body = SUPPORTED_LEVELS
 }
 
-exports.fetch = async function (ctx) {
-  const db = getAppDB()
-  const roles = await getAllDBRoles(db)
-  let permissions = {}
+export async function fetch(ctx: BBContext) {
+  const db = context.getAppDB()
+  const dbRoles: Role[] = await getAllDBRoles(db)
+  let permissions: any = {}
   // create an object with structure role ID -> resource ID -> level
-  for (let role of roles) {
+  for (let role of dbRoles) {
     if (!role.permissions) {
       continue
     }
-    const roleId = getExternalRoleID(role._id)
+    const roleId = roles.getExternalRoleID(role._id)
+    if (!roleId) {
+      ctx.throw(400, "Unable to retrieve role")
+    }
     for (let [resource, levelArr] of Object.entries(role.permissions)) {
-      const levels = Array.isArray(levelArr) ? [levelArr] : levelArr
-      const perms = {}
-      levels.forEach(level => (perms[level] = roleId))
+      const levels: string[] = Array.isArray(levelArr) ? levelArr : [levelArr]
+      const perms: Record<string, string> = {}
+      levels.forEach(level => (perms[level] = roleId!))
       permissions[resource] = perms
     }
   }
   // apply the base permissions
-  const finalPermissions = {}
+  const finalPermissions: Record<string, Record<string, string>> = {}
   for (let [resource, permission] of Object.entries(permissions)) {
     const basePerms = getBasePermissions(resource)
     finalPermissions[resource] = Object.assign(basePerms, permission)
@@ -132,33 +132,36 @@ exports.fetch = async function (ctx) {
   ctx.body = finalPermissions
 }
 
-exports.getResourcePerms = async function (ctx) {
+export async function getResourcePerms(ctx: BBContext) {
   const resourceId = ctx.params.resourceId
-  const db = getAppDB()
+  const db = context.getAppDB()
   const body = await db.allDocs(
     getRoleParams(null, {
       include_docs: true,
     })
   )
-  const roles = body.rows.map(row => row.doc)
-  let permissions = {}
+  const rolesList = body.rows.map(row => row.doc)
+  let permissions: Record<string, string> = {}
   for (let level of SUPPORTED_LEVELS) {
     // update the various roleIds in the resource permissions
-    for (let role of roles) {
-      const rolePerms = checkForRoleResourceArray(role.permissions, resourceId)
+    for (let role of rolesList) {
+      const rolePerms = roles.checkForRoleResourceArray(
+        role.permissions,
+        resourceId
+      )
       if (
         rolePerms &&
         rolePerms[resourceId] &&
         rolePerms[resourceId].indexOf(level) !== -1
       ) {
-        permissions[level] = getExternalRoleID(role._id)
+        permissions[level] = roles.getExternalRoleID(role._id)!
       }
     }
   }
   ctx.body = Object.assign(getBasePermissions(resourceId), permissions)
 }
 
-exports.addPermission = async function (ctx) {
+export async function addPermission(ctx: BBContext) {
   ctx.body = await updatePermissionOnRole(
     ctx.appId,
     ctx.params,
@@ -166,7 +169,7 @@ exports.addPermission = async function (ctx) {
   )
 }
 
-exports.removePermission = async function (ctx) {
+export async function removePermission(ctx: BBContext) {
   ctx.body = await updatePermissionOnRole(
     ctx.appId,
     ctx.params,

package/src/api/controllers/plugin/index.ts

@@ -1,6 +1,5 @@
 import { npmUpload, urlUpload, githubUpload, fileUpload } from "./uploaders"
-import { getGlobalDB } from "@budibase/backend-core/tenancy"
-import { validate } from "@budibase/backend-core/plugins"
+import { plugins as pluginCore, tenancy } from "@budibase/backend-core"
 import { PluginType, FileType, PluginSource } from "@budibase/types"
 import env from "../../../environment"
 import { ClientAppSocket } from "../../../websocket"
@@ -8,7 +7,7 @@ import { db as dbCore } from "@budibase/backend-core"
 import { plugins } from "@budibase/pro"
 
 export async function getPlugins(type?: PluginType) {
-  const db = getGlobalDB()
+  const db = tenancy.getGlobalDB()
   const response = await db.allDocs(
     dbCore.getPluginParams(null, {
       include_docs: true,
@@ -76,7 +75,7 @@ export async function create(ctx: any) {
         break
     }
 
-    validate(metadata?.schema)
+    pluginCore.validate(metadata?.schema)
 
     // Only allow components in cloud
     if (!env.SELF_HOSTED && metadata?.schema?.type !== PluginType.COMPONENT) {
@@ -121,7 +120,7 @@ export async function processUploadedPlugin(
   source?: PluginSource
 ) {
   const { metadata, directory } = await fileUpload(plugin)
-  validate(metadata?.schema)
+  pluginCore.validate(metadata?.schema)
 
   // Only allow components in cloud
   if (!env.SELF_HOSTED && metadata?.schema?.type !== PluginType.COMPONENT) {

package/src/api/controllers/plugin/utils.ts

@@ -1,7 +1,5 @@
-import {
-  createTempFolder,
-  downloadTarballDirect,
-} from "../../../utilities/fileSystem"
+import { createTempFolder } from "../../../utilities/fileSystem"
+import { objectStore } from "@budibase/backend-core"
 
 export async function downloadUnzipTarball(
   url: string,
@@ -10,7 +8,7 @@ export async function downloadUnzipTarball(
 ) {
   try {
     const path = createTempFolder(name)
-    await downloadTarballDirect(url, path, headers)
+    await objectStore.downloadTarballDirect(url, path, headers)
 
     return path
   } catch (e: any) {