@budibase/server 2.1.45 → 2.1.46-alpha.0

package/src/constants/index.js

@@ -1,208 +0,0 @@
-const { BUILTIN_ROLE_IDS } = require("@budibase/backend-core/roles")
-const { UserStatus } = require("@budibase/backend-core/constants")
-const { objectStore } = require("@budibase/backend-core")
-
-const FilterTypes = {
-  STRING: "string",
-  FUZZY: "fuzzy",
-  RANGE: "range",
-  EQUAL: "equal",
-  NOT_EQUAL: "notEqual",
-  EMPTY: "empty",
-  NOT_EMPTY: "notEmpty",
-  CONTAINS: "contains",
-  NOT_CONTAINS: "notContains",
-  ONE_OF: "oneOf",
-}
-
-exports.FilterTypes = FilterTypes
-exports.NoEmptyFilterStrings = [
-  FilterTypes.STRING,
-  FilterTypes.FUZZY,
-  FilterTypes.EQUAL,
-  FilterTypes.NOT_EQUAL,
-  FilterTypes.CONTAINS,
-  FilterTypes.NOT_CONTAINS,
-]
-
-exports.FieldTypes = {
-  STRING: "string",
-  BARCODEQR: "barcodeqr",
-  LONGFORM: "longform",
-  OPTIONS: "options",
-  NUMBER: "number",
-  BOOLEAN: "boolean",
-  ARRAY: "array",
-  DATETIME: "datetime",
-  ATTACHMENT: "attachment",
-  LINK: "link",
-  FORMULA: "formula",
-  AUTO: "auto",
-  JSON: "json",
-  INTERNAL: "internal",
-}
-
-exports.CanSwitchTypes = [
-  [exports.FieldTypes.JSON, exports.FieldTypes.ARRAY],
-  [
-    exports.FieldTypes.STRING,
-    exports.FieldTypes.OPTIONS,
-    exports.FieldTypes.LONGFORM,
-    exports.FieldTypes.BARCODEQR,
-  ],
-  [exports.FieldTypes.BOOLEAN, exports.FieldTypes.NUMBER],
-]
-
-exports.SwitchableTypes = exports.CanSwitchTypes.reduce((prev, current) =>
-  prev ? prev.concat(current) : current
-)
-
-exports.RelationshipTypes = {
-  ONE_TO_MANY: "one-to-many",
-  MANY_TO_ONE: "many-to-one",
-  MANY_TO_MANY: "many-to-many",
-}
-
-exports.FormulaTypes = {
-  STATIC: "static",
-  DYNAMIC: "dynamic",
-}
-
-exports.AuthTypes = {
-  APP: "app",
-  BUILDER: "builder",
-  EXTERNAL: "external",
-}
-
-exports.DataSourceOperation = {
-  CREATE: "CREATE",
-  READ: "READ",
-  UPDATE: "UPDATE",
-  DELETE: "DELETE",
-  BULK_CREATE: "BULK_CREATE",
-  CREATE_TABLE: "CREATE_TABLE",
-  UPDATE_TABLE: "UPDATE_TABLE",
-  DELETE_TABLE: "DELETE_TABLE",
-}
-
-exports.DatasourceAuthTypes = {
-  GOOGLE: "google",
-}
-
-exports.SortDirection = {
-  ASCENDING: "ASCENDING",
-  DESCENDING: "DESCENDING",
-}
-
-exports.USERS_TABLE_SCHEMA = {
-  _id: "ta_users",
-  type: "table",
-  views: {},
-  name: "Users",
-  // TODO: ADMIN PANEL - when implemented this doesn't need to be carried out
-  schema: {
-    email: {
-      type: exports.FieldTypes.STRING,
-      constraints: {
-        type: exports.FieldTypes.STRING,
-        email: true,
-        length: {
-          maximum: "",
-        },
-        presence: true,
-      },
-      fieldName: "email",
-      name: "email",
-    },
-    firstName: {
-      name: "firstName",
-      fieldName: "firstName",
-      type: exports.FieldTypes.STRING,
-      constraints: {
-        type: exports.FieldTypes.STRING,
-        presence: false,
-      },
-    },
-    lastName: {
-      name: "lastName",
-      fieldName: "lastName",
-      type: exports.FieldTypes.STRING,
-      constraints: {
-        type: exports.FieldTypes.STRING,
-        presence: false,
-      },
-    },
-    roleId: {
-      fieldName: "roleId",
-      name: "roleId",
-      type: exports.FieldTypes.OPTIONS,
-      constraints: {
-        type: exports.FieldTypes.STRING,
-        presence: false,
-        inclusion: Object.values(BUILTIN_ROLE_IDS),
-      },
-    },
-    status: {
-      fieldName: "status",
-      name: "status",
-      type: exports.FieldTypes.OPTIONS,
-      constraints: {
-        type: exports.FieldTypes.STRING,
-        presence: false,
-        inclusion: Object.values(UserStatus),
-      },
-    },
-  },
-  primaryDisplay: "email",
-}
-
-exports.AutoFieldSubTypes = {
-  CREATED_BY: "createdBy",
-  CREATED_AT: "createdAt",
-  UPDATED_BY: "updatedBy",
-  UPDATED_AT: "updatedAt",
-  AUTO_ID: "autoID",
-}
-
-exports.AutoFieldDefaultNames = {
-  CREATED_BY: "Created By",
-  CREATED_AT: "Created At",
-  UPDATED_BY: "Updated By",
-  UPDATED_AT: "Updated At",
-  AUTO_ID: "Auto ID",
-}
-
-exports.OBJ_STORE_DIRECTORY = "/prod-budi-app-assets"
-exports.BaseQueryVerbs = {
-  CREATE: "create",
-  READ: "read",
-  UPDATE: "update",
-  DELETE: "delete",
-}
-
-exports.MetadataTypes = {
-  AUTOMATION_TEST_INPUT: "automationTestInput",
-  AUTOMATION_TEST_HISTORY: "automationTestHistory",
-}
-
-exports.InvalidColumns = {
-  ID: "_id",
-  REV: "_rev",
-  TABLE_ID: "tableId",
-}
-
-exports.BuildSchemaErrors = {
-  NO_KEY: "no_key",
-  INVALID_COLUMN: "invalid_column",
-}
-
-exports.AutomationErrors = {
-  INCORRECT_TYPE: "INCORRECT_TYPE",
-  MAX_ITERATIONS: "MAX_ITERATIONS_REACHED",
-  FAILURE_CONDITION: "FAILURE_CONDITION_MET",
-}
-
-// pass through the list from the auth/core lib
-exports.ObjectStoreBuckets = objectStore.ObjectStoreBuckets
-
-exports.MAX_AUTOMATION_RECURRING_ERRORS = 5

package/src/constants/screens.js

@@ -1,46 +0,0 @@
-const { BUILTIN_ROLE_IDS } = require("@budibase/backend-core/roles")
-const { BASE_LAYOUT_PROP_IDS } = require("./layouts")
-
-exports.createHomeScreen = () => ({
-  description: "",
-  url: "",
-  layoutId: BASE_LAYOUT_PROP_IDS.PRIVATE,
-  props: {
-    _id: "d834fea2-1b3e-4320-ab34-f9009f5ecc59",
-    _component: "@budibase/standard-components/container",
-    _styles: {
-      normal: {},
-      hover: {},
-      active: {},
-      selected: {},
-    },
-    _transition: "fade",
-    _children: [
-      {
-        _id: "ef60083f-4a02-4df3-80f3-a0d3d16847e7",
-        _component: "@budibase/standard-components/heading",
-        _styles: {
-          hover: {},
-          active: {},
-          selected: {},
-        },
-        text: "Welcome to your Budibase App 👋",
-        size: "M",
-        align: "left",
-        _instanceName: "Heading",
-        _children: [],
-      },
-    ],
-    _instanceName: "Home",
-    direction: "column",
-    hAlign: "stretch",
-    vAlign: "top",
-    size: "grow",
-    gap: "M",
-  },
-  routing: {
-    route: "/",
-    roleId: BUILTIN_ROLE_IDS.BASIC,
-  },
-  name: "home-screen",
-})

package/src/db/index.js

@@ -1,16 +0,0 @@
-const core = require("@budibase/backend-core")
-const env = require("../environment")
-
-exports.init = () => {
-  const dbConfig = {
-    replication: true,
-    find: true,
-  }
-
-  if (env.isTest() && !env.COUCH_DB_URL) {
-    dbConfig.inMemory = true
-    dbConfig.allDbs = true
-  }
-
-  core.init({ db: dbConfig })
-}

package/src/events/utils.js

@@ -1,38 +0,0 @@
-exports.rowEmission = ({ emitter, eventName, appId, row, table, metadata }) => {
-  let event = {
-    row,
-    appId,
-    tableId: row.tableId,
-  }
-  if (table) {
-    event.table = table
-  }
-  event.id = row._id
-  if (row._rev) {
-    event.revision = row._rev
-  }
-  if (metadata) {
-    event.metadata = metadata
-  }
-  emitter.emit(eventName, event)
-}
-
-exports.tableEmission = ({ emitter, eventName, appId, table, metadata }) => {
-  const tableId = table._id
-  let event = {
-    table: {
-      ...table,
-      tableId: tableId,
-    },
-    appId,
-    tableId: tableId,
-  }
-  event.id = tableId
-  if (table._rev) {
-    event.revision = table._rev
-  }
-  if (metadata) {
-    event.metadata = metadata
-  }
-  emitter.emit(eventName, event)
-}

package/src/middleware/appInfo.js

@@ -1,19 +0,0 @@
-const { isDevAppID, isProdAppID } = require("../db/utils")
-
-exports.AppType = {
-  DEV: "dev",
-  PROD: "prod",
-}
-
-exports.middleware =
-  ({ appType } = {}) =>
-  (ctx, next) => {
-    const appId = ctx.appId
-    if (appType === exports.AppType.DEV && appId && !isDevAppID(appId)) {
-      ctx.throw(400, "Only apps in development support this endpoint")
-    }
-    if (appType === exports.AppType.PROD && appId && !isProdAppID(appId)) {
-      ctx.throw(400, "Only apps in production support this endpoint")
-    }
-    return next()
-  }

package/src/middleware/publicApi.js

@@ -1,21 +0,0 @@
-const { Headers } = require("@budibase/backend-core/constants")
-const { getAppIdFromCtx } = require("@budibase/backend-core/utils")
-
-module.exports = function ({ requiresAppId } = {}) {
-  return async (ctx, next) => {
-    const appId = await getAppIdFromCtx(ctx)
-    if (requiresAppId && !appId) {
-      ctx.throw(
-        400,
-        `Invalid app ID provided, please check the ${Headers.APP_ID} header.`
-      )
-    }
-    if (!ctx.headers[Headers.API_KEY]) {
-      ctx.throw(
-        400,
-        `Invalid API key provided, please check the ${Headers.API_KEY} header.`
-      )
-    }
-    return next()
-  }
-}

package/src/module.d.ts

@@ -1,14 +0,0 @@
-declare module "@budibase/backend-core/tenancy"
-declare module "@budibase/backend-core/db"
-declare module "@budibase/backend-core/context"
-declare module "@budibase/backend-core/cache"
-declare module "@budibase/backend-core/permissions"
-declare module "@budibase/backend-core/roles"
-declare module "@budibase/backend-core/constants"
-declare module "@budibase/backend-core/auth"
-declare module "@budibase/backend-core/sessions"
-declare module "@budibase/backend-core/encryption"
-declare module "@budibase/backend-core/utils"
-declare module "@budibase/backend-core/redis"
-declare module "@budibase/backend-core/objectStore"
-declare module "@budibase/backend-core/plugins"

package/src/tests/utilities/controllers.js

@@ -1,16 +0,0 @@
-module.exports = {
-  table: require("../../api/controllers/table"),
-  row: require("../../api/controllers/row"),
-  role: require("../../api/controllers/role"),
-  perms: require("../../api/controllers/permission"),
-  view: require("../../api/controllers/view"),
-  app: require("../../api/controllers/application"),
-  user: require("../../api/controllers/user"),
-  automation: require("../../api/controllers/automation"),
-  datasource: require("../../api/controllers/datasource"),
-  query: require("../../api/controllers/query"),
-  screen: require("../../api/controllers/screen"),
-  webhook: require("../../api/controllers/webhook"),
-  layout: require("../../api/controllers/layout"),
-  deploy: require("../../api/controllers/deploy"),
-}

package/src/utilities/budibaseDir.js

@@ -1,3 +0,0 @@
-const { budibaseTempDir } = require("@budibase/backend-core/objectStore")
-
-module.exports.budibaseTempDir = budibaseTempDir

package/src/utilities/fileSystem/utilities.js

@@ -1,36 +0,0 @@
-const {
-  ObjectStore,
-  makeSureBucketExists,
-  upload,
-  deleteFiles,
-  streamUpload,
-  retrieve,
-  retrieveToTmp,
-  retrieveDirectory,
-  deleteFolder,
-  uploadDirectory,
-  downloadTarball,
-  downloadTarballDirect,
-} = require("@budibase/backend-core/objectStore")
-
-/***********************************
- *              NOTE               *
- * This file purely exists so that *
- *  the object store functionality *
- *   can easily be mocked out of   *
- *  the server without mocking the *
- *      entire core library.       *
- ***********************************/
-
-exports.ObjectStore = ObjectStore
-exports.makeSureBucketExists = makeSureBucketExists
-exports.upload = upload
-exports.streamUpload = streamUpload
-exports.retrieve = retrieve
-exports.retrieveToTmp = retrieveToTmp
-exports.retrieveDirectory = retrieveDirectory
-exports.deleteFolder = deleteFolder
-exports.uploadDirectory = uploadDirectory
-exports.downloadTarball = downloadTarball
-exports.downloadTarballDirect = downloadTarballDirect
-exports.deleteFiles = deleteFiles

package/src/utilities/global.js

@@ -1,127 +0,0 @@
-const {
-  getMultiIDParams,
-  getGlobalIDFromUserMetadataID,
-} = require("../db/utils")
-const { BUILTIN_ROLE_IDS } = require("@budibase/backend-core/roles")
-const { getProdAppID } = require("@budibase/backend-core/db")
-const { getGlobalUserParams } = require("@budibase/backend-core/db")
-const { user: userCache } = require("@budibase/backend-core/cache")
-const {
-  getGlobalDB,
-  isUserInAppTenant,
-} = require("@budibase/backend-core/tenancy")
-const env = require("../environment")
-const { getAppId } = require("@budibase/backend-core/context")
-const { groups } = require("@budibase/pro")
-
-exports.updateAppRole = (user, { appId } = {}) => {
-  appId = appId || getAppId()
-
-  if (!user || !user.roles) {
-    return user
-  }
-  // if in an multi-tenancy environment make sure roles are never updated
-  if (env.MULTI_TENANCY && !isUserInAppTenant(appId, user)) {
-    delete user.builder
-    delete user.admin
-    user.roleId = BUILTIN_ROLE_IDS.PUBLIC
-    return user
-  }
-  // always use the deployed app
-  user.roleId = user.roles[getProdAppID(appId)]
-  // if a role wasn't found then either set as admin (builder) or public (everyone else)
-  if (!user.roleId && user.builder && user.builder.global) {
-    user.roleId = BUILTIN_ROLE_IDS.ADMIN
-  } else if (!user.roleId && !user?.userGroups?.length) {
-    user.roleId = BUILTIN_ROLE_IDS.PUBLIC
-  } else if (user?.userGroups?.length) {
-    user.roleId = null
-  }
-
-  delete user.roles
-  return user
-}
-
-async function checkGroupRoles(user, { appId } = {}) {
-  if (user.roleId && user.roleId !== BUILTIN_ROLE_IDS.PUBLIC) {
-    return user
-  }
-  user.roleId = await groups.getGroupRoleId(user, appId)
-  return user
-}
-
-async function processUser(user, { appId } = {}) {
-  if (user) {
-    delete user.password
-  }
-  user = await exports.updateAppRole(user, { appId })
-  if (!user.roleId && user?.userGroups?.length) {
-    user = await checkGroupRoles(user, { appId })
-  }
-
-  return user
-}
-
-exports.getCachedSelf = async (ctx, appId) => {
-  // this has to be tenant aware, can't depend on the context to find it out
-  // running some middlewares before the tenancy causes context to break
-  const user = await userCache.getUser(ctx.user._id)
-  return processUser(user, { appId })
-}
-
-exports.getRawGlobalUser = async userId => {
-  const db = getGlobalDB()
-  return db.get(getGlobalIDFromUserMetadataID(userId))
-}
-
-exports.getGlobalUser = async userId => {
-  const appId = getAppId()
-  let user = await exports.getRawGlobalUser(userId)
-  return processUser(user, { appId })
-}
-
-exports.getGlobalUsers = async (users = null) => {
-  const appId = getAppId()
-  const db = getGlobalDB()
-  let globalUsers
-  if (users) {
-    const globalIds = users.map(user => getGlobalIDFromUserMetadataID(user._id))
-    globalUsers = (await db.allDocs(getMultiIDParams(globalIds))).rows.map(
-      row => row.doc
-    )
-  } else {
-    globalUsers = (
-      await db.allDocs(
-        getGlobalUserParams(null, {
-          include_docs: true,
-        })
-      )
-    ).rows.map(row => row.doc)
-  }
-  globalUsers = globalUsers
-    .filter(user => user != null)
-    .map(user => {
-      delete user.password
-      delete user.forceResetPassword
-      return user
-    })
-  if (!appId) {
-    return globalUsers
-  }
-
-  return globalUsers.map(user => exports.updateAppRole(user))
-}
-
-exports.getGlobalUsersFromMetadata = async users => {
-  const globalUsers = await exports.getGlobalUsers(users)
-  return users.map(user => {
-    const globalUser = globalUsers.find(
-      globalUser => globalUser && user._id.includes(globalUser._id)
-    )
-    return {
-      ...globalUser,
-      // doing user second overwrites the id and rev (always metadata)
-      ...user,
-    }
-  })
-}

package/src/utilities/queue/inMemoryQueue.js

@@ -1,122 +0,0 @@
-let events = require("events")
-
-/**
- * Bull works with a Job wrapper around all messages that contains a lot more information about
- * the state of the message, this object constructor implements the same schema of Bull jobs
- * for the sake of maintaining API consistency.
- * @param {string} queue The name of the queue which the message will be carried on.
- * @param {object} message The JSON message which will be passed back to the consumer.
- * @returns {Object} A new job which can now be put onto the queue, this is mostly an
- * internal structure so that an in memory queue can be easily swapped for a Bull queue.
- */
-function newJob(queue, message) {
-  return {
-    timestamp: Date.now(),
-    queue: queue,
-    data: message,
-  }
-}
-
-/**
- * This is designed to replicate Bull (https://github.com/OptimalBits/bull) in memory as a sort of mock.
- * It is relatively simple, using an event emitter internally to register when messages are available
- * to the consumers - in can support many inputs and many consumers.
- */
-class InMemoryQueue {
-  /**
-   * The constructor the queue, exactly the same as that of Bulls.
-   * @param {string} name The name of the queue which is being configured.
-   * @param {object|null} opts This is not used by the in memory queue as there is no real use
-   * case when in memory, but is the same API as Bull
-   */
-  constructor(name, opts = null) {
-    this._name = name
-    this._opts = opts
-    this._messages = []
-    this._emitter = new events.EventEmitter()
-  }
-
-  /**
-   * Same callback API as Bull, each callback passed to this will consume messages as they are
-   * available. Please note this is a queue service, not a notification service, so each
-   * consumer will receive different messages.
-   * @param {function<object>} func The callback function which will return a "Job", the same
-   * as the Bull API, within this job the property "data" contains the JSON message. Please
-   * note this is incredibly limited compared to Bull as in reality the Job would contain
-   * a lot more information about the queue and current status of Bull cluster.
-   */
-  process(func) {
-    this._emitter.on("message", async () => {
-      if (this._messages.length <= 0) {
-        return
-      }
-      let msg = this._messages.shift()
-      let resp = func(msg)
-      if (resp.then != null) {
-        await resp
-      }
-    })
-  }
-
-  // simply puts a message to the queue and emits to the queue for processing
-  /**
-   * Simple function to replicate the add message functionality of Bull, putting
-   * a new message on the queue. This then emits an event which will be used to
-   * return the message to a consumer (if one is attached).
-   * @param {object} msg A message to be transported over the queue, this should be
-   * a JSON message as this is required by Bull.
-   */
-  // eslint-disable-next-line no-unused-vars
-  add(msg, repeat) {
-    if (typeof msg !== "object") {
-      throw "Queue only supports carrying JSON."
-    }
-    this._messages.push(newJob(this._name, msg))
-    this._emitter.emit("message")
-  }
-
-  /**
-   * replicating the close function from bull, which waits for jobs to finish.
-   */
-  async close() {
-    return []
-  }
-
-  /**
-   * This removes a cron which has been implemented, this is part of Bull API.
-   * @param {string} cronJobId The cron which is to be removed.
-   */
-  removeRepeatableByKey(cronJobId) {
-    // TODO: implement for testing
-    console.log(cronJobId)
-  }
-
-  /**
-   * Implemented for tests
-   */
-  getRepeatableJobs() {
-    return []
-  }
-
-  // eslint-disable-next-line no-unused-vars
-  removeJobs(pattern) {
-    // no-op
-  }
-
-  /**
-   * Implemented for tests
-   */
-  async clean() {
-    return []
-  }
-
-  async getJob() {
-    return {}
-  }
-
-  on() {
-    // do nothing
-  }
-}
-
-module.exports = InMemoryQueue

package/src/utilities/routing/index.js

@@ -1,25 +0,0 @@
-const { createRoutingView } = require("../../db/views/staticViews")
-const { ViewName, getQueryIndex, UNICODE_MAX } = require("../../db/utils")
-const { getAppDB } = require("@budibase/backend-core/context")
-
-exports.getRoutingInfo = async () => {
-  const db = getAppDB()
-  try {
-    const allRouting = await db.query(getQueryIndex(ViewName.ROUTING), {
-      startKey: "",
-      endKey: UNICODE_MAX,
-    })
-    return allRouting.rows.map(row => row.value)
-  } catch (err) {
-    // 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 exports.getRoutingInfo()
-    } else {
-      throw err
-    }
-  }
-}
-
-exports.createRoutingView = createRoutingView