1 files changed, 78 insertions, 0 deletions
diff --git a/toolkit/components/search/tests/xpcshell/test_location_timeout.js b/toolkit/components/search/tests/xpcshell/test_location_timeout.js
new file mode 100644
index 000000000..c1d5270e5
--- /dev/null
+++ b/toolkit/components/search/tests/xpcshell/test_location_timeout.js
@@ -0,0 +1,78 @@
+/* Any copyright is dedicated to the Public Domain.
+   http://creativecommons.org/publicdomain/zero/1.0/ */
+
+// This is testing the "normal" timer-based timeout for the location search.
+
+function startServer(continuePromise) {
+  let srv = new HttpServer();
+  function lookupCountry(metadata, response) {
+    response.processAsync();
+    // wait for our continuePromise to resolve before writing a valid
+    // response.
+    // This will be resolved after the timeout period, so we can check
+    // the behaviour in that case.
+    continuePromise.then(() => {
+      response.setStatusLine("1.1", 200, "OK");
+      response.write('{"country_code" : "AU"}');
+      response.finish();
+    });
+  }
+  srv.registerPathHandler("/lookup_country", lookupCountry);
+  srv.start(-1);
+  return srv;
+}
+
+function getProbeSum(probe, sum) {
+  let histogram = Services.telemetry.getHistogramById(probe);
+  return histogram.snapshot().sum;
+}
+
+function run_test() {
+  installTestEngine();
+
+  let resolveContinuePromise;
+  let continuePromise = new Promise(resolve => {
+    resolveContinuePromise = resolve;
+  });
+
+  let server = startServer(continuePromise);
+  let url = "http://localhost:" + server.identity.primaryPort + "/lookup_country";
+  Services.prefs.setCharPref("browser.search.geoip.url", url);
+  Services.prefs.setIntPref("browser.search.geoip.timeout", 50);
+  Services.search.init(() => {
+    ok(!Services.prefs.prefHasUserValue("browser.search.countryCode"), "should be no countryCode pref");
+    ok(!Services.prefs.prefHasUserValue("browser.search.region"), "should be no region pref");
+    // should be no result recorded at all.
+    checkCountryResultTelemetry(null);
+
+    // should have set the flag indicating we saw a timeout.
+    let histogram = Services.telemetry.getHistogramById("SEARCH_SERVICE_COUNTRY_TIMEOUT");
+    let snapshot = histogram.snapshot();
+    deepEqual(snapshot.counts, [0, 1, 0]);
+    // should not yet have SEARCH_SERVICE_COUNTRY_FETCH_TIME_MS recorded as our
+    // test server is still blocked on our promise.
+    equal(getProbeSum("SEARCH_SERVICE_COUNTRY_FETCH_TIME_MS"), 0);
+
+    waitForSearchNotification("geoip-lookup-xhr-complete").then(() => {
+      // now we *should* have a report of how long the response took even though
+      // it timed out.
+      // The telemetry "sum" will be the actual time in ms - just check it's non-zero.
+      ok(getProbeSum("SEARCH_SERVICE_COUNTRY_FETCH_TIME_MS") != 0);
+      // should have reported the fetch ended up being successful
+      checkCountryResultTelemetry(TELEMETRY_RESULT_ENUM.SUCCESS);
+
+      // and should have the result of the response that finally came in, and
+      // everything dependent should also be updated.
+      equal(Services.prefs.getCharPref("browser.search.countryCode"), "AU");
+      equal(Services.prefs.getCharPref("browser.search.region"), "AU");
+      ok(!Services.prefs.prefHasUserValue("browser.search.isUS"), "should never have an isUS pref");
+
+      do_test_finished();
+      server.stop(run_next_test);
+    });
+    // now tell the server to send its response.  That will end up causing the
+    // search service to notify of that the response was received.
+    resolveContinuePromise();
+  });
+  do_test_pending();
+}