gecko-dev/dom/tests/browser/browser_ConsoleStorageAPITests.js

/* Any copyright is dedicated to the Public Domain.
   http://creativecommons.org/publicdomain/zero/1.0/ */

const TEST_URI = "http://example.com/browser/dom/tests/browser/test-console-api.html";
const TEST_URI_NAV = "http://example.com/browser/dom/tests/browser/";

let ConsoleAPIStorage = Cc["@mozilla.org/consoleAPI-storage;1"]
                          .getService(Ci.nsIConsoleAPIStorage);

var apiCallCount;

var ConsoleObserver = {
  QueryInterface: XPCOMUtils.generateQI([Ci.nsIObserver]),

  init: function CO_init()
  {
    Services.obs.addObserver(this, "console-storage-cache-event", false);
    apiCallCount = 0;
  },

  observe: function CO_observe(aSubject, aTopic, aData)
  {
    if (aTopic == "console-storage-cache-event") {
      apiCallCount ++;
      if (apiCallCount == 4) {
        Services.obs.removeObserver(this, "console-storage-cache-event");

        try {
        let tab = gBrowser.selectedTab;
        let browser = gBrowser.selectedBrowser;
        let win = browser.contentWindow;
        let windowID = getWindowId(win);
        let messages = ConsoleAPIStorage.getEvents(windowID);
        ok(messages.length >= 4, "Some messages found in the storage service");

        ConsoleAPIStorage.clearEvents();
        messages = ConsoleAPIStorage.getEvents(windowID);
        is(messages.length, 0, "Cleared Storage");

        // make sure a closed window's events are in fact removed from the
        // storage cache
        win.console.log("adding a new event");
        // Close the window.
        gBrowser.removeTab(tab, {animate: false});
        // Ensure actual window destruction is not delayed (too long).
        SpecialPowers.DOMWindowUtils.garbageCollect();
        // Ensure "inner-window-destroyed" event is processed,
        // so the storage cache is cleared.
        executeSoon(function () {
          // use the old windowID again to see if we have any stray cached messages
          messages = ConsoleAPIStorage.getEvents(windowID);
          is(messages.length, 0, "tab close is clearing the cache");
          finish();
        });
        } catch (ex) {
          dump(ex + "\n\n\n");
          dump(ex.stack + "\n\n\n");
          ok(false, "We got an unexpected exception");
        }
      }
    }
  }
};

function tearDown()
{
  while (gBrowser.tabs.length > 1)
    gBrowser.removeCurrentTab();
}

function test()
{
  // Don't cache removed tabs, so "clear console cache on tab close" triggers.
  Services.prefs.setIntPref("browser.tabs.max_tabs_undo", 0);
  registerCleanupFunction(function() {
    Services.prefs.clearUserPref("browser.tabs.max_tabs_undo");
  });

  registerCleanupFunction(tearDown);

  ConsoleObserver.init();

  waitForExplicitFinish();

  var tab = gBrowser.addTab(TEST_URI);
  gBrowser.selectedTab = tab;
  var browser = gBrowser.selectedBrowser;
  browser.addEventListener("DOMContentLoaded", function onLoad(event) {
    browser.removeEventListener("DOMContentLoaded", onLoad, false);
    executeSoon(function test_executeSoon() {
      let win = browser.contentWindow;
      win.console.log("this", "is", "a", "log message");
      win.console.info("this", "is", "a", "info message");
      win.console.warn("this", "is", "a", "warn message");
      win.console.error("this", "is", "a", "error message");
    });
  }, false);
}

function getWindowId(aWindow)
{
  return SpecialPowers.getDOMWindowUtils(aWindow).currentInnerWindowID;
}