@budibase/server 2.1.32-alpha.5 → 2.1.32-alpha.7

package/src/tests/utilities/TestConfiguration.js

@@ -1,5 +1,4 @@
 require("../../db").init()
-const { BUILTIN_ROLE_IDS } = require("@budibase/backend-core/roles")
 const env = require("../../environment")
 const {
   basicTable,
@@ -13,18 +12,21 @@ const {
   basicWebhook,
   TENANT_ID,
 } = require("./structures")
+const {
+  constants,
+  tenancy,
+  sessions,
+  cache,
+  context,
+  db: dbCore,
+  encryption,
+  auth,
+  roles,
+} = require("@budibase/backend-core")
 const controllers = require("./controllers")
 const supertest = require("supertest")
 const { cleanup } = require("../../utilities/fileSystem")
-const { Cookie, Header } = require("@budibase/backend-core/constants")
-const { jwt } = require("@budibase/backend-core/auth")
-const { doInTenant, doWithGlobalDB } = require("@budibase/backend-core/tenancy")
-const { createASession } = require("@budibase/backend-core/sessions")
-const { user: userCache } = require("@budibase/backend-core/cache")
 const newid = require("../../db/newid")
-const context = require("@budibase/backend-core/context")
-const { generateDevInfoID, SEPARATOR } = require("@budibase/backend-core/db")
-const { encrypt } = require("@budibase/backend-core/encryption")
 const { DocumentType, generateUserMetadataID } = require("../../db/utils")
 const { startup } = require("../../startup")
 
@@ -83,7 +85,7 @@ class TestConfiguration {
     if (!appId) {
       appId = this.appId
     }
-    return doInTenant(TENANT_ID, () => {
+    return tenancy.doInTenant(TENANT_ID, () => {
       // check if already in a context
       if (context.getAppId() == null && appId !== null) {
         return context.doInAppContext(appId, async () => {
@@ -155,7 +157,7 @@ class TestConfiguration {
     email = EMAIL,
     roles,
   } = {}) {
-    return doWithGlobalDB(TENANT_ID, async db => {
+    return tenancy.doWithGlobalDB(TENANT_ID, async db => {
       let existing
       try {
         existing = await db.get(id)
@@ -170,7 +172,7 @@ class TestConfiguration {
         firstName,
         lastName,
       }
-      await createASession(id, {
+      await sessions.createASession(id, {
         sessionId: "sessionid",
         tenantId: TENANT_ID,
         csrfToken: CSRF_TOKEN,
@@ -212,7 +214,7 @@ class TestConfiguration {
       admin,
       roles,
     })
-    await userCache.invalidateUser(globalId)
+    await cache.user.invalidateUser(globalId)
     return {
       ...resp,
       globalId,
@@ -227,19 +229,19 @@ class TestConfiguration {
         throw "Server has not been opened, cannot login."
       }
       // make sure the user exists in the global DB
-      if (roleId !== BUILTIN_ROLE_IDS.PUBLIC) {
+      if (roleId !== roles.BUILTIN_ROLE_IDS.PUBLIC) {
         await this.globalUser({
           id: userId,
           builder,
           roles: { [this.prodAppId]: roleId },
         })
       }
-      await createASession(userId, {
+      await sessions.createASession(userId, {
         sessionId: "sessionid",
         tenantId: TENANT_ID,
       })
       // have to fake this
-      const auth = {
+      const authObj = {
         userId,
         sessionId: "sessionid",
         tenantId: TENANT_ID,
@@ -248,45 +250,45 @@ class TestConfiguration {
         roleId: roleId,
         appId,
       }
-      const authToken = jwt.sign(auth, env.JWT_SECRET)
-      const appToken = jwt.sign(app, env.JWT_SECRET)
+      const authToken = auth.jwt.sign(authObj, env.JWT_SECRET)
+      const appToken = auth.jwt.sign(app, env.JWT_SECRET)
 
       // returning necessary request headers
-      await userCache.invalidateUser(userId)
+      await cache.user.invalidateUser(userId)
       return {
         Accept: "application/json",
         Cookie: [
-          `${Cookie.Auth}=${authToken}`,
-          `${Cookie.CurrentApp}=${appToken}`,
+          `${constants.Cookie.Auth}=${authToken}`,
+          `${constants.Cookie.CurrentApp}=${appToken}`,
         ],
-        [Header.APP_ID]: appId,
+        [constants.Header.APP_ID]: appId,
       }
     })
   }
 
   defaultHeaders(extras = {}) {
-    const auth = {
+    const authObj = {
       userId: GLOBAL_USER_ID,
       sessionId: "sessionid",
       tenantId: TENANT_ID,
     }
     const app = {
-      roleId: BUILTIN_ROLE_IDS.ADMIN,
+      roleId: roles.BUILTIN_ROLE_IDS.ADMIN,
       appId: this.appId,
     }
-    const authToken = jwt.sign(auth, env.JWT_SECRET)
-    const appToken = jwt.sign(app, env.JWT_SECRET)
+    const authToken = auth.jwt.sign(authObj, env.JWT_SECRET)
+    const appToken = auth.jwt.sign(app, env.JWT_SECRET)
     const headers = {
       Accept: "application/json",
       Cookie: [
-        `${Cookie.Auth}=${authToken}`,
-        `${Cookie.CurrentApp}=${appToken}`,
+        `${constants.Cookie.Auth}=${authToken}`,
+        `${constants.Cookie.CurrentApp}=${appToken}`,
       ],
-      [Header.CSRF_TOKEN]: CSRF_TOKEN,
+      [constants.Header.CSRF_TOKEN]: CSRF_TOKEN,
       ...extras,
     }
     if (this.appId) {
-      headers[Header.APP_ID] = this.appId
+      headers[constants.Header.APP_ID] = this.appId
     }
     return headers
   }
@@ -298,14 +300,14 @@ class TestConfiguration {
       Accept: "application/json",
     }
     if (appId) {
-      headers[Header.APP_ID] = appId
+      headers[constants.Header.APP_ID] = appId
     }
     return headers
   }
 
   async roleHeaders({
     email = EMAIL,
-    roleId = BUILTIN_ROLE_IDS.ADMIN,
+    roleId = roles.BUILTIN_ROLE_IDS.ADMIN,
     builder = false,
     prodApp = true,
   } = {}) {
@@ -315,15 +317,17 @@ class TestConfiguration {
   // API
 
   async generateApiKey(userId = GLOBAL_USER_ID) {
-    return doWithGlobalDB(TENANT_ID, async db => {
-      const id = generateDevInfoID(userId)
+    return tenancy.doWithGlobalDB(TENANT_ID, async db => {
+      const id = dbCore.generateDevInfoID(userId)
       let devInfo
       try {
         devInfo = await db.get(id)
       } catch (err) {
         devInfo = { _id: id, userId }
       }
-      devInfo.apiKey = encrypt(`${TENANT_ID}${SEPARATOR}${newid()}`)
+      devInfo.apiKey = encryption.encrypt(
+        `${TENANT_ID}${dbCore.SEPARATOR}${newid()}`
+      )
       await db.put(devInfo)
       return devInfo.apiKey
     })

package/src/tests/utilities/structures.js

@@ -1,5 +1,4 @@
-const { BUILTIN_ROLE_IDS } = require("@budibase/backend-core/roles")
-const { BuiltinPermissionID } = require("@budibase/backend-core/permissions")
+const { roles, permissions } = require("@budibase/backend-core")
 const { createHomeScreen } = require("../../constants/screens")
 const { EMPTY_LAYOUT } = require("../../constants/layouts")
 const { cloneDeep } = require("lodash/fp")
@@ -134,8 +133,8 @@ exports.basicLinkedRow = (tableId, linkedRowId, linkField = "link") => {
 exports.basicRole = () => {
   return {
     name: "NewRole",
-    inherits: BUILTIN_ROLE_IDS.BASIC,
-    permissionId: BuiltinPermissionID.READ_ONLY,
+    inherits: roles.BUILTIN_ROLE_IDS.BASIC,
+    permissionId: permissions.BuiltinPermissionID.READ_ONLY,
   }
 }
 

package/src/threads/automation.ts

@@ -23,15 +23,14 @@ import {
   AutomationMetadata,
 } from "../definitions/automations"
 import { WorkerCallback } from "./definitions"
-const { doInAppContext, getAppDB } = require("@budibase/backend-core/context")
-const { logAlertWithInfo, logWarn } = require("@budibase/backend-core/logging")
-const { processObject } = require("@budibase/string-templates")
+import { context, logging } from "@budibase/backend-core"
+import { processObject } from "@budibase/string-templates"
+import { cloneDeep } from "lodash/fp"
+import env from "../environment"
 const FILTER_STEP_ID = actions.ACTION_DEFINITIONS.FILTER.stepId
 const LOOP_STEP_ID = actions.ACTION_DEFINITIONS.LOOP.stepId
 const CRON_STEP_ID = triggerDefs.CRON.stepId
 const STOPPED_STATUS = { success: true, status: AutomationStatus.STOPPED }
-const { cloneDeep } = require("lodash/fp")
-const env = require("../environment")
 
 function typecastForLooping(loopStep: LoopStep, input: LoopInput) {
   if (!input || !input.binding) {
@@ -121,7 +120,7 @@ class Orchestrator {
 
   async getMetadata(): Promise<AutomationMetadata> {
     const metadataId = generateAutomationMetadataID(this._automation._id!)
-    const db = getAppDB()
+    const db = context.getAppDB()
     let metadata: AutomationMetadata
     try {
       metadata = await db.get(metadataId)
@@ -138,7 +137,7 @@ class Orchestrator {
     if (!this._job.opts.repeat) {
       return
     }
-    logWarn(
+    logging.logWarn(
       `CRON disabled reason=${reason} - ${this._appId}/${this._automation._id}`
     )
     const automation = this._automation
@@ -184,14 +183,14 @@ class Orchestrator {
     } else {
       metadata.errorCount = 0
     }
-    const db = getAppDB()
+    const db = context.getAppDB()
     try {
       await db.put(metadata)
     } catch (err) {
-      logAlertWithInfo(
+      logging.logAlertWithInfo(
         "Failed to write automation metadata",
         db.name,
-        automation._id,
+        automation._id!,
         err
       )
     }
@@ -265,7 +264,7 @@ class Orchestrator {
 
     for (let step of automation.definition.steps) {
       stepCount++
-      let input,
+      let input: any,
         iterations = 1,
         iterationCount = 0
 
@@ -283,7 +282,7 @@ class Orchestrator {
         let originalStepInput = cloneDeep(step.inputs)
         // Handle if the user has set a max iteration count or if it reaches the max limit set by us
         if (loopStep && input.binding) {
-          let newInput = await processObject(
+          let newInput: any = await processObject(
             loopStep.inputs,
             cloneDeep(this._context)
           )
@@ -352,7 +351,7 @@ class Orchestrator {
             }
           }
           if (
-            index === env.AUTOMATION_MAX_ITERATION ||
+            index === env.AUTOMATION_MAX_ITERATIONS ||
             index === parseInt(loopStep.inputs.iterations)
           ) {
             this.updateContextAndOutput(loopStepNumber, step, tempOutput, {
@@ -481,7 +480,7 @@ export function execute(job: Job, callback: WorkerCallback) {
   if (!appId) {
     throw new Error("Unable to execute, event doesn't contain app ID.")
   }
-  doInAppContext(appId, async () => {
+  return context.doInAppContext(appId, async () => {
     const automationOrchestrator = new Orchestrator(job)
     try {
       const response = await automationOrchestrator.execute()
@@ -497,7 +496,7 @@ export const removeStalled = async (job: Job) => {
   if (!appId) {
     throw new Error("Unable to execute, event doesn't contain app ID.")
   }
-  await doInAppContext(appId, async () => {
+  await context.doInAppContext(appId, async () => {
     const automationOrchestrator = new Orchestrator(job)
     await automationOrchestrator.stopCron("stalled")
   })

package/src/threads/query.ts

@@ -1,17 +1,12 @@
 import { default as threadUtils } from "./utils"
 threadUtils.threadSetup()
 import { WorkerCallback, QueryEvent, QueryVariable } from "./definitions"
-const ScriptRunner = require("../utilities/scriptRunner")
-const { getIntegration } = require("../integrations")
-const { processStringSync } = require("@budibase/string-templates")
-const { doInAppContext, getAppDB } = require("@budibase/backend-core/context")
-const {
-  refreshOAuthToken,
-  updateUserOAuth,
-} = require("@budibase/backend-core/auth")
-const { user: userCache } = require("@budibase/backend-core/cache")
-const { getGlobalIDFromUserMetadataID } = require("../db/utils")
-const { cloneDeep } = require("lodash/fp")
+import ScriptRunner from "../utilities/scriptRunner"
+import { getIntegration } from "../integrations"
+import { processStringSync } from "@budibase/string-templates"
+import { context, cache, auth } from "@budibase/backend-core"
+import { getGlobalIDFromUserMetadataID } from "../db/utils"
+import { cloneDeep } from "lodash/fp"
 
 const { isSQL } = require("../integrations/utils")
 const {
@@ -170,7 +165,7 @@ class QueryRunner {
   }
 
   async runAnotherQuery(queryId: string, parameters: any) {
-    const db = getAppDB()
+    const db = context.getAppDB()
     const query = await db.get(queryId)
     const datasource = await db.get(query.datasourceId)
     return new QueryRunner(
@@ -194,7 +189,7 @@ class QueryRunner {
       throw new Error("No refresh token found for authenticated user")
     }
 
-    const resp = await refreshOAuthToken(
+    const resp: any = await auth.refreshOAuthToken(
       oauth2.refreshToken,
       providerType,
       configId
@@ -204,8 +199,8 @@ class QueryRunner {
     // There are several other properties available in 'resp'
     if (!resp.err) {
       const globalUserId = getGlobalIDFromUserMetadataID(_id)
-      await updateUserOAuth(globalUserId, resp)
-      this.ctx.user = await userCache.getUser(globalUserId)
+      await auth.updateUserOAuth(globalUserId, resp)
+      this.ctx.user = await cache.user.getUser(globalUserId)
     } else {
       // In this event the user may have oAuth issues that
       // could require re-authenticating with their provider.
@@ -285,7 +280,7 @@ class QueryRunner {
 }
 
 export function execute(input: QueryEvent, callback: WorkerCallback) {
-  doInAppContext(input.appId, async () => {
+  context.doInAppContext(input.appId!, async () => {
     const Runner = new QueryRunner(input)
     try {
       const response = await Runner.execute()

package/src/threads/utils.ts

@@ -1,8 +1,7 @@
 import { QueryVariable } from "./definitions"
-const env = require("../environment")
-const db = require("../db")
-const redis = require("@budibase/backend-core/redis")
-const { SEPARATOR } = require("@budibase/backend-core/db")
+import env from "../environment"
+import db from "../db"
+import { redis, db as dbCore } from "@budibase/backend-core"
 
 const VARIABLE_TTL_SECONDS = 3600
 let client: any
@@ -21,7 +20,7 @@ process.on("exit", async () => {
 })
 
 function makeVariableKey(queryId: string, variable: string) {
-  return `${queryId}${SEPARATOR}${variable}`
+  return `${queryId}${dbCore.SEPARATOR}${variable}`
 }
 
 export function threadSetup() {

package/src/utilities/budibaseDir.ts

@@ -0,0 +1,3 @@
+import { objectStore } from "@budibase/backend-core"
+
+export const budibaseTempDir = objectStore.budibaseTempDir

package/src/utilities/fileSystem/clientLibrary.js

@@ -1,7 +1,7 @@
 const { join } = require("path")
 const { ObjectStoreBuckets } = require("../../constants")
 const fs = require("fs")
-const { upload, retrieveToTmp, streamUpload } = require("./utilities")
+const { objectStore } = require("@budibase/backend-core")
 const { resolve } = require("../centralPath")
 const env = require("../../environment")
 const TOP_LEVEL_PATH = join(__dirname, "..", "..", "..")
@@ -38,13 +38,13 @@ exports.backupClientLibrary = async appId => {
   let tmpManifestPath
   try {
     // Try to load the manifest from the new file location
-    tmpManifestPath = await retrieveToTmp(
+    tmpManifestPath = await objectStore.retrieveToTmp(
       ObjectStoreBuckets.APPS,
       join(appId, "manifest.json")
     )
   } catch (error) {
     // Fallback to loading it from the old location for old apps
-    tmpManifestPath = await retrieveToTmp(
+    tmpManifestPath = await objectStore.retrieveToTmp(
       ObjectStoreBuckets.APPS,
       join(
         appId,
@@ -58,19 +58,19 @@ exports.backupClientLibrary = async appId => {
   }
 
   // Copy existing client lib to tmp
-  const tmpClientPath = await retrieveToTmp(
+  const tmpClientPath = await objectStore.retrieveToTmp(
     ObjectStoreBuckets.APPS,
     join(appId, "budibase-client.js")
   )
 
   // Upload manifest and client library as backups
-  const manifestUpload = upload({
+  const manifestUpload = objectStore.upload({
     bucket: ObjectStoreBuckets.APPS,
     filename: join(appId, "manifest.json.bak"),
     path: tmpManifestPath,
     type: "application/json",
   })
-  const clientUpload = upload({
+  const clientUpload = objectStore.upload({
     bucket: ObjectStoreBuckets.APPS,
     filename: join(appId, "budibase-client.js.bak"),
     path: tmpClientPath,
@@ -99,7 +99,7 @@ exports.updateClientLibrary = async appId => {
   }
 
   // Upload latest manifest and client library
-  const manifestUpload = streamUpload(
+  const manifestUpload = objectStore.streamUpload(
     ObjectStoreBuckets.APPS,
     join(appId, "manifest.json"),
     fs.createReadStream(manifest),
@@ -107,7 +107,7 @@ exports.updateClientLibrary = async appId => {
       ContentType: "application/json",
     }
   )
-  const clientUpload = streamUpload(
+  const clientUpload = objectStore.streamUpload(
     ObjectStoreBuckets.APPS,
     join(appId, "budibase-client.js"),
     fs.createReadStream(client),
@@ -126,25 +126,25 @@ exports.updateClientLibrary = async appId => {
  */
 exports.revertClientLibrary = async appId => {
   // Copy backups manifest to tmp directory
-  const tmpManifestPath = await retrieveToTmp(
+  const tmpManifestPath = await objectStore.retrieveToTmp(
     ObjectStoreBuckets.APPS,
     join(appId, "manifest.json.bak")
   )
 
   // Copy backup client lib to tmp
-  const tmpClientPath = await retrieveToTmp(
+  const tmpClientPath = await objectStore.retrieveToTmp(
     ObjectStoreBuckets.APPS,
     join(appId, "budibase-client.js.bak")
   )
 
   // Upload backups as new versions
-  const manifestUpload = upload({
+  const manifestUpload = objectStore.upload({
     bucket: ObjectStoreBuckets.APPS,
     filename: join(appId, "manifest.json"),
     path: tmpManifestPath,
     type: "application/json",
   })
-  const clientUpload = upload({
+  const clientUpload = objectStore.upload({
     bucket: ObjectStoreBuckets.APPS,
     filename: join(appId, "budibase-client.js"),
     path: tmpClientPath,

package/src/utilities/fileSystem/index.js

@@ -2,7 +2,13 @@ const { budibaseTempDir } = require("../budibaseDir")
 const fs = require("fs")
 const { join } = require("path")
 const uuid = require("uuid/v4")
+const { context, objectStore } = require("@budibase/backend-core")
 const { ObjectStoreBuckets } = require("../../constants")
+const { updateClientLibrary } = require("./clientLibrary")
+const { checkSlashesInUrl } = require("../")
+const env = require("../../environment")
+const tar = require("tar")
+const fetch = require("node-fetch")
 const {
   upload,
   retrieve,
@@ -11,13 +17,7 @@ const {
   downloadTarball,
   downloadTarballDirect,
   deleteFiles,
-} = require("./utilities")
-const { updateClientLibrary } = require("./clientLibrary")
-const { checkSlashesInUrl } = require("../")
-const env = require("../../environment")
-const { getAppId } = require("@budibase/backend-core/context")
-const tar = require("tar")
-const fetch = require("node-fetch")
+} = objectStore
 
 const TOP_LEVEL_PATH = join(__dirname, "..", "..", "..")
 const NODE_MODULES_PATH = join(TOP_LEVEL_PATH, "node_modules")
@@ -165,7 +165,7 @@ exports.downloadTemplate = async (type, name) => {
  * Retrieves component libraries from object store (or tmp symlink if in local)
  */
 exports.getComponentLibraryManifest = async library => {
-  const appId = getAppId()
+  const appId = context.getAppId()
   const filename = "manifest.json"
   /* istanbul ignore next */
   // when testing in cypress and so on we need to get the package