@budibase/worker 3.13.22 → 3.13.24

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@budibase/worker",
   "email": "hi@budibase.com",
-  "version": "3.13.22",
+  "version": "3.13.24",
   "description": "Budibase background service",
   "main": "src/index.ts",
   "repository": {
@@ -114,5 +114,5 @@
       }
     }
   },
-  "gitHead": "72110c606f8b12bbf037346388c63d682c1aa9c0"
+  "gitHead": "9dea790829ad44142eb0baa2bfa7fb7a5d3531ad"
 }

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

@@ -0,0 +1 @@
+export * from "./standard"

package/src/api/routes/endpointGroups/standard.ts

@@ -0,0 +1,22 @@
+import cloudRestricted from "../../../middleware/cloudRestricted"
+import { auth, EndpointGroupList, middleware } from "@budibase/backend-core"
+
+export const endpointGroupList = new EndpointGroupList()
+
+export const builderOrAdminRoutes = endpointGroupList.group(auth.builderOrAdmin)
+builderOrAdminRoutes.lockMiddleware()
+
+export const builderRoutes = endpointGroupList.group(auth.builderOnly)
+builderRoutes.lockMiddleware()
+
+export const adminRoutes = endpointGroupList.group(auth.adminOnly)
+adminRoutes.lockMiddleware()
+
+export const cloudRestrictedRoutes = endpointGroupList.group(cloudRestricted)
+cloudRestrictedRoutes.lockMiddleware()
+
+export const internalRoutes = endpointGroupList.group(middleware.internalApi)
+internalRoutes.lockMiddleware()
+
+export const loggedInRoutes = endpointGroupList.group()
+loggedInRoutes.lockMiddleware()

package/src/api/routes/global/auth.ts

@@ -1,9 +1,7 @@
-import Router from "@koa/router"
 import * as authController from "../../controllers/global/auth"
 import { auth } from "@budibase/backend-core"
 import Joi from "joi"
-
-const router: Router = new Router()
+import { loggedInRoutes } from "../endpointGroups"
 
 function buildAuthValidation() {
   // prettier-ignore
@@ -28,7 +26,7 @@ function buildResetUpdateValidation() {
   }).required().unknown(false))
 }
 
-router
+loggedInRoutes
   // PASSWORD
   .post(
     "/api/global/auth/:tenantId/login",
@@ -87,5 +85,3 @@ router
   // OIDC - SINGLE TENANT - DEPRECATED
   .get("/api/global/auth/oidc/callback", authController.oidcCallback)
   .get("/api/admin/auth/oidc/callback", authController.oidcCallback)
-
-export default router

package/src/api/routes/global/configs.ts

@@ -1,10 +1,8 @@
-import Router from "@koa/router"
 import * as controller from "../../controllers/global/configs"
 import { auth } from "@budibase/backend-core"
 import Joi from "joi"
 import { ConfigType } from "@budibase/types"
-
-const router: Router = new Router()
+import { adminRoutes, loggedInRoutes } from "../endpointGroups"
 
 function smtpValidation() {
   // prettier-ignore
@@ -121,23 +119,17 @@ function buildConfigGetValidation() {
   }).required().unknown(true))
 }
 
-router
-  .post(
-    "/api/global/configs",
-    auth.adminOnly,
-    buildConfigSaveValidation(),
-    controller.save
-  )
-  .delete("/api/global/configs/:id/:rev", auth.adminOnly, controller.destroy)
-  .get("/api/global/configs/checklist", controller.configChecklist)
-  .get("/api/global/configs/public", controller.publicSettings)
-  .get("/api/global/configs/public/oidc", controller.publicOidc)
-  .get("/api/global/configs/:type", buildConfigGetValidation(), controller.find)
+adminRoutes
+  .post("/api/global/configs", buildConfigSaveValidation(), controller.save)
+  .delete("/api/global/configs/:id/:rev", controller.destroy)
   .post(
     "/api/global/configs/upload/:type/:name",
-    auth.adminOnly,
     buildUploadValidation(),
     controller.upload
   )
 
-export default router
+loggedInRoutes
+  .get("/api/global/configs/checklist", controller.configChecklist)
+  .get("/api/global/configs/public", controller.publicSettings)
+  .get("/api/global/configs/public/oidc", controller.publicOidc)
+  .get("/api/global/configs/:type", buildConfigGetValidation(), controller.find)

package/src/api/routes/global/email.ts

@@ -1,10 +1,8 @@
-import Router from "@koa/router"
 import * as controller from "../../controllers/global/email"
 import { auth } from "@budibase/backend-core"
 import { EmailTemplatePurpose } from "@budibase/types"
 import Joi from "joi"
-
-const router: Router = new Router()
+import { adminRoutes } from "../endpointGroups"
 
 function buildEmailSendValidation() {
   // prettier-ignore
@@ -26,11 +24,8 @@ function buildEmailSendValidation() {
   }).required().unknown(true))
 }
 
-router.post(
+adminRoutes.post(
   "/api/global/email/send",
   buildEmailSendValidation(),
-  auth.adminOnly,
   controller.sendEmail
 )
-
-export default router

package/src/api/routes/global/events.ts

@@ -1,8 +1,4 @@
-import Router from "@koa/router"
 import * as controller from "../../controllers/global/events"
+import { loggedInRoutes } from "../endpointGroups"
 
-const router: Router = new Router()
-
-router.post("/api/global/event/publish", controller.publish)
-
-export default router
+loggedInRoutes.post("/api/global/event/publish", controller.publish)

package/src/api/routes/global/license.ts

@@ -1,7 +1,7 @@
-import Router from "@koa/router"
 import * as controller from "../../controllers/global/license"
 import { middleware } from "@budibase/backend-core"
 import Joi from "joi"
+import { loggedInRoutes } from "../endpointGroups"
 
 const activateLicenseKeyValidator = middleware.joiValidator.body(
   Joi.object({
@@ -15,9 +15,7 @@ const activateOfflineLicenseValidator = middleware.joiValidator.body(
   }).required()
 )
 
-const router: Router = new Router()
-
-router
+loggedInRoutes
   .post("/api/global/license/refresh", controller.refresh)
   .get("/api/global/license/usage", controller.getQuotaUsage)
   // LICENSE KEY
@@ -40,5 +38,3 @@ router
     "/api/global/license/offline/identifier",
     controller.getOfflineLicenseIdentifier
   )
-
-export default router

package/src/api/routes/global/roles.ts

@@ -1,16 +1,7 @@
-import Router from "@koa/router"
 import * as controller from "../../controllers/global/roles"
-import { auth } from "@budibase/backend-core"
+import { builderOrAdminRoutes } from "../endpointGroups"
 
-const router: Router = new Router()
-
-router
-  .get("/api/global/roles", auth.builderOrAdmin, controller.fetch)
-  .get("/api/global/roles/:appId", auth.builderOrAdmin, controller.find)
-  .delete(
-    "/api/global/roles/:appId",
-    auth.builderOrAdmin,
-    controller.removeAppRole
-  )
-
-export default router
+builderOrAdminRoutes
+  .get("/api/global/roles", controller.fetch)
+  .get("/api/global/roles/:appId", controller.find)
+  .delete("/api/global/roles/:appId", controller.removeAppRole)

package/src/api/routes/global/self.ts

@@ -1,18 +1,14 @@
-import Router from "@koa/router"
 import * as controller from "../../controllers/global/self"
-import { auth } from "@budibase/backend-core"
 import { users } from "../validation"
+import { builderRoutes, loggedInRoutes } from "../endpointGroups"
+builderRoutes
+  .post("/api/global/self/api_key", controller.generateAPIKey)
+  .get("/api/global/self/api_key", controller.fetchAPIKey)
 
-const router: Router = new Router()
-
-router
-  .post("/api/global/self/api_key", auth.builderOnly, controller.generateAPIKey)
-  .get("/api/global/self/api_key", auth.builderOnly, controller.fetchAPIKey)
+loggedInRoutes
   .get("/api/global/self", controller.getSelf)
   .post(
     "/api/global/self",
     users.buildSelfSaveValidation(),
     controller.updateSelf
   )
-
-export default router

package/src/api/routes/global/templates.ts

@@ -1,12 +1,10 @@
-import Router from "@koa/router"
 import * as controller from "../../controllers/global/templates"
 import { TemplatePurpose, TemplateType } from "../../../constants"
 import { auth as authCore } from "@budibase/backend-core"
+import { loggedInRoutes, adminRoutes } from "../endpointGroups"
 import Joi from "joi"
 
-const { adminOnly, joiValidator } = authCore
-
-const router: Router = new Router()
+const { joiValidator } = authCore
 
 function buildTemplateSaveValidation() {
   // prettier-ignore
@@ -21,19 +19,14 @@ function buildTemplateSaveValidation() {
   }).required().unknown(true).optional())
 }
 
-router
+loggedInRoutes
   .get("/api/global/template/definitions", controller.definitions)
-  .post(
-    "/api/global/template",
-    adminOnly,
-    buildTemplateSaveValidation(),
-    controller.save
-  )
   .get("/api/global/template", controller.fetch)
   .get("/api/global/template/:type", controller.fetchByType)
   .get("/api/global/template/:ownerId", controller.fetchByOwner)
   .get("/api/global/template/:id", controller.find)
   .post("/api/global/template/:type/export", controller.exportTemplates)
-  .delete("/api/global/template/:id/:rev", adminOnly, controller.destroy)
 
-export default router
+adminRoutes
+  .post("/api/global/template", buildTemplateSaveValidation(), controller.save)
+  .delete("/api/global/template/:id/:rev", controller.destroy)

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

@@ -1,11 +1,14 @@
-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 {
+  loggedInRoutes,
+  cloudRestrictedRoutes,
+  builderOrAdminRoutes,
+  adminRoutes,
+} from "../endpointGroups"
 
-const router: Router = new Router()
 const OPTIONAL_STRING = Joi.string().optional().allow(null).allow("")
 
 function buildAdminInitValidation() {
@@ -69,92 +72,68 @@ function buildChangeTenantOwnerEmailValidation() {
   )
 }
 
-router
-  .post(
-    "/api/global/users",
-    createUserAdminOnly,
-    users.buildUserSaveValidation(),
-    controller.save
-  )
+cloudRestrictedRoutes
   .post(
     "/api/global/users/sso",
-    cloudRestricted,
     users.buildAddSsoSupport(),
     controller.addSsoSupport
   )
+  .post(
+    "/api/global/users/init",
+    buildAdminInitValidation(),
+    controller.adminUser
+  )
+  .put(
+    "/api/global/users/tenant/owner",
+    buildChangeTenantOwnerEmailValidation(),
+    controller.changeTenantOwnerEmail
+  )
+
+adminRoutes
   .post(
     "/api/global/users/bulk",
-    auth.adminOnly,
     users.buildUserBulkUserValidation(),
     controller.bulkUpdate
   )
+  .delete("/api/global/users/:id", controller.destroy)
 
-  .get("/api/global/users", auth.builderOrAdmin, controller.fetch)
-  // search can be used by any user now, to retrieve users for user column
-  .post("/api/global/users/search", 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",
-    auth.builderOrAdmin,
-    buildInviteValidation(),
-    controller.invite
-  )
+builderOrAdminRoutes
+  .get("/api/global/users", controller.fetch)
+  .get("/api/global/users/count/:appId", controller.countByApp)
+  .post("/api/global/users/invite", buildInviteValidation(), controller.invite)
   .post(
     "/api/global/users/onboard",
-    auth.builderOrAdmin,
     buildInviteMultipleValidation(),
     controller.onboardUsers
   )
   .post(
     "/api/global/users/multi/invite",
-    auth.builderOrAdmin,
     buildInviteMultipleValidation(),
     controller.inviteMultiple
   )
   .post(
     "/api/global/users/multi/invite/delete",
-    auth.builderOrAdmin,
     controller.removeMultipleInvites
   )
+  .post("/api/global/users/invite/update/:code", controller.updateInvite)
+  .get("/api/global/users/invites", controller.getUserInvites)
+  .get("/api/global/users/:id", controller.find)
 
-  // non-global endpoints
-  .get("/api/global/users/invite/:code", controller.checkInvite)
+loggedInRoutes
+  // search can be used by any user now, to retrieve users for user column
+  .post("/api/global/users/search", controller.search)
   .post(
-    "/api/global/users/invite/update/:code",
-    auth.builderOrAdmin,
-    controller.updateInvite
-  )
-  .get(
-    "/api/global/users/invites",
-    auth.builderOrAdmin,
-    controller.getUserInvites
+    "/api/global/users",
+    createUserAdminOnly,
+    users.buildUserSaveValidation(),
+    controller.save
   )
+  // non-global endpoints
+  .get("/api/global/users/invite/:code", controller.checkInvite)
   .post(
     "/api/global/users/invite/accept",
     buildInviteAcceptValidation(),
     controller.inviteAccept
   )
-  .post(
-    "/api/global/users/init",
-    cloudRestricted,
-    buildAdminInitValidation(),
-    controller.adminUser
-  )
   .get("/api/global/users/accountholder", controller.accountHolderLookup)
   .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", auth.builderOrAdmin, controller.find)
-  .put(
-    "/api/global/users/tenant/owner",
-    cloudRestricted,
-    buildChangeTenantOwnerEmailValidation(),
-    controller.changeTenantOwnerEmail
-  )
-
-export default router

package/src/api/routes/index.ts

@@ -1,44 +1,33 @@
 import Router from "@koa/router"
 import { api as pro } from "@budibase/pro"
-import userRoutes from "./global/users"
-import configRoutes from "./global/configs"
-import templateRoutes from "./global/templates"
-import emailRoutes from "./global/email"
-import authRoutes from "./global/auth"
-import roleRoutes from "./global/roles"
-import eventRoutes from "./global/events"
-import environmentRoutes from "./system/environment"
-import tenantsRoutes from "./system/tenants"
-import statusRoutes from "./system/status"
-import selfRoutes from "./global/self"
-import licenseRoutes from "./global/license"
-import accountRoutes from "./system/accounts"
-import restoreRoutes from "./system/restore"
-import systemLogRoutes from "./system/logs"
+import { endpointGroupList } from "./endpointGroups"
 
-import env from "../../environment"
+// import to register the routes with the endpoint groups
+import "./global/auth"
+import "./global/users"
+import "./global/configs"
+import "./global/templates"
+import "./global/email"
+import "./global/roles"
+import "./global/events"
+import "./system/environment"
+import "./system/tenants"
+import "./system/status"
+import "./global/self"
+import "./global/license"
+import "./system/accounts"
+import "./system/restore"
+import "./system/logs"
+
+const endpointGroupsRouter = new Router()
+for (let endpoint of endpointGroupList.listAllEndpoints()) {
+  endpoint.apply(endpointGroupsRouter)
+}
 
 export const routes: Router[] = [
-  configRoutes,
-  userRoutes,
+  endpointGroupsRouter,
   pro.users,
-  authRoutes,
-  templateRoutes,
-  tenantsRoutes,
-  emailRoutes,
-  roleRoutes,
-  environmentRoutes,
-  statusRoutes,
-  selfRoutes,
-  licenseRoutes,
   pro.groups,
   pro.auditLogs,
-  accountRoutes,
-  restoreRoutes,
-  eventRoutes,
   pro.scim,
 ]
-
-if (env.SELF_HOSTED) {
-  routes.push(systemLogRoutes)
-}

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

@@ -1,19 +1,6 @@
-import Router from "@koa/router"
 import * as controller from "../../controllers/system/accounts"
-import { middleware } from "@budibase/backend-core"
+import { internalRoutes } from "../endpointGroups"
 
-const router: Router = new Router()
-
-router
-  .put(
-    "/api/system/accounts/:accountId/metadata",
-    middleware.internalApi,
-    controller.save
-  )
-  .delete(
-    "/api/system/accounts/:accountId/metadata",
-    middleware.internalApi,
-    controller.destroy
-  )
-
-export default router
+internalRoutes
+  .put("/api/system/accounts/:accountId/metadata", controller.save)
+  .delete("/api/system/accounts/:accountId/metadata", controller.destroy)

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

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

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

@@ -1,9 +1,7 @@
-import Router from "@koa/router"
-import { middleware } from "@budibase/backend-core"
 import * as controller from "../../controllers/system/logs"
+import { adminRoutes } from "../endpointGroups"
+import env from "../../../environment"
 
-const router: Router = new Router()
-
-router.get("/api/system/logs", middleware.adminOnly, controller.getLogs)
-
-export default router
+if (env.SELF_HOSTED) {
+  adminRoutes.get("/api/system/logs", controller.getLogs)
+}

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

@@ -1,8 +1,4 @@
 import * as controller from "../../controllers/system/restore"
-import Router from "@koa/router"
+import { loggedInRoutes } from "../endpointGroups"
 
-const router: Router = new Router()
-
-router.post("/api/system/restored", controller.systemRestored)
-
-export default router
+loggedInRoutes.post("/api/system/restored", controller.systemRestored)

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

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

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

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