gecko/services/metrics/modules-testing/mocks.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 = [
  "DummyMeasurement",
  "DummyProvider",
];

const {utils: Cu} = Components;

Cu.import("resource://gre/modules/services/metrics/dataprovider.jsm");

this.DummyMeasurement = function DummyMeasurement(name="DummyMeasurement") {
  MetricsMeasurement.call(this, name, 2);
}
DummyMeasurement.prototype = {
  __proto__: MetricsMeasurement.prototype,

  fields: {
    "string": {
      type: "TYPE_STRING",
    },

    "uint32": {
      type: "TYPE_UINT32",
      optional: true,
    },
  },
};


this.DummyProvider = function DummyProvider(name="DummyProvider") {
  MetricsProvider.call(this, name);

  this.constantMeasurementName = "DummyMeasurement";
  this.collectConstantCount = 0;
  this.throwDuringCollectConstantMeasurements = null;
  this.throwDuringConstantPopulate = null;
}
DummyProvider.prototype = {
  __proto__: MetricsProvider.prototype,

  collectConstantMeasurements: function collectConstantMeasurements() {
    this.collectConstantCount++;

    let result = this.createResult();
    result.expectMeasurement(this.constantMeasurementName);

    result.populate = this._populateConstantResult.bind(this);

    if (this.throwDuringCollectConstantMeasurements) {
      throw new Error(this.throwDuringCollectConstantMeasurements);
    }

    return result;
  },

  _populateConstantResult: function _populateConstantResult(result) {
    if (this.throwDuringConstantPopulate) {
      throw new Error(this.throwDuringConstantPopulate);
    }

    this._log.debug("Populating constant measurement in DummyProvider.");
    result.addMeasurement(new DummyMeasurement(this.constantMeasurementName));

    result.setValue(this.constantMeasurementName, "string", "foo");
    result.setValue(this.constantMeasurementName, "uint32", 24);

    result.finish();
  },
};