-
Notifications
You must be signed in to change notification settings - Fork 1
/
errors.js
198 lines (154 loc) · 4.52 KB
/
errors.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
//Dependencies
var inherits = require('util').inherits,
async = require('async');
// ==================================================================================
// ERRORS
// ==================================================================================
/**
* Base (error to inherit from)
*/
var Base = exports.Base = function(msg) {
this.name = 'Error';
this.message = msg || 'Error';
this.statusCode = 500;
Error.call(this, this.message);
Error.captureStackTrace(this, arguments.callee);
};
inherits(Base, Error);
Base.prototype.toJSON = function() {
return {
type: this.name,
message: this.message
};
};
/**
* NotFound
* @param {String} Optional message
*/
var NotFound = exports.NotFound = function(msg) {
Base.call(this);
this.name = 'NotFound';
this.message = msg || 'Not found';
this.statusCode = 404;
};
inherits(NotFound, Base);
/**
* BadRequest
* @param {String} Optional message
* @param {Object} Optional dictionary of errors by fields e.g. { email: 'required' }
*/
var BadRequest = exports.BadRequest = function(msg, errors) {
Base.call(this);
this.name = 'BadRequest';
this.message = msg || 'Bad request';
this.statusCode = 400;
this.errors = errors;
};
inherits(BadRequest, Base);
BadRequest.prototype.toJSON = function() {
return {
type: this.name,
message: this.message,
errors: this.errors
};
};
/**
* Unauthorized
* @param {String} Optional message
*/
var Unauthorized = exports.Unauthorized = function(msg) {
Base.call(this);
this.name = 'Unauthorized';
this.message = msg || 'Not authorized';
this.statusCode = 401;
};
inherits(Unauthorized, Base);
/**
* Validation
* @param {Object} Fields/parameters and the error type e.g. { email: 'invalid' }
* @param {String} Optional message
*/
var Validation = exports.Validation = function(fields, msg) {
Base.call(this);
this.name = 'Validation';
this.message = msg || 'Validation error';
this.statusCode = 400;
this.fields = fields;
}
inherits(Validation, Base);
Validation.prototype.toJSON = function() {
return {
type: this.name,
fields: this.fields
};
}
/**
* Converts a Mongoose ValidationError to a custom ValidationError
* @param {ValidationError} Mongoose ValidationError (contains err.errors rather than err.fields)
* @return {ValidationError} Custom ValidationError
*/
Validation.createFromMongoose = function(err) {
var fields = {};
Object.keys(err.errors).forEach(function(key) {
var item = err.errors[key];
fields[key] = item.type;
});
return new Validation(fields);
};
// ==================================================================================
// ERROR HANDLER
// ==================================================================================
/**
* API rror handler
*
* @param {Object} options
*
* Options
* - dumpExceptions {Boolean}
* - showStack {Boolean}
* - sendException {Boolean} Sends detailed error info to the API response
* - handleMongooseErrors {Boolean} Converts Mongoose ValidationErrors to custom ValidationError
* - middleware {Function} Custom middleware to run. Receives: err, req, res, next
*/
exports.errHandler = function errHandler(options) {
options = options || {};
var dumpExceptions = options.dumpExceptions || false,
showStack = options.showStack || false,
sendException = options.sendException || false,
handleMongooseErrors = options.handleMongooseErrors || false,
middleware = options.middleware || null;
if (handleMongooseErrors) {
var mongooseValidationError = require('mongoose').Document.ValidationError;
}
return function(err, req, res, next) {
async.series([
function runMiddleware(cb) {
if (!middleware) return cb(err, req, res);
middleware(err, req, res, cb);
}
], function runErrHandler(newErr) {
if (newErr) err = newErr;
//Convert Mongoose ValidationErrors
if (mongooseValidationError && err instanceof mongooseValidationError) {
err = Validation.createFromMongoose(err);
}
if (dumpExceptions) {
console.error(err);
if (showStack) console.log(err.stack);
}
var statusCode = err.statusCode || 500;
var response = {
error: err
};
if (sendException) {
response.details = {
name: err.name,
type: err.type,
message: err.message,
stack: err.stack
}
}
res.send(response, statusCode);
});
}
};