synced/infisical
1
0
Fork 0
mirror of https://github.com/Infisical/infisical.git synced 2025-03-25 14:05:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: Wrong error handler middleware position

Browse Source 
Error handler is a middleware that captures errors from throw and
next(...), so in order to be able to handle it needs to come after
all of the routing and other middlewares. Previously it was before
routuing logic and wasn't working, now it works as intended.

Also added check for LogLevel to Sentry for not sending false-positive
errors like `BadRequestError`, `UnauthorizedRequestError` and etc.
This commit is contained in:
Hüseyin Berke Bütün
2022-12-22 17:51:53 +01:00
parent 6f5d7a831b
commit 843757fcf5
1 changed files with 33 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
backend/src/app.ts
View File

@ -30,8 +30,8 @@ import {
integrationAuth as integrationAuthRouter
} from './routes';
import { getLogger } from './utils/logger';
import RequestError from './utils/requestError';
import { InternalServerError } from './utils/errors';
import RequestError, { LogLevel } from './utils/requestError';
import { InternalServerError, RouteNotFoundError } from './utils/errors';
export const app = express();
@ -53,23 +53,6 @@ if (NODE_ENV === 'production') {
app.use(helmet());
}
//* Error Handling Middleware
app.use((error: RequestError|Error, req: Request, res: Response, next: NextFunction)=>{
if(res.headersSent) return next();
if(!(error instanceof RequestError)){
error = InternalServerError({context: {exception: error.message}, stack: error.stack})
getLogger('backend-main').log((<RequestError>error).levelName.toLowerCase(), (<RequestError>error).message)
}
//* Sentry Error Capture
if(req.user !== undefined || req.user !== null)
Sentry.setUser({ email: req.user.email })
Sentry.captureException(error)
res.status((<RequestError>error).statusCode).json((<RequestError>error).format(req))
next()
})
// routers
app.use('/api/v1/signup', signupRouter);
@ -90,6 +73,37 @@ app.use('/api/v1/stripe', stripeRouter);
app.use('/api/v1/integration', integrationRouter);
app.use('/api/v1/integration-auth', integrationAuthRouter);
//* Handle unrouted requests and respond with proper error message as well as status code
app.use((req, res, next)=>{
if(res.headersSent) return next();
next(RouteNotFoundError({message: `The requested source '(${req.method})${req.url}' was not found`}))
})
//* Error Handling Middleware (must be after all routing logic)
app.use((error: RequestError|Error, req: Request, res: Response, next: NextFunction)=>{
if(res.headersSent) return next();
//TODO: Find better way to type check for error. In current setting you need to cast type to get the functions and variables from RequestError
if(!(error instanceof RequestError)){
error = InternalServerError({context: {exception: error.message}, stack: error.stack})
getLogger('backend-main').log((<RequestError>error).levelName.toLowerCase(), (<RequestError>error).message)
}
//* Set Sentry user identification if req.user is populated
if(req.user !== undefined && req.user !== null){
Sentry.setUser({ email: req.user.email })
}
//* Only sent error to Sentry if LogLevel is one of the following level 'ERROR', 'EMERGENCY' or 'CRITICAL'
//* with this we will eliminate false-positive errors like 'BadRequestError', 'UnauthorizedRequestError' and so on
if([LogLevel.ERROR, LogLevel.EMERGENCY, LogLevel.CRITICAL].includes((<RequestError>error).level)){
Sentry.captureException(error)
}
res.status((<RequestError>error).statusCode).json((<RequestError>error).format(req))
next()
})
export const server = app.listen(PORT, () => {
getLogger("backend-main").info(`Server started listening at port ${PORT}`)
});