This repository has been archived by the owner on Apr 3, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 120
/
error-utils.js
123 lines (108 loc) · 3.74 KB
/
error-utils.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
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/**
* Error handling utilities
*/
define(function (require, exports, module) {
'use strict';
var AuthErrors = require('lib/auth-errors');
var Constants = require('lib/constants');
var Logger = require('lib/logger');
var OAuthErrors = require('lib/oauth-errors');
var p = require('lib/promise');
var ERROR_REDIRECT_TIMEOUT_MS = Constants.ERROR_REDIRECT_TIMEOUT_MS;
module.exports = {
ERROR_REDIRECT_TIMEOUT_MS: ERROR_REDIRECT_TIMEOUT_MS,
/**
* Get the URL of the error page to which an error should redirect.
*
* @param {Error} error - error for which to get error page URL
* @returns {String}
*/
getErrorPageUrl: function (error) {
if (AuthErrors.is(error, 'INVALID_PARAMETER') ||
AuthErrors.is(error, 'MISSING_PARAMETER') ||
OAuthErrors.is(error, 'INVALID_PARAMETER') ||
OAuthErrors.is(error, 'MISSING_PARAMETER') ||
OAuthErrors.is(error, 'UNKNOWN_CLIENT')) {
return Constants.BAD_REQUEST_PAGE;
}
return Constants.INTERNAL_ERROR_PAGE;
},
/**
* Get an interpolated and translated error message.
*
* @param {Error} error - error to convert
* @param {Object} translator - translator to translate error
* @returns {String}
*/
getDisplayedErrorMessage: function (error, translator) {
if (error.errorModule) {
return error.errorModule.toInterpolatedMessage(error, translator);
} else {
return error.message;
}
},
/**
* Report an error to metrics. No metrics report is sent.
*
* @param {Error} error
* @param {Object} sentryMetrics
* @param {Object} metrics
* @param {Object} window
*/
captureError: function (error, sentryMetrics, metrics, win) {
var logger = new Logger(win);
logger.error(error);
sentryMetrics.captureException(error);
if (metrics) {
metrics.logError(error);
}
},
/**
* Report an error to metrics. Send metrics report.
*
* @param {Error} error
* @param {Object} sentryMetrics
* @param {Object} metrics
* @param {Object} window
* @returns {promise};
*/
captureAndFlushError: function (error, sentryMetrics, metrics, win) {
this.captureError(error, sentryMetrics, metrics, win);
return p().then(function () {
if (metrics) {
return metrics.flush();
}
});
},
/**
* Handle a fatal error. Logs and reports the error, then redirects
* to the appropriate error page.
*
* @param {Error} error
* @param {Object} sentryMetrics
* @param {Object} metrics
* @param {Object} window
* @param {Object} translator
* @returns {promise}
*/
fatalError: function (error, sentryMetrics, metrics, win, translator) {
var self = this;
return self.captureAndFlushError(error, sentryMetrics, metrics, win)
// give a bit of time to flush the Sentry error logs,
// otherwise Safari Mobile redirects too quickly.
.delay(self.ERROR_REDIRECT_TIMEOUT_MS)
.then(function () {
var errorMessage = self.getDisplayedErrorMessage(error, translator);
// Pass the error message in a session cookie to prevent messages
// from being tampered with. The cookie is immediately cleared
// by the server.
win.document.cookie = '__400_message=' + errorMessage + '; path=/400.html;';
var errorPageUrl = self.getErrorPageUrl(error);
win.location.href = errorPageUrl;
});
}
};
});