@budibase/server 1.0.49 → 1.0.50-alpha.0

package/src/api/controllers/datasource.js

@@ -1,4 +1,3 @@
-const CouchDB = require("../../db")
 const {
   generateDatasourceID,
   getDatasourceParams,
@@ -11,12 +10,11 @@ const { BuildSchemaErrors, InvalidColumns } = require("../../constants")
 const { integrations } = require("../../integrations")
 const { getDatasourceAndQuery } = require("./row/utils")
 const { invalidateDynamicVariables } = require("../../threads/utils")
+const { getAppDB } = require("@budibase/backend-core/context")
 
 exports.fetch = async function (ctx) {
-  const database = new CouchDB(ctx.appId)
-
   // Get internal tables
-  const db = new CouchDB(ctx.appId)
+  const db = getAppDB()
   const internalTables = await db.allDocs(
     getTableParams(null, {
       include_docs: true,
@@ -31,18 +29,25 @@ exports.fetch = async function (ctx) {
 
   // Get external datasources
   const datasources = (
-    await database.allDocs(
+    await db.allDocs(
       getDatasourceParams(null, {
         include_docs: true,
       })
     )
   ).rows.map(row => row.doc)
 
+  for (let datasource of datasources) {
+    if (datasource.config && datasource.config.auth) {
+      // strip secrets from response so they don't show in the network request
+      delete datasource.config.auth
+    }
+  }
+
   ctx.body = [bbInternalDb, ...datasources]
 }
 
 exports.buildSchemaFromDb = async function (ctx) {
-  const db = new CouchDB(ctx.appId)
+  const db = getAppDB()
   const datasource = await db.get(ctx.params.datasourceId)
 
   const { tables, error } = await buildSchemaHelper(datasource)
@@ -91,11 +96,16 @@ const invalidateVariables = async (existingDatasource, updatedDatasource) => {
 }
 
 exports.update = async function (ctx) {
-  const db = new CouchDB(ctx.appId)
+  const db = getAppDB()
   const datasourceId = ctx.params.datasourceId
   let datasource = await db.get(datasourceId)
+  const auth = datasource.config.auth
   await invalidateVariables(datasource, ctx.request.body)
   datasource = { ...datasource, ...ctx.request.body }
+  if (auth && !ctx.request.body.auth) {
+    // don't strip auth config from DB
+    datasource.config.auth = auth
+  }
 
   const response = await db.put(datasource)
   datasource._rev = response.rev
@@ -114,7 +124,7 @@ exports.update = async function (ctx) {
 }
 
 exports.save = async function (ctx) {
-  const db = new CouchDB(ctx.appId)
+  const db = getAppDB()
   const plus = ctx.request.body.datasource.plus
   const fetchSchema = ctx.request.body.fetchSchema
 
@@ -150,7 +160,7 @@ exports.save = async function (ctx) {
 }
 
 exports.destroy = async function (ctx) {
-  const db = new CouchDB(ctx.appId)
+  const db = getAppDB()
 
   // Delete all queries for the datasource
   const queries = await db.allDocs(
@@ -172,7 +182,7 @@ exports.destroy = async function (ctx) {
 }
 
 exports.find = async function (ctx) {
-  const database = new CouchDB(ctx.appId)
+  const database = getAppDB()
   ctx.body = await database.get(ctx.params.datasourceId)
 }
 
@@ -180,7 +190,7 @@ exports.find = async function (ctx) {
 exports.query = async function (ctx) {
   const queryJson = ctx.request.body
   try {
-    ctx.body = await getDatasourceAndQuery(ctx.appId, queryJson)
+    ctx.body = await getDatasourceAndQuery(queryJson)
   } catch (err) {
     ctx.throw(400, err)
   }

package/src/api/controllers/deploy/Deployment.js

@@ -1,18 +1,14 @@
 const newid = require("../../../db/newid")
+const { getAppId } = require("@budibase/backend-core/context")
 
 /**
  * This is used to pass around information about the deployment that is occurring
  */
 class Deployment {
-  constructor(appId, id = null) {
-    this.appId = appId
+  constructor(id = null) {
     this._id = id || newid()
   }
 
-  getAppId() {
-    return this.appId
-  }
-
   setVerification(verification) {
     if (!verification) {
       return
@@ -43,7 +39,7 @@ class Deployment {
   getJSON() {
     const obj = {
       _id: this._id,
-      appId: this.appId,
+      appId: getAppId(),
       status: this.status,
     }
     if (this.err) {

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

@@ -1,12 +1,20 @@
-const CouchDB = require("../../../db")
 const Deployment = require("./Deployment")
-const { Replication, getDeployedAppID } = require("@budibase/backend-core/db")
+const {
+  Replication,
+  getProdAppID,
+  getDevelopmentAppID,
+} = require("@budibase/backend-core/db")
 const { DocumentTypes, getAutomationParams } = require("../../../db/utils")
 const {
   disableAllCrons,
   enableCronTrigger,
 } = require("../../../automations/utils")
 const { app: appCache } = require("@budibase/backend-core/cache")
+const {
+  getAppId,
+  getAppDB,
+  getProdAppDB,
+} = require("@budibase/backend-core/context")
 
 // the max time we can wait for an invalidation to complete before considering it failed
 const MAX_PENDING_TIME_MS = 30 * 60000
@@ -34,9 +42,8 @@ async function checkAllDeployments(deployments) {
 }
 
 async function storeDeploymentHistory(deployment) {
-  const appId = deployment.getAppId()
   const deploymentJSON = deployment.getJSON()
-  const db = new CouchDB(appId)
+  const db = getAppDB()
 
   let deploymentDoc
   try {
@@ -64,7 +71,7 @@ async function storeDeploymentHistory(deployment) {
 }
 
 async function initDeployedApp(prodAppId) {
-  const db = new CouchDB(prodAppId)
+  const db = getProdAppDB()
   console.log("Reading automation docs")
   const automations = (
     await db.allDocs(
@@ -88,10 +95,12 @@ async function initDeployedApp(prodAppId) {
 
 async function deployApp(deployment) {
   try {
-    const productionAppId = getDeployedAppID(deployment.appId)
+    const appId = getAppId()
+    const devAppId = getDevelopmentAppID(appId)
+    const productionAppId = getProdAppID(appId)
 
     const replication = new Replication({
-      source: deployment.appId,
+      source: devAppId,
       target: productionAppId,
     })
 
@@ -99,7 +108,7 @@ async function deployApp(deployment) {
 
     await replication.replicate()
     console.log("replication complete.. replacing app meta doc")
-    const db = new CouchDB(productionAppId)
+    const db = getProdAppDB()
     const appDoc = await db.get(DocumentTypes.APP_METADATA)
     appDoc.appId = productionAppId
     appDoc.instance._id = productionAppId
@@ -122,8 +131,7 @@ async function deployApp(deployment) {
 
 exports.fetchDeployments = async function (ctx) {
   try {
-    const appId = ctx.appId
-    const db = new CouchDB(appId)
+    const db = getAppDB()
     const deploymentDoc = await db.get(DocumentTypes.DEPLOYMENTS)
     const { updated, deployments } = await checkAllDeployments(
       deploymentDoc,
@@ -140,8 +148,7 @@ exports.fetchDeployments = async function (ctx) {
 
 exports.deploymentProgress = async function (ctx) {
   try {
-    const appId = ctx.appId
-    const db = new CouchDB(appId)
+    const db = getAppDB()
     const deploymentDoc = await db.get(DocumentTypes.DEPLOYMENTS)
     ctx.body = deploymentDoc[ctx.params.deploymentId]
   } catch (err) {
@@ -153,7 +160,7 @@ exports.deploymentProgress = async function (ctx) {
 }
 
 exports.deployApp = async function (ctx) {
-  let deployment = new Deployment(ctx.appId)
+  let deployment = new Deployment()
   console.log("Deployment object created")
   deployment.setStatus(DeploymentStatus.PENDING)
   console.log("Deployment object set to pending")

package/src/api/controllers/dev.js

@@ -1,12 +1,12 @@
 const fetch = require("node-fetch")
-const CouchDB = require("../../db")
 const env = require("../../environment")
 const { checkSlashesInUrl } = require("../../utilities")
 const { request } = require("../../utilities/workerRequests")
 const { clearLock } = require("../../utilities/redis")
-const { Replication } = require("@budibase/backend-core/db")
+const { Replication, getProdAppID } = require("@budibase/backend-core/db")
 const { DocumentTypes } = require("../../db/utils")
 const { app: appCache } = require("@budibase/backend-core/cache")
+const { getProdAppDB, getAppDB } = require("@budibase/backend-core/context")
 
 async function redirect(ctx, method, path = "global") {
   const { devPath } = ctx.params
@@ -77,11 +77,11 @@ exports.clearLock = async ctx => {
 
 exports.revert = async ctx => {
   const { appId } = ctx.params
-  const productionAppId = appId.replace("_dev", "")
+  const productionAppId = getProdAppID(appId)
 
   // App must have been deployed first
   try {
-    const db = new CouchDB(productionAppId, { skip_setup: true })
+    const db = getProdAppDB({ skip_setup: true })
     const info = await db.info()
     if (info.error) throw info.error
     const deploymentDoc = await db.get(DocumentTypes.DEPLOYMENTS)
@@ -103,7 +103,7 @@ exports.revert = async ctx => {
 
     await replication.rollback()
     // update appID in reverted app to be dev version again
-    const db = new CouchDB(appId)
+    const db = getAppDB()
     const appDoc = await db.get(DocumentTypes.APP_METADATA)
     appDoc.appId = appId
     appDoc.instance._id = appId

package/src/api/controllers/layout.js

@@ -2,11 +2,11 @@ const {
   EMPTY_LAYOUT,
   BASE_LAYOUT_PROP_IDS,
 } = require("../../constants/layouts")
-const CouchDB = require("../../db")
 const { generateLayoutID, getScreenParams } = require("../../db/utils")
+const { getAppDB } = require("@budibase/backend-core/context")
 
 exports.save = async function (ctx) {
-  const db = new CouchDB(ctx.appId)
+  const db = getAppDB()
   let layout = ctx.request.body
 
   if (!layout.props) {
@@ -26,7 +26,7 @@ exports.save = async function (ctx) {
 }
 
 exports.destroy = async function (ctx) {
-  const db = new CouchDB(ctx.appId)
+  const db = getAppDB()
   const layoutId = ctx.params.layoutId,
     layoutRev = ctx.params.layoutRev
 

package/src/api/controllers/metadata.js

@@ -1,7 +1,7 @@
 const { MetadataTypes } = require("../../constants")
-const CouchDB = require("../../db")
 const { generateMetadataID } = require("../../db/utils")
 const { saveEntityMetadata, deleteEntityMetadata } = require("../../utilities")
+const { getAppDB } = require("@budibase/backend-core/context")
 
 exports.getTypes = async ctx => {
   ctx.body = {
@@ -14,17 +14,12 @@ exports.saveMetadata = async ctx => {
   if (type === MetadataTypes.AUTOMATION_TEST_HISTORY) {
     ctx.throw(400, "Cannot save automation history type")
   }
-  ctx.body = await saveEntityMetadata(
-    ctx.appId,
-    type,
-    entityId,
-    ctx.request.body
-  )
+  ctx.body = await saveEntityMetadata(type, entityId, ctx.request.body)
 }
 
 exports.deleteMetadata = async ctx => {
   const { type, entityId } = ctx.params
-  await deleteEntityMetadata(ctx.appId, type, entityId)
+  await deleteEntityMetadata(type, entityId)
   ctx.body = {
     message: "Metadata deleted successfully",
   }
@@ -32,7 +27,7 @@ exports.deleteMetadata = async ctx => {
 
 exports.getMetadata = async ctx => {
   const { type, entityId } = ctx.params
-  const db = new CouchDB(ctx.appId)
+  const db = getAppDB()
   const id = generateMetadataID(type, entityId)
   try {
     ctx.body = await db.get(id)

package/src/api/controllers/migrations.js

@@ -0,0 +1,13 @@
+const { migrate, MIGRATIONS } = require("../../migrations")
+
+exports.migrate = async ctx => {
+  const options = ctx.request.body
+  // don't await as can take a while, just return
+  migrate(options)
+  ctx.status = 200
+}
+
+exports.fetchDefinitions = async ctx => {
+  ctx.body = MIGRATIONS
+  ctx.status = 200
+}

package/src/api/controllers/permission.js

@@ -6,12 +6,12 @@ const {
   getBuiltinRoles,
 } = require("@budibase/backend-core/roles")
 const { getRoleParams } = require("../../db/utils")
-const CouchDB = require("../../db")
 const {
   CURRENTLY_SUPPORTED_LEVELS,
   getBasePermissions,
 } = require("../../utilities/security")
 const { removeFromArray } = require("../../utilities")
+const { getAppDB } = require("@budibase/backend-core/context")
 
 const PermissionUpdateType = {
   REMOVE: "remove",
@@ -35,7 +35,7 @@ async function updatePermissionOnRole(
   { roleId, resourceId, level },
   updateType
 ) {
-  const db = new CouchDB(appId)
+  const db = getAppDB()
   const remove = updateType === PermissionUpdateType.REMOVE
   const isABuiltin = isBuiltin(roleId)
   const dbRoleId = getDBRoleID(roleId)
@@ -106,7 +106,7 @@ exports.fetchLevels = function (ctx) {
 }
 
 exports.fetch = async function (ctx) {
-  const db = new CouchDB(ctx.appId)
+  const db = getAppDB()
   const roles = await getAllDBRoles(db)
   let permissions = {}
   // create an object with structure role ID -> resource ID -> level
@@ -133,7 +133,7 @@ exports.fetch = async function (ctx) {
 
 exports.getResourcePerms = async function (ctx) {
   const resourceId = ctx.params.resourceId
-  const db = new CouchDB(ctx.appId)
+  const db = getAppDB()
   const body = await db.allDocs(
     getRoleParams(null, {
       include_docs: true,

package/src/api/controllers/query/import/index.ts

@@ -1,10 +1,11 @@
-import CouchDB from "../../../../db"
 import { queryValidation } from "../validation"
 import { generateQueryID } from "../../../../db/utils"
 import { ImportInfo, ImportSource } from "./sources/base"
 import { OpenAPI2 } from "./sources/openapi2"
 import { Query } from "./../../../../definitions/common"
 import { Curl } from "./sources/curl"
+// @ts-ignore
+import { getAppDB } from "@budibase/backend-core/context"
 interface ImportResult {
   errorQueries: Query[]
   queries: Query[]
@@ -33,10 +34,7 @@ export class RestImporter {
     return this.source.getInfo()
   }
 
-  importQueries = async (
-    appId: string,
-    datasourceId: string
-  ): Promise<ImportResult> => {
+  importQueries = async (datasourceId: string): Promise<ImportResult> => {
     // constuct the queries
     let queries = await this.source.getQueries(datasourceId)
 
@@ -58,7 +56,7 @@ export class RestImporter {
       })
 
     // persist queries
-    const db = new CouchDB(appId)
+    const db = getAppDB()
     const response = await db.bulkDocs(queries)
 
     // create index to seperate queries and errors

package/src/api/controllers/query/import/tests/index.spec.js

@@ -6,6 +6,7 @@ const db = jest.fn(() => {
   }
 })
 jest.mock("../../../../../db", () => db)
+require("@budibase/backend-core").init(require("../../../../../db"))
 
 const { RestImporter } = require("../index")
 
@@ -77,7 +78,7 @@ describe("Rest Importer", () => {
   const testImportQueries = async (key, data, assertions) => {
     await init(data)
     bulkDocs.mockReturnValue([])
-    const importResult = await restImporter.importQueries("appId", "datasourceId")
+    const importResult = await restImporter.importQueries("datasourceId")
     expect(importResult.errorQueries.length).toBe(0)
     expect(importResult.queries.length).toBe(assertions[key].count)
     expect(bulkDocs).toHaveBeenCalledTimes(1)

package/src/api/controllers/query/index.js

@@ -1,4 +1,3 @@
-const CouchDB = require("../../../db")
 const {
   generateQueryID,
   getQueryParams,
@@ -10,6 +9,7 @@ const { save: saveDatasource } = require("../datasource")
 const { RestImporter } = require("./import")
 const { invalidateDynamicVariables } = require("../../../threads/utils")
 const environment = require("../../../environment")
+const { getAppDB } = require("@budibase/backend-core/context")
 
 const Runner = new Thread(ThreadType.QUERY, {
   timeoutMs: environment.QUERY_THREAD_TIMEOUT || 10000,
@@ -28,7 +28,7 @@ function enrichQueries(input) {
 }
 
 exports.fetch = async function (ctx) {
-  const db = new CouchDB(ctx.appId)
+  const db = getAppDB()
 
   const body = await db.allDocs(
     getQueryParams(null, {
@@ -69,7 +69,7 @@ exports.import = async ctx => {
     datasourceId = body.datasourceId
   }
 
-  const importResult = await importer.importQueries(ctx.appId, datasourceId)
+  const importResult = await importer.importQueries(datasourceId)
 
   ctx.body = {
     ...importResult,
@@ -79,7 +79,7 @@ exports.import = async ctx => {
 }
 
 exports.save = async function (ctx) {
-  const db = new CouchDB(ctx.appId)
+  const db = getAppDB()
   const query = ctx.request.body
 
   if (!query._id) {
@@ -94,7 +94,7 @@ exports.save = async function (ctx) {
 }
 
 exports.find = async function (ctx) {
-  const db = new CouchDB(ctx.appId)
+  const db = getAppDB()
   const query = enrichQueries(await db.get(ctx.params.queryId))
   // remove properties that could be dangerous in real app
   if (isProdAppID(ctx.appId)) {
@@ -105,7 +105,7 @@ exports.find = async function (ctx) {
 }
 
 exports.preview = async function (ctx) {
-  const db = new CouchDB(ctx.appId)
+  const db = getAppDB()
 
   const datasource = await db.get(ctx.request.body.datasourceId)
   // preview may not have a queryId as it hasn't been saved, but if it does
@@ -136,7 +136,7 @@ exports.preview = async function (ctx) {
 }
 
 async function execute(ctx, opts = { rowsOnly: false }) {
-  const db = new CouchDB(ctx.appId)
+  const db = getAppDB()
 
   const query = await db.get(ctx.params.queryId)
   const datasource = await db.get(query.datasourceId)
@@ -181,7 +181,8 @@ exports.executeV2 = async function (ctx) {
   return execute(ctx, { rowsOnly: false })
 }
 
-const removeDynamicVariables = async (db, queryId) => {
+const removeDynamicVariables = async queryId => {
+  const db = getAppDB()
   const query = await db.get(queryId)
   const datasource = await db.get(query.datasourceId)
   const dynamicVariables = datasource.config.dynamicVariables
@@ -202,8 +203,8 @@ const removeDynamicVariables = async (db, queryId) => {
 }
 
 exports.destroy = async function (ctx) {
-  const db = new CouchDB(ctx.appId)
-  await removeDynamicVariables(db, ctx.params.queryId)
+  const db = getAppDB()
+  await removeDynamicVariables(ctx.params.queryId)
   await db.remove(ctx.params.queryId, ctx.params.revId)
   ctx.message = `Query deleted.`
   ctx.status = 200

package/src/api/controllers/role.js

@@ -1,4 +1,3 @@
-const CouchDB = require("../../db")
 const {
   Role,
   getRole,
@@ -10,6 +9,7 @@ const {
   getUserMetadataParams,
   InternalTables,
 } = require("../../db/utils")
+const { getAppDB } = require("@budibase/backend-core/context")
 
 const UpdateRolesOptions = {
   CREATED: "created",
@@ -40,15 +40,15 @@ async function updateRolesOnUserTable(db, roleId, updateOption) {
 }
 
 exports.fetch = async function (ctx) {
-  ctx.body = await getAllRoles(ctx.appId)
+  ctx.body = await getAllRoles()
 }
 
 exports.find = async function (ctx) {
-  ctx.body = await getRole(ctx.appId, ctx.params.roleId)
+  ctx.body = await getRole(ctx.params.roleId)
 }
 
 exports.save = async function (ctx) {
-  const db = new CouchDB(ctx.appId)
+  const db = getAppDB()
   let { _id, name, inherits, permissionId } = ctx.request.body
   if (!_id) {
     _id = generateRoleID()
@@ -69,7 +69,7 @@ exports.save = async function (ctx) {
 }
 
 exports.destroy = async function (ctx) {
-  const db = new CouchDB(ctx.appId)
+  const db = getAppDB()
   const roleId = ctx.params.roleId
   if (isBuiltin(roleId)) {
     ctx.throw(400, "Cannot delete builtin role.")

package/src/api/controllers/routing.js

@@ -39,12 +39,11 @@ Routing.prototype.addScreenId = function (fullpath, roleId, screenId) {
 
 /**
  * Gets the full routing structure by querying the routing view and processing the result into the tree.
- * @param {string} appId The application to produce the routing structure for.
  * @returns {Promise<object>} The routing structure, this is the full structure designed for use in the builder,
  * if the client routing is required then the updateRoutingStructureForUserRole should be used.
  */
-async function getRoutingStructure(appId) {
-  const screenRoutes = await getRoutingInfo(appId)
+async function getRoutingStructure() {
+  const screenRoutes = await getRoutingInfo()
   const routing = new Routing()
 
   for (let screenRoute of screenRoutes) {
@@ -57,13 +56,13 @@ async function getRoutingStructure(appId) {
 }
 
 exports.fetch = async ctx => {
-  ctx.body = await getRoutingStructure(ctx.appId)
+  ctx.body = await getRoutingStructure()
 }
 
 exports.clientFetch = async ctx => {
-  const routing = await getRoutingStructure(ctx.appId)
+  const routing = await getRoutingStructure()
   let roleId = ctx.user.role._id
-  const roleIds = await getUserRoleHierarchy(ctx.appId, roleId)
+  const roleIds = await getUserRoleHierarchy(roleId)
   for (let topLevel of Object.values(routing.routes)) {
     for (let subpathKey of Object.keys(topLevel.subpaths)) {
       let found = false