/
index.js
286 lines (269 loc) · 10.4 KB
/
index.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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
/**
* rejected-or-not
* Promise-based implementation of Node v10's `assert.rejects()` and `assert.doesNotReject()` for old Nodes and browsers.
*
* https://github.com/twada/rejected-or-not
*
* Copyright (c) 2018 Takuto Wada
* Licensed under the MIT license.
* https://github.com/twada/rejected-or-not/blob/master/LICENSE
*/
'use strict';
var AssertionError = require('assert').AssertionError;
var deepStrictEqual = require('universal-deep-strict-equal');
var slice = Array.prototype.slice;
function rejects (promiseFn, error, message) {
if (!(typeof promiseFn === 'function' || isPromiseLike(promiseFn))) {
return rejectWithInvalidArgType('promiseFn', 'function or an instance of Promise', promiseFn);
}
if (typeof error === 'string' && arguments.length === 3) {
return rejectWithInvalidArgType('error', 'function or an instance of Error, RegExp, or Object', error);
}
if (isPromiseLike(promiseFn)) {
return wantReject(rejects, promiseFn, error, message);
}
var ret = promiseFn();
if (isPromiseLike(ret)) {
return wantReject(rejects, ret, error, message);
} else {
return rejectWithInvalidReturnValue('promiseFn', ret);
}
}
function doesNotReject (promiseFn, error, message) {
if (!(typeof promiseFn === 'function' || isPromiseLike(promiseFn))) {
return rejectWithInvalidArgType('promiseFn', 'function or an instance of Promise', promiseFn);
}
if (typeof error === 'string') {
message = error;
error = undefined;
}
if (isPromiseLike(promiseFn)) {
return doesNotWantReject(doesNotReject, promiseFn, error, message);
}
var ret = promiseFn();
if (isPromiseLike(ret)) {
return doesNotWantReject(doesNotReject, ret, error, message);
} else {
return rejectWithInvalidReturnValue('promiseFn', ret);
}
}
function wantReject (stackStartFn, thennable, errorHandler, message) {
return new Promise(function (resolve, reject) {
var onFulfilled = ensureSettled(reject, function () {
// If a string is provided as the second argument, then error is assumed to be omitted and the string will be used for message instead.
if (typeof errorHandler === 'string' && typeof message === 'undefined') {
message = errorHandler;
errorHandler = undefined;
}
return reject(createMissingRejectionError(stackStartFn, errorHandler, message));
});
var onRejected = ensureSettled(reject, function (actualRejectionResult) {
if (!errorHandler) {
return resolve();
}
if (typeof errorHandler === 'string') {
if (typeof actualRejectionResult === 'object' && actualRejectionResult !== null) {
if (actualRejectionResult.message === errorHandler) {
return reject(createAmbiguousArgumentError('message "' + errorHandler + '"'));
}
} else if (actualRejectionResult === errorHandler) {
return reject(createAmbiguousArgumentError('"' + errorHandler + '"'));
}
}
if (errorHandler instanceof RegExp) {
if (errorHandler.test(actualRejectionResult)) {
return resolve();
} else {
return reject(new AssertionError({
actual: actualRejectionResult,
expected: errorHandler,
message: message || 'The input did not match the regular expression ' + errorHandler + '. Input:\n\n\'' + actualRejectionResult + '\'\n',
operator: stackStartFn.name,
stackStartFn: stackStartFn
}));
}
}
if (typeof errorHandler === 'function') {
// ensureSettled instanceof against arrow functions as they don't have a prototype.
if (errorHandler.prototype !== undefined) {
if (actualRejectionResult instanceof errorHandler) {
return resolve();
} else if (Error.isPrototypeOf(errorHandler)) {
// Dealing with ES2015 class that extends Error
// see: https://github.com/nodejs/node/issues/3188
// see: https://github.com/nodejs/node/pull/4166
return reject(actualRejectionResult);
}
}
var handlerFuncResult = errorHandler.call({}, actualRejectionResult);
if (handlerFuncResult === true) {
return resolve();
} else {
return reject(new AssertionError({
actual: actualRejectionResult,
expected: errorHandler,
message: message || 'The validation function is expected to return "true". Received ' + handlerFuncResult + '\n\nCaught error:\n\n' + actualRejectionResult,
operator: stackStartFn.name,
stackStartFn: stackStartFn
}));
}
}
if (typeof errorHandler === 'object') {
var expectedKeys = Object.keys(errorHandler);
if (errorHandler instanceof Error) {
// an instance of error where each property will be tested for including the non-enumerable message and name properties
expectedKeys.push('name', 'message');
}
var differs = expectedKeys.some(function (key) {
return !(key in actualRejectionResult) ||
!deepStrictEqual(actualRejectionResult[key], errorHandler[key]);
});
if (differs) {
return reject(new AssertionError({
actual: actualRejectionResult,
expected: errorHandler,
message: message || createComparisonMessage(actualRejectionResult, errorHandler, expectedKeys, stackStartFn),
operator: stackStartFn.name,
stackStartFn: stackStartFn
}));
} else {
return resolve();
}
}
return reject(actualRejectionResult);
});
thennable.then(onFulfilled, onRejected);
});
}
function doesNotWantReject (stackStartFn, thennable, errorHandler, message) {
return new Promise(function (resolve, reject) {
var onFulfilled = ensureSettled(reject, function () {
return resolve();
});
var onRejected = ensureSettled(reject, function (actualRejectionResult) {
if (!errorHandler) {
return reject(createUnwantedRejectionError(stackStartFn, actualRejectionResult, errorHandler, message));
}
if (errorHandler instanceof RegExp) {
if (errorHandler.test(actualRejectionResult)) {
return reject(createUnwantedRejectionError(stackStartFn, actualRejectionResult, errorHandler, message));
} else {
return reject(actualRejectionResult);
}
} else if (typeof errorHandler === 'function') {
if (errorHandler.prototype !== undefined) {
if (actualRejectionResult instanceof errorHandler) {
return reject(createUnwantedRejectionError(stackStartFn, actualRejectionResult, errorHandler, message));
} else if (Error.isPrototypeOf(errorHandler)) {
return reject(actualRejectionResult);
}
}
if (errorHandler.call({}, actualRejectionResult) === true) {
return reject(createUnwantedRejectionError(stackStartFn, actualRejectionResult, errorHandler, message));
} else {
return reject(actualRejectionResult);
}
} else {
return reject(createInvalidArgTypeError('expected', 'function or an instance of RegExp', errorHandler));
}
});
thennable.then(onFulfilled, onRejected);
});
}
function createMissingRejectionError (stackStartFn, expected, message) {
var failureMessage = 'Missing expected rejection';
if (expected && expected.name) {
failureMessage += ' (' + expected.name + ')';
}
failureMessage += message ? ': ' + message : '.';
return new AssertionError({
actual: undefined,
expected: expected,
operator: stackStartFn.name,
message: failureMessage,
stackStartFn: stackStartFn
});
}
function createUnwantedRejectionError (stackStartFn, actual, expected, message) {
var actualMessage = actual && actual.message;
var failureMessage = 'Got unwanted rejection';
failureMessage += message ? ': ' + message : '.';
failureMessage += '\nActual message: "' + actualMessage + '"';
return new AssertionError({
actual: actual,
expected: expected,
operator: stackStartFn.name,
message: failureMessage,
stackStartFn: stackStartFn
});
}
function createAmbiguousArgumentError (msg) {
var te = new TypeError('The "error/message" argument is ambiguous. The error ' + msg + ' is identical to the message.');
te.code = 'ERR_AMBIGUOUS_ARGUMENT';
return te;
}
function createInvalidArgTypeError (argName, typeNames, actualArg) {
var actualArgDesc = actualArg === null ? 'null' : 'type ' + typeof actualArg;
var te = new TypeError('The "' + argName + '" argument must be of type ' + typeNames + '. Received ' + actualArgDesc);
te.code = 'ERR_INVALID_ARG_TYPE';
return te;
}
function createInvalidReturnValueError (fnName, ret) {
var wrongType;
if (ret && ret.constructor && ret.constructor.name) {
wrongType = 'instance of ' + ret.constructor.name;
} else {
wrongType = 'type ' + typeof ret;
}
var te = new TypeError('Expected instance of Promise to be returned from the "' + fnName + '" function but got ' + wrongType + '.');
te.code = 'ERR_INVALID_RETURN_VALUE';
return te;
}
function rejectWithInvalidArgType (argName, typeNames, actualArg) {
return Promise.reject(createInvalidArgTypeError(argName, typeNames, actualArg));
}
function rejectWithInvalidReturnValue (fnName, ret) {
return Promise.reject(createInvalidReturnValueError(fnName, ret));
}
function comparison (obj, keys) {
var dest = {};
keys.forEach(function (key) {
if (key in obj) {
dest[key] = obj[key];
}
});
return dest;
}
function createComparisonMessage (actual, expected, keys, stackStartFn) {
var a = comparison(actual, keys);
var b = comparison(expected, keys);
var tmpLimit = Error.stackTraceLimit;
Error.stackTraceLimit = 0;
var err = new AssertionError({
actual: a,
expected: b,
operator: 'deepStrictEqual',
stackStartFn: stackStartFn
});
Error.stackTraceLimit = tmpLimit;
return err.message;
}
function isPromiseLike (obj) {
return obj !== null &&
typeof obj === 'object' &&
typeof obj.then === 'function' &&
typeof obj.catch === 'function';
}
function ensureSettled (reject, promiseFn) {
return function () {
try {
return promiseFn.apply(null, slice.call(arguments));
} catch (e) {
return reject(e);
}
};
}
module.exports = {
rejects: ensureSettled(function (e) { return Promise.reject(e); }, rejects),
doesNotReject: ensureSettled(function (e) { return Promise.reject(e); }, doesNotReject)
};