Blame view
node_modules/async-listener/glue.js
13.6 KB
f7563de62
|
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 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 |
var wrap = require('shimmer').wrap; /* * * CONSTANTS * */ var HAS_CREATE_AL = 1 << 0; var HAS_BEFORE_AL = 1 << 1; var HAS_AFTER_AL = 1 << 2; var HAS_ERROR_AL = 1 << 3; /** * There is one list of currently active listeners that is mutated in place by * addAsyncListener and removeAsyncListener. This complicates error-handling, * for reasons that are discussed below. */ var listeners = []; /** * There can be multiple listeners with the same properties, so disambiguate * them by assigning them an ID at creation time. */ var uid = 0; /** * Ensure that errors coming from within listeners are handed off to domains, * process._fatalException, or uncaughtException without being treated like * user errors. */ var inAsyncTick = false; /** * Because asynchronous contexts can be nested, and errors can come from anywhere * in the stack, a little extra work is required to keep track of where in the * nesting we are. Because JS arrays are frequently mutated in place */ var listenerStack = []; /** * The error handler on a listener can capture errors thrown during synchronous * execution immediately after the listener is added. To capture both * synchronous and asynchronous errors, the error handler just uses the * "global" list of active listeners, and the rest of the code ensures that the * listener list is correct by using a stack of listener lists during * asynchronous execution. */ var asyncCatcher; /** * The guts of the system -- called each time an asynchronous event happens * while one or more listeners are active. */ var asyncWrap; /** * Simple helper function that's probably faster than using Array * filter methods and can be inlined. */ function union(dest, added) { var destLength = dest.length; var addedLength = added.length; var returned = []; if (destLength === 0 && addedLength === 0) return returned; for (var j = 0; j < destLength; j++) returned[j] = dest[j]; if (addedLength === 0) return returned; for (var i = 0; i < addedLength; i++) { var missing = true; for (j = 0; j < destLength; j++) { if (dest[j].uid === added[i].uid) { missing = false; break; } } if (missing) returned.push(added[i]); } return returned; } /* * For performance, split error-handlers and asyncCatcher up into two separate * code paths. */ // 0.9+ if (process._fatalException) { /** * Error handlers on listeners can throw, the catcher needs to be able to * discriminate between exceptions thrown by user code, and exceptions coming * from within the catcher itself. Use a global to keep track of which state * the catcher is currently in. */ var inErrorTick = false; /** * Throwing always happens synchronously. If the current array of values for * the current list of asyncListeners is put in a module-scoped variable right * before a call that can throw, it will always be correct when the error * handlers are run. */ var errorValues; asyncCatcher = function asyncCatcher(er) { var length = listeners.length; if (inErrorTick || length === 0) return false; var handled = false; /* * error handlers */ inErrorTick = true; for (var i = 0; i < length; ++i) { var listener = listeners[i]; if ((listener.flags & HAS_ERROR_AL) === 0) continue; var value = errorValues && errorValues[listener.uid]; handled = listener.error(value, er) || handled; } inErrorTick = false; /* Test whether there are any listener arrays on the stack. In the case of * synchronous throws when the listener is active, there may have been * none pushed yet. */ if (listenerStack.length > 0) listeners = listenerStack.pop(); errorValues = undefined; return handled && !inAsyncTick; }; asyncWrap = function asyncWrap(original, list, length) { var values = []; /* * listeners */ inAsyncTick = true; for (var i = 0; i < length; ++i) { var listener = list[i]; values[listener.uid] = listener.data; if ((listener.flags & HAS_CREATE_AL) === 0) continue; var value = listener.create(listener.data); if (value !== undefined) values[listener.uid] = value; } inAsyncTick = false; /* One of the main differences between this polyfill and the core * asyncListener support is that core avoids creating closures by putting a * lot of the state managemnt on the C++ side of Node (and of course also it * bakes support for async listeners into the Node C++ API through the * AsyncWrap class, which means that it doesn't monkeypatch basically every * async method like this does). */ return function () { // put the current values where the catcher can see them errorValues = values; /* More than one listener can end up inside these closures, so save the * current listeners on a stack. */ listenerStack.push(listeners); /* Activate both the listeners that were active when the closure was * created and the listeners that were previously active. */ listeners = union(list, listeners); /* * before handlers */ inAsyncTick = true; for (var i = 0; i < length; ++i) { if ((list[i].flags & HAS_BEFORE_AL) > 0) { list[i].before(this, values[list[i].uid]); } } inAsyncTick = false; // save the return value to pass to the after callbacks var returned = original.apply(this, arguments); /* * after handlers (not run if original throws) */ inAsyncTick = true; for (i = 0; i < length; ++i) { if ((list[i].flags & HAS_AFTER_AL) > 0) { list[i].after(this, values[list[i].uid]); } } inAsyncTick = false; // back to the previous listener list on the stack listeners = listenerStack.pop(); errorValues = undefined; return returned; }; }; wrap(process, '_fatalException', function (_fatalException) { return function _asyncFatalException(er) { return asyncCatcher(er) || _fatalException(er); }; }); } // 0.8 and below else { /** * If an error handler in asyncWrap throws, the process must die. Under 0.8 * and earlier the only way to put a bullet through the head of the process * is to rethrow from inside the exception handler, so rethrow and set * errorThrew to tell the uncaughtHandler what to do. */ var errorThrew = false; /** * Under Node 0.8, this handler *only* handles synchronously thrown errors. * This simplifies it, which almost but not quite makes up for the hit taken * by putting everything in a try-catch. */ asyncCatcher = function uncaughtCatcher(er) { // going down hard if (errorThrew) throw er; var handled = false; /* * error handlers */ var length = listeners.length; for (var i = 0; i < length; ++i) { var listener = listeners[i]; if ((listener.flags & HAS_ERROR_AL) === 0) continue; handled = listener.error(null, er) || handled; } /* Rethrow if one of the before / after handlers fire, which will bring the * process down immediately. */ if (!handled && inAsyncTick) throw er; }; asyncWrap = function asyncWrap(original, list, length) { var values = []; /* * listeners */ inAsyncTick = true; for (var i = 0; i < length; ++i) { var listener = list[i]; values[listener.uid] = listener.data; if ((listener.flags & HAS_CREATE_AL) === 0) continue; var value = listener.create(listener.data); if (value !== undefined) values[listener.uid] = value; } inAsyncTick = false; /* One of the main differences between this polyfill and the core * asyncListener support is that core avoids creating closures by putting a * lot of the state managemnt on the C++ side of Node (and of course also it * bakes support for async listeners into the Node C++ API through the * AsyncWrap class, which means that it doesn't monkeypatch basically every * async method like this does). */ return function () { /*jshint maxdepth:4*/ // after() handlers don't run if threw var threw = false; // ...unless the error is handled var handled = false; /* More than one listener can end up inside these closures, so save the * current listeners on a stack. */ listenerStack.push(listeners); /* Activate both the listeners that were active when the closure was * created and the listeners that were previously active. */ listeners = union(list, listeners); /* * before handlers */ inAsyncTick = true; for (var i = 0; i < length; ++i) { if ((list[i].flags & HAS_BEFORE_AL) > 0) { list[i].before(this, values[list[i].uid]); } } inAsyncTick = false; // save the return value to pass to the after callbacks var returned; try { returned = original.apply(this, arguments); } catch (er) { threw = true; for (var i = 0; i < length; ++i) { if ((listeners[i].flags & HAS_ERROR_AL) == 0) continue; try { handled = listeners[i].error(values[list[i].uid], er) || handled; } catch (x) { errorThrew = true; throw x; } } if (!handled) { // having an uncaughtException handler here alters crash semantics process.removeListener('uncaughtException', asyncCatcher); process._originalNextTick(function () { process.addListener('uncaughtException', asyncCatcher); }); throw er; } } finally { /* * after handlers (not run if original throws) */ if (!threw || handled) { inAsyncTick = true; for (i = 0; i < length; ++i) { if ((list[i].flags & HAS_AFTER_AL) > 0) { list[i].after(this, values[list[i].uid]); } } inAsyncTick = false; } // back to the previous listener list on the stack listeners = listenerStack.pop(); } return returned; }; }; // will be the first to fire if async-listener is the first module loaded process.addListener('uncaughtException', asyncCatcher); } // for performance in the case where there are no handlers, just the listener function simpleWrap(original, list, length) { inAsyncTick = true; for (var i = 0; i < length; ++i) { var listener = list[i]; if (listener.create) listener.create(listener.data); } inAsyncTick = false; // still need to make sure nested async calls are made in the context // of the listeners active at their creation return function () { listenerStack.push(listeners); listeners = union(list, listeners); var returned = original.apply(this, arguments); listeners = listenerStack.pop(); return returned; }; } /** * Called each time an asynchronous function that's been monkeypatched in * index.js is called. If there are no listeners, return the function * unwrapped. If there are any asyncListeners and any of them have callbacks, * pass them off to asyncWrap for later use, otherwise just call the listener. */ function wrapCallback(original) { var length = listeners.length; // no context to capture, so avoid closure creation if (length === 0) return original; // capture the active listeners as of when the wrapped function was called var list = listeners.slice(); for (var i = 0; i < length; ++i) { if (list[i].flags > 0) return asyncWrap(original, list, length); } return simpleWrap(original, list, length); } function AsyncListener(callbacks, data) { if (typeof callbacks.create === 'function') { this.create = callbacks.create; this.flags |= HAS_CREATE_AL; } if (typeof callbacks.before === 'function') { this.before = callbacks.before; this.flags |= HAS_BEFORE_AL; } if (typeof callbacks.after === 'function') { this.after = callbacks.after; this.flags |= HAS_AFTER_AL; } if (typeof callbacks.error === 'function') { this.error = callbacks.error; this.flags |= HAS_ERROR_AL; } this.uid = ++uid; this.data = data === undefined ? null : data; } AsyncListener.prototype.create = undefined; AsyncListener.prototype.before = undefined; AsyncListener.prototype.after = undefined; AsyncListener.prototype.error = undefined; AsyncListener.prototype.data = undefined; AsyncListener.prototype.uid = 0; AsyncListener.prototype.flags = 0; function createAsyncListener(callbacks, data) { if (typeof callbacks !== 'object' || !callbacks) { throw new TypeError('callbacks argument must be an object'); } if (callbacks instanceof AsyncListener) { return callbacks; } else { return new AsyncListener(callbacks, data); } } function addAsyncListener(callbacks, data) { var listener; if (!(callbacks instanceof AsyncListener)) { listener = createAsyncListener(callbacks, data); } else { listener = callbacks; } // Make sure the listener isn't already in the list. var registered = false; for (var i = 0; i < listeners.length; i++) { if (listener === listeners[i]) { registered = true; break; } } if (!registered) listeners.push(listener); return listener; } function removeAsyncListener(listener) { for (var i = 0; i < listeners.length; i++) { if (listener === listeners[i]) { listeners.splice(i, 1); break; } } } process.createAsyncListener = createAsyncListener; process.addAsyncListener = addAsyncListener; process.removeAsyncListener = removeAsyncListener; module.exports = wrapCallback; |