@budibase/server 2.1.32-alpha.4 → 2.1.32-alpha.6

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

@@ -1,17 +1,20 @@
-const env = require("../environment")
-const { OBJ_STORE_DIRECTORY } = require("../constants")
-const { sanitizeKey } = require("@budibase/backend-core/objectStore")
-const { generateMetadataID } = require("../db/utils")
-const Readable = require("stream").Readable
-const { getAppDB } = require("@budibase/backend-core/context")
-
-exports.wait = ms => new Promise(resolve => setTimeout(resolve, ms))
+import env from "../environment"
+import { OBJ_STORE_DIRECTORY } from "../constants"
+import { objectStore, context } from "@budibase/backend-core"
+import { generateMetadataID } from "../db/utils"
+import { Document } from "@budibase/types"
+import stream from "stream"
+const Readable = stream.Readable
+
+export function wait(ms: number) {
+  return new Promise(resolve => setTimeout(resolve, ms))
+}
 
-exports.isDev = env.isDev
+export const isDev = env.isDev
 
-exports.NUMBER_REGEX = /^[+-]?([0-9]*[.])?[0-9]+$/g
+export const NUMBER_REGEX = /^[+-]?([0-9]*[.])?[0-9]+$/g
 
-exports.removeFromArray = (array, element) => {
+export function removeFromArray(array: any[], element: any) {
   const index = array.indexOf(element)
   if (index !== -1) {
     array.splice(index, 1)
@@ -25,7 +28,7 @@ exports.removeFromArray = (array, element) => {
  * @param {string} url The URL to test and remove any extra double slashes.
  * @return {string} The updated url.
  */
-exports.checkSlashesInUrl = url => {
+export function checkSlashesInUrl(url: string) {
   return url.replace(/(https?:\/\/)|(\/)+/g, "$1$2")
 }
 
@@ -33,7 +36,7 @@ exports.checkSlashesInUrl = url => {
  * Gets the address of the object store, depending on whether self hosted or in cloud.
  * @return {string} The base URL of the object store (MinIO or S3).
  */
-exports.objectStoreUrl = () => {
+export function objectStoreUrl() {
   if (env.SELF_HOSTED || env.MINIO_URL) {
     // can use a relative url for this as all goes through the proxy (this is hosted in minio)
     return OBJ_STORE_DIRECTORY
@@ -52,9 +55,9 @@ exports.objectStoreUrl = () => {
  * @return {string} The URL to be inserted into appPackage response or server rendered
  * app index file.
  */
-exports.clientLibraryPath = (appId, version) => {
+export function clientLibraryPath(appId: string, version: string) {
   if (env.isProd()) {
-    let url = `${exports.objectStoreUrl()}/${sanitizeKey(
+    let url = `${objectStoreUrl()}/${objectStore.sanitizeKey(
       appId
     )}/budibase-client.js`
 
@@ -68,18 +71,19 @@ exports.clientLibraryPath = (appId, version) => {
   }
 }
 
-exports.attachmentsRelativeURL = attachmentKey => {
-  return exports.checkSlashesInUrl(
-    `${exports.objectStoreUrl()}/${attachmentKey}`
-  )
+export function attachmentsRelativeURL(attachmentKey: string) {
+  return checkSlashesInUrl(`${objectStoreUrl()}/${attachmentKey}`)
 }
 
-exports.updateEntityMetadata = async (type, entityId, updateFn) => {
-  const db = getAppDB()
+export async function updateEntityMetadata(
+  type: string,
+  entityId: string,
+  updateFn: any
+) {
+  const db = context.getAppDB()
   const id = generateMetadataID(type, entityId)
   // read it to see if it exists, we'll overwrite it no matter what
-  let rev,
-    metadata = {}
+  let rev, metadata: Document
   try {
     const oldMetadata = await db.get(id)
     rev = oldMetadata._rev
@@ -100,14 +104,18 @@ exports.updateEntityMetadata = async (type, entityId, updateFn) => {
   }
 }
 
-exports.saveEntityMetadata = async (type, entityId, metadata) => {
-  return exports.updateEntityMetadata(type, entityId, () => {
+export async function saveEntityMetadata(
+  type: string,
+  entityId: string,
+  metadata: Document
+) {
+  return updateEntityMetadata(type, entityId, () => {
     return metadata
   })
 }
 
-exports.deleteEntityMetadata = async (type, entityId) => {
-  const db = getAppDB()
+export async function deleteEntityMetadata(type: string, entityId: string) {
+  const db = context.getAppDB()
   const id = generateMetadataID(type, entityId)
   let rev
   try {
@@ -123,7 +131,7 @@ exports.deleteEntityMetadata = async (type, entityId) => {
   }
 }
 
-exports.escapeDangerousCharacters = string => {
+export function escapeDangerousCharacters(string: string) {
   return string
     .replace(/[\\]/g, "\\\\")
     .replace(/[\b]/g, "\\b")
@@ -133,7 +141,7 @@ exports.escapeDangerousCharacters = string => {
     .replace(/[\t]/g, "\\t")
 }
 
-exports.stringToReadStream = string => {
+export function stringToReadStream(string: string) {
   return new Readable({
     read() {
       this.push(string)
@@ -142,7 +150,7 @@ exports.stringToReadStream = string => {
   })
 }
 
-exports.formatBytes = bytes => {
+export function formatBytes(bytes: string) {
   const units = ["B", "KB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB"]
   const byteIncrements = 1024
   let unit = 0
@@ -153,7 +161,7 @@ exports.formatBytes = bytes => {
   return `${size.toFixed(size < 10 && unit > 0 ? 1 : 0)}${units[unit]}`
 }
 
-exports.convertBookmark = bookmark => {
+export function convertBookmark(bookmark: string) {
   const IS_NUMBER = /^\d+\.?\d*$/
   if (typeof bookmark === "string" && bookmark.match(IS_NUMBER)) {
     return parseFloat(bookmark)
@@ -161,7 +169,7 @@ exports.convertBookmark = bookmark => {
   return bookmark
 }
 
-exports.isQsTrue = param => {
+export function isQsTrue(param: string) {
   if (typeof param === "string") {
     return param.toLowerCase() === "true"
   } else {

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

@@ -1,46 +1,47 @@
-const { Client, utils } = require("@budibase/backend-core/redis")
-const { getGlobalIDFromUserMetadataID } = require("../db/utils")
+import { redis } from "@budibase/backend-core"
+import { getGlobalIDFromUserMetadataID } from "../db/utils"
+import { ContextUser } from "@budibase/types"
 
 const APP_DEV_LOCK_SECONDS = 600
 const AUTOMATION_TEST_FLAG_SECONDS = 60
-let devAppClient, debounceClient, flagClient
+let devAppClient: any, debounceClient: any, flagClient: any
 
 // we init this as we want to keep the connection open all the time
 // reduces the performance hit
-exports.init = async () => {
-  devAppClient = new Client(utils.Databases.DEV_LOCKS)
-  debounceClient = new Client(utils.Databases.DEBOUNCE)
-  flagClient = new Client(utils.Databases.FLAGS)
+export async function init() {
+  devAppClient = new redis.Client(redis.utils.Databases.DEV_LOCKS)
+  debounceClient = new redis.Client(redis.utils.Databases.DEBOUNCE)
+  flagClient = new redis.Client(redis.utils.Databases.FLAGS)
   await devAppClient.init()
   await debounceClient.init()
   await flagClient.init()
 }
 
-exports.shutdown = async () => {
+export async function shutdown() {
   if (devAppClient) await devAppClient.finish()
   if (debounceClient) await debounceClient.finish()
   if (flagClient) await flagClient.finish()
   console.log("Redis shutdown")
 }
 
-exports.doesUserHaveLock = async (devAppId, user) => {
+export async function doesUserHaveLock(devAppId: string, user: ContextUser) {
   const value = await devAppClient.get(devAppId)
   if (!value) {
     return true
   }
   // make sure both IDs are global
   const expected = getGlobalIDFromUserMetadataID(value._id)
-  const userId = getGlobalIDFromUserMetadataID(user._id)
+  const userId = getGlobalIDFromUserMetadataID(user._id!)
   return expected === userId
 }
 
-exports.getLocksById = async appIds => {
+export async function getLocksById(appIds: string[]) {
   return await devAppClient.bulkGet(appIds)
 }
 
-exports.updateLock = async (devAppId, user) => {
+export async function updateLock(devAppId: string, user: ContextUser) {
   // make sure always global user ID
-  const globalId = getGlobalIDFromUserMetadataID(user._id)
+  const globalId = getGlobalIDFromUserMetadataID(user._id!)
   const inputUser = {
     ...user,
     userId: globalId,
@@ -51,35 +52,35 @@ exports.updateLock = async (devAppId, user) => {
   await devAppClient.store(devAppId, inputUser, APP_DEV_LOCK_SECONDS)
 }
 
-exports.clearLock = async (devAppId, user) => {
+export async function clearLock(devAppId: string, user: ContextUser) {
   const value = await devAppClient.get(devAppId)
   if (!value) {
     return
   }
-  const userId = getGlobalIDFromUserMetadataID(user._id)
+  const userId = getGlobalIDFromUserMetadataID(user._id!)
   if (value._id !== userId) {
     throw "User does not hold lock, cannot clear it."
   }
   await devAppClient.delete(devAppId)
 }
 
-exports.checkDebounce = async id => {
+export async function checkDebounce(id: string) {
   return debounceClient.get(id)
 }
 
-exports.setDebounce = async (id, seconds) => {
+export async function setDebounce(id: string, seconds: number) {
   await debounceClient.store(id, "debouncing", seconds)
 }
 
-exports.setTestFlag = async id => {
+export async function setTestFlag(id: string) {
   await flagClient.store(id, { testing: true }, AUTOMATION_TEST_FLAG_SECONDS)
 }
 
-exports.checkTestFlag = async id => {
+export async function checkTestFlag(id: string) {
   const flag = await flagClient.get(id)
   return !!(flag && flag.testing)
 }
 
-exports.clearTestFlag = async id => {
+export async function clearTestFlag(id: string) {
   await devAppClient.delete(id)
 }

package/src/utilities/routing/index.ts

@@ -0,0 +1,32 @@
+import { createRoutingView } from "../../db/views/staticViews"
+import { ViewName, getQueryIndex, UNICODE_MAX } from "../../db/utils"
+import { context } from "@budibase/backend-core"
+import { ScreenRouting } from "@budibase/types"
+
+type ScreenRoutesView = {
+  id: string
+  routing: ScreenRouting
+}
+
+export async function getRoutingInfo(): Promise<ScreenRoutesView[]> {
+  const db = context.getAppDB()
+  try {
+    const allRouting = await db.query<ScreenRoutesView>(
+      getQueryIndex(ViewName.ROUTING),
+      {
+        startkey: "",
+        endkey: UNICODE_MAX,
+      }
+    )
+    return allRouting.rows.map(row => row.value as ScreenRoutesView)
+  } catch (err: any) {
+    // check if the view doesn't exist, it should for all new instances
+    /* istanbul ignore next */
+    if (err != null && err.name === "not_found") {
+      await createRoutingView()
+      return getRoutingInfo()
+    } else {
+      throw err
+    }
+  }
+}

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

@@ -1,129 +1,41 @@
-const linkRows = require("../../db/linkedRows")
+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 { cloneDeep } = require("lodash/fp")
-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")
+export * from "./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
-      }
-    },
-  },
+type AutoColumnProcessingOpts = {
+  reprocessing?: boolean
+  noAutoRelationships?: boolean
 }
 
+const BASE_AUTO_ID = 1
+
 /**
  * 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, attachmentKey) {
+function getRemovedAttachmentKeys(
+  oldRow: Row,
+  row: Row,
+  attachmentKey: string
+) {
   if (!oldRow[attachmentKey]) {
     return []
   }
-  const oldKeys = oldRow[attachmentKey].map(attachment => attachment.key)
+  const oldKeys = oldRow[attachmentKey].map((attachment: any) => attachment.key)
   // no attachments in new row, all removed
   if (!row[attachmentKey]) {
     return oldKeys
   }
-  const newKeys = row[attachmentKey].map(attachment => attachment.key)
-  return oldKeys.filter(key => newKeys.indexOf(key) === -1)
+  const newKeys = row[attachmentKey].map((attachment: any) => attachment.key)
+  return oldKeys.filter((key: any) => newKeys.indexOf(key) === -1)
 }
 
 /**
@@ -136,11 +48,11 @@ function getRemovedAttachmentKeys(oldRow, row, attachmentKey) {
  * @returns {{row: Object, table: Object}} The updated row and table, the table may need to be updated
  * for automatic ID purposes.
  */
-function processAutoColumn(
-  user,
-  table,
-  row,
-  opts = { reprocessing: false, noAutoRelationships: false }
+export function processAutoColumn(
+  user: User | null,
+  table: Table,
+  row: Row,
+  opts?: AutoColumnProcessingOpts
 ) {
   let noUser = !user || !user.userId
   let isUserTable = table._id === InternalTables.USER_METADATA
@@ -149,7 +61,7 @@ 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
@@ -159,7 +71,7 @@ function processAutoColumn(
     }
     switch (schema.subtype) {
       case AutoFieldSubTypes.CREATED_BY:
-        if (creating && shouldUpdateUserFields) {
+        if (creating && shouldUpdateUserFields && user) {
           row[key] = [user.userId]
         }
         break
@@ -169,7 +81,7 @@ function processAutoColumn(
         }
         break
       case AutoFieldSubTypes.UPDATED_BY:
-        if (shouldUpdateUserFields) {
+        if (shouldUpdateUserFields && user) {
           row[key] = [user.userId]
         }
         break
@@ -186,9 +98,6 @@ 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
@@ -196,15 +105,17 @@ exports.processFormulas = processFormulas
  * @param {object} type The type fo coerce to
  * @returns {object} The coerced value
  */
-exports.coerce = (row, type) => {
+export function coerce(row: any, type: any) {
   // 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)
   }
 
@@ -220,12 +131,12 @@ exports.coerce = (row, type) => {
  * @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.
  */
-exports.inputProcessing = (
-  user = {},
-  table,
-  row,
-  opts = { noAutoRelationships: false }
-) => {
+export function inputProcessing(
+  user: User,
+  table: Table,
+  row: Row,
+  opts: AutoColumnProcessingOpts
+) {
   let clonedRow = cloneDeep(row)
   // need to copy the table so it can be differenced on way out
   const copiedTable = cloneDeep(table)
@@ -245,7 +156,7 @@ exports.inputProcessing = (
     }
     // otherwise coerce what is there to correct types
     else {
-      clonedRow[key] = exports.coerce(value, field.type)
+      clonedRow[key] = coerce(value, field.type)
     }
   }
 
@@ -267,7 +178,11 @@ exports.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.
  */
-exports.outputProcessing = async (table, rows, opts = { squash: true }) => {
+export async function outputProcessing(
+  table: Table,
+  rows: Row[] | Row,
+  opts = { squash: true }
+) {
   let wasArray = true
   if (!(rows instanceof Array)) {
     rows = [rows]
@@ -286,7 +201,7 @@ exports.outputProcessing = async (table, rows, opts = { squash: true }) => {
         if (row[property] == null || !Array.isArray(row[property])) {
           continue
         }
-        row[property].forEach(attachment => {
+        row[property].forEach((attachment: any) => {
           attachment.url = attachmentsRelativeURL(attachment.key)
         })
       }
@@ -308,20 +223,28 @@ exports.outputProcessing = async (table, rows, opts = { squash: true }) => {
  * deleted attachment columns.
  * @return {Promise<void>} When all attachments have been removed this will return.
  */
-exports.cleanupAttachments = async (table, { row, rows, oldRow, oldTable }) => {
-  const appId = getAppId()
-  if (!isProdAppID(appId)) {
-    const prodAppId = getProdAppID(appId)
+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!)
     // if prod exists, then don't allow deleting
-    const exists = await dbExists(prodAppId)
+    const exists = await dbCore.dbExists(prodAppId)
     if (exists) {
       return
     }
   }
-  let files = []
-  function addFiles(row, key) {
+  let files: string[] = []
+  function addFiles(row: Row, key: string) {
     if (row[key]) {
-      files = files.concat(row[key].map(attachment => attachment.key))
+      files = files.concat(row[key].map((attachment: any) => attachment.key))
     }
   }
   const schemaToUse = oldTable ? oldTable.schema : table.schema
@@ -330,7 +253,7 @@ exports.cleanupAttachments = async (table, { row, rows, oldRow, oldTable }) => {
       continue
     }
     // old table had this column, new table doesn't - delete it
-    if (oldTable && !table.schema[key]) {
+    if (rows && oldTable && !table.schema[key]) {
       rows.forEach(row => addFiles(row, key))
     } else if (oldRow && row) {
       // if updating, need to manage the differences
@@ -342,6 +265,6 @@ exports.cleanupAttachments = async (table, { row, rows, oldRow, oldTable }) => {
     }
   }
   if (files.length > 0) {
-    return deleteFiles(ObjectStoreBuckets.APPS, files)
+    return objectStore.deleteFiles(ObjectStoreBuckets.APPS, files)
   }
 }