A Quick Guide to Handling Express.js Errors in Your Application
source link: https://hackernoon.com/a-quick-guide-to-handling-expressjs-errors-in-your-application-ia3b331n
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
A Quick Guide to Handling Express.js Errors in Your Application
@dhruv479Dhruv Bansal
I’m a Software Engineer from India. In ♡ with JavaScript and all amazing things there. Reach me: [email protected]
Handling Errors is overlooked time and again by inexperienced developers, but this has a significant impact on the stability, monitoring, and performance of the application. In this article, I will explain how to handle errors efficiently in your express application.
There is no definite way to handle errors, but some are better than others. let’s dive into this.
Handle Errors in Controller (Bad Approach):
In this approach, we handle errors in the controllers. For every failed condition/exception, the error will be raised and returned by the controller itself in the response.
For example:
const express = require('express');
const bodyParser = require('body-parser');
const app = express();
const port = 3000;
app.use(bodyParser.json());
app.post('/post', async (req, res) => {
const { title, author } = req.body;
if (!title || !author) {
return res.status(400).json({
status: 'error',
message: 'Missing required fields: title or author'
});
}
try {
const post = await db.post.insert({ title, author });
res.json(post);
} catch (error) {
return res.status(500).json({
status: 'error',
message: 'Internal Server Error'
});
}
});
app.listen(port, () =>
console.log(`app is listening at http://localhost:${port}`)
);In this, we have a route /post that is adding a new Post in the database. The errors are handled explicitly at every condition and return a response.
This kind of design has multiple caveats that can increase the system complexity. For example, if you want to track all the errors thrown by the system, you have to invoke that piece of code(tracker) everywhere, even
multiple times in a single controller. 😑 Now that’s something, you had never want to do!
Note: This type of application architecture will hinder the scaling of the app and also it will be really hard to track the errors altogether.
How to Handle Errors in Your Application (Better Approach):
In this approach, we use a common error handler for the complete app. Yes! all the errors are handled in the same place. To make the process more smooth, we will use
@hapi/boomconst express = require('express');
const bodyParser = require('body-parser');
const Boom = require('@hapi/boom');
const app = express();
const port = 3000;
app.use(bodyParser.json());
app.post('/post', async (req, res, next) => {
const { title, author } = req.body;
try {
if (!title || !author) {
throw Boom.badRequest()
}
const post = await db.post.insert({ title, author });
res.json(post);
} catch (error) {
next(error);
}
});
// error handler
app.use((error, req, res, _) => {
const { message = 'Oops! Something went wrong', isBoom, output } = error;
if (isBoom) { // if the error is explicitly thrown
return res.status(output.statusCode).json({
message,
success: false,
});
}
// return generic error response for unexpected error
return res.status(500).json({
success: false,
message: 'Oops! Something went wrong',
});
});
app.listen(port, () =>
console.log(`app is listening at http://localhost:${port}`)
);This might seem a bit complicated initially but it is way better than the preceding approach.
In Express, we get
nextThis way, all the errors will pass through this handler and you can easily
track the errors generated and take actions to counter system failure.
Also, this design will help you scale your application, you won’t need to
return an error for every condition but simply pass any error raised to the
error handler using next and the rest can be taken care of there.
You can also integrate error monitoring tools like
SentryConclusion:
The basic principle of designing systems should be to keep things as simple as possible which supports scaling too for the bigger picture.
Checkout the boilerplate that I have created for Express, Mongoose. You are going to like it: https://github.com/dhruv/node
I hope you have enjoyed this article and found it valuable. You can follow me on Twitter. Thanks for the support!
Also published on: https://javascript.plainenglish.io/how-to-handle-errors-in-express-js-9fe2522ccc53
@dhruv479Dhruv Bansal
I’m a Software Engineer from India. In ♡ with JavaScript and all amazing things there. Reach me: [email protected]
Create your free account to unlock your custom reading experience.
Recommend
-
49
Mistakes happen. That’s a given. According to Murphy’s law, whatever can go wrong, will go wrong. Your job, as a programmer, is to be prepared for that fact. You have a set of tools that are prepared to do precisely that....
-
22
Handling Errors in JavaScript: the definite guide Photo by
-
36
README.md errors
-
35
Go 2 aims to improve the overhead of error handling , but do you know what is better than an improved syntax for h...
-
25
I actually covered this topic before, inthis post, but given my recent experience I feel it needs reiterating and a bit of restructuring. It boils down to the observation that any error handling I have encountered — be i...
-
15
When designing how to handlenetwork calls in your app, you might think that you are done as soon as you define your interface. You are halfway there: you have defined the "happy" path. But what happens when not everything...
-
6
Errors and Error Handling in JavaScriptWhy handle them in the first place?
-
2
A Beginner's Guide to Handling Errors in Rust #rust Apr 6 ...
-
4
A quick guide to error handlingFor mobile apps
-
2
To err is human. It happens all the time. If we don't account for errors on our websites, then our users will get an awful browsing experience. That's why it is better to plan for errors. In today's post, we'll go through different ways of...
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK