[CHE-170] Refactor Global Error Handler #138
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
brok3turtl3
approved these changes
Jun 9, 2024
server/middleware/errorHandler.ts
Outdated
Comment on lines
10
to
25
| const errorHandler = (err: Error | OldError, _req: Request, res: Response, _next: NextFunction) => { | ||
| // If it is one of our custom errors use its properties/method | ||
| if (err instanceof CustomError) { | ||
| console.log(err.message); | ||
| return res.status(err.statusCode).send(err.serializeErrors()); | ||
| } | ||
|
|
||
| // Handle errors thrown the old way | ||
| if (!(err instanceof Error) && err.status && err.log && err.message) { | ||
| console.log(err.log); | ||
| return res.status(err.status).send([{ message: err.message.err }]); | ||
| } | ||
|
|
||
| // If it is an unknown error send back a generic error | ||
| const internalError = new InternalError(); | ||
| return res.status(internalError.statusCode).send(internalError.serializeErrors()); |
There was a problem hiding this comment.
Great transitional logic here @seantokuzo !
Comment on lines
+1
to
+8
| export * from './badRequestError'; | ||
| export * from './customError'; | ||
| export * from './databaseConnectionError'; | ||
| export * from './internalError'; | ||
| export * from './notAuthorizedError'; | ||
| export * from './notFoundError'; | ||
| export * from './requestValidationError'; | ||
| export * from './validationError'; |
Mnelson98
reviewed
Jun 10, 2024
server/middleware/errorHandler.ts
Outdated
| const errorHandler = (err: Error | OldError, _req: Request, res: Response, _next: NextFunction) => { | ||
| // If it is one of our custom errors use its properties/method | ||
| if (err instanceof CustomError) { | ||
| console.log(err.message); |
There was a problem hiding this comment.
This looks great to me! I'm curious if 'console.error' would be more fitting here, however? Maybe not, just wondering.
There was a problem hiding this comment.
Great catch! console.error is def more appropriate.
I think I also need to be logging the entire err to get the stack trace for debugging. Refactor coming in hot
|
Good job @seantokuzo! |
brok3turtl3
merged commit 061e069
into
CHE-167/story/BE-Refactor-Error-Handling
1 check passed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
As Part of the CHE-167 story to refactor error handling, this PR aims to:
Create and use a global error handler middleware that handles:
The goal of this error handler is:
serializeErrorsmethod):{ message: string, field?: string }[]This PR also:
server/errors/index.ts)Jira Task
JIRA TICKET
Testing Instructions
(Make sure you have the most recent image by running
npm run docker-remove-allfirst)Check if current tests still pass with:
npm run docker-test:allMake sure error handler is working
- 3000:3000to the ports array in docker-compose-dev.ymlnpm run docker-devChecklist
All Team Members
npm run docker-testin my local environment to check that this PR passes all unit tests.