gecko-dev/toolkit/components/telemetry/tests/unit/test_CoveragePing.js
Kris Maglione e930b89c34 Bug 1514594: Part 3 - Change ChromeUtils.import API.
***
Bug 1514594: Part 3a - Change ChromeUtils.import to return an exports object; not pollute global. r=mccr8

This changes the behavior of ChromeUtils.import() to return an exports object,
rather than a module global, in all cases except when `null` is passed as a
second argument, and changes the default behavior not to pollute the global
scope with the module's exports. Thus, the following code written for the old
model:

  ChromeUtils.import("resource://gre/modules/Services.jsm");

is approximately the same as the following, in the new model:

  var {Services} = ChromeUtils.import("resource://gre/modules/Services.jsm");

Since the two behaviors are mutually incompatible, this patch will land with a
scripted rewrite to update all existing callers to use the new model rather
than the old.
***
Bug 1514594: Part 3b - Mass rewrite all JS code to use the new ChromeUtils.import API. rs=Gijs

This was done using the followng script:

https://bitbucket.org/kmaglione/m-c-rewrites/src/tip/processors/cu-import-exports.jsm
***
Bug 1514594: Part 3c - Update ESLint plugin for ChromeUtils.import API changes. r=Standard8

Differential Revision: https://phabricator.services.mozilla.com/D16747
***
Bug 1514594: Part 3d - Remove/fix hundreds of duplicate imports from sync tests. r=Gijs

Differential Revision: https://phabricator.services.mozilla.com/D16748
***
Bug 1514594: Part 3e - Remove no-op ChromeUtils.import() calls. r=Gijs

Differential Revision: https://phabricator.services.mozilla.com/D16749
***
Bug 1514594: Part 3f.1 - Cleanup various test corner cases after mass rewrite. r=Gijs
***
Bug 1514594: Part 3f.2 - Cleanup various non-test corner cases after mass rewrite. r=Gijs

Differential Revision: https://phabricator.services.mozilla.com/D16750

--HG--
extra : rebase_source : 359574ee3064c90f33bf36c2ebe3159a24cc8895
extra : histedit_source : b93c8f42808b1599f9122d7842d2c0b3e656a594%2C64a3a4e3359dc889e2ab2b49461bab9e27fc10a7
2019-01-17 10:18:31 -08:00

103 lines
3.5 KiB
JavaScript

/* -*- Mode: indent-tabs-mode: nil; js-indent-level: 2 -*- */
/* vim: set sts=2 sw=2 et tw=80: */
"use strict";
const {NetUtil} = ChromeUtils.import("resource://gre/modules/NetUtil.jsm");
const {Services} = ChromeUtils.import("resource://gre/modules/Services.jsm");
const {HttpServer} = ChromeUtils.import("resource://testing-common/httpd.js");
const COVERAGE_VERSION = "2";
const COVERAGE_ENABLED_PREF = "toolkit.coverage.enabled";
const OPT_OUT_PREF = "toolkit.coverage.opt-out";
const ALREADY_RUN_PREF = `toolkit.coverage.already-run.v${COVERAGE_VERSION}`;
const COVERAGE_UUID_PREF = `toolkit.coverage.uuid.v${COVERAGE_VERSION}`;
const TELEMETRY_ENABLED_PREF = "datareporting.healthreport.uploadEnabled";
const REPORTING_ENDPOINT_BASE_PREF = "toolkit.coverage.endpoint.base";
const REPORTING_ENDPOINT = "submit/coverage/coverage";
Services.prefs.setIntPref("toolkit.coverage.log-level", 20);
add_task(async function setup() {
let uuid = "test123";
Services.prefs.setCharPref(COVERAGE_UUID_PREF, uuid);
const server = new HttpServer();
server.start(-1);
const serverPort = server.identity.primaryPort;
Services.prefs.setCharPref(REPORTING_ENDPOINT_BASE_PREF, `http://localhost:${serverPort}`);
server.registerPathHandler(`/${REPORTING_ENDPOINT}/${COVERAGE_VERSION}/${uuid}`, (request, response) => {
equal(request.method, "PUT");
let telemetryEnabled = Services.prefs.getBoolPref(TELEMETRY_ENABLED_PREF, false);
let requestBody = NetUtil.readInputStreamToString(request.bodyInputStream,
request.bodyInputStream.available());
let resultObj = JSON.parse(requestBody);
deepEqual(Object.keys(resultObj), [
"appUpdateChannel", "osName", "osVersion", "telemetryEnabled",
]);
if (telemetryEnabled) {
ok(resultObj.telemetryEnabled);
} else {
ok(!resultObj.telemetryEnabled);
}
const response_body = "OK";
response.bodyOutputStream.write(response_body, response_body.length);
server.stop();
});
// Trigger a proper telemetry init.
do_get_profile(true);
// Make sure we don't generate unexpected pings due to pref changes.
await setEmptyPrefWatchlist();
await TelemetryController.testSetup();
});
add_task(async function test_prefs() {
// Telemetry reporting setting does not control this ping, but it
// reported by this ping.
Services.prefs.setBoolPref(TELEMETRY_ENABLED_PREF, false);
// should not run if enabled pref is false
Services.prefs.setBoolPref(COVERAGE_ENABLED_PREF, false);
Services.prefs.setBoolPref(ALREADY_RUN_PREF, false);
Services.prefs.setBoolPref(OPT_OUT_PREF, false);
await TelemetryController.testReset();
let alreadyRun = Services.prefs.getBoolPref(ALREADY_RUN_PREF, false);
ok(!alreadyRun, "should not have run with enabled pref false");
// should not run if opt-out pref is true
Services.prefs.setBoolPref(COVERAGE_ENABLED_PREF, true);
Services.prefs.setBoolPref(ALREADY_RUN_PREF, false);
Services.prefs.setBoolPref(OPT_OUT_PREF, true);
await TelemetryController.testReset();
// should run if opt-out pref is false and coverage is enabled
Services.prefs.setBoolPref(COVERAGE_ENABLED_PREF, true);
Services.prefs.setBoolPref(ALREADY_RUN_PREF, false);
Services.prefs.setBoolPref(OPT_OUT_PREF, false);
await TelemetryController.testReset();
// the telemetry setting should be set correctly
Services.prefs.setBoolPref(TELEMETRY_ENABLED_PREF, true);
await TelemetryController.testReset();
alreadyRun = Services.prefs.getBoolPref(ALREADY_RUN_PREF, false);
ok(alreadyRun, "should run if no opt-out and enabled");
});