The Tor Browser: comparison services/healthreport/tests/xpcshell/test_provider_searches.js

comparison: services/healthreport/tests/xpcshell/test_provider_searches.js

services/healthreport/tests/xpcshell/test_provider_searches.js

branch: TOR_BUG_9701
changeset 15: b8a032363ba2

equal deleted inserted replaced

--1:000000000000
+:51360da98730
+/* Any copyright is dedicated to the Public Domain.
+* http://creativecommons.org/publicdomain/zero/1.0/ */
+"use strict";
+const {utils: Cu} = Components;
+Cu.import("resource://gre/modules/Metrics.jsm");
+Cu.import("resource://gre/modules/Services.jsm");
+let bsp = Cu.import("resource://gre/modules/services/healthreport/providers.jsm");
+const DEFAULT_ENGINES = [
+{name: "Amazon.com",    identifier: "amazondotcom"},
+{name: "Bing",          identifier: "bing"},
+{name: "Google",        identifier: "google"},
+{name: "Yahoo",         identifier: "yahoo"},
+{name: "Foobar Search", identifier: "foobar"},
+];
+function MockSearchCountMeasurement() {
+bsp.SearchCountMeasurement3.call(this);
+}
+MockSearchCountMeasurement.prototype = {
+__proto__: bsp.SearchCountMeasurement3.prototype,
+};
+function MockSearchesProvider() {
+SearchesProvider.call(this);
+}
+MockSearchesProvider.prototype = {
+__proto__: SearchesProvider.prototype,
+measurementTypes: [MockSearchCountMeasurement],
+};
+function run_test() {
+run_next_test();
+}
+add_test(function test_constructor() {
+let provider = new SearchesProvider();
+run_next_test();
+});
+add_task(function* test_record() {
+let storage = yield Metrics.Storage("record");
+let provider = new MockSearchesProvider();
+yield provider.init(storage);
+let now = new Date();
+// Record searches for all but one of our defaults, and one engine that's
+// not a default.
+for (let engine of DEFAULT_ENGINES.concat([{name: "Not Default", identifier: "notdef"}])) {
+if (engine.identifier == "yahoo") {
+continue;
+}
+yield provider.recordSearch(engine, "abouthome");
+yield provider.recordSearch(engine, "contextmenu");
+yield provider.recordSearch(engine, "newtab");
+yield provider.recordSearch(engine, "searchbar");
+yield provider.recordSearch(engine, "urlbar");
+}
+// Invalid sources should throw.
+let errored = false;
+try {
+yield provider.recordSearch(DEFAULT_ENGINES[0], "bad source");
+} catch (ex) {
+errored = true;
+} finally {
+do_check_true(errored);
+}
+let m = provider.getMeasurement("counts", 3);
+let data = yield m.getValues();
+do_check_eq(data.days.size, 1);
+do_check_true(data.days.hasDay(now));
+let day = data.days.getDay(now);
+for (let engine of DEFAULT_ENGINES) {
+let identifier = engine.identifier;
+let expected = identifier != "yahoo";
+for (let source of ["abouthome", "contextmenu", "searchbar", "urlbar"]) {
+let field = identifier + "." + source;
+if (expected) {
+do_check_true(day.has(field));
+do_check_eq(day.get(field), 1);
+} else {
+do_check_false(day.has(field));
+}
+}
+}
+// Also, check that our non-default engine contributed, with a computed
+// identifier.
+let identifier = "notdef";
+for (let source of ["abouthome", "contextmenu", "searchbar", "urlbar"]) {
+let field = identifier + "." + source;
+do_check_true(day.has(field));
+}
+yield storage.close();
+});
+add_task(function* test_includes_other_fields() {
+let storage = yield Metrics.Storage("includes_other_fields");
+let provider = new MockSearchesProvider();
+yield provider.init(storage);
+let m = provider.getMeasurement("counts", 3);
+// Register a search against a provider that isn't live in this session.
+let id = yield m.storage.registerField(m.id, "test.searchbar",
+Metrics.Storage.FIELD_DAILY_COUNTER);
+let testField = "test.searchbar";
+let now = new Date();
+yield m.storage.incrementDailyCounterFromFieldID(id, now);
+// Make sure we don't know about it.
+do_check_false(testField in m.fields);
+// But we want to include it in payloads.
+do_check_true(m.shouldIncludeField(testField));
+// And we do so.
+let data = yield provider.storage.getMeasurementValues(m.id);
+let serializer = m.serializer(m.SERIALIZE_JSON);
+let formatted = serializer.daily(data.days.getDay(now));
+do_check_true(testField in formatted);
+do_check_eq(formatted[testField], 1);
+yield storage.close();
+});
+add_task(function* test_default_search_engine() {
+let storage = yield Metrics.Storage("default_search_engine");
+let provider = new SearchesProvider();
+yield provider.init(storage);
+let m = provider.getMeasurement("engines", 1);
+// Ensure no collection if Telemetry not enabled.
+Services.prefs.setBoolPref("toolkit.telemetry.enabled", false);
+let now = new Date();
+yield provider.collectDailyData();
+let data = yield m.getValues();
+Assert.equal(data.days.hasDay(now), false);
+// Now enable telemetry and ensure we populate.
+Services.prefs.setBoolPref("toolkit.telemetry.enabled", true);
+yield provider.collectDailyData();
+data = yield m.getValues();
+Assert.ok(data.days.hasDay(now));
+let day = data.days.getDay(now);
+Assert.equal(day.size, 1);
+Assert.ok(day.has("default"));
+// test environment doesn't have a default engine.
+Assert.equal(day.get("default"), "NONE");
+Services.search.addEngineWithDetails("testdefault",
+"http://localhost/icon.png",
+null,
+"test description",
+"GET",
+"http://localhost/search/%s");
+let engine1 = Services.search.getEngineByName("testdefault");
+Assert.ok(engine1);
+Services.search.defaultEngine = engine1;
+yield provider.collectDailyData();
+data = yield m.getValues();
+Assert.equal(data.days.getDay(now).get("default"), "other-testdefault");
+yield storage.close();
+});