browser/modules/test/browser_UITour_registerPageID.js

changeset 0
6474c204b198
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/browser/modules/test/browser_UITour_registerPageID.js	Wed Dec 31 06:09:35 2014 +0100
     1.3 @@ -0,0 +1,110 @@
     1.4 +/* Any copyright is dedicated to the Public Domain.
     1.5 + * http://creativecommons.org/publicdomain/zero/1.0/ */
     1.6 +
     1.7 +"use strict";
     1.8 +
     1.9 +let gTestTab;
    1.10 +let gContentAPI;
    1.11 +let gContentWindow;
    1.12 +
    1.13 +Components.utils.import("resource:///modules/UITour.jsm");
    1.14 +Components.utils.import("resource://gre/modules/UITelemetry.jsm");
    1.15 +Components.utils.import("resource:///modules/BrowserUITelemetry.jsm");
    1.16 +
    1.17 +function test() {
    1.18 +  UITelemetry._enabled = true;
    1.19 +
    1.20 +  registerCleanupFunction(function() {
    1.21 +    Services.prefs.clearUserPref("browser.uitour.seenPageIDs");
    1.22 +    resetSeenPageIDsLazyGetter();
    1.23 +    UITelemetry._enabled = undefined;
    1.24 +    BrowserUITelemetry.setBucket(null);
    1.25 +    delete window.UITelemetry;
    1.26 +    delete window.BrowserUITelemetry;
    1.27 +  });
    1.28 +  UITourTest();
    1.29 +}
    1.30 +
    1.31 +function resetSeenPageIDsLazyGetter() {
    1.32 +  delete UITour.seenPageIDs;
    1.33 +  // This should be kept in sync with how UITour.init() sets this.
    1.34 +  Object.defineProperty(UITour, "seenPageIDs", {
    1.35 +    get: UITour.restoreSeenPageIDs.bind(UITour),
    1.36 +    configurable: true,
    1.37 +  });
    1.38 +}
    1.39 +
    1.40 +function checkExpectedSeenPageIDs(expected) {
    1.41 +  is(UITour.seenPageIDs.size, expected.length, "Should be " + expected.length + " total seen page IDs");
    1.42 +
    1.43 +  for (let id of expected)
    1.44 +    ok(UITour.seenPageIDs.has(id), "Should have seen '" + id + "' page ID");
    1.45 +
    1.46 +  let prefData = Services.prefs.getCharPref("browser.uitour.seenPageIDs");
    1.47 +  prefData = new Map(JSON.parse(prefData));
    1.48 +
    1.49 +  is(prefData.size, expected.length, "Should be " + expected.length + " total seen page IDs persisted");
    1.50 +
    1.51 +  for (let id of expected)
    1.52 +    ok(prefData.has(id), "Should have seen '" + id + "' page ID persisted");
    1.53 +}
    1.54 +
    1.55 +let tests = [
    1.56 +  function test_seenPageIDs_restore(done) {
    1.57 +    info("Setting up seenPageIDs to be restored from pref");
    1.58 +    let data = JSON.stringify([
    1.59 +      ["savedID1", { lastSeen: Date.now() }],
    1.60 +      ["savedID2", { lastSeen: Date.now() }],
    1.61 +      // 9 weeks ago, should auto expire.
    1.62 +      ["savedID3", { lastSeen: Date.now() - 9 * 7 * 24 * 60 * 60 * 1000 }],
    1.63 +    ]);
    1.64 +    Services.prefs.setCharPref("browser.uitour.seenPageIDs",
    1.65 +                               data);
    1.66 +
    1.67 +    resetSeenPageIDsLazyGetter();
    1.68 +    checkExpectedSeenPageIDs(["savedID1", "savedID2"]);
    1.69 +
    1.70 +    done();
    1.71 +  },
    1.72 +  function test_seenPageIDs_set_1(done) {
    1.73 +    gContentAPI.registerPageID("testpage1");
    1.74 +
    1.75 +    checkExpectedSeenPageIDs(["savedID1", "savedID2", "testpage1"]);
    1.76 +
    1.77 +    const PREFIX = BrowserUITelemetry.BUCKET_PREFIX;
    1.78 +    const SEP = BrowserUITelemetry.BUCKET_SEPARATOR;
    1.79 +
    1.80 +    let bucket = PREFIX + "UITour" + SEP + "testpage1";
    1.81 +    is(BrowserUITelemetry.currentBucket, bucket, "Bucket should have correct name");
    1.82 +
    1.83 +    gBrowser.selectedTab = gBrowser.addTab("about:blank");
    1.84 +    bucket = PREFIX + "UITour" + SEP + "testpage1" + SEP + "inactive" + SEP + "1m";
    1.85 +    is(BrowserUITelemetry.currentBucket, bucket,
    1.86 +       "After switching tabs, bucket should be expiring");
    1.87 +
    1.88 +    gBrowser.removeTab(gBrowser.selectedTab);
    1.89 +    gBrowser.selectedTab = gTestTab;
    1.90 +    BrowserUITelemetry.setBucket(null);
    1.91 +    done();
    1.92 +  },
    1.93 +  function test_seenPageIDs_set_2(done) {
    1.94 +    gContentAPI.registerPageID("testpage2");
    1.95 +
    1.96 +    checkExpectedSeenPageIDs(["savedID1", "savedID2", "testpage1", "testpage2"]);
    1.97 +
    1.98 +    const PREFIX = BrowserUITelemetry.BUCKET_PREFIX;
    1.99 +    const SEP = BrowserUITelemetry.BUCKET_SEPARATOR;
   1.100 +
   1.101 +    let bucket = PREFIX + "UITour" + SEP + "testpage2";
   1.102 +    is(BrowserUITelemetry.currentBucket, bucket, "Bucket should have correct name");
   1.103 +
   1.104 +    gBrowser.removeTab(gTestTab);
   1.105 +    gTestTab = null;
   1.106 +    bucket = PREFIX + "UITour" + SEP + "testpage2" + SEP + "closed" + SEP + "1m";
   1.107 +    is(BrowserUITelemetry.currentBucket, bucket,
   1.108 +       "After closing tab, bucket should be expiring");
   1.109 +
   1.110 +    BrowserUITelemetry.setBucket(null);
   1.111 +    done();
   1.112 +  },
   1.113 +];

mercurial