@budibase/server 2.1.43-alpha.1 → 2.1.43

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

@@ -13,28 +13,28 @@ import {
 } from "../../../constants"
 import { getViews, saveView } from "../view/utils"
 import viewTemplate from "../view/viewBuilder"
+const { getAppDB } = require("@budibase/backend-core/context")
 import { cloneDeep } from "lodash/fp"
 import { quotas } from "@budibase/pro"
-import { events, context } from "@budibase/backend-core"
-import { Database } from "@budibase/types"
+import { events } from "@budibase/backend-core"
 
 export async function clearColumns(table: any, columnNames: any) {
-  const db: Database = context.getAppDB()
+  const db = getAppDB()
   const rows = await db.allDocs(
     getRowParams(table._id, null, {
       include_docs: true,
     })
   )
-  return (await db.bulkDocs(
+  return db.bulkDocs(
     rows.rows.map(({ doc }: any) => {
       columnNames.forEach((colName: any) => delete doc[colName])
       return doc
     })
-  )) as { id: string; _rev?: string }[]
+  )
 }
 
 export async function checkForColumnUpdates(oldTable: any, updatedTable: any) {
-  const db = context.getAppDB()
+  const db = getAppDB()
   let updatedRows = []
   const rename = updatedTable._rename
   let deletedColumns: any = []
@@ -95,7 +95,18 @@ export function makeSureTableUpToDate(table: any, tableToSave: any) {
   return tableToSave
 }
 
-export function importToRows(data: any, table: any, user: any = {}) {
+export async function handleDataImport(user: any, table: any, dataImport: any) {
+  if (!dataImport || !dataImport.csvString) {
+    return table
+  }
+
+  const db = getAppDB()
+  // Populate the table with rows imported from CSV in a bulk update
+  const data = await transform({
+    ...dataImport,
+    existingTable: table,
+  })
+
   let finalData: any = []
   for (let i = 0; i < data.length; i++) {
     let row = data[i]
@@ -125,22 +136,6 @@ export function importToRows(data: any, table: any, user: any = {}) {
 
     finalData.push(row)
   }
-  return finalData
-}
-
-export async function handleDataImport(user: any, table: any, dataImport: any) {
-  if (!dataImport || !dataImport.csvString) {
-    return table
-  }
-
-  const db = context.getAppDB()
-  // Populate the table with rows imported from CSV in a bulk update
-  const data = await transform({
-    ...dataImport,
-    existingTable: table,
-  })
-
-  let finalData: any = importToRows(data, table, user)
 
   await quotas.addRows(finalData.length, () => db.bulkDocs(finalData), {
     tableId: table._id,
@@ -150,7 +145,7 @@ export async function handleDataImport(user: any, table: any, dataImport: any) {
 }
 
 export async function handleSearchIndexes(table: any) {
-  const db = context.getAppDB()
+  const db = getAppDB()
   // create relevant search indexes
   if (table.indexes && table.indexes.length > 0) {
     const currentIndexes = await db.getIndexes()
@@ -214,7 +209,7 @@ class TableSaveFunctions {
   rows: any
 
   constructor({ user, oldTable, dataImport }: any) {
-    this.db = context.getAppDB()
+    this.db = getAppDB()
     this.user = user
     this.oldTable = oldTable
     this.dataImport = dataImport
@@ -338,7 +333,7 @@ export function generateJunctionTableName(
   return `jt_${table.name}_${relatedTable.name}_${column.name}_${column.fieldName}`
 }
 
-export function foreignKeyStructure(keyName: any, meta?: any) {
+export function foreignKeyStructure(keyName: any, meta = null) {
   const structure: any = {
     type: FieldTypes.NUMBER,
     constraints: {},

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

@@ -1,20 +1,17 @@
-import nodeFetch from "node-fetch"
-import { downloadTemplate as dlTemplate } from "../../utilities/fileSystem"
-import env from "../../environment"
-import { BBContext } from "@budibase/types"
+const fetch = require("node-fetch")
+const { downloadTemplate } = require("../../utilities/fileSystem")
+const env = require("../../environment")
 
 // development flag, can be used to test against templates exported locally
 const DEFAULT_TEMPLATES_BUCKET =
   "prod-budi-templates.s3-eu-west-1.amazonaws.com"
 
-export async function fetch(ctx: BBContext) {
+exports.fetch = async function (ctx) {
   let type = env.TEMPLATE_REPOSITORY
   let response,
     error = false
   try {
-    response = await nodeFetch(
-      `https://${DEFAULT_TEMPLATES_BUCKET}/manifest.json`
-    )
+    response = await fetch(`https://${DEFAULT_TEMPLATES_BUCKET}/manifest.json`)
     if (response.status !== 200) {
       error = true
     }
@@ -32,10 +29,10 @@ export async function fetch(ctx: BBContext) {
 
 // can't currently test this, have to ignore from coverage
 /* istanbul ignore next */
-export async function downloadTemplate(ctx: BBContext) {
+exports.downloadTemplate = async function (ctx) {
   const { type, name } = ctx.params
 
-  await dlTemplate(type, name)
+  await downloadTemplate(type, name)
 
   ctx.body = {
     message: `template ${type}:${name} downloaded successfully.`,

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

@@ -1,22 +1,23 @@
-import {
+const {
   generateUserMetadataID,
   getUserMetadataParams,
   generateUserFlagID,
-} from "../../db/utils"
-import { InternalTables } from "../../db/utils"
-import { getGlobalUsers, getRawGlobalUser } from "../../utilities/global"
-import { getFullUser } from "../../utilities/users"
-import { isEqual } from "lodash"
-import {
-  context,
-  constants,
-  roles as rolesCore,
-  db as dbCore,
-} from "@budibase/backend-core"
-import { BBContext, User } from "@budibase/types"
+} = require("../../db/utils")
+const { InternalTables } = require("../../db/utils")
+const { getGlobalUsers, getRawGlobalUser } = require("../../utilities/global")
+const { getFullUser } = require("../../utilities/users")
+const { isEqual } = require("lodash")
+const { BUILTIN_ROLE_IDS } = require("@budibase/backend-core/roles")
+const {
+  getDevelopmentAppID,
+  getProdAppIDs,
+  dbExists,
+} = require("@budibase/backend-core/db")
+const { UserStatus } = require("@budibase/backend-core/constants")
+const { getAppDB, doInAppContext } = require("@budibase/backend-core/context")
 
 async function rawMetadata() {
-  const db = context.getAppDB()
+  const db = getAppDB()
   return (
     await db.allDocs(
       getUserMetadataParams(null, {
@@ -26,9 +27,9 @@ async function rawMetadata() {
   ).rows.map(row => row.doc)
 }
 
-function combineMetadataAndUser(user: any, metadata: any) {
+function combineMetadataAndUser(user, metadata) {
   // skip users with no access
-  if (user.roleId === rolesCore.BUILTIN_ROLE_IDS.PUBLIC) {
+  if (user.roleId === BUILTIN_ROLE_IDS.PUBLIC) {
     return null
   }
   delete user._rev
@@ -54,9 +55,9 @@ function combineMetadataAndUser(user: any, metadata: any) {
   return null
 }
 
-export async function syncGlobalUsers() {
+exports.syncGlobalUsers = async () => {
   // sync user metadata
-  const db = context.getAppDB()
+  const db = getAppDB()
   const [users, metadata] = await Promise.all([getGlobalUsers(), rawMetadata()])
   const toWrite = []
   for (let user of users) {
@@ -68,13 +69,13 @@ export async function syncGlobalUsers() {
   await db.bulkDocs(toWrite)
 }
 
-export async function syncUser(ctx: BBContext) {
+exports.syncUser = async function (ctx) {
   let deleting = false,
-    user: User | any
+    user
   const userId = ctx.params.id
   try {
     user = await getRawGlobalUser(userId)
-  } catch (err: any) {
+  } catch (err) {
     if (err && err.status === 404) {
       user = {}
       deleting = true
@@ -91,21 +92,21 @@ export async function syncUser(ctx: BBContext) {
   let prodAppIds
   // if they are a builder then get all production app IDs
   if ((user.builder && user.builder.global) || deleting) {
-    prodAppIds = await dbCore.getProdAppIDs()
+    prodAppIds = await getProdAppIDs()
   } else {
     prodAppIds = Object.entries(roles)
-      .filter(entry => entry[1] !== rolesCore.BUILTIN_ROLE_IDS.PUBLIC)
+      .filter(entry => entry[1] !== BUILTIN_ROLE_IDS.PUBLIC)
       .map(([appId]) => appId)
   }
   for (let prodAppId of prodAppIds) {
     const roleId = roles[prodAppId]
-    const devAppId = dbCore.getDevelopmentAppID(prodAppId)
+    const devAppId = getDevelopmentAppID(prodAppId)
     for (let appId of [prodAppId, devAppId]) {
-      if (!(await dbCore.dbExists(appId))) {
+      if (!(await dbExists(appId))) {
         continue
       }
-      await context.doInAppContext(appId, async () => {
-        const db = context.getAppDB()
+      await doInAppContext(appId, async () => {
+        const db = getAppDB()
         const metadataId = generateUserMetadataID(userId)
         let metadata
         try {
@@ -126,8 +127,8 @@ export async function syncUser(ctx: BBContext) {
           ? combineMetadataAndUser(user, metadata)
           : {
               ...metadata,
-              status: constants.UserStatus.INACTIVE,
-              metadata: rolesCore.BUILTIN_ROLE_IDS.PUBLIC,
+              status: UserStatus.INACTIVE,
+              metadata: BUILTIN_ROLE_IDS.PUBLIC,
             }
         // if its null then there was no updates required
         if (combined) {
@@ -141,9 +142,10 @@ export async function syncUser(ctx: BBContext) {
   }
 }
 
-export async function fetchMetadata(ctx: BBContext) {
+exports.fetchMetadata = async function (ctx) {
+  const database = getAppDB()
   const global = await getGlobalUsers()
-  const metadata = await rawMetadata()
+  const metadata = await rawMetadata(database)
   const users = []
   for (let user of global) {
     // find the metadata that matches up to the global ID
@@ -160,18 +162,18 @@ export async function fetchMetadata(ctx: BBContext) {
   ctx.body = users
 }
 
-export async function updateSelfMetadata(ctx: BBContext) {
+exports.updateSelfMetadata = async function (ctx) {
   // overwrite the ID with current users
-  ctx.request.body._id = ctx.user?._id
+  ctx.request.body._id = ctx.user._id
   // make sure no stale rev
   delete ctx.request.body._rev
   // make sure no csrf token
   delete ctx.request.body.csrfToken
-  await updateMetadata(ctx)
+  await exports.updateMetadata(ctx)
 }
 
-export async function updateMetadata(ctx: BBContext) {
-  const db = context.getAppDB()
+exports.updateMetadata = async function (ctx) {
+  const db = getAppDB()
   const user = ctx.request.body
   // this isn't applicable to the user
   delete user.roles
@@ -182,8 +184,8 @@ export async function updateMetadata(ctx: BBContext) {
   ctx.body = await db.put(metadata)
 }
 
-export async function destroyMetadata(ctx: BBContext) {
-  const db = context.getAppDB()
+exports.destroyMetadata = async function (ctx) {
+  const db = getAppDB()
   try {
     const dbUser = await db.get(ctx.params.id)
     await db.remove(dbUser._id, dbUser._rev)
@@ -195,18 +197,18 @@ export async function destroyMetadata(ctx: BBContext) {
   }
 }
 
-export async function findMetadata(ctx: BBContext) {
+exports.findMetadata = async function (ctx) {
   ctx.body = await getFullUser(ctx, ctx.params.id)
 }
 
-export async function setFlag(ctx: BBContext) {
-  const userId = ctx.user?._id
+exports.setFlag = async function (ctx) {
+  const userId = ctx.user._id
   const { flag, value } = ctx.request.body
   if (!flag) {
     ctx.throw(400, "Must supply a 'flag' field in request body.")
   }
-  const flagDocId = generateUserFlagID(userId!)
-  const db = context.getAppDB()
+  const flagDocId = generateUserFlagID(userId)
+  const db = getAppDB()
   let doc
   try {
     doc = await db.get(flagDocId)
@@ -218,10 +220,10 @@ export async function setFlag(ctx: BBContext) {
   ctx.body = { message: "Flag set successfully" }
 }
 
-export async function getFlags(ctx: BBContext) {
-  const userId = ctx.user?._id
-  const docId = generateUserFlagID(userId!)
-  const db = context.getAppDB()
+exports.getFlags = async function (ctx) {
+  const userId = ctx.user._id
+  const docId = generateUserFlagID(userId)
+  const db = getAppDB()
   let doc
   try {
     doc = await db.get(docId)

package/src/api/controllers/view/{exporters.ts → exporters.js}

@@ -1,6 +1,4 @@
-import { Row } from "@budibase/types"
-
-export function csv(headers: string[], rows: Row[]) {
+exports.csv = function (headers, rows) {
   let csv = headers.map(key => `"${key}"`).join(",")
 
   for (let row of rows) {
@@ -18,11 +16,11 @@ export function csv(headers: string[], rows: Row[]) {
   return csv
 }
 
-export function json(headers: string[], rows: Row[]) {
+exports.json = function (headers, rows) {
   return JSON.stringify(rows, undefined, 2)
 }
 
-export const ExportFormats = {
+exports.ExportFormats = {
   CSV: "csv",
   JSON: "json",
 }

package/src/api/controllers/view/{index.ts → index.js}

@@ -1,29 +1,21 @@
-import viewTemplate from "./viewBuilder"
-import { apiFileReturn } from "../../../utilities/fileSystem"
-import * as exporters from "./exporters"
-import { deleteView, getView, getViews, saveView } from "./utils"
-import { fetchView } from "../row"
-import { FieldTypes } from "../../../constants"
-import { context, events } from "@budibase/backend-core"
-import { DocumentType } from "../../../db/utils"
-import sdk from "../../../sdk"
-import {
-  BBContext,
-  Row,
-  Table,
-  TableExportFormat,
-  TableSchema,
-  View,
-} from "@budibase/types"
-
+const viewTemplate = require("./viewBuilder")
+const { apiFileReturn } = require("../../../utilities/fileSystem")
+const exporters = require("./exporters")
+const { saveView, getView, getViews, deleteView } = require("./utils")
+const { fetchView } = require("../row")
+const { FieldTypes } = require("../../../constants")
+const { getAppDB } = require("@budibase/backend-core/context")
+const { events } = require("@budibase/backend-core")
+const { DocumentType } = require("../../../db/utils")
 const { cloneDeep, isEqual } = require("lodash")
+const sdk = require("../../../sdk")
 
-export async function fetch(ctx: BBContext) {
+exports.fetch = async ctx => {
   ctx.body = await getViews()
 }
 
-export async function save(ctx: BBContext) {
-  const db = context.getAppDB()
+exports.save = async ctx => {
+  const db = getAppDB()
   const { originalName, ...viewToSave } = ctx.request.body
   const view = viewTemplate(viewToSave)
   const viewName = viewToSave.name
@@ -55,7 +47,7 @@ export async function save(ctx: BBContext) {
   }
 }
 
-export async function calculationEvents(existingView: View, newView: View) {
+const calculationEvents = async (existingView, newView) => {
   const existingCalculation = existingView && existingView.calculation
   const newCalculation = newView && newView.calculation
 
@@ -76,7 +68,7 @@ export async function calculationEvents(existingView: View, newView: View) {
   }
 }
 
-export async function filterEvents(existingView: View, newView: View) {
+const filterEvents = async (existingView, newView) => {
   const hasExistingFilters = !!(
     existingView &&
     existingView.filters &&
@@ -101,7 +93,7 @@ export async function filterEvents(existingView: View, newView: View) {
   }
 }
 
-async function handleViewEvents(existingView: View, newView: View) {
+const handleViewEvents = async (existingView, newView) => {
   if (!existingView) {
     await events.view.created(newView)
   } else {
@@ -111,8 +103,8 @@ async function handleViewEvents(existingView: View, newView: View) {
   await filterEvents(existingView, newView)
 }
 
-export async function destroy(ctx: BBContext) {
-  const db = context.getAppDB()
+exports.destroy = async ctx => {
+  const db = getAppDB()
   const viewName = decodeURI(ctx.params.viewName)
   const view = await deleteView(viewName)
   const table = await db.get(view.meta.tableId)
@@ -123,11 +115,11 @@ export async function destroy(ctx: BBContext) {
   ctx.body = view
 }
 
-export async function exportView(ctx: BBContext) {
-  const viewName = decodeURI(ctx.query.view as string)
+exports.exportView = async ctx => {
+  const viewName = decodeURI(ctx.query.view)
   const view = await getView(viewName)
 
-  const format = ctx.query.format as string
+  const format = ctx.query.format
   if (!format || !Object.values(exporters.ExportFormats).includes(format)) {
     ctx.throw(400, "Format must be specified, either csv or json")
   }
@@ -138,7 +130,6 @@ export async function exportView(ctx: BBContext) {
     ctx.query = {
       group: view.meta.groupBy,
       calculation: view.meta.calculation,
-      // @ts-ignore
       stats: !!view.meta.field,
       field: view.meta.field,
     }
@@ -149,11 +140,11 @@ export async function exportView(ctx: BBContext) {
   }
 
   await fetchView(ctx)
-  let rows = ctx.body as Row[]
+  let rows = ctx.body
 
-  let schema: TableSchema = view && view.meta && view.meta.schema
+  let schema = view && view.meta && view.meta.schema
   const tableId = ctx.params.tableId || view.meta.tableId
-  const table: Table = await sdk.tables.getTable(tableId)
+  const table = await sdk.tables.getTable(tableId)
   if (!schema) {
     schema = table.schema
   }
@@ -184,15 +175,15 @@ export async function exportView(ctx: BBContext) {
 
   // Export part
   let headers = Object.keys(schema)
-  const exporter = format === "csv" ? exporters.csv : exporters.json
+  const exporter = exporters[format]
   const filename = `${viewName}.${format}`
   // send down the file
   ctx.attachment(filename)
   ctx.body = apiFileReturn(exporter(headers, rows))
 
   if (viewName.startsWith(DocumentType.TABLE)) {
-    await events.table.exported(table, format as TableExportFormat)
+    await events.table.exported(table, format)
   } else {
-    await events.view.exported(table, format as TableExportFormat)
+    await events.view.exported(table, format)
   }
 }

package/src/api/controllers/view/{utils.ts → utils.js}

@@ -1,17 +1,16 @@
-import {
+const {
   ViewName,
   generateMemoryViewID,
   getMemoryViewParams,
   DocumentType,
   SEPARATOR,
-} from "../../../db/utils"
-import env from "../../../environment"
-import { context } from "@budibase/backend-core"
-import viewBuilder from "./viewBuilder"
-import { Database } from "@budibase/types"
+} = require("../../../db/utils")
+const env = require("../../../environment")
+const { getAppDB } = require("@budibase/backend-core/context")
+const viewBuilder = require("./viewBuilder")
 
-export async function getView(viewName: string) {
-  const db = context.getAppDB()
+exports.getView = async viewName => {
+  const db = getAppDB()
   if (env.SELF_HOSTED) {
     const designDoc = await db.get("_design/database")
     return designDoc.views[viewName]
@@ -24,7 +23,7 @@ export async function getView(viewName: string) {
     try {
       const viewDoc = await db.get(generateMemoryViewID(viewName))
       return viewDoc.view
-    } catch (err: any) {
+    } catch (err) {
       // Return null when PouchDB doesn't found the view
       if (err.status === 404) {
         return null
@@ -35,15 +34,14 @@ export async function getView(viewName: string) {
   }
 }
 
-export async function getViews() {
-  const db = context.getAppDB()
+exports.getViews = async () => {
+  const db = getAppDB()
   const response = []
   if (env.SELF_HOSTED) {
     const designDoc = await db.get("_design/database")
     for (let name of Object.keys(designDoc.views)) {
       // Only return custom views, not built ins
-      const viewNames = Object.values(ViewName) as string[]
-      if (viewNames.indexOf(name) !== -1) {
+      if (Object.values(ViewName).indexOf(name) !== -1) {
         continue
       }
       response.push({
@@ -69,12 +67,8 @@ export async function getViews() {
   return response
 }
 
-export async function saveView(
-  originalName: string | null,
-  viewName: string,
-  viewTemplate: any
-) {
-  const db = context.getAppDB()
+exports.saveView = async (originalName, viewName, viewTemplate) => {
+  const db = getAppDB()
   if (env.SELF_HOSTED) {
     const designDoc = await db.get("_design/database")
     designDoc.views = {
@@ -89,7 +83,7 @@ export async function saveView(
   } else {
     const id = generateMemoryViewID(viewName)
     const originalId = originalName ? generateMemoryViewID(originalName) : null
-    const viewDoc: any = {
+    const viewDoc = {
       _id: id,
       view: viewTemplate,
       name: viewName,
@@ -111,8 +105,8 @@ export async function saveView(
   }
 }
 
-export async function deleteView(viewName: string) {
-  const db = context.getAppDB()
+exports.deleteView = async viewName => {
+  const db = getAppDB()
   if (env.SELF_HOSTED) {
     const designDoc = await db.get("_design/database")
     const view = designDoc.views[viewName]
@@ -127,7 +121,7 @@ export async function deleteView(viewName: string) {
   }
 }
 
-export async function migrateToInMemoryView(db: Database, viewName: string) {
+exports.migrateToInMemoryView = async (db, viewName) => {
   // delete the view initially
   const designDoc = await db.get("_design/database")
   // run the view back through the view builder to update it
@@ -137,7 +131,7 @@ export async function migrateToInMemoryView(db: Database, viewName: string) {
   await exports.saveView(db, null, viewName, view)
 }
 
-export async function migrateToDesignView(db: Database, viewName: string) {
+exports.migrateToDesignView = async (db, viewName) => {
   let view = await db.get(generateMemoryViewID(viewName))
   const designDoc = await db.get("_design/database")
   designDoc.views[viewName] = viewBuilder(view.view.meta)
@@ -145,7 +139,7 @@ export async function migrateToDesignView(db: Database, viewName: string) {
   await db.remove(view._id, view._rev)
 }
 
-export async function getFromDesignDoc(db: Database, viewName: string) {
+exports.getFromDesignDoc = async (db, viewName) => {
   const designDoc = await db.get("_design/database")
   let view = designDoc.views[viewName]
   if (view == null) {
@@ -154,7 +148,7 @@ export async function getFromDesignDoc(db: Database, viewName: string) {
   return view
 }
 
-export async function getFromMemoryDoc(db: Database, viewName: string) {
+exports.getFromMemoryDoc = async (db, viewName) => {
   let view = await db.get(generateMemoryViewID(viewName))
   if (view) {
     view = view.view