@budibase/server 2.1.32-alpha.8 → 2.1.33

package/src/utilities/rowProcessor/{index.ts → index.js}

@@ -1,41 +1,129 @@
-import linkRows from "../../db/linkedRows"
-import { FieldTypes, AutoFieldSubTypes } from "../../constants"
-import { attachmentsRelativeURL } from "../index"
-import { processFormulas, fixAutoColumnSubType } from "./utils"
-import { ObjectStoreBuckets } from "../../constants"
-import { context, db as dbCore, objectStore } from "@budibase/backend-core"
-import { InternalTables } from "../../db/utils"
-import { TYPE_TRANSFORM_MAP } from "./map"
-import { Row, User, Table } from "@budibase/types"
+const linkRows = require("../../db/linkedRows")
 const { cloneDeep } = require("lodash/fp")
-export * from "./utils"
-
-type AutoColumnProcessingOpts = {
-  reprocessing?: boolean
-  noAutoRelationships?: boolean
-}
+const { FieldTypes, AutoFieldSubTypes } = require("../../constants")
+const { attachmentsRelativeURL } = require("../index")
+const { processFormulas, fixAutoColumnSubType } = require("./utils")
+const { deleteFiles } = require("../../utilities/fileSystem/utilities")
+const { ObjectStoreBuckets } = require("../../constants")
+const {
+  isProdAppID,
+  getProdAppID,
+  dbExists,
+} = require("@budibase/backend-core/db")
+const { getAppId } = require("@budibase/backend-core/context")
+const { InternalTables } = require("../../db/utils")
 
 const BASE_AUTO_ID = 1
 
+/**
+ * A map of how we convert various properties in rows to each other based on the row type.
+ */
+const TYPE_TRANSFORM_MAP = {
+  [FieldTypes.LINK]: {
+    "": [],
+    [null]: [],
+    [undefined]: undefined,
+    parse: link => {
+      if (Array.isArray(link) && typeof link[0] === "object") {
+        return link.map(el => (el && el._id ? el._id : el))
+      }
+      if (typeof link === "string") {
+        return [link]
+      }
+      return link
+    },
+  },
+  [FieldTypes.OPTIONS]: {
+    "": null,
+    [null]: null,
+    [undefined]: undefined,
+  },
+  [FieldTypes.ARRAY]: {
+    "": [],
+    [null]: [],
+    [undefined]: undefined,
+  },
+  [FieldTypes.STRING]: {
+    "": "",
+    [null]: "",
+    [undefined]: undefined,
+  },
+  [FieldTypes.BARCODEQR]: {
+    "": "",
+    [null]: "",
+    [undefined]: undefined,
+  },
+  [FieldTypes.FORMULA]: {
+    "": "",
+    [null]: "",
+    [undefined]: undefined,
+  },
+  [FieldTypes.LONGFORM]: {
+    "": "",
+    [null]: "",
+    [undefined]: undefined,
+  },
+  [FieldTypes.NUMBER]: {
+    "": null,
+    [null]: null,
+    [undefined]: undefined,
+    parse: n => parseFloat(n),
+  },
+  [FieldTypes.DATETIME]: {
+    "": null,
+    [undefined]: undefined,
+    [null]: null,
+    parse: date => {
+      if (date instanceof Date) {
+        return date.toISOString()
+      }
+      return date
+    },
+  },
+  [FieldTypes.ATTACHMENT]: {
+    "": [],
+    [null]: [],
+    [undefined]: undefined,
+  },
+  [FieldTypes.BOOLEAN]: {
+    "": null,
+    [null]: null,
+    [undefined]: undefined,
+    true: true,
+    false: false,
+  },
+  [FieldTypes.AUTO]: {
+    parse: () => undefined,
+  },
+  [FieldTypes.JSON]: {
+    parse: input => {
+      try {
+        if (input === "") {
+          return undefined
+        }
+        return JSON.parse(input)
+      } catch (err) {
+        return input
+      }
+    },
+  },
+}
+
 /**
  * Given the old state of the row and the new one after an update, this will
  * find the keys that have been removed in the updated row.
  */
-function getRemovedAttachmentKeys(
-  oldRow: Row,
-  row: Row,
-  attachmentKey: string
-) {
+function getRemovedAttachmentKeys(oldRow, row, attachmentKey) {
   if (!oldRow[attachmentKey]) {
     return []
   }
-  const oldKeys = oldRow[attachmentKey].map((attachment: any) => attachment.key)
+  const oldKeys = oldRow[attachmentKey].map(attachment => attachment.key)
   // no attachments in new row, all removed
   if (!row[attachmentKey]) {
     return oldKeys
   }
-  const newKeys = row[attachmentKey].map((attachment: any) => attachment.key)
-  return oldKeys.filter((key: any) => newKeys.indexOf(key) === -1)
+  const newKeys = row[attachmentKey].map(attachment => attachment.key)
+  return oldKeys.filter(key => newKeys.indexOf(key) === -1)
 }
 
 /**
@@ -48,11 +136,11 @@ function getRemovedAttachmentKeys(
  * @returns {{row: Object, table: Object}} The updated row and table, the table may need to be updated
  * for automatic ID purposes.
  */
-export function processAutoColumn(
-  user: User | null,
-  table: Table,
-  row: Row,
-  opts?: AutoColumnProcessingOpts
+function processAutoColumn(
+  user,
+  table,
+  row,
+  opts = { reprocessing: false, noAutoRelationships: false }
 ) {
   let noUser = !user || !user.userId
   let isUserTable = table._id === InternalTables.USER_METADATA
@@ -61,7 +149,7 @@ export function processAutoColumn(
   const creating = !row._rev
   // check its not user table, or whether any of the processing options have been disabled
   const shouldUpdateUserFields =
-    !isUserTable && !opts?.reprocessing && !opts?.noAutoRelationships && !noUser
+    !isUserTable && !opts.reprocessing && !opts.noAutoRelationships && !noUser
   for (let [key, schema] of Object.entries(table.schema)) {
     if (!schema.autocolumn) {
       continue
@@ -71,7 +159,7 @@ export function processAutoColumn(
     }
     switch (schema.subtype) {
       case AutoFieldSubTypes.CREATED_BY:
-        if (creating && shouldUpdateUserFields && user) {
+        if (creating && shouldUpdateUserFields) {
           row[key] = [user.userId]
         }
         break
@@ -81,7 +169,7 @@ export function processAutoColumn(
         }
         break
       case AutoFieldSubTypes.UPDATED_BY:
-        if (shouldUpdateUserFields && user) {
+        if (shouldUpdateUserFields) {
           row[key] = [user.userId]
         }
         break
@@ -98,6 +186,9 @@ export function processAutoColumn(
   }
   return { table, row }
 }
+exports.processAutoColumn = processAutoColumn
+exports.fixAutoColumnSubType = fixAutoColumnSubType
+exports.processFormulas = processFormulas
 
 /**
  * This will coerce a value to the correct types based on the type transform map
@@ -105,17 +196,15 @@ export function processAutoColumn(
  * @param {object} type The type fo coerce to
  * @returns {object} The coerced value
  */
-export function coerce(row: any, type: any) {
+exports.coerce = (row, type) => {
   // no coercion specified for type, skip it
   if (!TYPE_TRANSFORM_MAP[type]) {
     return row
   }
   // eslint-disable-next-line no-prototype-builtins
   if (TYPE_TRANSFORM_MAP[type].hasOwnProperty(row)) {
-    // @ts-ignore
     return TYPE_TRANSFORM_MAP[type][row]
   } else if (TYPE_TRANSFORM_MAP[type].parse) {
-    // @ts-ignore
     return TYPE_TRANSFORM_MAP[type].parse(row)
   }
 
@@ -131,12 +220,12 @@ export function coerce(row: any, type: any) {
  * @param {object} opts some input processing options (like disabling auto-column relationships).
  * @returns {object} the row which has been prepared to be written to the DB.
  */
-export function inputProcessing(
-  user: User,
-  table: Table,
-  row: Row,
-  opts: AutoColumnProcessingOpts
-) {
+exports.inputProcessing = (
+  user = {},
+  table,
+  row,
+  opts = { noAutoRelationships: false }
+) => {
   let clonedRow = cloneDeep(row)
   // need to copy the table so it can be differenced on way out
   const copiedTable = cloneDeep(table)
@@ -156,7 +245,7 @@ export function inputProcessing(
     }
     // otherwise coerce what is there to correct types
     else {
-      clonedRow[key] = coerce(value, field.type)
+      clonedRow[key] = exports.coerce(value, field.type)
     }
   }
 
@@ -178,11 +267,7 @@ export function inputProcessing(
  * @param {object} opts used to set some options for the output, such as disabling relationship squashing.
  * @returns {object[]|object} the enriched rows will be returned.
  */
-export async function outputProcessing(
-  table: Table,
-  rows: Row[] | Row,
-  opts = { squash: true }
-) {
+exports.outputProcessing = async (table, rows, opts = { squash: true }) => {
   let wasArray = true
   if (!(rows instanceof Array)) {
     rows = [rows]
@@ -201,7 +286,7 @@ export async function outputProcessing(
         if (row[property] == null || !Array.isArray(row[property])) {
           continue
         }
-        row[property].forEach((attachment: any) => {
+        row[property].forEach(attachment => {
           attachment.url = attachmentsRelativeURL(attachment.key)
         })
       }
@@ -223,28 +308,20 @@ export async function outputProcessing(
  * deleted attachment columns.
  * @return {Promise<void>} When all attachments have been removed this will return.
  */
-export async function cleanupAttachments(
-  table: Table,
-  {
-    row,
-    rows,
-    oldRow,
-    oldTable,
-  }: { row?: Row; rows?: Row[]; oldRow?: Row; oldTable?: Table }
-): Promise<any> {
-  const appId = context.getAppId()
-  if (!dbCore.isProdAppID(appId)) {
-    const prodAppId = dbCore.getProdAppID(appId!)
+exports.cleanupAttachments = async (table, { row, rows, oldRow, oldTable }) => {
+  const appId = getAppId()
+  if (!isProdAppID(appId)) {
+    const prodAppId = getProdAppID(appId)
     // if prod exists, then don't allow deleting
-    const exists = await dbCore.dbExists(prodAppId)
+    const exists = await dbExists(prodAppId)
     if (exists) {
       return
     }
   }
-  let files: string[] = []
-  function addFiles(row: Row, key: string) {
+  let files = []
+  function addFiles(row, key) {
     if (row[key]) {
-      files = files.concat(row[key].map((attachment: any) => attachment.key))
+      files = files.concat(row[key].map(attachment => attachment.key))
     }
   }
   const schemaToUse = oldTable ? oldTable.schema : table.schema
@@ -253,7 +330,7 @@ export async function cleanupAttachments(
       continue
     }
     // old table had this column, new table doesn't - delete it
-    if (rows && oldTable && !table.schema[key]) {
+    if (oldTable && !table.schema[key]) {
       rows.forEach(row => addFiles(row, key))
     } else if (oldRow && row) {
       // if updating, need to manage the differences
@@ -265,6 +342,6 @@ export async function cleanupAttachments(
     }
   }
   if (files.length > 0) {
-    return objectStore.deleteFiles(ObjectStoreBuckets.APPS, files)
+    return deleteFiles(ObjectStoreBuckets.APPS, files)
   }
 }

package/src/utilities/rowProcessor/{utils.ts → utils.js}

@@ -1,17 +1,16 @@
-import {
+const {
   FieldTypes,
   FormulaTypes,
   AutoFieldDefaultNames,
   AutoFieldSubTypes,
-} from "../../constants"
-import { processStringSync } from "@budibase/string-templates"
-import { FieldSchema, Table, Row } from "@budibase/types"
+} = require("../../constants")
+const { processStringSync } = require("@budibase/string-templates")
 
 /**
  * If the subtype has been lost for any reason this works out what
  * subtype the auto column should be.
  */
-export function fixAutoColumnSubType(column: FieldSchema) {
+exports.fixAutoColumnSubType = column => {
   if (!column.autocolumn || !column.name || column.subtype) {
     return column
   }
@@ -33,18 +32,15 @@ export function fixAutoColumnSubType(column: FieldSchema) {
 /**
  * Looks through the rows provided and finds formulas - which it then processes.
  */
-export function processFormulas(
-  table: Table,
-  rows: Row[] | Row,
-  { dynamic, contextRows }: any = { dynamic: true }
-) {
+exports.processFormulas = (
+  table,
+  rows,
+  { dynamic, contextRows } = { dynamic: true }
+) => {
   const single = !Array.isArray(rows)
-  let rowArray: Row[]
   if (single) {
-    rowArray = [rows]
+    rows = [rows]
     contextRows = contextRows ? [contextRows] : contextRows
-  } else {
-    rowArray = rows
   }
   for (let [column, schema] of Object.entries(table.schema)) {
     const isStatic = schema.formulaType === FormulaTypes.STATIC
@@ -56,25 +52,25 @@ export function processFormulas(
       continue
     }
     // iterate through rows and process formula
-    for (let i = 0; i < rowArray.length; i++) {
+    for (let i = 0; i < rows.length; i++) {
       if (schema.formula) {
-        let row = rowArray[i]
+        let row = rows[i]
         let context = contextRows ? contextRows[i] : row
-        rowArray[i] = {
+        rows[i] = {
           ...row,
           [column]: processStringSync(schema.formula, context),
         }
       }
     }
   }
-  return single ? rowArray[0] : rowArray
+  return single ? rows[0] : rows
 }
 
 /**
  * Processes any date columns and ensures that those without the ignoreTimezones
  * flag set are parsed as UTC rather than local time.
  */
-export function processDates(table: Table, rows: Row[]) {
+exports.processDates = (table, rows) => {
   let datesWithTZ = []
   for (let [column, schema] of Object.entries(table.schema)) {
     if (schema.type !== FieldTypes.DATETIME) {

package/src/utilities/security.js

@@ -0,0 +1,71 @@
+const {
+  PermissionLevels,
+  PermissionTypes,
+  getBuiltinPermissionByID,
+  isPermissionLevelHigherThanRead,
+} = require("@budibase/backend-core/permissions")
+const {
+  lowerBuiltinRoleID,
+  getBuiltinRoles,
+} = require("@budibase/backend-core/roles")
+const { DocumentType } = require("../db/utils")
+
+const CURRENTLY_SUPPORTED_LEVELS = [
+  PermissionLevels.WRITE,
+  PermissionLevels.READ,
+  PermissionLevels.EXECUTE,
+]
+
+exports.getPermissionType = resourceId => {
+  const docType = Object.values(DocumentType).filter(docType =>
+    resourceId.startsWith(docType)
+  )[0]
+  switch (docType) {
+    case DocumentType.TABLE:
+    case DocumentType.ROW:
+      return PermissionTypes.TABLE
+    case DocumentType.AUTOMATION:
+      return PermissionTypes.AUTOMATION
+    case DocumentType.WEBHOOK:
+      return PermissionTypes.WEBHOOK
+    case DocumentType.QUERY:
+    case DocumentType.DATASOURCE:
+      return PermissionTypes.QUERY
+    default:
+      // views don't have an ID, will end up here
+      return PermissionTypes.VIEW
+  }
+}
+
+/**
+ *  works out the basic permissions based on builtin roles for a resource, using its ID
+ * @param resourceId
+ * @returns {{}}
+ */
+exports.getBasePermissions = resourceId => {
+  const type = exports.getPermissionType(resourceId)
+  const permissions = {}
+  for (let [roleId, role] of Object.entries(getBuiltinRoles())) {
+    if (!role.permissionId) {
+      continue
+    }
+    const perms = getBuiltinPermissionByID(role.permissionId)
+    const typedPermission = perms.permissions.find(perm => perm.type === type)
+    if (
+      typedPermission &&
+      CURRENTLY_SUPPORTED_LEVELS.indexOf(typedPermission.level) !== -1
+    ) {
+      const level = typedPermission.level
+      permissions[level] = lowerBuiltinRoleID(permissions[level], roleId)
+      if (isPermissionLevelHigherThanRead(level)) {
+        permissions[PermissionLevels.READ] = lowerBuiltinRoleID(
+          permissions[PermissionLevels.READ],
+          roleId
+        )
+      }
+    }
+  }
+  return permissions
+}
+
+exports.CURRENTLY_SUPPORTED_LEVELS = CURRENTLY_SUPPORTED_LEVELS

package/src/utilities/usageQuota/{rows.ts → rows.js}

@@ -1,19 +1,23 @@
-import { getRowParams, USER_METDATA_PREFIX } from "../../db/utils"
-import { db as dbCore } from "@budibase/backend-core"
-import { Database, Row } from "@budibase/types"
+const { getRowParams, USER_METDATA_PREFIX } = require("../../db/utils")
+const {
+  isDevAppID,
+  getDevelopmentAppID,
+  getProdAppID,
+  doWithDB,
+} = require("@budibase/backend-core/db")
 
 const ROW_EXCLUSIONS = [USER_METDATA_PREFIX]
 
-function getAppPairs(appIds: string[]) {
+const getAppPairs = appIds => {
   // collect the app ids into dev / prod pairs
   // keyed by the dev app id
-  const pairs: { [key: string]: { devId?: string; prodId?: string } } = {}
+  const pairs = {}
   for (let appId of appIds) {
-    const devId = dbCore.getDevelopmentAppID(appId)
+    const devId = getDevelopmentAppID(appId)
     if (!pairs[devId]) {
       pairs[devId] = {}
     }
-    if (dbCore.isDevAppID(appId)) {
+    if (isDevAppID(appId)) {
       pairs[devId].devId = appId
     } else {
       pairs[devId].prodId = appId
@@ -22,9 +26,9 @@ function getAppPairs(appIds: string[]) {
   return pairs
 }
 
-async function getAppRows(appId: string) {
+const getAppRows = async appId => {
   // need to specify the app ID, as this is used for different apps in one call
-  return dbCore.doWithDB(appId, async (db: Database) => {
+  return doWithDB(appId, async db => {
     const response = await db.allDocs(
       getRowParams(null, null, {
         include_docs: false,
@@ -48,13 +52,13 @@ async function getAppRows(appId: string) {
  * The returned rows will be unique on a per dev/prod app basis.
  * Rows duplicates may exist across apps due to data import so they are not filtered out.
  */
-export async function getUniqueRows(appIds: string[]) {
-  let uniqueRows: Row[] = [],
-    rowsByApp: { [key: string]: Row[] } = {}
+exports.getUniqueRows = async appIds => {
+  let uniqueRows = [],
+    rowsByApp = {}
   const pairs = getAppPairs(appIds)
 
   for (let pair of Object.values(pairs)) {
-    let appRows: Row[] = []
+    let appRows = []
     for (let appId of [pair.devId, pair.prodId]) {
       if (!appId) {
         continue
@@ -71,7 +75,7 @@ export async function getUniqueRows(appIds: string[]) {
     // this can't be done on all rows because app import results in
     // duplicate row ids across apps
     // the array pre-concat is important to avoid stack overflow
-    const prodId = dbCore.getProdAppID((pair.devId || pair.prodId)!)
+    const prodId = getProdAppID(pair.devId || pair.prodId)
     rowsByApp[prodId] = [...new Set(appRows)]
     uniqueRows = uniqueRows.concat(rowsByApp[prodId])
   }

package/src/utilities/{users.ts → users.js}

@@ -1,11 +1,12 @@
-import { InternalTables } from "../db/utils"
-import { getGlobalUser } from "./global"
-import { context, db as dbCore, roles } from "@budibase/backend-core"
-import { BBContext } from "@budibase/types"
+const { InternalTables } = require("../db/utils")
+const { getGlobalUser } = require("../utilities/global")
+const { getAppDB } = require("@budibase/backend-core/context")
+const { getProdAppID } = require("@budibase/backend-core/db")
+const { BUILTIN_ROLE_IDS } = require("@budibase/backend-core/roles")
 
-export async function getFullUser(ctx: BBContext, userId: string) {
+exports.getFullUser = async (ctx, userId) => {
   const global = await getGlobalUser(userId)
-  let metadata: any = {}
+  let metadata = {}
 
   // always prefer the user metadata _id and _rev
   delete global._id
@@ -13,7 +14,7 @@ export async function getFullUser(ctx: BBContext, userId: string) {
 
   try {
     // this will throw an error if the db doesn't exist, or there is no appId
-    const db = context.getAppDB()
+    const db = getAppDB()
     metadata = await db.get(userId)
   } catch (err) {
     // it is fine if there is no user metadata yet
@@ -22,14 +23,14 @@ export async function getFullUser(ctx: BBContext, userId: string) {
   return {
     ...metadata,
     ...global,
-    roleId: global.roleId || roles.BUILTIN_ROLE_IDS.PUBLIC,
+    roleId: global.roleId || BUILTIN_ROLE_IDS.PUBLIC,
     tableId: InternalTables.USER_METADATA,
     // make sure the ID is always a local ID, not a global one
     _id: userId,
   }
 }
 
-export function publicApiUserFix(ctx: BBContext) {
+exports.publicApiUserFix = ctx => {
   if (!ctx.request.body) {
     return ctx
   }
@@ -39,9 +40,10 @@ export function publicApiUserFix(ctx: BBContext) {
   if (!ctx.request.body.roles) {
     ctx.request.body.roles = {}
   } else {
-    const newRoles: { [key: string]: any } = {}
+    const newRoles = {}
     for (let [appId, role] of Object.entries(ctx.request.body.roles)) {
-      newRoles[dbCore.getProdAppID(appId)] = role
+      // @ts-ignore
+      newRoles[getProdAppID(appId)] = role
     }
     ctx.request.body.roles = newRoles
   }