Merge pull request #2876 from asashour/missing-workspace-header

fix(core): clear message when the workspace property is missing

src/bp/core/routers/admin/bots.ts

@@ -8,8 +8,8 @@ import Joi from 'joi'
 import _ from 'lodash'
 
 import { CustomRouter } from '../customRouter'
-import { ConflictError, ForbiddenError, NotFoundError } from '../errors'
-import { assertBotpressPro, hasPermissions, needPermissions, success as sendSuccess } from '../util'
+import { ConflictError, ForbiddenError } from '../errors'
+import { assertBotpressPro, assertWorkspace, hasPermissions, needPermissions, success as sendSuccess } from '../util'
 
 const chatUserBotFields = [
   'id',
@@ -51,6 +51,7 @@ export class BotsRouter extends CustomRouter {
 
     router.get(
       '/',
+      assertWorkspace,
       this.asyncMiddleware(async (req, res) => {
         const isBotAdmin = await this.hasPermissions(req, 'read', this.resource)
         const isChatUser = await this.hasPermissions(req, 'read', 'user.bots')

src/bp/core/routers/admin/users.ts

@@ -1,5 +1,5 @@
 import { Logger } from 'botpress/sdk'
-import { CreatedUser, WorkspaceUser } from 'common/typings'
+import { WorkspaceUser } from 'common/typings'
 import AuthService from 'core/services/auth/auth-service'
 import { InvalidOperationError } from 'core/services/auth/errors'
 import { WorkspaceService } from 'core/services/workspace-service'
@@ -145,12 +145,8 @@ export class UsersRouter extends CustomRouter {
           throw new ConflictError(`User "${email}" is already taken`)
         }
 
-        if (!req.workspace) {
-          throw new InvalidOperationError(`Workspace is missing. Set header X-BP-Workspace`)
-        }
-
         const result = await this.authService.createUser({ email, strategy }, strategy)
-        await this.workspaceService.addUserToWorkspace(email, strategy, req.workspace, { role })
+        await this.workspaceService.addUserToWorkspace(email, strategy, req.workspace!, { role })
 
         return sendSuccess(res, 'User created successfully', {
           email,
@@ -186,7 +182,7 @@ export class UsersRouter extends CustomRouter {
 
         const tempPassword = await this.authService.resetPassword(email, strategy)
 
-        return sendSuccess(res, 'Password reseted', {
+        return sendSuccess(res, 'Password reset', {
           tempPassword
         })
       })

src/bp/core/routers/auth.ts

@@ -12,7 +12,7 @@ import _ from 'lodash'
 
 import { CustomRouter } from './customRouter'
 import { BadRequestError, NotFoundError } from './errors'
-import { checkTokenHeader, success as sendSuccess, validateBodySchema } from './util'
+import { assertWorkspace, checkTokenHeader, success as sendSuccess, validateBodySchema } from './util'
 
 export class AuthRouter extends CustomRouter {
   private checkTokenHeader!: RequestHandler
@@ -72,6 +72,7 @@ export class AuthRouter extends CustomRouter {
     router.get(
       '/me/profile',
       this.checkTokenHeader,
+      assertWorkspace,
       this.asyncMiddleware(async (req: RequestWithUser, res) => {
         const { email, strategy, isSuperAdmin } = req.tokenUser!
         const user = await this.authService.findUser(email, strategy)

src/bp/core/routers/modules.ts

@@ -1,13 +1,13 @@
 import { FlowGeneratorMetadata, Logger } from 'botpress/sdk'
+import { ConfigProvider } from 'core/config/config-loader'
 import AuthService, { TOKEN_AUDIENCE } from 'core/services/auth/auth-service'
 import { RequestHandler, Router } from 'express'
 
 import { ModuleLoader } from '../module-loader'
 import { SkillService } from '../services/dialog/skill/service'
 
 import { CustomRouter } from './customRouter'
-import { checkTokenHeader, assertSuperAdmin } from './util'
-import { ConfigProvider } from 'core/config/config-loader'
+import { assertSuperAdmin, checkTokenHeader } from './util'
 
 export class ModulesRouter extends CustomRouter {
   private checkTokenHeader!: RequestHandler
@@ -25,15 +25,15 @@ export class ModulesRouter extends CustomRouter {
   }
 
   private setupRoutes(): void {
-    this.router.get('/', (req, res) => {
+    this.router.get('/', (_req, res) => {
       res.json(this.moduleLoader.getLoadedModules())
     })
 
     this.router.get(
       '/reload/:moduleName',
       this.checkTokenHeader,
       assertSuperAdmin,
-      this.asyncMiddleware(async (req, res, next) => {
+      this.asyncMiddleware(async (req, res, _next) => {
         const moduleName = req.params.moduleName
         const config = await this.configProvider.getBotpressConfig()
         const module = config.modules.find(x => x.location.endsWith(moduleName))
@@ -50,15 +50,15 @@ export class ModulesRouter extends CustomRouter {
     this.router.get(
       '/botTemplates',
       this.checkTokenHeader,
-      this.asyncMiddleware(async (req, res, next) => {
-        res.send(await this.moduleLoader.getBotTemplates())
+      this.asyncMiddleware(async (_req, res, _next) => {
+        res.send(this.moduleLoader.getBotTemplates())
       })
     )
 
     this.router.get(
       '/skills',
       this.checkTokenHeader,
-      this.asyncMiddleware(async (req, res, next) => {
+      this.asyncMiddleware(async (_req, res, _next) => {
         res.send(await this.moduleLoader.getAllSkills())
       })
     )

src/bp/core/routers/util.ts

@@ -1,6 +1,7 @@
 import { Logger } from 'botpress/sdk'
 import { checkRule } from 'common/auth'
 import { StrategyUser } from 'core/repositories/strategy_users'
+import { InvalidOperationError } from 'core/services/auth/errors'
 import { WorkspaceService } from 'core/services/workspace-service'
 import { NextFunction, Request, Response } from 'express'
 import Joi from 'joi'
@@ -158,6 +159,13 @@ export const assertSuperAdmin = (req: Request, res: Response, next: Function) =>
   next()
 }
 
+export const assertWorkspace = async (req: RequestWithUser, _res: Response, next: NextFunction) => {
+  if (!req.workspace) {
+    return next(new InvalidOperationError(`Workspace is missing. Set header X-BP-Workspace`))
+  }
+  next()
+}
+
 export const assertBotpressPro = (workspaceService: WorkspaceService) => async (
   _req: RequestWithUser,
   _res: Response,
@@ -231,6 +239,10 @@ const checkPermissions = (workspaceService: WorkspaceService) => (operation: str
     req.workspace = await workspaceService.getBotWorkspaceId(req.params.botId)
   }
 
+  if (!req.workspace) {
+    throw new InvalidOperationError(`Workspace is missing. Set header X-BP-Workspace`)
+  }
+
   const { email, strategy, isSuperAdmin } = req.tokenUser
 
   // The server user is used internally, and has all the permissions
@@ -246,7 +258,7 @@ const checkPermissions = (workspaceService: WorkspaceService) => (operation: str
     return
   }
 
-  if (!email || !strategy || !req.workspace) {
+  if (!email || !strategy) {
     debugFailure(`${req.originalUrl} %o`, {
       method: req.method,
       email,
@@ -255,7 +267,7 @@ const checkPermissions = (workspaceService: WorkspaceService) => (operation: str
       ip: req.ip,
       reason: 'missing auth parameter'
     })
-    return new NotFoundError(`Missing one of the required parameters: email, strategy or workspace`)
+    return new NotFoundError(`Missing one of the required parameters: email or strategy`)
   }
 
   const user = await workspaceService.findUser(email, strategy, req.workspace)