@budibase/server 2.1.39 → 2.1.40-alpha.0

package/src/api/routes/tests/table.spec.js

@@ -1,17 +1,18 @@
 const { checkBuilderEndpoint } = require("./utilities/TestFunctions")
-const { getAppDB } = require("@budibase/backend-core/context")
 const setup = require("./utilities")
 const { basicTable } = setup.structures
-const { events } = require("@budibase/backend-core")
+const { events, context } = require("@budibase/backend-core")
 
 describe("/tables", () => {
   let request = setup.getRequest()
   let config = setup.getConfig()
+  let appId
 
   afterAll(setup.afterAll)
 
   beforeEach(async () => {
-    await config.init()
+    const app = await config.init()
+    appId = app.appId
   })
 
   describe("create", () => {
@@ -199,38 +200,6 @@ describe("/tables", () => {
     })
   })
 
-  describe("indexing", () => {
-    it("should be able to create a table with indexes", async () => {
-      const db = getAppDB(config)
-      const indexCount = (await db.getIndexes()).total_rows
-      const table = basicTable()
-      table.indexes = ["name"]
-      const res = await request
-        .post(`/api/tables`)
-        .send(table)
-        .set(config.defaultHeaders())
-        .expect('Content-Type', /json/)
-        .expect(200)
-      expect(res.body._id).toBeDefined()
-      expect(res.body._rev).toBeDefined()
-      expect((await db.getIndexes()).total_rows).toEqual(indexCount + 1)
-      // update index to see what happens
-      table.indexes = ["name", "description"]
-      await request
-        .post(`/api/tables`)
-        .send({
-          ...table,
-          _id: res.body._id,
-          _rev: res.body._rev,
-        })
-        .set(config.defaultHeaders())
-        .expect('Content-Type', /json/)
-        .expect(200)
-      // shouldn't have created a new index
-      expect((await db.getIndexes()).total_rows).toEqual(indexCount + 1)
-    })
-  })
-
   describe("validate csv", () => {
     it("should be able to validate a CSV layout", async () => {
       const res = await request
@@ -249,6 +218,40 @@ describe("/tables", () => {
     })
   })
 
+  describe("indexing", () => {
+    it("should be able to create a table with indexes", async () => {
+      await context.doInAppContext(appId, async () => {
+        const db = context.getAppDB()
+        const indexCount = (await db.getIndexes()).total_rows
+        const table = basicTable()
+        table.indexes = ["name"]
+        const res = await request
+          .post(`/api/tables`)
+          .send(table)
+          .set(config.defaultHeaders())
+          .expect('Content-Type', /json/)
+          .expect(200)
+        expect(res.body._id).toBeDefined()
+        expect(res.body._rev).toBeDefined()
+        expect((await db.getIndexes()).total_rows).toEqual(indexCount + 1)
+        // update index to see what happens
+        table.indexes = ["name", "description"]
+        await request
+          .post(`/api/tables`)
+          .send({
+            ...table,
+            _id: res.body._id,
+            _rev: res.body._rev,
+          })
+          .set(config.defaultHeaders())
+          .expect('Content-Type', /json/)
+          .expect(200)
+        // shouldn't have created a new index
+        expect((await db.getIndexes()).total_rows).toEqual(indexCount + 1)
+      })
+    })
+  })
+
   describe("destroy", () => {
     let testTable
 
@@ -268,7 +271,7 @@ describe("/tables", () => {
         .expect(200)
       expect(res.body.message).toEqual(`Table ${testTable._id} deleted.`)
       expect(events.table.deleted).toBeCalledTimes(1)
-      expect(events.table.deleted).toBeCalledWith(testTable)
+      expect(events.table.deleted).toBeCalledWith({ ...testTable, tableId: testTable._id })
     })
 
     it("deletes linked references to the table after deletion", async () => {
@@ -285,6 +288,7 @@ describe("/tables", () => {
           },
           TestTable: {
             type: "link",
+            fieldName: "TestTable",
             tableId: testTable._id,
             constraints: {
               type: "array"

package/src/api/routes/tests/user.spec.js

@@ -1,6 +1,7 @@
-const { BUILTIN_ROLE_IDS } = require("@budibase/backend-core/roles")
+const { roles } = require("@budibase/backend-core")
 const { checkPermissionsEndpoint } = require("./utilities/TestFunctions")
 const setup = require("./utilities")
+const { BUILTIN_ROLE_IDS } = roles
 
 jest.mock("../../../utilities/workerRequests", () => ({
   getGlobalUsers: jest.fn(() => {

package/src/api/routes/tests/utilities/TestFunctions.ts

@@ -1,10 +1,8 @@
 import * as rowController from "../../../controllers/row"
 import * as appController from "../../../controllers/application"
 import { AppStatus } from "../../../../db/utils"
-import { BUILTIN_ROLE_IDS } from "@budibase/backend-core/roles"
-import { doInTenant } from "@budibase/backend-core/tenancy"
+import { roles, tenancy, context } from "@budibase/backend-core"
 import { TENANT_ID } from "../../../../tests/utilities/structures"
-import { getAppDB, doInAppContext } from "@budibase/backend-core/context"
 import * as env from "../../../../environment"
 
 class Request {
@@ -21,7 +19,7 @@ class Request {
 }
 
 function runRequest(appId: any, controlFunc: any, request?: any) {
-  return doInAppContext(appId, async () => {
+  return context.doInAppContext(appId, async () => {
     return controlFunc(request)
   })
 }
@@ -33,7 +31,7 @@ export const getAllTableRows = async (config: any) => {
 }
 
 export const clearAllApps = async (tenantId = TENANT_ID) => {
-  await doInTenant(tenantId, async () => {
+  await tenancy.doInTenant(tenantId, async () => {
     const req: any = { query: { status: AppStatus.DEV }, user: { tenantId } }
     await appController.fetch(req)
     const apps = req.body
@@ -51,7 +49,7 @@ export const clearAllApps = async (tenantId = TENANT_ID) => {
 export const clearAllAutomations = async (config: any) => {
   const automations = await config.getAllAutomations()
   for (let auto of automations) {
-    await doInAppContext(config.appId, async () => {
+    await context.doInAppContext(config.appId, async () => {
       await config.deleteAutomation(auto)
     })
   }
@@ -110,7 +108,7 @@ export const checkPermissionsEndpoint = async ({
     .expect(200)
 
   let failHeader
-  if (failRole === BUILTIN_ROLE_IDS.PUBLIC) {
+  if (failRole === roles.BUILTIN_ROLE_IDS.PUBLIC) {
     failHeader = config.publicHeaders({ prodApp: true })
   } else {
     failHeader = await config.login({
@@ -127,7 +125,7 @@ export const checkPermissionsEndpoint = async ({
 }
 
 export const getDB = () => {
-  return getAppDB()
+  return context.getAppDB()
 }
 
 export const testAutomation = async (config: any, automation: any) => {

package/src/api/routes/tests/utilities/{index.js → index.ts}

@@ -1,6 +1,6 @@
-const TestConfig = require("../../../../tests/utilities/TestConfiguration")
-const structures = require("../../../../tests/utilities/structures")
-const env = require("../../../../environment")
+import TestConfig from "../../../../tests/utilities/TestConfiguration"
+import env from "../../../../environment"
+export * as structures from "../../../../tests/utilities/structures"
 
 function user() {
   return {
@@ -40,16 +40,18 @@ jest.mock("../../../../utilities/workerRequests", () => ({
   removeAppFromUserRoles: jest.fn(),
 }))
 
-exports.delay = ms => new Promise(resolve => setTimeout(resolve, ms))
+export function delay(ms: number) {
+  return new Promise(resolve => setTimeout(resolve, ms))
+}
 
-let request, config
+let request: any, config: any
 
-exports.beforeAll = () => {
+export function beforeAll() {
   config = new TestConfig()
   request = config.getRequest()
 }
 
-exports.afterAll = () => {
+export function afterAll() {
   if (config) {
     config.end()
   }
@@ -59,21 +61,21 @@ exports.afterAll = () => {
   config = null
 }
 
-exports.getRequest = () => {
+export function getRequest() {
   if (!request) {
     exports.beforeAll()
   }
   return request
 }
 
-exports.getConfig = () => {
+export function getConfig() {
   if (!config) {
     exports.beforeAll()
   }
   return config
 }
 
-exports.switchToSelfHosted = async func => {
+export async function switchToSelfHosted(func: any) {
   // self hosted stops any attempts to Dynamo
   env._set("NODE_ENV", "production")
   env._set("SELF_HOSTED", true)
@@ -90,5 +92,3 @@ exports.switchToSelfHosted = async func => {
     throw error
   }
 }
-
-exports.structures = structures

package/src/api/routes/user.ts

@@ -0,0 +1,51 @@
+import Router from "@koa/router"
+import * as controller from "../controllers/user"
+import authorized from "../../middleware/authorized"
+import { permissions } from "@budibase/backend-core"
+const { PermissionType, PermissionLevel } = permissions
+
+const router: Router = new Router()
+
+router
+  .get(
+    "/api/users/metadata",
+    authorized(PermissionType.USER, PermissionLevel.READ),
+    controller.fetchMetadata
+  )
+  .get(
+    "/api/users/metadata/:id",
+    authorized(PermissionType.USER, PermissionLevel.READ),
+    controller.findMetadata
+  )
+  .put(
+    "/api/users/metadata",
+    authorized(PermissionType.USER, PermissionLevel.WRITE),
+    controller.updateMetadata
+  )
+  .post(
+    "/api/users/metadata/self",
+    authorized(PermissionType.USER, PermissionLevel.WRITE),
+    controller.updateSelfMetadata
+  )
+  .delete(
+    "/api/users/metadata/:id",
+    authorized(PermissionType.USER, PermissionLevel.WRITE),
+    controller.destroyMetadata
+  )
+  .post(
+    "/api/users/metadata/sync/:id",
+    authorized(PermissionType.USER, PermissionLevel.WRITE),
+    controller.syncUser
+  )
+  .post(
+    "/api/users/flags",
+    authorized(PermissionType.USER, PermissionLevel.WRITE),
+    controller.setFlag
+  )
+  .get(
+    "/api/users/flags",
+    authorized(PermissionType.USER, PermissionLevel.READ),
+    controller.getFlags
+  )
+
+export = router

package/src/api/routes/utils/{validators.js → validators.ts}

@@ -1,20 +1,16 @@
-const { joiValidator } = require("@budibase/backend-core/auth")
-const { DataSourceOperation } = require("../../../constants")
-const {
-  BUILTIN_PERMISSION_IDS,
-  PermissionLevels,
-} = require("@budibase/backend-core/permissions")
-const { WebhookActionType } = require("@budibase/types")
-const Joi = require("joi")
+import { auth, permissions } from "@budibase/backend-core"
+import { DataSourceOperation } from "../../../constants"
+import { WebhookActionType } from "@budibase/types"
+import Joi from "joi"
 
 const OPTIONAL_STRING = Joi.string().optional().allow(null).allow("")
 const OPTIONAL_NUMBER = Joi.number().optional().allow(null)
 const OPTIONAL_BOOLEAN = Joi.boolean().optional().allow(null)
 const APP_NAME_REGEX = /^[\w\s]+$/
 
-exports.tableValidator = () => {
+export function tableValidator() {
   // prettier-ignore
-  return joiValidator.body(Joi.object({
+  return auth.joiValidator.body(Joi.object({
     _id: OPTIONAL_STRING,
     _rev: OPTIONAL_STRING,
     type: OPTIONAL_STRING.valid("table", "internal", "external"),
@@ -26,16 +22,16 @@ exports.tableValidator = () => {
   }).unknown(true))
 }
 
-exports.nameValidator = () => {
+export function nameValidator() {
   // prettier-ignore
-  return joiValidator.body(Joi.object({
+  return auth.joiValidator.body(Joi.object({
     name: OPTIONAL_STRING,
   }))
 }
 
-exports.datasourceValidator = () => {
+export function datasourceValidator() {
   // prettier-ignore
-  return joiValidator.body(Joi.object({
+  return auth.joiValidator.body(Joi.object({
     _id: Joi.string(),
     _rev: Joi.string(),
     type: OPTIONAL_STRING.allow("datasource_plus"),
@@ -64,9 +60,9 @@ function filterObject() {
   }).unknown(true)
 }
 
-exports.internalSearchValidator = () => {
+export function internalSearchValidator() {
   // prettier-ignore
-  return joiValidator.body(Joi.object({
+  return auth.joiValidator.body(Joi.object({
     tableId: OPTIONAL_STRING,
     query: filterObject(),
     limit: OPTIONAL_NUMBER,
@@ -78,8 +74,8 @@ exports.internalSearchValidator = () => {
   }))
 }
 
-exports.externalSearchValidator = () => {
-  return joiValidator.body(
+export function externalSearchValidator() {
+  return auth.joiValidator.body(
     Joi.object({
       query: filterObject(),
       paginate: Joi.boolean().optional(),
@@ -96,9 +92,9 @@ exports.externalSearchValidator = () => {
   )
 }
 
-exports.datasourceQueryValidator = () => {
+export function datasourceQueryValidator() {
   // prettier-ignore
-  return joiValidator.body(Joi.object({
+  return auth.joiValidator.body(Joi.object({
     endpoint: Joi.object({
       datasourceId: Joi.string().required(),
       operation: Joi.string().required().valid(...Object.values(DataSourceOperation)),
@@ -117,9 +113,9 @@ exports.datasourceQueryValidator = () => {
   }))
 }
 
-exports.webhookValidator = () => {
+export function webhookValidator() {
   // prettier-ignore
-  return joiValidator.body(Joi.object({
+  return auth.joiValidator.body(Joi.object({
     live: Joi.bool(),
     _id: OPTIONAL_STRING,
     _rev: OPTIONAL_STRING,
@@ -132,15 +128,15 @@ exports.webhookValidator = () => {
   }).unknown(true))
 }
 
-exports.roleValidator = () => {
-  const permLevelArray = Object.values(PermissionLevels)
+export function roleValidator() {
+  const permLevelArray = Object.values(permissions.PermissionLevel)
   // prettier-ignore
-  return joiValidator.body(Joi.object({
+  return auth.joiValidator.body(Joi.object({
     _id: OPTIONAL_STRING,
     _rev: OPTIONAL_STRING,
     name: Joi.string().required(),
     // this is the base permission ID (for now a built in)
-    permissionId: Joi.string().valid(...Object.values(BUILTIN_PERMISSION_IDS)).required(),
+    permissionId: Joi.string().valid(...Object.values(permissions.BuiltinPermissionID)).required(),
     permissions: Joi.object()
       .pattern(/.*/, [Joi.string().valid(...permLevelArray)])
       .optional(),
@@ -148,19 +144,19 @@ exports.roleValidator = () => {
   }).unknown(true))
 }
 
-exports.permissionValidator = () => {
-  const permLevelArray = Object.values(PermissionLevels)
+export function permissionValidator() {
+  const permLevelArray = Object.values(permissions.PermissionLevel)
   // prettier-ignore
-  return joiValidator.params(Joi.object({
+  return auth.joiValidator.params(Joi.object({
     level: Joi.string().valid(...permLevelArray).required(),
     resourceId: Joi.string(),
     roleId: Joi.string(),
   }).unknown(true))
 }
 
-exports.screenValidator = () => {
+export function screenValidator() {
   // prettier-ignore
-  return joiValidator.body(Joi.object({
+  return auth.joiValidator.body(Joi.object({
     name: Joi.string().required(),
     showNavigation: OPTIONAL_BOOLEAN,
     width: OPTIONAL_STRING,
@@ -181,7 +177,7 @@ exports.screenValidator = () => {
   }).unknown(true))
 }
 
-function generateStepSchema(allowStepTypes) {
+function generateStepSchema(allowStepTypes: string[]) {
   // prettier-ignore
   return Joi.object({
     stepId: Joi.string().required(),
@@ -196,9 +192,9 @@ function generateStepSchema(allowStepTypes) {
   }).unknown(true)
 }
 
-exports.automationValidator = (existing = false) => {
+export function automationValidator(existing = false) {
   // prettier-ignore
-  return joiValidator.body(Joi.object({
+  return auth.joiValidator.body(Joi.object({
     _id: existing ? Joi.string().required() : OPTIONAL_STRING,
     _rev: existing ? Joi.string().required() : OPTIONAL_STRING,
     name: Joi.string().required(),
@@ -210,9 +206,9 @@ exports.automationValidator = (existing = false) => {
   }).unknown(true))
 }
 
-exports.applicationValidator = (opts = { isCreate: true }) => {
+export function applicationValidator(opts = { isCreate: true }) {
   // prettier-ignore
-  const base = {
+  const base: any = {
     _id: OPTIONAL_STRING,
     _rev: OPTIONAL_STRING,
     url: OPTIONAL_STRING,
@@ -230,7 +226,7 @@ exports.applicationValidator = (opts = { isCreate: true }) => {
     base.name = appNameValidator.optional()
   }
 
-  return joiValidator.body(
+  return auth.joiValidator.body(
     Joi.object({
       _id: OPTIONAL_STRING,
       _rev: OPTIONAL_STRING,

package/src/api/routes/view.ts

@@ -0,0 +1,34 @@
+import Router from "@koa/router"
+import * as viewController from "../controllers/view"
+import * as rowController from "../controllers/row"
+import authorized from "../../middleware/authorized"
+import { paramResource } from "../../middleware/resourceId"
+import { permissions } from "@budibase/backend-core"
+
+const router: Router = new Router()
+
+router
+  .get(
+    "/api/views/export",
+    authorized(permissions.BUILDER),
+    viewController.exportView
+  )
+  .get(
+    "/api/views/:viewName",
+    paramResource("viewName"),
+    authorized(
+      permissions.PermissionType.VIEW,
+      permissions.PermissionLevel.READ
+    ),
+    rowController.fetchView
+  )
+  .get("/api/views", authorized(permissions.BUILDER), viewController.fetch)
+  .delete(
+    "/api/views/:viewName",
+    paramResource("viewName"),
+    authorized(permissions.BUILDER),
+    viewController.destroy
+  )
+  .post("/api/views", authorized(permissions.BUILDER), viewController.save)
+
+export = router

package/src/api/routes/webhook.ts

@@ -5,7 +5,7 @@ import { permissions } from "@budibase/backend-core"
 import { webhookValidator } from "./utils/validators"
 
 const BUILDER = permissions.BUILDER
-const router = new Router()
+const router: Router = new Router()
 
 router
   .get("/api/webhooks", authorized(BUILDER), controller.fetch)
@@ -24,4 +24,4 @@ router
   // this shouldn't have authorisation, right now its always public
   .post("/api/webhooks/trigger/:instance/:id", controller.trigger)
 
-export default router
+export = router

package/src/app.ts

@@ -10,21 +10,20 @@ if (process.env.ELASTIC_APM_ENABLED) {
 }
 
 import { ExtendableContext } from "koa"
-import db from "./db"
+import * as db from "./db"
 db.init()
-const Koa = require("koa")
-const destroyable = require("server-destroy")
-const koaBody = require("koa-body")
-const http = require("http")
-const api = require("./api")
-const automations = require("./automations/index")
-const Sentry = require("@sentry/node")
-const { logAlert } = require("@budibase/backend-core/logging")
-const { Thread } = require("./threads")
-import redis from "./utilities/redis"
-import { events } from "@budibase/backend-core"
+import Koa from "koa"
+import koaBody from "koa-body"
+import http from "http"
+import * as api from "./api"
+import * as automations from "./automations"
+import { Thread } from "./threads"
+import * as redis from "./utilities/redis"
+import { events, logging } from "@budibase/backend-core"
 import { initialise as initialiseWebsockets } from "./websocket"
 import { startup } from "./startup"
+const Sentry = require("@sentry/node")
+const destroyable = require("server-destroy")
 
 const app = new Koa()
 
@@ -35,6 +34,7 @@ app.use(
     formLimit: "10mb",
     jsonLimit: "10mb",
     textLimit: "10mb",
+    // @ts-ignore
     enableTypes: ["json", "form", "text"],
     parsedMethods: ["POST", "PUT", "PATCH", "DELETE"],
   })
@@ -77,12 +77,13 @@ server.on("close", async () => {
   }
 })
 
-module.exports = server.listen(env.PORT || 0, async () => {
+export = server.listen(env.PORT || 0, async () => {
   await startup(app, server)
 })
 
 const shutdown = () => {
   server.close()
+  // @ts-ignore
   server.destroy()
 }
 
@@ -93,7 +94,7 @@ process.on("uncaughtException", err => {
     return
   }
   errCode = -1
-  logAlert("Uncaught exception.", err)
+  logging.logAlert("Uncaught exception.", err)
   shutdown()
 })
 

package/src/automations/{actions.js → actions.ts}

@@ -1,22 +1,26 @@
-const sendSmtpEmail = require("./steps/sendSmtpEmail")
-const createRow = require("./steps/createRow")
-const updateRow = require("./steps/updateRow")
-const deleteRow = require("./steps/deleteRow")
-const executeScript = require("./steps/executeScript")
-const executeQuery = require("./steps/executeQuery")
-const outgoingWebhook = require("./steps/outgoingWebhook")
-const serverLog = require("./steps/serverLog")
-const discord = require("./steps/discord")
-const slack = require("./steps/slack")
-const zapier = require("./steps/zapier")
-const integromat = require("./steps/integromat")
-let filter = require("./steps/filter")
-let delay = require("./steps/delay")
-let queryRow = require("./steps/queryRows")
-let loop = require("./steps/loop")
-const env = require("../environment")
+import * as sendSmtpEmail from "./steps/sendSmtpEmail"
+import * as createRow from "./steps/createRow"
+import * as updateRow from "./steps/updateRow"
+import * as deleteRow from "./steps/deleteRow"
+import * as executeScript from "./steps/executeScript"
+import * as executeQuery from "./steps/executeQuery"
+import * as outgoingWebhook from "./steps/outgoingWebhook"
+import * as serverLog from "./steps/serverLog"
+import * as discord from "./steps/discord"
+import * as slack from "./steps/slack"
+import * as zapier from "./steps/zapier"
+import * as integromat from "./steps/integromat"
+import * as filter from "./steps/filter"
+import * as delay from "./steps/delay"
+import * as queryRow from "./steps/queryRows"
+import * as loop from "./steps/loop"
+import env from "../environment"
+import { AutomationStepSchema, AutomationStepInput } from "@budibase/types"
 
-const ACTION_IMPLS = {
+const ACTION_IMPLS: Record<
+  string,
+  (opts: AutomationStepInput) => Promise<any>
+> = {
   SEND_EMAIL_SMTP: sendSmtpEmail.run,
   CREATE_ROW: createRow.run,
   UPDATE_ROW: updateRow.run,
@@ -28,14 +32,13 @@ const ACTION_IMPLS = {
   DELAY: delay.run,
   FILTER: filter.run,
   QUERY_ROWS: queryRow.run,
-  LOOP: loop.run,
   // these used to be lowercase step IDs, maintain for backwards compat
   discord: discord.run,
   slack: slack.run,
   zapier: zapier.run,
   integromat: integromat.run,
 }
-const ACTION_DEFINITIONS = {
+export const ACTION_DEFINITIONS: Record<string, AutomationStepSchema> = {
   SEND_EMAIL_SMTP: sendSmtpEmail.definition,
   CREATE_ROW: createRow.definition,
   UPDATE_ROW: updateRow.definition,
@@ -60,15 +63,15 @@ const ACTION_DEFINITIONS = {
 // ran at all
 if (env.SELF_HOSTED) {
   const bash = require("./steps/bash")
+  // @ts-ignore
   ACTION_IMPLS["EXECUTE_BASH"] = bash.run
+  // @ts-ignore
   ACTION_DEFINITIONS["EXECUTE_BASH"] = bash.definition
 }
 
 /* istanbul ignore next */
-exports.getAction = async function (actionName) {
+export async function getAction(actionName: string) {
   if (ACTION_IMPLS[actionName] != null) {
     return ACTION_IMPLS[actionName]
   }
 }
-
-exports.ACTION_DEFINITIONS = ACTION_DEFINITIONS