@budibase/server 2.1.43-alpha.2 → 2.1.43

package/src/api/routes/public/index.ts

@@ -12,8 +12,11 @@ import env from "../../../environment"
 // below imports don't have declaration files
 const Router = require("@koa/router")
 const { RateLimit, Stores } = require("koa2-ratelimit")
-import { redis, permissions } from "@budibase/backend-core"
-const { PermissionType, PermissionLevel } = permissions
+const {
+  PermissionLevels,
+  PermissionTypes,
+} = require("@budibase/backend-core/permissions")
+const { getRedisOptions } = require("@budibase/backend-core/redis").utils
 
 const PREFIX = "/api/public/v1"
 // allow a lot more requests when in test
@@ -28,7 +31,7 @@ function getApiLimitPerSecond(): number {
 
 let rateLimitStore: any = null
 if (!env.isTest()) {
-  const REDIS_OPTS = redis.utils.getRedisOptions()
+  const REDIS_OPTS = getRedisOptions()
   let options
   if (REDIS_OPTS.redisProtocolUrl) {
     // fully qualified redis URL
@@ -102,7 +105,7 @@ function applyRoutes(
     : paramResource(resource)
   const publicApiMiddleware = publicApi({
     requiresAppId:
-      permType !== PermissionType.APP && permType !== PermissionType.USER,
+      permType !== PermissionTypes.APP && permType !== PermissionTypes.USER,
   })
   addMiddleware(endpoints.read, publicApiMiddleware)
   addMiddleware(endpoints.write, publicApiMiddleware)
@@ -110,8 +113,8 @@ function applyRoutes(
   addMiddleware(endpoints.read, paramMiddleware)
   addMiddleware(endpoints.write, paramMiddleware)
   // add the authorization middleware, using the correct perm type
-  addMiddleware(endpoints.read, authorized(permType, PermissionLevel.READ))
-  addMiddleware(endpoints.write, authorized(permType, PermissionLevel.WRITE))
+  addMiddleware(endpoints.read, authorized(permType, PermissionLevels.READ))
+  addMiddleware(endpoints.write, authorized(permType, PermissionLevels.WRITE))
   // add the output mapper middleware
   addMiddleware(endpoints.read, mapperMiddleware, { output: true })
   addMiddleware(endpoints.write, mapperMiddleware, { output: true })
@@ -119,12 +122,12 @@ function applyRoutes(
   addToRouter(endpoints.write)
 }
 
-applyRoutes(appEndpoints, PermissionType.APP, "appId")
-applyRoutes(tableEndpoints, PermissionType.TABLE, "tableId")
-applyRoutes(userEndpoints, PermissionType.USER, "userId")
-applyRoutes(queryEndpoints, PermissionType.QUERY, "queryId")
+applyRoutes(appEndpoints, PermissionTypes.APP, "appId")
+applyRoutes(tableEndpoints, PermissionTypes.TABLE, "tableId")
+applyRoutes(userEndpoints, PermissionTypes.USER, "userId")
+applyRoutes(queryEndpoints, PermissionTypes.QUERY, "queryId")
 // needs to be applied last for routing purposes, don't override other endpoints
-applyRoutes(rowEndpoints, PermissionType.TABLE, "tableId", "rowId")
+applyRoutes(rowEndpoints, PermissionTypes.TABLE, "tableId", "rowId")
 
 export default publicRouter
 

package/src/api/routes/public/tests/compare.spec.js

@@ -31,7 +31,7 @@ async function makeRequest(method, endpoint, body, appId = config.getAppId()) {
   if (body) {
     req.send(body)
   }
-  const res = await req
+  const res = await req.expect("Content-Type", /json/).expect(200)
   expect(res.body).toBeDefined()
   return res
 }

package/src/api/routes/{query.ts → query.js}

@@ -1,19 +1,22 @@
-import Router from "@koa/router"
-import * as queryController from "../controllers/query"
-import authorized from "../../middleware/authorized"
-import { permissions } from "@budibase/backend-core"
-import {
+const Router = require("@koa/router")
+const queryController = require("../controllers/query")
+const authorized = require("../../middleware/authorized")
+const {
+  PermissionLevels,
+  PermissionTypes,
+  BUILDER,
+} = require("@budibase/backend-core/permissions")
+const {
   bodyResource,
   bodySubResource,
   paramResource,
-} from "../../middleware/resourceId"
-import {
+} = require("../../middleware/resourceId")
+const {
   generateQueryPreviewValidation,
   generateQueryValidation,
-} from "../controllers/query/validation"
-const { BUILDER, PermissionType, PermissionLevel } = permissions
+} = require("../controllers/query/validation")
 
-const router: Router = new Router()
+const router = new Router()
 
 router
   .get("/api/queries", authorized(BUILDER), queryController.fetch)
@@ -35,27 +38,27 @@ router
   .get(
     "/api/queries/:queryId",
     paramResource("queryId"),
-    authorized(PermissionType.QUERY, PermissionLevel.READ),
+    authorized(PermissionTypes.QUERY, PermissionLevels.READ),
     queryController.find
   )
   // DEPRECATED - use new query endpoint for future work
   .post(
     "/api/queries/:queryId",
     paramResource("queryId"),
-    authorized(PermissionType.QUERY, PermissionLevel.WRITE),
+    authorized(PermissionTypes.QUERY, PermissionLevels.WRITE),
     queryController.executeV1
   )
+  .post(
+    "/api/v2/queries/:queryId",
+    paramResource("queryId"),
+    authorized(PermissionTypes.QUERY, PermissionLevels.WRITE),
+    queryController.executeV2
+  )
   .delete(
     "/api/queries/:queryId/:revId",
     paramResource("queryId"),
     authorized(BUILDER),
     queryController.destroy
   )
-  .post(
-    "/api/v2/queries/:queryId",
-    paramResource("queryId"),
-    authorized(PermissionType.QUERY, PermissionLevel.WRITE),
-    queryController.executeV2 as any
-  )
 
-export = router
+module.exports = router

package/src/api/routes/role.js

@@ -0,0 +1,15 @@
+const Router = require("@koa/router")
+const controller = require("../controllers/role")
+const authorized = require("../../middleware/authorized")
+const { BUILDER } = require("@budibase/backend-core/permissions")
+const { roleValidator } = require("./utils/validators")
+
+const router = new Router()
+
+router
+  .post("/api/roles", authorized(BUILDER), roleValidator(), controller.save)
+  .get("/api/roles", authorized(BUILDER), controller.fetch)
+  .get("/api/roles/:roleId", authorized(BUILDER), controller.find)
+  .delete("/api/roles/:roleId/:rev", authorized(BUILDER), controller.destroy)
+
+module.exports = router

package/src/api/routes/routing.js

@@ -0,0 +1,14 @@
+const Router = require("@koa/router")
+const authorized = require("../../middleware/authorized")
+const { BUILDER } = require("@budibase/backend-core/permissions")
+const controller = require("../controllers/routing")
+
+const router = new Router()
+
+router
+  // gets correct structure for user role
+  .get("/api/routing/client", controller.clientFetch)
+  // gets the full structure, not just the correct screen ID for user role
+  .get("/api/routing", authorized(BUILDER), controller.fetch)
+
+module.exports = router

package/src/api/routes/row.ts

@@ -2,11 +2,13 @@ import Router from "@koa/router"
 import * as rowController from "../controllers/row"
 import authorized from "../../middleware/authorized"
 import { paramResource, paramSubResource } from "../../middleware/resourceId"
-import { permissions } from "@budibase/backend-core"
+const {
+  PermissionLevels,
+  PermissionTypes,
+} = require("@budibase/backend-core/permissions")
 const { internalSearchValidator } = require("./utils/validators")
-const { PermissionType, PermissionLevel } = permissions
 
-const router: Router = new Router()
+const router = new Router()
 
 router
   /**
@@ -26,7 +28,7 @@ router
   .get(
     "/api/:tableId/:rowId/enrich",
     paramSubResource("tableId", "rowId"),
-    authorized(PermissionType.TABLE, PermissionLevel.READ),
+    authorized(PermissionTypes.TABLE, PermissionLevels.READ),
     rowController.fetchEnrichedRow
   )
   /**
@@ -46,7 +48,7 @@ router
   .get(
     "/api/:tableId/rows",
     paramResource("tableId"),
-    authorized(PermissionType.TABLE, PermissionLevel.READ),
+    authorized(PermissionTypes.TABLE, PermissionLevels.READ),
     rowController.fetch
   )
   /**
@@ -65,7 +67,7 @@ router
   .get(
     "/api/:tableId/rows/:rowId",
     paramSubResource("tableId", "rowId"),
-    authorized(PermissionType.TABLE, PermissionLevel.READ),
+    authorized(PermissionTypes.TABLE, PermissionLevels.READ),
     rowController.find
   )
   /**
@@ -135,7 +137,7 @@ router
     "/api/:tableId/search",
     internalSearchValidator(),
     paramResource("tableId"),
-    authorized(PermissionType.TABLE, PermissionLevel.READ),
+    authorized(PermissionTypes.TABLE, PermissionLevels.READ),
     rowController.search
   )
   // DEPRECATED - this is an old API, but for backwards compat it needs to be
@@ -143,7 +145,7 @@ router
   .post(
     "/api/search/:tableId/rows",
     paramResource("tableId"),
-    authorized(PermissionType.TABLE, PermissionLevel.READ),
+    authorized(PermissionTypes.TABLE, PermissionLevels.READ),
     rowController.search
   )
   /**
@@ -173,7 +175,7 @@ router
   .post(
     "/api/:tableId/rows",
     paramResource("tableId"),
-    authorized(PermissionType.TABLE, PermissionLevel.WRITE),
+    authorized(PermissionTypes.TABLE, PermissionLevels.WRITE),
     rowController.save
   )
   /**
@@ -187,7 +189,7 @@ router
   .patch(
     "/api/:tableId/rows",
     paramResource("tableId"),
-    authorized(PermissionType.TABLE, PermissionLevel.WRITE),
+    authorized(PermissionTypes.TABLE, PermissionLevels.WRITE),
     rowController.patch
   )
   /**
@@ -213,7 +215,7 @@ router
   .post(
     "/api/:tableId/rows/validate",
     paramResource("tableId"),
-    authorized(PermissionType.TABLE, PermissionLevel.WRITE),
+    authorized(PermissionTypes.TABLE, PermissionLevels.WRITE),
     rowController.validate
   )
   /**
@@ -239,7 +241,7 @@ router
   .delete(
     "/api/:tableId/rows",
     paramResource("tableId"),
-    authorized(PermissionType.TABLE, PermissionLevel.WRITE),
+    authorized(PermissionTypes.TABLE, PermissionLevels.WRITE),
     rowController.destroy
   )
 
@@ -259,7 +261,7 @@ router
   .post(
     "/api/:tableId/rows/exportRows",
     paramResource("tableId"),
-    authorized(PermissionType.TABLE, PermissionLevel.WRITE),
+    authorized(PermissionTypes.TABLE, PermissionLevels.WRITE),
     rowController.exportRows
   )
 

package/src/api/routes/screen.js

@@ -0,0 +1,18 @@
+const Router = require("@koa/router")
+const controller = require("../controllers/screen")
+const authorized = require("../../middleware/authorized")
+const { BUILDER } = require("@budibase/backend-core/permissions")
+const { screenValidator } = require("./utils/validators")
+
+const router = new Router()
+
+router
+  .get("/api/screens", authorized(BUILDER), controller.fetch)
+  .post("/api/screens", authorized(BUILDER), screenValidator(), controller.save)
+  .delete(
+    "/api/screens/:screenId/:screenRev",
+    authorized(BUILDER),
+    controller.destroy
+  )
+
+module.exports = router

package/src/api/routes/script.js

@@ -0,0 +1,10 @@
+const Router = require("@koa/router")
+const controller = require("../controllers/script")
+const authorized = require("../../middleware/authorized")
+const { BUILDER } = require("@budibase/backend-core/permissions")
+
+const router = new Router()
+
+router.post("/api/script", authorized(BUILDER), controller.save)
+
+module.exports = router

package/src/api/routes/static.ts

@@ -2,12 +2,15 @@ import Router from "@koa/router"
 import * as controller from "../controllers/static"
 import { budibaseTempDir } from "../../utilities/budibaseDir"
 import authorized from "../../middleware/authorized"
-import { permissions } from "@budibase/backend-core"
+import {
+  BUILDER,
+  PermissionTypes,
+  PermissionLevels,
+} from "@budibase/backend-core/permissions"
 import * as env from "../../environment"
 import { paramResource } from "../../middleware/resourceId"
-const { BUILDER, PermissionType, PermissionLevel } = permissions
 
-const router: Router = new Router()
+const router = new Router()
 
 /* istanbul ignore next */
 router.param("file", async (file: any, ctx: any, next: any) => {
@@ -44,13 +47,13 @@ router
   .post(
     "/api/attachments/:tableId/upload",
     paramResource("tableId"),
-    authorized(PermissionType.TABLE, PermissionLevel.WRITE),
+    authorized(PermissionTypes.TABLE, PermissionLevels.WRITE),
     controller.uploadFile
   )
   .post(
     "/api/attachments/:tableId/delete",
     paramResource("tableId"),
-    authorized(PermissionType.TABLE, PermissionLevel.WRITE),
+    authorized(PermissionTypes.TABLE, PermissionLevels.WRITE),
     controller.deleteObjects
   )
   .get("/app/preview", authorized(BUILDER), controller.serveBuilderPreview)
@@ -58,8 +61,8 @@ router
   .get("/app/:appUrl/:path*", controller.serveApp)
   .post(
     "/api/attachments/:datasourceId/url",
-    authorized(PermissionType.TABLE, PermissionLevel.READ),
+    authorized(PermissionTypes.TABLE, PermissionLevels.READ),
     controller.getSignedUploadURL
   )
 
-export = router
+export default router

package/src/api/routes/{table.ts → table.js}

@@ -1,12 +1,15 @@
-import Router from "@koa/router"
-import * as tableController from "../controllers/table"
-import authorized from "../../middleware/authorized"
-import { paramResource, bodyResource } from "../../middleware/resourceId"
-import { permissions } from "@budibase/backend-core"
-import { tableValidator } from "./utils/validators"
-const { BUILDER, PermissionLevel, PermissionType } = permissions
+const Router = require("@koa/router")
+const tableController = require("../controllers/table")
+const authorized = require("../../middleware/authorized")
+const { paramResource, bodyResource } = require("../../middleware/resourceId")
+const {
+  BUILDER,
+  PermissionLevels,
+  PermissionTypes,
+} = require("@budibase/backend-core/permissions")
+const { tableValidator } = require("./utils/validators")
 
-const router: Router = new Router()
+const router = new Router()
 
 router
   /**
@@ -37,7 +40,7 @@ router
   .get(
     "/api/tables/:tableId",
     paramResource("tableId"),
-    authorized(PermissionType.TABLE, PermissionLevel.READ, { schema: true }),
+    authorized(PermissionTypes.TABLE, PermissionLevels.READ, { schema: true }),
     tableController.find
   )
   /**
@@ -190,4 +193,4 @@ router
     tableController.bulkImport
   )
 
-export = router
+module.exports = router

package/src/api/routes/templates.js

@@ -0,0 +1,16 @@
+const Router = require("@koa/router")
+const controller = require("../controllers/templates")
+const authorized = require("../../middleware/authorized")
+const { BUILDER } = require("@budibase/backend-core/permissions")
+
+const router = new Router()
+
+router
+  .get("/api/templates", authorized(BUILDER), controller.fetch)
+  .get(
+    "/api/templates/:type/:name",
+    authorized(BUILDER),
+    controller.downloadTemplate
+  )
+
+module.exports = router

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

@@ -43,7 +43,7 @@ describe("/static", () => {
 
     it("should ping from app", async () => {
       const headers = config.defaultHeaders()
-      headers[constants.Header.APP_ID] = config.prodAppId
+      headers[constants.Headers.APP_ID] = config.prodAppId
 
       await request
         .post("/api/bbtel/ping")

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

@@ -1,12 +1,4 @@
-jest.mock("@budibase/backend-core", () => {
-  const core = jest.requireActual("@budibase/backend-core")
-  return {
-    ...core,
-    objectStore: {
-      budibaseTempDir: core.objectStore.budibaseTempDir,
-    },
-  }
-})
+jest.mock("../../../utilities/fileSystem/utilities")
 
 const { checkBuilderEndpoint } = require("./utilities/TestFunctions")
 const setup = require("./utilities")

package/src/api/routes/tests/deployment.spec.ts

@@ -1,4 +1,4 @@
-import * as setup from "./utilities"
+import setup from "./utilities"
 import { events } from "@budibase/backend-core"
 
 describe("/deployments", () => {

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

@@ -1,7 +1,6 @@
-const { roles } = require("@budibase/backend-core")
+const { BUILTIN_ROLE_IDS } = require("@budibase/backend-core/roles")
 const setup = require("./utilities")
 const { basicRow } = setup.structures
-const { BUILTIN_ROLE_IDS } = roles
 
 const HIGHER_ROLE_ID = BUILTIN_ROLE_IDS.BASIC
 const STD_ROLE_ID = BUILTIN_ROLE_IDS.PUBLIC

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

@@ -4,21 +4,16 @@ jest.mock("node-fetch")
 
 // Mock isProdAppID to we can later mock the implementation and pretend we are
 // using prod app IDs
-jest.mock("@budibase/backend-core", () => {
-  const core = jest.requireActual("@budibase/backend-core")
-  return {
-    ...core,
-    db: {
-      ...core.db,
-      isProdAppID: jest.fn(),
-    }
-  }
-})
+const authDb = require("@budibase/backend-core/db")
+const { isProdAppID } = authDb
+const mockIsProdAppID = jest.fn(isProdAppID)
+authDb.isProdAppID = mockIsProdAppID
+
 const setup = require("./utilities")
 const { checkBuilderEndpoint } = require("./utilities/TestFunctions")
 const { checkCacheForDynamicVariable } = require("../../../threads/utils")
 const { basicQuery, basicDatasource } = setup.structures
-const { events, db: dbCore } = require("@budibase/backend-core")
+const { events } = require("@budibase/backend-core")
 
 describe("/queries", () => {
   let request = setup.getRequest()
@@ -157,8 +152,8 @@ describe("/queries", () => {
 
     it("should remove sensitive info for prod apps", async () => {
       // Mock isProdAppID to pretend we are using a prod app
-      dbCore.isProdAppID.mockClear()
-      dbCore.isProdAppID.mockImplementation(() => true)
+      mockIsProdAppID.mockClear()
+      mockIsProdAppID.mockImplementation(() => true)
 
       const query = await config.createQuery()
       const res = await request
@@ -172,8 +167,8 @@ describe("/queries", () => {
       expect(res.body.schema).toBeDefined()
 
       // Reset isProdAppID mock
-      expect(dbCore.isProdAppID).toHaveBeenCalledTimes(1)
-      dbCore.isProdAppID.mockImplementation(() => false)
+      expect(mockIsProdAppID).toHaveBeenCalledTimes(1)
+      mockIsProdAppID.mockImplementation(isProdAppID)
     })
   })
 

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

@@ -1,8 +1,10 @@
-const { roles, events, permissions } = require("@budibase/backend-core")
+const { BUILTIN_ROLE_IDS } = require("@budibase/backend-core/roles")
+const {
+  BUILTIN_PERMISSION_IDS,
+} = require("@budibase/backend-core/permissions")
 const setup = require("./utilities")
 const { basicRole } = setup.structures
-const { BUILTIN_ROLE_IDS } = roles
-const { BuiltinPermissionID } = permissions
+const { events } = require("@budibase/backend-core")
 
 describe("/roles", () => {
   let request = setup.getRequest()
@@ -74,18 +76,18 @@ describe("/roles", () => {
       const adminRole = res.body.find(r => r._id === BUILTIN_ROLE_IDS.ADMIN)
       expect(adminRole).toBeDefined()
       expect(adminRole.inherits).toEqual(BUILTIN_ROLE_IDS.POWER)
-      expect(adminRole.permissionId).toEqual(BuiltinPermissionID.ADMIN)
+      expect(adminRole.permissionId).toEqual(BUILTIN_PERMISSION_IDS.ADMIN)
 
       const powerUserRole = res.body.find(r => r._id === BUILTIN_ROLE_IDS.POWER)
       expect(powerUserRole).toBeDefined()
       expect(powerUserRole.inherits).toEqual(BUILTIN_ROLE_IDS.BASIC)
-      expect(powerUserRole.permissionId).toEqual(BuiltinPermissionID.POWER)
+      expect(powerUserRole.permissionId).toEqual(BUILTIN_PERMISSION_IDS.POWER)
 
       const customRoleFetched = res.body.find(r => r._id === customRole._id)
       expect(customRoleFetched).toBeDefined()
       expect(customRoleFetched.inherits).toEqual(BUILTIN_ROLE_IDS.BASIC)
       expect(customRoleFetched.permissionId).toEqual(
-        BuiltinPermissionID.READ_ONLY
+        BUILTIN_PERMISSION_IDS.READ_ONLY
       )
     })
 
@@ -107,7 +109,7 @@ describe("/roles", () => {
     it("should delete custom roles", async () => {
       const customRole = await config.createRole({
         name: "user",
-        permissionId: BuiltinPermissionID.READ_ONLY,
+        permissionId: BUILTIN_PERMISSION_IDS.READ_ONLY,
         inherits: BUILTIN_ROLE_IDS.BASIC,
       })
       delete customRole._rev_tree

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

@@ -1,8 +1,7 @@
 const setup = require("./utilities")
 const { basicScreen } = setup.structures
 const { checkBuilderEndpoint, runInProd } = require("./utilities/TestFunctions")
-const { roles } = require("@budibase/backend-core")
-const { BUILTIN_ROLE_IDS } = roles
+const { BUILTIN_ROLE_IDS } = require("@budibase/backend-core/roles")
 
 const route = "/test"
 

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

@@ -1,7 +1,8 @@
 const { outputProcessing } = require("../../../utilities/rowProcessor")
 const setup = require("./utilities")
 const { basicRow } = setup.structures
-const { context, tenancy } = require("@budibase/backend-core")
+const { doInAppContext } = require("@budibase/backend-core/context")
+const { doInTenant } = require("@budibase/backend-core/tenancy")
 const {
   quotas,
 } = require("@budibase/pro")
@@ -446,7 +447,7 @@ describe("/rows", () => {
 
   describe("fetchEnrichedRows", () => {
     it("should allow enriching some linked rows", async () => {
-      const { table, firstRow, secondRow } = await tenancy.doInTenant(
+      const { table, firstRow, secondRow } = await doInTenant(
         setup.structures.TENANT_ID,
         async () => {
           const table = await config.createLinkedTable()
@@ -506,7 +507,7 @@ describe("/rows", () => {
       })
       // the environment needs configured for this
       await setup.switchToSelfHosted(async () => {
-        context.doInAppContext(config.getAppId(), async () => {
+        doInAppContext(config.getAppId(), async () => {
           const enriched = await outputProcessing(table, [row])
           expect(enriched[0].attachment[0].url).toBe(
             `/prod-budi-app-assets/${config.getAppId()}/attachments/test/thing.csv`

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

@@ -46,7 +46,7 @@ describe("/static", () => {
 
     it("should serve the app by id", async () => {
       const headers = config.defaultHeaders()
-      delete headers[constants.Header.APP_ID]
+      delete headers[constants.Headers.APP_ID]
 
       const res = await request
         .get(`/${config.prodAppId}`)
@@ -58,7 +58,7 @@ describe("/static", () => {
 
     it("should serve the app by url", async () => {
       const headers = config.defaultHeaders()
-      delete headers[constants.Header.APP_ID]
+      delete headers[constants.Headers.APP_ID]
 
       const res = await request
         .get(`/app${config.prodApp.url}`)