serverless/lib/classes/PromiseTracker.js

Serverless Framework - Build web, mobile and IoT applications with serverless architectures using AWS Lambda, Azure Functions, Google CloudFunctions & more

'use strict';

const logInfo = require('./Error').logInfo;

class PromiseTracker {
  constructor() {
    this.reset();
  }
  reset() {
    this.promiseList = [];
    this.promiseMap = {};
    this.startTime = Date.now();
  }
  start() {
    this.reset();
    this.interval = setInterval(this.report.bind(this), 2500);
  }
  report() {
    const delta = Date.now() - this.startTime;
    const pending = this.getPending();
    logInfo([
      '##########################################################################################',
      `# ${delta}: ${this.getSettled().length} of ${this.getAll().length} promises have settled`,
      `# ${delta}: ${pending.length} unsettled promises:`,
    ].concat(
      pending.map((promise) => `# ${delta}:   ${promise.waitList}`)
    ).concat([
      '# This can result from latent connections but may represent a cyclic variable dependency',
      '##########################################################################################',
    ]).join('\n  '));
  }
  stop() {
    clearInterval(this.interval);
    this.reset();
  }
  add(variable, prms, specifier) {
    const promise = prms;
    promise.waitList = `${variable} waited on by: ${specifier}`;
    promise.state = 'pending';
    promise.then( // creates a promise with the following effects but that we otherwise ignore
      () => { promise.state = 'resolved'; },
      () => { promise.state = 'rejected'; });
    this.promiseList.push(promise);
    this.promiseMap[variable] = promise;
    return promise;
  }
  contains(variable) {
    return variable in this.promiseMap;
  }
  get(variable, specifier) {
    const promise = this.promiseMap[variable];
    promise.waitList += ` ${specifier}`;
    return promise;
  }
  getPending() { return this.promiseList.filter(p => (p.state === 'pending')); }
  getSettled() { return this.promiseList.filter(p => (p.state !== 'pending')); }
  getAll() { return this.promiseList; }
}

module.exports = PromiseTracker;