promise.js
11.1 KB
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
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
'use strict';
var util = require('util');
var EventEmitter = require('events').EventEmitter;
function toArray(arr, start, end) {
return Array.prototype.slice.call(arr, start, end)
}
function strongUnshift(x, arrLike) {
var arr = toArray(arrLike);
arr.unshift(x);
return arr;
}
/**
* MPromise constructor.
*
* _NOTE: The success and failure event names can be overridden by setting `Promise.SUCCESS` and `Promise.FAILURE` respectively._
*
* @param {Function} back a function that accepts `fn(err, ...){}` as signature
* @inherits NodeJS EventEmitter http://nodejs.org/api/events.html#events_class_events_eventemitter
* @event `reject`: Emits when the promise is rejected (event name may be overridden)
* @event `fulfill`: Emits when the promise is fulfilled (event name may be overridden)
* @api public
*/
function Promise(back) {
this.emitter = new EventEmitter();
this.emitted = {};
this.ended = false;
if ('function' == typeof back) {
this.ended = true;
this.onResolve(back);
}
}
/*
* Module exports.
*/
module.exports = Promise;
/*!
* event names
*/
Promise.SUCCESS = 'fulfill';
Promise.FAILURE = 'reject';
/**
* Adds `listener` to the `event`.
*
* If `event` is either the success or failure event and the event has already been emitted, the`listener` is called immediately and passed the results of the original emitted event.
*
* @param {String} event
* @param {Function} callback
* @return {MPromise} this
* @api private
*/
Promise.prototype.on = function (event, callback) {
if (this.emitted[event])
callback.apply(undefined, this.emitted[event]);
else
this.emitter.on(event, callback);
return this;
};
/**
* Keeps track of emitted events to run them on `on`.
*
* @api private
*/
Promise.prototype.safeEmit = function (event) {
// ensures a promise can't be fulfill() or reject() more than once
if (event == Promise.SUCCESS || event == Promise.FAILURE) {
if (this.emitted[Promise.SUCCESS] || this.emitted[Promise.FAILURE]) {
return this;
}
this.emitted[event] = toArray(arguments, 1);
}
this.emitter.emit.apply(this.emitter, arguments);
return this;
};
/**
* @api private
*/
Promise.prototype.hasRejectListeners = function () {
return EventEmitter.listenerCount(this.emitter, Promise.FAILURE) > 0;
};
/**
* Fulfills this promise with passed arguments.
*
* If this promise has already been fulfilled or rejected, no action is taken.
*
* @api public
*/
Promise.prototype.fulfill = function () {
return this.safeEmit.apply(this, strongUnshift(Promise.SUCCESS, arguments));
};
/**
* Rejects this promise with `reason`.
*
* If this promise has already been fulfilled or rejected, no action is taken.
*
* @api public
* @param {Object|String} reason
* @return {MPromise} this
*/
Promise.prototype.reject = function (reason) {
if (this.ended && !this.hasRejectListeners())
throw reason;
return this.safeEmit(Promise.FAILURE, reason);
};
/**
* Resolves this promise to a rejected state if `err` is passed or
* fulfilled state if no `err` is passed.
*
* @param {Error} [err] error or null
* @param {Object} [val] value to fulfill the promise with
* @api public
*/
Promise.prototype.resolve = function (err, val) {
if (err) return this.reject(err);
return this.fulfill(val);
};
/**
* Adds a listener to the SUCCESS event.
*
* @return {MPromise} this
* @api public
*/
Promise.prototype.onFulfill = function (fn) {
if (!fn) return this;
if ('function' != typeof fn) throw new TypeError("fn should be a function");
return this.on(Promise.SUCCESS, fn);
};
/**
* Adds a listener to the FAILURE event.
*
* @return {MPromise} this
* @api public
*/
Promise.prototype.onReject = function (fn) {
if (!fn) return this;
if ('function' != typeof fn) throw new TypeError("fn should be a function");
return this.on(Promise.FAILURE, fn);
};
/**
* Adds a single function as a listener to both SUCCESS and FAILURE.
*
* It will be executed with traditional node.js argument position:
* function (err, args...) {}
*
* Also marks the promise as `end`ed, since it's the common use-case, and yet has no
* side effects unless `fn` is undefined or null.
*
* @param {Function} fn
* @return {MPromise} this
*/
Promise.prototype.onResolve = function (fn) {
if (!fn) return this;
if ('function' != typeof fn) throw new TypeError("fn should be a function");
this.on(Promise.FAILURE, function (err) { fn.call(this, err); });
this.on(Promise.SUCCESS, function () { fn.apply(this, strongUnshift(null, arguments)); });
return this;
};
/**
* Creates a new promise and returns it. If `onFulfill` or
* `onReject` are passed, they are added as SUCCESS/ERROR callbacks
* to this promise after the next tick.
*
* Conforms to [promises/A+](https://github.com/promises-aplus/promises-spec) specification. Read for more detail how to use this method.
*
* ####Example:
*
* var p = new Promise;
* p.then(function (arg) {
* return arg + 1;
* }).then(function (arg) {
* throw new Error(arg + ' is an error!');
* }).then(null, function (err) {
* assert.ok(err instanceof Error);
* assert.equal('2 is an error', err.message);
* });
* p.complete(1);
*
* @see promises-A+ https://github.com/promises-aplus/promises-spec
* @param {Function} onFulfill
* @param {Function} [onReject]
* @return {MPromise} newPromise
*/
Promise.prototype.then = function (onFulfill, onReject) {
var newPromise = new Promise;
if ('function' == typeof onFulfill) {
this.onFulfill(handler(newPromise, onFulfill));
} else {
this.onFulfill(newPromise.fulfill.bind(newPromise));
}
if ('function' == typeof onReject) {
this.onReject(handler(newPromise, onReject));
} else {
this.onReject(newPromise.reject.bind(newPromise));
}
return newPromise;
};
function handler(promise, fn) {
function newTickHandler() {
var pDomain = promise.emitter.domain;
if (pDomain && pDomain !== process.domain) pDomain.enter();
try {
var x = fn.apply(undefined, boundHandler.args);
} catch (err) {
promise.reject(err);
return;
}
resolve(promise, x);
}
function boundHandler() {
boundHandler.args = arguments;
process.nextTick(newTickHandler);
}
return boundHandler;
}
function resolve(promise, x) {
function fulfillOnce() {
if (done++) return;
resolve.apply(undefined, strongUnshift(promise, arguments));
}
function rejectOnce(reason) {
if (done++) return;
promise.reject(reason);
}
if (promise === x) {
promise.reject(new TypeError("promise and x are the same"));
return;
}
var rest = toArray(arguments, 1);
var type = typeof x;
if ('undefined' == type || null == x || !('object' == type || 'function' == type)) {
promise.fulfill.apply(promise, rest);
return;
}
try {
var theThen = x.then;
} catch (err) {
promise.reject(err);
return;
}
if ('function' != typeof theThen) {
promise.fulfill.apply(promise, rest);
return;
}
var done = 0;
try {
var ret = theThen.call(x, fulfillOnce, rejectOnce);
return ret;
} catch (err) {
if (done++) return;
promise.reject(err);
}
}
/**
* Signifies that this promise was the last in a chain of `then()s`: if a handler passed to the call to `then` which produced this promise throws, the exception will go uncaught.
*
* ####Example:
*
* var p = new Promise;
* p.then(function(){ throw new Error('shucks') });
* setTimeout(function () {
* p.fulfill();
* // error was caught and swallowed by the promise returned from
* // p.then(). we either have to always register handlers on
* // the returned promises or we can do the following...
* }, 10);
*
* // this time we use .end() which prevents catching thrown errors
* var p = new Promise;
* var p2 = p.then(function(){ throw new Error('shucks') }).end(); // <--
* setTimeout(function () {
* p.fulfill(); // throws "shucks"
* }, 10);
*
* @api public
* @param {Function} [onReject]
* @return {MPromise} this
*/
Promise.prototype.end = Promise.prototype['catch'] = function (onReject) {
if (!onReject && !this.hasRejectListeners())
onReject = function idRejector(e) { throw e; };
this.onReject(onReject);
this.ended = true;
return this;
};
/**
* A debug utility function that adds handlers to a promise that will log some output to the `console`
*
* ####Example:
*
* var p = new Promise;
* p.then(function(){ throw new Error('shucks') });
* setTimeout(function () {
* p.fulfill();
* // error was caught and swallowed by the promise returned from
* // p.then(). we either have to always register handlers on
* // the returned promises or we can do the following...
* }, 10);
*
* // this time we use .end() which prevents catching thrown errors
* var p = new Promise;
* var p2 = p.then(function(){ throw new Error('shucks') }).end(); // <--
* setTimeout(function () {
* p.fulfill(); // throws "shucks"
* }, 10);
*
* @api public
* @param {MPromise} p
* @param {String} name
* @return {MPromise} this
*/
Promise.trace = function (p, name) {
p.then(
function () {
console.log("%s fulfill %j", name, toArray(arguments));
},
function () {
console.log("%s reject %j", name, toArray(arguments));
}
)
};
Promise.prototype.chain = function (p2) {
var p1 = this;
p1.onFulfill(p2.fulfill.bind(p2));
p1.onReject(p2.reject.bind(p2));
return p2;
};
Promise.prototype.all = function (promiseOfArr) {
var pRet = new Promise;
this.then(promiseOfArr).then(
function (promiseArr) {
var count = 0;
var ret = [];
var errSentinel;
if (!promiseArr.length) pRet.resolve();
promiseArr.forEach(function (promise, index) {
if (errSentinel) return;
count++;
promise.then(
function (val) {
if (errSentinel) return;
ret[index] = val;
--count;
if (count == 0) pRet.fulfill(ret);
},
function (err) {
if (errSentinel) return;
errSentinel = err;
pRet.reject(err);
}
);
});
return pRet;
}
, pRet.reject.bind(pRet)
);
return pRet;
};
Promise.hook = function (arr) {
var p1 = new Promise;
var pFinal = new Promise;
var signalP = function () {
--count;
if (count == 0)
pFinal.fulfill();
return pFinal;
};
var count = 1;
var ps = p1;
arr.forEach(function (hook) {
ps = ps.then(
function () {
var p = new Promise;
count++;
hook(p.resolve.bind(p), signalP);
return p;
}
)
});
ps = ps.then(signalP);
p1.resolve();
return ps;
};
/* This is for the A+ tests, but it's very useful as well */
Promise.fulfilled = function fulfilled() { var p = new Promise; p.fulfill.apply(p, arguments); return p; };
Promise.rejected = function rejected(reason) { return new Promise().reject(reason); };
Promise.deferred = function deferred() {
var p = new Promise;
return {
promise: p,
reject: p.reject.bind(p),
resolve: p.fulfill.bind(p),
callback: p.resolve.bind(p)
}
};
/* End A+ tests adapter bit */