/
ResponseHelper.js
234 lines (207 loc) · 6.34 KB
/
ResponseHelper.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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
/**
* Helper for handling the response and support response (res) object methods
*/
var PluginHelper = require("./PluginHelper"),
getMsg = require("./i18n").get;
var DOWNLOAD = "download", SEND = "send", REDIRECT = "redirect", JSON = "json",
SUCCESS = "success", ERROR = "error";
function downloadResponse(err, path) {
// if an error occurs in this callback
// the file most likely does not exist,
// and it's safe to respond or next(err)
if (err) {
throw err;
}
// the file has been transferred, do not respond
// from here, though you may use this callback
// for stats etc.
global.Debug._l('transferred %s', path);
}
function downloadTransmissionErrorHandler(err) {
// this second optional callback is used when
// an error occurs during transmission
if (err) {
throw err;
}
}
exports.handleResponse = function (req, res, pageContent) {
!req.attrs.method && exports.setSend(req, pageContent);
callResponseMethod(req, res);
};
var callResponseMethod = exports.callResponseMethod = function (req, res) {
// if (err) {
// var page = req.attrs.page, ns = PluginHelper.getNamespace(req);
// var getErrMsg = function (err, ns) {
// var errStr = err.stack || err.toString();
// Debug._l(errStr);
// if (err.hasOwnProperty("localizedMessageKey")) {
// return ns + ":" + getMsg({key: err.localizedMessageKey});
// }
// else if (err.hasOwnProperty("message")) {
// return ns + ":" + err.message;
// }
// else {
// return ns + ":" + getMsg({key: "error-occurred"});
// }
// };
//
// //set error status code for ok status code
// //if error code is 404 then status code is not changed.
// if (exports.is200Response(res)) {
// exports.set500StatusCode(res);
// }
//
// if (req.xhr) {
//// var ret = {status: "error"};
//// ret.message = ns ? getErrMsg(err, ns) : err.toString();
//
// //writing err response
// //res.json(ret);
// //return;
// exports.setError(req, err);
// }
//
// //handling errors for app routes in this case page is null
// else if (page && ns) {
// req.attrs.errorMsg = getErrMsg(err, ns);
// } else {
// next(err);
// }
// }
var method = req.attrs.method;
if (method == REDIRECT && req.xhr) {
exports.setSuccess(req, SUCCESS, {});
}
var ret = req.attrs.value;
if (!_.isArray(ret)) {
ret = [ret];
}
// add helper function to download method
//TODO Method not tested, but should work
if (method == DOWNLOAD) {
ret.push(downloadResponse);
ret.push(downloadTransmissionErrorHandler);
}
res[method].apply(res, ret);
};
var setRedirect = exports.setRedirect = function (req, redirect) {
req.attrs.method = REDIRECT;
req.attrs.value = redirect;
};
var setJSON = exports.setJSON = function (req, json) {
req.attrs.method = JSON;
req.attrs.value = json;
};
var setSend = exports.setSend = function (req, sendString) {
req.attrs.method = SEND;
req.attrs.value = sendString;
};
var setDownload = exports.setDownload = function (req, options) {
req.attrs.method = DOWNLOAD;
req.attrs.value = options;
};
/**
* Method to handle ajax request for success flash notifications
* success param when object should have "localizedMessageKey" to show localized message
* @param req - Request Object
* @param success - Object || String
* @param data - JSON
*/
exports.setSuccess = function (req, success, data) {
var successMessage;
if (_.isObject(success)) { //If object
if (success.hasOwnProperty("localizedMessageKey")) { // show localized message
successMessage = getMsg(success.localizedMessageKey);// localized message retrieved from current locale
}
}
else {
successMessage = success;
}
data = data || {};
data.namespace = PluginHelper.getNamespace(req);
setJSON(req, {
status: SUCCESS,
message: successMessage,
data: data
});
};
/**
* Method to handle ajax request for error flash notifications
* If error param is of JS Error object which have "localizedMessageKey === true", then localized message
* will be displayed.
*
* @param req - Request Object
* @param error - JS Error Object || String
* @param data - JSON
*/
var setError = exports.setError = function (req, error, data) {
var errorMessage;
var header = error.header;
data = data || {};
if (error instanceof Error) { //check for js Error object
Debug._l(error.stack || error);
if (error.hasOwnProperty("localizedMessageKey")) { //get message as localized
errorMessage = getMsg(error.localizedMessageKey);// localized message retrieved from current locale
}
else if (error.hasOwnProperty("message")) {
errorMessage = error.message;
}
if (error.hasOwnProperty("name")) {
data.errorName = error.name;
}
}
errorMessage = errorMessage || error.toString();
data.namespace = PluginHelper.getNamespace(req);
setJSON(req, [
{
status: ERROR,
message: errorMessage,
data: data
},
header
]);
};
/**
* Returns true if status code is 200 OK
* @param res
* @returns {boolean}
*/
exports.is200Response = function (res) {
return res.statusCode == 200;
};
/**
* Method to set response status code
* @param statusCode {Number} status code
* @param res {Object}
*/
var setStatusCode = exports.setStatusCode = function (statusCode, res) {
res.statusCode = statusCode;
};
/**
* Sets http status code to 200 OK.
* @param res {Object}
*/
exports.set200StatusCode = function (res) {
setStatusCode(200, res);
};
/**
* Sets http status code to 401 Unauthorized access.
* @param res {Object}
*/
exports.set401StatusCode = function (res) {
setStatusCode(401, res);
};
/**
* Sets http status code to 404 Not found.
* @param res {Object}
*/
exports.set404StatusCode = function (res) {
setStatusCode(404, res);
};
/**
* Sets http status code to 500 Internal server error
* @param res {Object}
*/
exports.set500StatusCode = function (res) {
setStatusCode(500, res);
};