gecko/services/metrics/collector.jsm

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

"use strict";

this.EXPORTED_SYMBOLS = ["MetricsCollector"];

const {utils: Cu} = Components;

Cu.import("resource://gre/modules/commonjs/promise/core.js");
Cu.import("resource://services-common/log4moz.js");
Cu.import("resource://services-common/utils.js");
Cu.import("resource://gre/modules/services/metrics/dataprovider.jsm");


/**
 * Handles and coordinates the collection of metrics data from providers.
 *
 * This provides an interface for managing `MetricsProvider` instances. It
 * provides APIs for bulk collection of data.
 */
this.MetricsCollector = function MetricsCollector() {
  this._log = Log4Moz.repository.getLogger("Metrics.MetricsCollector");

  this._providers = [];
  this.collectionResults = new Map();
  this.providerErrors = new Map();
}

MetricsCollector.prototype = {
  /**
   * Registers a `MetricsProvider` with this collector.
   *
   * Once a `MetricsProvider` is registered, data will be collected from it
   * whenever we collect data.
   *
   * @param provider
   *        (MetricsProvider) The provider instance to register.
   */
  registerProvider: function registerProvider(provider) {
    if (!(provider instanceof MetricsProvider)) {
      throw new Error("argument must be a MetricsProvider instance.");
    }

    for (let p of this._providers) {
      if (p.provider == provider) {
        return;
      }
    }

    this._providers.push({
      provider: provider,
      constantsCollected: false,
    });

    this.providerErrors.set(provider.name, []);
  },

  /**
   * Collects all constant measurements from all providers.
   *
   * Returns a Promise that will be fulfilled once all data providers have
   * provided their constant data. A side-effect of this promise fulfillment
   * is that the collector is populated with the obtained collection results.
   * The resolved value to the promise is this `MetricsCollector` instance.
   */
  collectConstantMeasurements: function collectConstantMeasurements() {
    let promises = [];

    for (let provider of this._providers) {
      let name = provider.provider.name;

      if (provider.constantsCollected) {
        this._log.trace("Provider has already provided constant data: " +
                        name);
        continue;
      }

      let result;
      try {
        result = provider.provider.collectConstantMeasurements();
      } catch (ex) {
        this._log.warn("Exception when calling " + name +
                       ".collectConstantMeasurements: " +
                       CommonUtils.exceptionStr(ex));
        this.providerErrors.get(name).push(ex);
        continue;
      }

      if (!result) {
        this._log.trace("Provider does not provide constant data: " + name);
        continue;
      }

      try {
        this._log.debug("Populating constant measurements: " + name);
        result.populate(result);
      } catch (ex) {
        this._log.warn("Exception when calling " + name + ".populate(): " +
                       CommonUtils.exceptionStr(ex));
        result.addError(ex);
        promises.push(Promise.resolve(result));
        continue;
      }

      // Chain an invisible promise that updates state.
      let promise = result.onFinished(function onFinished(result) {
        provider.constantsCollected = true;

        return Promise.resolve(result);
      });

      promises.push(promise);
    }

    return this._handleCollectionPromises(promises);
  },

  /**
   * Handles promises returned by the collect* functions.
   *
   * This consumes the data resolved by the promises and returns a new promise
   * that will be resolved once all promises have been resolved.
   */
  _handleCollectionPromises: function _handleCollectionPromises(promises) {
    if (!promises.length) {
      return Promise.resolve(this);
    }

    let deferred = Promise.defer();
    let finishedCount = 0;

    let onResult = function onResult(result) {
      try {
        this._log.debug("Got result for " + result.name);

        if (this.collectionResults.has(result.name)) {
          this.collectionResults.get(result.name).aggregate(result);
        } else {
          this.collectionResults.set(result.name, result);
        }
      } finally {
        finishedCount++;
        if (finishedCount >= promises.length) {
          deferred.resolve(this);
        }
      }
    }.bind(this);

    let onError = function onError(error) {
      this._log.warn("Error when handling result: " +
                     CommonUtils.exceptionStr(error));
      deferred.reject(error);
    }.bind(this);

    for (let promise of promises) {
      promise.then(onResult, onError);
    }

    return deferred.promise;
  },
};

Object.freeze(MetricsCollector.prototype);