All files / lib async_hooks.js

99.37% Statements 315/317
98.7% Branches 76/77
100% Functions 19/19
99.37% Lines 315/317

Press n or j to go to the next uncovered block, b, p or k for the previous block.

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 31843x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 2794x 2794x 2794x 2794x 2794x 2794x 2794x 2794x 2794x 2794x 2759x 2759x 2759x 2759x 2759x 2759x 2794x 43x 43x 2592x 2592x 2592x 2592x 2592x 2592x 2592x 2592x 2592x 2428x 2428x 2428x 2428x 2428x 2428x 2428x 2428x 2428x 2428x 2428x 2428x 2428x 2428x 2592x 276x 276x 2428x 2428x 2592x 43x 43x 2228x 2228x 2228x 2228x 2228x 2219x 2219x 2219x 2219x 2219x 2219x 2219x 2219x 2219x 2219x 2219x 2228x 61x 61x 2219x 2219x 2228x 43x 43x 43x 2794x 2794x 2794x 43x 43x 43x 43x 43x 43x 43x 43x 4329x 4329x 4329x 4329x 4329x 4317x 4317x 4317x 4317x 4321x 4321x 4321x 4329x 3x 3x 4318x 4318x 4318x 4318x 4318x 4318x 2166x 1x 1x 2165x 2165x 2165x 4316x 4316x 4182x 4182x 4182x 4182x 4182x 4329x 43x 43x 2159x 2159x 2159x 2159x 2159x 2159x 2159x 2159x 2159x 2159x 2158x 2158x 2158x 2159x 43x 43x 139x 6x 6x 139x 139x 139x 43x 43x 4012x 4012x 43x 43x 4010x 4010x 43x 43x 43x 43x 43x 74x 74x 74x 79x 79x 74x 43x 43x 43x 43x 14x 14x 14x 43x 43x 2x 2x 2x 2x 2x 2x 2x 2x 2x 43x 43x 43x 79x 79x 72x 72x 79x 43x 43x 25x 15x 15x 15x 15x 25x 25x 25x 43x 43x 11x 11x 11x 11x 11x 11x 11x 11x 11x 43x 43x 4x     4x 4x 4x 4x 4x 4x 4x 43x 43x 65x 65x 58x 58x 65x 43x 43x 13x 13x 13x 13x 13x 13x 43x 43x 5x 1x 1x 4x 4x 4x 5x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x  
'use strict';
 
const {
  NumberIsSafeInteger,
  ReflectApply,
  Symbol,
} = primordials;
 
const {
  ERR_ASYNC_CALLBACK,
  ERR_ASYNC_TYPE,
  ERR_INVALID_ASYNC_ID
} = require('internal/errors').codes;
const { validateString } = require('internal/validators');
const internal_async_hooks = require('internal/async_hooks');
 
// Get functions
// For userland AsyncResources, make sure to emit a destroy event when the
// resource gets gced.
const { registerDestroyHook } = internal_async_hooks;
const {
  executionAsyncId,
  triggerAsyncId,
  // Private API
  hasAsyncIdStack,
  getHookArrays,
  enableHooks,
  disableHooks,
  executionAsyncResource,
  // Internal Embedder API
  newAsyncId,
  getDefaultTriggerAsyncId,
  emitInit,
  emitBefore,
  emitAfter,
  emitDestroy,
  enabledHooksExist,
  initHooksExist,
} = internal_async_hooks;
 
// Get symbols
const {
  async_id_symbol, trigger_async_id_symbol,
  init_symbol, before_symbol, after_symbol, destroy_symbol,
  promise_resolve_symbol
} = internal_async_hooks.symbols;
 
// Get constants
const {
  kInit, kBefore, kAfter, kDestroy, kTotals, kPromiseResolve,
} = internal_async_hooks.constants;
 
// Listener API //
 
class AsyncHook {
  constructor({ init, before, after, destroy, promiseResolve }) {
    if (init !== undefined && typeof init !== 'function')
      throw new ERR_ASYNC_CALLBACK('hook.init');
    if (before !== undefined && typeof before !== 'function')
      throw new ERR_ASYNC_CALLBACK('hook.before');
    if (after !== undefined && typeof after !== 'function')
      throw new ERR_ASYNC_CALLBACK('hook.after');
    if (destroy !== undefined && typeof destroy !== 'function')
      throw new ERR_ASYNC_CALLBACK('hook.destroy');
    if (promiseResolve !== undefined && typeof promiseResolve !== 'function')
      throw new ERR_ASYNC_CALLBACK('hook.promiseResolve');
 
    this[init_symbol] = init;
    this[before_symbol] = before;
    this[after_symbol] = after;
    this[destroy_symbol] = destroy;
    this[promise_resolve_symbol] = promiseResolve;
  }
 
  enable() {
    // The set of callbacks for a hook should be the same regardless of whether
    // enable()/disable() are run during their execution. The following
    // references are reassigned to the tmp arrays if a hook is currently being
    // processed.
    const [hooks_array, hook_fields] = getHookArrays();
 
    // Each hook is only allowed to be added once.
    if (hooks_array.includes(this))
      return this;
 
    const prev_kTotals = hook_fields[kTotals];
 
    // createHook() has already enforced that the callbacks are all functions,
    // so here simply increment the count of whether each callbacks exists or
    // not.
    hook_fields[kTotals] = hook_fields[kInit] += +!!this[init_symbol];
    hook_fields[kTotals] += hook_fields[kBefore] += +!!this[before_symbol];
    hook_fields[kTotals] += hook_fields[kAfter] += +!!this[after_symbol];
    hook_fields[kTotals] += hook_fields[kDestroy] += +!!this[destroy_symbol];
    hook_fields[kTotals] +=
        hook_fields[kPromiseResolve] += +!!this[promise_resolve_symbol];
    hooks_array.push(this);
 
    if (prev_kTotals === 0 && hook_fields[kTotals] > 0) {
      enableHooks();
    }
 
    return this;
  }
 
  disable() {
    const [hooks_array, hook_fields] = getHookArrays();
 
    const index = hooks_array.indexOf(this);
    if (index === -1)
      return this;
 
    const prev_kTotals = hook_fields[kTotals];
 
    hook_fields[kTotals] = hook_fields[kInit] -= +!!this[init_symbol];
    hook_fields[kTotals] += hook_fields[kBefore] -= +!!this[before_symbol];
    hook_fields[kTotals] += hook_fields[kAfter] -= +!!this[after_symbol];
    hook_fields[kTotals] += hook_fields[kDestroy] -= +!!this[destroy_symbol];
    hook_fields[kTotals] +=
        hook_fields[kPromiseResolve] -= +!!this[promise_resolve_symbol];
    hooks_array.splice(index, 1);
 
    if (prev_kTotals > 0 && hook_fields[kTotals] === 0) {
      disableHooks();
    }
 
    return this;
  }
}
 
 
function createHook(fns) {
  return new AsyncHook(fns);
}
 
 
// Embedder API //
 
const destroyedSymbol = Symbol('destroyed');
 
class AsyncResource {
  constructor(type, opts = {}) {
    validateString(type, 'type');
 
    let triggerAsyncId = opts;
    let requireManualDestroy = false;
    if (typeof opts !== 'number') {
      triggerAsyncId = opts.triggerAsyncId === undefined ?
        getDefaultTriggerAsyncId() : opts.triggerAsyncId;
      requireManualDestroy = !!opts.requireManualDestroy;
    }
 
    // Unlike emitInitScript, AsyncResource doesn't supports null as the
    // triggerAsyncId.
    if (!NumberIsSafeInteger(triggerAsyncId) || triggerAsyncId < -1) {
      throw new ERR_INVALID_ASYNC_ID('triggerAsyncId', triggerAsyncId);
    }
 
    const asyncId = newAsyncId();
    this[async_id_symbol] = asyncId;
    this[trigger_async_id_symbol] = triggerAsyncId;
 
    if (initHooksExist()) {
      if (enabledHooksExist() && type.length === 0) {
        throw new ERR_ASYNC_TYPE(type);
      }
 
      emitInit(asyncId, type, triggerAsyncId, this);
    }
 
    if (!requireManualDestroy) {
      // This prop name (destroyed) has to be synchronized with C++
      const destroyed = { destroyed: false };
      this[destroyedSymbol] = destroyed;
      registerDestroyHook(this, asyncId, destroyed);
    }
  }
 
  runInAsyncScope(fn, thisArg, ...args) {
    const asyncId = this[async_id_symbol];
    emitBefore(asyncId, this[trigger_async_id_symbol], this);
 
    try {
      const ret = thisArg === undefined ?
        fn(...args) :
        ReflectApply(fn, thisArg, args);
 
      return ret;
    } finally {
      if (hasAsyncIdStack())
        emitAfter(asyncId);
    }
  }
 
  emitDestroy() {
    if (this[destroyedSymbol] !== undefined) {
      this[destroyedSymbol].destroyed = true;
    }
    emitDestroy(this[async_id_symbol]);
    return this;
  }
 
  asyncId() {
    return this[async_id_symbol];
  }
 
  triggerAsyncId() {
    return this[trigger_async_id_symbol];
  }
}
 
const storageList = [];
const storageHook = createHook({
  init(asyncId, type, triggerAsyncId, resource) {
    const currentResource = executionAsyncResource();
    // Value of currentResource is always a non null object
    for (let i = 0; i < storageList.length; ++i) {
      storageList[i]._propagate(resource, currentResource);
    }
  }
});
 
class AsyncLocalStorage {
  constructor() {
    this.kResourceStore = Symbol('kResourceStore');
    this.enabled = false;
  }
 
  disable() {
    if (this.enabled) {
      this.enabled = false;
      // If this.enabled, the instance must be in storageList
      storageList.splice(storageList.indexOf(this), 1);
      if (storageList.length === 0) {
        storageHook.disable();
      }
    }
  }
 
  // Propagate the context from a parent resource to a child one
  _propagate(resource, triggerResource) {
    const store = triggerResource[this.kResourceStore];
    if (this.enabled) {
      resource[this.kResourceStore] = store;
    }
  }
 
  enterWith(store) {
    if (!this.enabled) {
      this.enabled = true;
      storageList.push(this);
      storageHook.enable();
    }
    const resource = executionAsyncResource();
    resource[this.kResourceStore] = store;
  }
 
  runSyncAndReturn(store, callback, ...args) {
    const resource = executionAsyncResource();
    const outerStore = resource[this.kResourceStore];
    this.enterWith(store);
    try {
      return callback(...args);
    } finally {
      resource[this.kResourceStore] = outerStore;
    }
  }
 
  exitSyncAndReturn(callback, ...args) {
    if (!this.enabled) {
      return callback(...args);
    }
    this.enabled = false;
    try {
      return callback(...args);
    } finally {
      this.enabled = true;
    }
  }
 
  getStore() {
    const resource = executionAsyncResource();
    if (this.enabled) {
      return resource[this.kResourceStore];
    }
  }
 
  run(store, callback, ...args) {
    const resource = executionAsyncResource();
    const outerStore = resource[this.kResourceStore];
    this.enterWith(store);
    process.nextTick(callback, ...args);
    resource[this.kResourceStore] = outerStore;
  }
 
  exit(callback, ...args) {
    if (!this.enabled) {
      return process.nextTick(callback, ...args);
    }
    this.enabled = false;
    process.nextTick(callback, ...args);
    this.enabled = true;
  }
}
 
// Placing all exports down here because the exported classes won't export
// otherwise.
module.exports = {
  // Public API
  AsyncLocalStorage,
  createHook,
  executionAsyncId,
  triggerAsyncId,
  executionAsyncResource,
  // Embedder API
  AsyncResource,
};