@budibase/worker 2.1.42 → 2.1.43-alpha.1

package/src/api/routes/global/tests/users.spec.ts

@@ -6,14 +6,12 @@ import {
   mocks,
   structures,
   TENANT_1,
-  API,
 } from "../../../../tests"
 const sendMailMock = mocks.email.mock()
 import { events, tenancy } from "@budibase/backend-core"
 
 describe("/api/global/users", () => {
   const config = new TestConfiguration()
-  const api = new API(config)
 
   beforeAll(async () => {
     await config.beforeAll()
@@ -30,7 +28,10 @@ describe("/api/global/users", () => {
   describe("invite", () => {
     it("should be able to generate an invitation", async () => {
       const email = structures.users.newEmail()
-      const { code, res } = await api.users.sendUserInvite(sendMailMock, email)
+      const { code, res } = await config.api.users.sendUserInvite(
+        sendMailMock,
+        email
+      )
 
       expect(res.body).toEqual({ message: "Invitation has been sent." })
       expect(sendMailMock).toHaveBeenCalled()
@@ -39,7 +40,7 @@ describe("/api/global/users", () => {
     })
 
     it("should not be able to generate an invitation for existing user", async () => {
-      const { code, res } = await api.users.sendUserInvite(
+      const { code, res } = await config.api.users.sendUserInvite(
         sendMailMock,
         config.defaultUser!.email,
         400
@@ -53,9 +54,12 @@ describe("/api/global/users", () => {
 
     it("should be able to create new user from invite", async () => {
       const email = structures.users.newEmail()
-      const { code } = await api.users.sendUserInvite(sendMailMock, email)
+      const { code } = await config.api.users.sendUserInvite(
+        sendMailMock,
+        email
+      )
 
-      const res = await api.users.acceptInvite(code)
+      const res = await config.api.users.acceptInvite(code)
 
       expect(res.body._id).toBeDefined()
       const user = await config.getUser(email)
@@ -74,7 +78,7 @@ describe("/api/global/users", () => {
       })
       const request = [newUserInvite(), newUserInvite()]
 
-      const res = await api.users.sendMultiUserInvite(request)
+      const res = await config.api.users.sendMultiUserInvite(request)
 
       const body = res.body as InviteUsersResponse
       expect(body.successful.length).toBe(2)
@@ -86,7 +90,7 @@ describe("/api/global/users", () => {
     it("should not be able to generate an invitation for existing user", async () => {
       const request = [{ email: config.defaultUser!.email, userInfo: {} }]
 
-      const res = await api.users.sendMultiUserInvite(request)
+      const res = await config.api.users.sendMultiUserInvite(request)
 
       const body = res.body as InviteUsersResponse
       expect(body.successful.length).toBe(0)
@@ -102,7 +106,7 @@ describe("/api/global/users", () => {
       const user = await config.createUser()
       jest.clearAllMocks()
 
-      const response = await api.users.bulkCreateUsers([user])
+      const response = await config.api.users.bulkCreateUsers([user])
 
       expect(response.created?.successful.length).toBe(0)
       expect(response.created?.unsuccessful.length).toBe(1)
@@ -115,7 +119,7 @@ describe("/api/global/users", () => {
       jest.resetAllMocks()
 
       await tenancy.doInTenant(TENANT_1, async () => {
-        const response = await api.users.bulkCreateUsers([user])
+        const response = await config.api.users.bulkCreateUsers([user])
 
         expect(response.created?.successful.length).toBe(0)
         expect(response.created?.unsuccessful.length).toBe(1)
@@ -126,11 +130,11 @@ describe("/api/global/users", () => {
 
     it("should ignore accounts using the same email", async () => {
       const account = structures.accounts.account()
-      const resp = await api.accounts.saveMetadata(account)
+      const resp = await config.api.accounts.saveMetadata(account)
       const user = structures.users.user({ email: resp.email })
       jest.clearAllMocks()
 
-      const response = await api.users.bulkCreateUsers([user])
+      const response = await config.api.users.bulkCreateUsers([user])
 
       expect(response.created?.successful.length).toBe(0)
       expect(response.created?.unsuccessful.length).toBe(1)
@@ -143,7 +147,11 @@ describe("/api/global/users", () => {
       const admin = structures.users.adminUser()
       const user = structures.users.user()
 
-      const response = await api.users.bulkCreateUsers([builder, admin, user])
+      const response = await config.api.users.bulkCreateUsers([
+        builder,
+        admin,
+        user,
+      ])
 
       expect(response.created?.successful.length).toBe(3)
       expect(response.created?.successful[0].email).toBe(builder.email)
@@ -160,7 +168,7 @@ describe("/api/global/users", () => {
     it("should be able to create a basic user", async () => {
       const user = structures.users.user()
 
-      await api.users.saveUser(user)
+      await config.api.users.saveUser(user)
 
       expect(events.user.created).toBeCalledTimes(1)
       expect(events.user.updated).not.toBeCalled()
@@ -171,7 +179,7 @@ describe("/api/global/users", () => {
     it("should be able to create an admin user", async () => {
       const user = structures.users.adminUser()
 
-      await api.users.saveUser(user)
+      await config.api.users.saveUser(user)
 
       expect(events.user.created).toBeCalledTimes(1)
       expect(events.user.updated).not.toBeCalled()
@@ -182,7 +190,7 @@ describe("/api/global/users", () => {
     it("should be able to create a builder user", async () => {
       const user = structures.users.builderUser()
 
-      await api.users.saveUser(user)
+      await config.api.users.saveUser(user)
 
       expect(events.user.created).toBeCalledTimes(1)
       expect(events.user.updated).not.toBeCalled()
@@ -197,7 +205,7 @@ describe("/api/global/users", () => {
         app_456: "role2",
       }
 
-      await api.users.saveUser(user)
+      await config.api.users.saveUser(user)
 
       const savedUser = await config.getUser(user.email)
       expect(events.user.created).toBeCalledTimes(1)
@@ -213,7 +221,7 @@ describe("/api/global/users", () => {
       delete user._id
       delete user._rev
 
-      const response = await api.users.saveUser(user, 400)
+      const response = await config.api.users.saveUser(user, 400)
 
       expect(response.body.message).toBe(`Unavailable`)
       expect(events.user.created).toBeCalledTimes(0)
@@ -225,7 +233,7 @@ describe("/api/global/users", () => {
 
       await tenancy.doInTenant(TENANT_1, async () => {
         delete user._id
-        const response = await api.users.saveUser(user, 400)
+        const response = await config.api.users.saveUser(user, 400)
 
         expect(response.body.message).toBe(`Unavailable`)
         expect(events.user.created).toBeCalledTimes(0)
@@ -237,7 +245,7 @@ describe("/api/global/users", () => {
       const account = structures.accounts.cloudAccount()
       mocks.accounts.getAccount.mockReturnValueOnce(account)
 
-      const response = await api.users.saveUser(user, 400)
+      const response = await config.api.users.saveUser(user, 400)
 
       expect(response.body.message).toBe(`Unavailable`)
       expect(events.user.created).toBeCalledTimes(0)
@@ -245,20 +253,20 @@ describe("/api/global/users", () => {
 
     it("should not be able to create a user with the same email and different casing", async () => {
       const user = structures.users.user()
-      await api.users.saveUser(user)
+      await config.api.users.saveUser(user)
 
       user.email = user.email.toUpperCase()
-      await api.users.saveUser(user, 400)
+      await config.api.users.saveUser(user, 400)
 
       expect(events.user.created).toBeCalledTimes(1)
     })
 
     it("should not be able to bulk create a user with the same email and different casing", async () => {
       const user = structures.users.user()
-      await api.users.saveUser(user)
+      await config.api.users.saveUser(user)
 
       user.email = user.email.toUpperCase()
-      await api.users.bulkCreateUsers([user])
+      await config.api.users.bulkCreateUsers([user])
 
       expect(events.user.created).toBeCalledTimes(1)
     })
@@ -268,7 +276,11 @@ describe("/api/global/users", () => {
       await config.createSession(nonAdmin)
 
       const newUser = structures.users.user()
-      await api.users.saveUser(newUser, 403, config.authHeaders(nonAdmin))
+      await config.api.users.saveUser(
+        newUser,
+        403,
+        config.authHeaders(nonAdmin)
+      )
     })
   })
 
@@ -277,7 +289,7 @@ describe("/api/global/users", () => {
       const user = await config.createUser()
       jest.clearAllMocks()
 
-      await api.users.saveUser(user)
+      await config.api.users.saveUser(user)
 
       expect(events.user.created).not.toBeCalled()
       expect(events.user.updated).toBeCalledTimes(1)
@@ -292,7 +304,7 @@ describe("/api/global/users", () => {
 
       user.forceResetPassword = true
       user.password = "tempPassword"
-      await api.users.saveUser(user)
+      await config.api.users.saveUser(user)
 
       expect(events.user.created).not.toBeCalled()
       expect(events.user.updated).toBeCalledTimes(1)
@@ -305,7 +317,7 @@ describe("/api/global/users", () => {
       const user = await config.createUser()
       jest.clearAllMocks()
 
-      await api.users.saveUser(structures.users.adminUser(user))
+      await config.api.users.saveUser(structures.users.adminUser(user))
 
       expect(events.user.created).not.toBeCalled()
       expect(events.user.updated).toBeCalledTimes(1)
@@ -317,7 +329,7 @@ describe("/api/global/users", () => {
       const user = await config.createUser()
       jest.clearAllMocks()
 
-      await api.users.saveUser(structures.users.builderUser(user))
+      await config.api.users.saveUser(structures.users.builderUser(user))
 
       expect(events.user.created).not.toBeCalled()
       expect(events.user.updated).toBeCalledTimes(1)
@@ -331,7 +343,7 @@ describe("/api/global/users", () => {
       user.admin!.global = false
       user.builder!.global = false
 
-      await api.users.saveUser(user)
+      await config.api.users.saveUser(user)
 
       expect(events.user.created).not.toBeCalled()
       expect(events.user.updated).toBeCalledTimes(1)
@@ -344,7 +356,7 @@ describe("/api/global/users", () => {
       jest.clearAllMocks()
       user.builder!.global = false
 
-      await api.users.saveUser(user)
+      await config.api.users.saveUser(user)
 
       expect(events.user.created).not.toBeCalled()
       expect(events.user.updated).toBeCalledTimes(1)
@@ -360,7 +372,7 @@ describe("/api/global/users", () => {
         app_456: "role2",
       }
 
-      await api.users.saveUser(user)
+      await config.api.users.saveUser(user)
 
       const savedUser = await config.getUser(user.email)
       expect(events.user.created).not.toBeCalled()
@@ -380,7 +392,7 @@ describe("/api/global/users", () => {
       jest.clearAllMocks()
       user.roles = {}
 
-      await api.users.saveUser(user)
+      await config.api.users.saveUser(user)
 
       const savedUser = await config.getUser(user.email)
       expect(events.user.created).not.toBeCalled()
@@ -403,7 +415,7 @@ describe("/api/global/users", () => {
         app_456: "role2-edit",
       }
 
-      await api.users.saveUser(user)
+      await config.api.users.saveUser(user)
 
       const savedUser = await config.getUser(user.email)
       expect(events.user.created).not.toBeCalled()
@@ -419,7 +431,7 @@ describe("/api/global/users", () => {
       const user = await config.createUser(structures.users.user({ email }))
       user.email = "new@test.com"
 
-      const response = await api.users.saveUser(user, 400)
+      const response = await config.api.users.saveUser(user, 400)
 
       const dbUser = await config.getUser(email)
       user.email = email
@@ -432,7 +444,11 @@ describe("/api/global/users", () => {
       const nonAdmin = await config.createUser(structures.users.builderUser())
       await config.createSession(nonAdmin)
 
-      await api.users.saveUser(existingUser, 200, config.authHeaders(nonAdmin))
+      await config.api.users.saveUser(
+        existingUser,
+        200,
+        config.authHeaders(nonAdmin)
+      )
     })
   })
 
@@ -440,7 +456,7 @@ describe("/api/global/users", () => {
     it("should not be able to bulk delete current user", async () => {
       const user = await config.defaultUser!
 
-      const response = await api.users.bulkDeleteUsers([user._id!], 400)
+      const response = await config.api.users.bulkDeleteUsers([user._id!], 400)
 
       expect(response.message).toBe("Unable to delete self.")
       expect(events.user.deleted).not.toBeCalled()
@@ -452,7 +468,7 @@ describe("/api/global/users", () => {
       account.budibaseUserId = user._id!
       mocks.accounts.getAccountByTenantId.mockReturnValue(account)
 
-      const response = await api.users.bulkDeleteUsers([user._id!])
+      const response = await config.api.users.bulkDeleteUsers([user._id!])
 
       expect(response.deleted?.successful.length).toBe(0)
       expect(response.deleted?.unsuccessful.length).toBe(1)
@@ -470,7 +486,7 @@ describe("/api/global/users", () => {
       const builder = structures.users.builderUser()
       const admin = structures.users.adminUser()
       const user = structures.users.user()
-      const createdUsers = await api.users.bulkCreateUsers([
+      const createdUsers = await config.api.users.bulkCreateUsers([
         builder,
         admin,
         user,
@@ -479,7 +495,7 @@ describe("/api/global/users", () => {
       const toDelete = createdUsers.created?.successful.map(
         u => u._id!
       ) as string[]
-      const response = await api.users.bulkDeleteUsers(toDelete)
+      const response = await config.api.users.bulkDeleteUsers(toDelete)
 
       expect(response.deleted?.successful.length).toBe(3)
       expect(response.deleted?.unsuccessful.length).toBe(0)
@@ -494,7 +510,7 @@ describe("/api/global/users", () => {
       const user = await config.createUser()
       jest.clearAllMocks()
 
-      await api.users.deleteUser(user._id!)
+      await config.api.users.deleteUser(user._id!)
 
       expect(events.user.deleted).toBeCalledTimes(1)
       expect(events.user.permissionBuilderRemoved).not.toBeCalled()
@@ -505,7 +521,7 @@ describe("/api/global/users", () => {
       const user = await config.createUser(structures.users.adminUser())
       jest.clearAllMocks()
 
-      await api.users.deleteUser(user._id!)
+      await config.api.users.deleteUser(user._id!)
 
       expect(events.user.deleted).toBeCalledTimes(1)
       expect(events.user.permissionBuilderRemoved).toBeCalledTimes(1)
@@ -516,7 +532,7 @@ describe("/api/global/users", () => {
       const user = await config.createUser(structures.users.builderUser())
       jest.clearAllMocks()
 
-      await api.users.deleteUser(user._id!)
+      await config.api.users.deleteUser(user._id!)
 
       expect(events.user.deleted).toBeCalledTimes(1)
       expect(events.user.permissionBuilderRemoved).toBeCalledTimes(1)
@@ -528,7 +544,7 @@ describe("/api/global/users", () => {
       const account = structures.accounts.cloudAccount()
       mocks.accounts.getAccount.mockReturnValueOnce(account)
 
-      const response = await api.users.deleteUser(user._id!, 400)
+      const response = await config.api.users.deleteUser(user._id!, 400)
 
       expect(response.body.message).toBe("Account holder cannot be deleted")
     })
@@ -539,7 +555,7 @@ describe("/api/global/users", () => {
       account.email = user.email
       mocks.accounts.getAccount.mockReturnValueOnce(account)
 
-      const response = await api.users.deleteUser(user._id!, 400)
+      const response = await config.api.users.deleteUser(user._id!, 400)
 
       expect(response.body.message).toBe("Unable to delete self.")
     })

package/src/api/routes/global/tests/workspaces.spec.ts

@@ -0,0 +1,29 @@
+import { TestConfiguration } from "../../../../tests"
+
+// TODO
+
+describe("/api/global/workspaces", () => {
+  const config = new TestConfiguration()
+
+  beforeAll(async () => {
+    await config.beforeAll()
+  })
+
+  afterAll(async () => {
+    await config.afterAll()
+  })
+
+  afterEach(() => {
+    jest.clearAllMocks()
+  })
+
+  describe("GET /api/global/workspaces", () => {
+    it("retrieves workspaces", () => {})
+  })
+
+  describe("DELETE /api/global/workspaces/:id", () => {})
+
+  describe("GET /api/global/workspaces", () => {})
+
+  describe("GET /api/global/workspaces/:id", () => {})
+})

package/src/api/routes/global/{users.js → users.ts}

@@ -1,17 +1,15 @@
-const Router = require("@koa/router")
-const controller = require("../../controllers/global/users")
-const { joiValidator } = require("@budibase/backend-core/auth")
-const { adminOnly } = require("@budibase/backend-core/auth")
-const Joi = require("joi")
-const cloudRestricted = require("../../../middleware/cloudRestricted")
-const { users } = require("../validation")
-const selfController = require("../../controllers/global/self")
-const { builderOrAdmin } = require("@budibase/backend-core/auth")
+import Router from "@koa/router"
+import * as controller from "../../controllers/global/users"
+import { auth } from "@budibase/backend-core"
+import Joi from "joi"
+import cloudRestricted from "../../../middleware/cloudRestricted"
+import { users } from "../validation"
+import * as selfController from "../../controllers/global/self"
 
-const router = new Router()
+const router: Router = new Router()
 
 function buildAdminInitValidation() {
-  return joiValidator.body(
+  return auth.joiValidator.body(
     Joi.object({
       email: Joi.string().required(),
       password: Joi.string(),
@@ -24,7 +22,7 @@ function buildAdminInitValidation() {
 
 function buildInviteValidation() {
   // prettier-ignore
-  return joiValidator.body(Joi.object({
+  return auth.joiValidator.body(Joi.object({
     email: Joi.string().required(),
     userInfo: Joi.object().optional(),
   }).required())
@@ -32,7 +30,7 @@ function buildInviteValidation() {
 
 function buildInviteMultipleValidation() {
   // prettier-ignore
-  return joiValidator.body(Joi.array().required().items(
+  return auth.joiValidator.body(Joi.array().required().items(
     Joi.object({
       email: Joi.string(),
       userInfo: Joi.object().optional(),
@@ -40,17 +38,17 @@ function buildInviteMultipleValidation() {
   ))
 }
 
-const createUserAdminOnly = (ctx, next) => {
+const createUserAdminOnly = (ctx: any, next: any) => {
   if (!ctx.request.body._id) {
-    return adminOnly(ctx, next)
+    return auth.adminOnly(ctx, next)
   } else {
-    return builderOrAdmin(ctx, next)
+    return auth.builderOrAdmin(ctx, next)
   }
 }
 
 function buildInviteAcceptValidation() {
   // prettier-ignore
-  return joiValidator.body(Joi.object({
+  return auth.joiValidator.body(Joi.object({
     inviteCode: Joi.string().required(),
     password: Joi.string().required(),
   }).required().unknown(true))
@@ -65,25 +63,29 @@ router
   )
   .post(
     "/api/global/users/bulk",
-    adminOnly,
+    auth.adminOnly,
     users.buildUserBulkUserValidation(),
     controller.bulkUpdate
   )
 
-  .get("/api/global/users", builderOrAdmin, controller.fetch)
-  .post("/api/global/users/search", builderOrAdmin, controller.search)
-  .delete("/api/global/users/:id", adminOnly, controller.destroy)
-  .get("/api/global/users/count/:appId", builderOrAdmin, controller.countByApp)
+  .get("/api/global/users", auth.builderOrAdmin, controller.fetch)
+  .post("/api/global/users/search", auth.builderOrAdmin, controller.search)
+  .delete("/api/global/users/:id", auth.adminOnly, controller.destroy)
+  .get(
+    "/api/global/users/count/:appId",
+    auth.builderOrAdmin,
+    controller.countByApp
+  )
   .get("/api/global/roles/:appId")
   .post(
     "/api/global/users/invite",
-    adminOnly,
+    auth.adminOnly,
     buildInviteValidation(),
     controller.invite
   )
   .post(
     "/api/global/users/multi/invite",
-    adminOnly,
+    auth.adminOnly,
     buildInviteMultipleValidation(),
     controller.inviteMultiple
   )
@@ -102,7 +104,7 @@ router
   )
   .get("/api/global/users/tenant/:id", controller.tenantUserLookup)
   // global endpoint but needs to come at end (blocks other endpoints otherwise)
-  .get("/api/global/users/:id", builderOrAdmin, controller.find)
+  .get("/api/global/users/:id", auth.builderOrAdmin, controller.find)
   // DEPRECATED - use new versions with self API
   .get("/api/global/users/self", selfController.getSelf)
   .post(
@@ -111,4 +113,4 @@ router
     selfController.updateSelf
   )
 
-module.exports = router
+export = router

package/src/api/routes/global/{workspaces.js → workspaces.ts}

@@ -1,14 +1,13 @@
-const Router = require("@koa/router")
-const controller = require("../../controllers/global/workspaces")
-const { joiValidator } = require("@budibase/backend-core/auth")
-const { adminOnly } = require("@budibase/backend-core/auth")
-const Joi = require("joi")
+import Router from "@koa/router"
+import * as controller from "../../controllers/global/workspaces"
+import { auth } from "@budibase/backend-core"
+import Joi from "joi"
 
-const router = new Router()
+const router: Router = new Router()
 
 function buildWorkspaceSaveValidation() {
   // prettier-ignore
-  return joiValidator.body(Joi.object({
+  return auth.joiValidator.body(Joi.object({
     _id: Joi.string().optional(),
     _rev: Joi.string().optional(),
     name: Joi.string().required(),
@@ -27,12 +26,12 @@ function buildWorkspaceSaveValidation() {
 router
   .post(
     "/api/global/workspaces",
-    adminOnly,
+    auth.adminOnly,
     buildWorkspaceSaveValidation(),
     controller.save
   )
-  .delete("/api/global/workspaces/:id", adminOnly, controller.destroy)
+  .delete("/api/global/workspaces/:id", auth.adminOnly, controller.destroy)
   .get("/api/global/workspaces", controller.fetch)
   .get("/api/global/workspaces/:id", controller.find)
 
-module.exports = router
+export = router

package/src/api/routes/index.ts

@@ -1,3 +1,4 @@
+import Router from "@koa/router"
 import { api } from "@budibase/pro"
 import userRoutes from "./global/users"
 import configRoutes from "./global/configs"
@@ -16,7 +17,7 @@ import accountRoutes from "./system/accounts"
 import restoreRoutes from "./system/restore"
 
 let userGroupRoutes = api.groups
-export const routes = [
+export const routes: Router[] = [
   configRoutes,
   userRoutes,
   workspaceRoutes,

package/src/api/routes/system/accounts.ts

@@ -2,7 +2,7 @@ import Router from "@koa/router"
 import * as controller from "../../controllers/system/accounts"
 import { middleware } from "@budibase/backend-core"
 
-const router = new Router()
+const router: Router = new Router()
 
 router
   .put(

package/src/api/routes/system/environment.ts

@@ -0,0 +1,8 @@
+import Router from "@koa/router"
+import * as controller from "../../controllers/system/environment"
+
+const router: Router = new Router()
+
+router.get("/api/system/environment", controller.fetch)
+
+export = router

package/src/api/routes/system/migrations.ts

@@ -2,7 +2,7 @@ import Router from "@koa/router"
 import * as migrationsController from "../../controllers/system/migrations"
 import { auth } from "@budibase/backend-core"
 
-const router = new Router()
+const router: Router = new Router()
 
 router
   .post(

package/src/api/routes/system/restore.ts

@@ -1,7 +1,7 @@
 import * as controller from "../../controllers/system/restore"
 import Router from "@koa/router"
 
-const router = new Router()
+const router: Router = new Router()
 
 router.post("/api/system/restored", controller.systemRestored)
 

package/src/api/routes/system/status.ts

@@ -0,0 +1,8 @@
+import Router from "@koa/router"
+import * as controller from "../../controllers/system/status"
+
+const router: Router = new Router()
+
+router.get("/api/system/status", controller.fetch)
+
+export = router

package/src/api/routes/system/tenants.ts

@@ -0,0 +1,13 @@
+import Router from "@koa/router"
+import * as controller from "../../controllers/system/tenants"
+import { middleware } from "@budibase/backend-core"
+
+const router: Router = new Router()
+
+router.delete(
+  "/api/system/tenants/:tenantId",
+  middleware.adminOnly,
+  controller.delete
+)
+
+export = router