@budibase/server 2.1.43-alpha.6 → 2.1.44

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

@@ -1,18 +1,17 @@
 const { checkBuilderEndpoint } = require("./utilities/TestFunctions")
+const { getAppDB } = require("@budibase/backend-core/context")
 const setup = require("./utilities")
 const { basicTable } = setup.structures
-const { events, context } = require("@budibase/backend-core")
+const { events } = require("@budibase/backend-core")
 
 describe("/tables", () => {
   let request = setup.getRequest()
   let config = setup.getConfig()
-  let appId
 
   afterAll(setup.afterAll)
 
   beforeEach(async () => {
-    const app = await config.init()
-    appId = app.appId
+    await config.init()
   })
 
   describe("create", () => {
@@ -200,6 +199,38 @@ 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
@@ -218,40 +249,6 @@ 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
 
@@ -271,7 +268,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, tableId: testTable._id })
+      expect(events.table.deleted).toBeCalledWith(testTable)
     })
 
     it("deletes linked references to the table after deletion", async () => {
@@ -288,7 +285,6 @@ describe("/tables", () => {
           },
           TestTable: {
             type: "link",
-            fieldName: "TestTable",
             tableId: testTable._id,
             constraints: {
               type: "array"

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

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

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

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

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

@@ -347,7 +347,7 @@ describe("/views", () => {
 
     const setupExport = async () => {
       const table = await config.createTable()
-      await config.createRow({ name: "test-name", description: "ùúûü" })
+      await config.createRow({ name: "test-name", description: "test-desc" })
       return table
     }
 
@@ -362,11 +362,11 @@ describe("/views", () => {
       const rows = JSON.parse(res.text)
       expect(rows.length).toBe(1)
       expect(rows[0].name).toBe("test-name")
-      expect(rows[0].description).toBe("ùúûü")
+      expect(rows[0].description).toBe("test-desc")
     }
 
     const assertCSVExport = (res) => {
-      expect(res.text).toBe(`"name","description"\n"test-name","ùúûü"`)
+      expect(res.text).toBe("\"name\",\"description\"\n\"test-name\",\"test-desc\"")
     }
 
     it("should be able to export a table as JSON", async () => {

package/src/api/routes/user.js

@@ -0,0 +1,53 @@
+const Router = require("@koa/router")
+const controller = require("../controllers/user")
+const authorized = require("../../middleware/authorized")
+const {
+  PermissionLevels,
+  PermissionTypes,
+} = require("@budibase/backend-core/permissions")
+
+const router = new Router()
+
+router
+  .get(
+    "/api/users/metadata",
+    authorized(PermissionTypes.USER, PermissionLevels.READ),
+    controller.fetchMetadata
+  )
+  .get(
+    "/api/users/metadata/:id",
+    authorized(PermissionTypes.USER, PermissionLevels.READ),
+    controller.findMetadata
+  )
+  .put(
+    "/api/users/metadata",
+    authorized(PermissionTypes.USER, PermissionLevels.WRITE),
+    controller.updateMetadata
+  )
+  .post(
+    "/api/users/metadata/self",
+    authorized(PermissionTypes.USER, PermissionLevels.WRITE),
+    controller.updateSelfMetadata
+  )
+  .delete(
+    "/api/users/metadata/:id",
+    authorized(PermissionTypes.USER, PermissionLevels.WRITE),
+    controller.destroyMetadata
+  )
+  .post(
+    "/api/users/metadata/sync/:id",
+    authorized(PermissionTypes.USER, PermissionLevels.WRITE),
+    controller.syncUser
+  )
+  .post(
+    "/api/users/flags",
+    authorized(PermissionTypes.USER, PermissionLevels.WRITE),
+    controller.setFlag
+  )
+  .get(
+    "/api/users/flags",
+    authorized(PermissionTypes.USER, PermissionLevels.READ),
+    controller.getFlags
+  )
+
+module.exports = router

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

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

package/src/api/routes/view.js

@@ -0,0 +1,31 @@
+const Router = require("@koa/router")
+const viewController = require("../controllers/view")
+const rowController = require("../controllers/row")
+const authorized = require("../../middleware/authorized")
+const { paramResource } = require("../../middleware/resourceId")
+const {
+  BUILDER,
+  PermissionTypes,
+  PermissionLevels,
+} = require("@budibase/backend-core/permissions")
+
+const router = new Router()
+
+router
+  .get("/api/views/export", authorized(BUILDER), viewController.exportView)
+  .get(
+    "/api/views/:viewName",
+    paramResource("viewName"),
+    authorized(PermissionTypes.VIEW, PermissionLevels.READ),
+    rowController.fetchView
+  )
+  .get("/api/views", authorized(BUILDER), viewController.fetch)
+  .delete(
+    "/api/views/:viewName",
+    paramResource("viewName"),
+    authorized(BUILDER),
+    viewController.destroy
+  )
+  .post("/api/views", authorized(BUILDER), viewController.save)
+
+module.exports = 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: Router = new Router()
+const 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 = router
+export default router

package/src/app.ts

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