Bug 461199 (Part 20) - Rewrite the private browsing visited link coloring test to make it work with the new async API

r=mconnor
r=sdwilsh
r=bz

layout/build/nsLayoutStatics.cpp

@@ -255,7 +255,11 @@ nsLayoutStatics::Initialize()
     return rv;
   }
 
-  nsCSSRuleProcessor::Startup();
+  rv = nsCSSRuleProcessor::Startup();
+  if (NS_FAILED(rv)) {
+    NS_ERROR("Could not initialize nsCSSRuleProcessor");
+    return rv;
+  }
 
 #ifdef MOZ_XUL
   rv = nsXULPopupManager::Init();
@@ -308,7 +312,7 @@ nsLayoutStatics::Shutdown()
   nsEventListenerManager::Shutdown();
   nsComputedDOMStyle::Shutdown();
   CSSLoaderImpl::Shutdown();
-  nsCSSRuleProcessor::FreeSystemMetrics();
+  nsCSSRuleProcessor::Shutdown();
   nsTextFrameTextRunCache::Shutdown();
   nsHTMLDNSPrefetch::Shutdown();
   nsCSSRendering::Shutdown();

layout/style/nsCSSRuleProcessor.cpp

@@ -87,6 +87,9 @@
 #include "nsIPrincipal.h"
 #include "nsStyleSet.h"
 #include "prlog.h"
+#include "nsIObserverService.h"
+#include "nsIPrivateBrowsingService.h"
+#include "nsNetCID.h"
 
 #define VISITED_PSEUDO_PREF "layout.css.visited_links_enabled"
 
@@ -768,6 +771,62 @@ RuleCascadeData::AttributeListFor(nsIAtom* aAttribute)
   return entry->mSelectors;
 }
 
+class nsPrivateBrowsingObserver : nsIObserver,
+                                  nsSupportsWeakReference
+{
+public:
+  nsPrivateBrowsingObserver();
+
+  NS_DECL_ISUPPORTS
+  NS_DECL_NSIOBSERVER
+
+  void Init();
+  PRBool InPrivateBrowsing() const { return mInPrivateBrowsing; }
+
+private:
+  PRBool mInPrivateBrowsing;
+};
+
+NS_IMPL_ISUPPORTS2(nsPrivateBrowsingObserver, nsIObserver, nsISupportsWeakReference)
+
+nsPrivateBrowsingObserver::nsPrivateBrowsingObserver()
+  : mInPrivateBrowsing(PR_FALSE)
+{
+}
+
+void
+nsPrivateBrowsingObserver::Init()
+{
+  nsCOMPtr<nsIPrivateBrowsingService> pbService =
+    do_GetService(NS_PRIVATE_BROWSING_SERVICE_CONTRACTID);
+  if (pbService) {
+    pbService->GetPrivateBrowsingEnabled(&mInPrivateBrowsing);
+
+    nsCOMPtr<nsIObserverService> observerService =
+      do_GetService("@mozilla.org/observer-service;1");
+    if (observerService) {
+      observerService->AddObserver(this, NS_PRIVATE_BROWSING_SWITCH_TOPIC, PR_TRUE);
+    }
+  }
+}
+
+nsresult
+nsPrivateBrowsingObserver::Observe(nsISupports *aSubject,
+                                   const char *aTopic,
+                                   const PRUnichar *aData)
+{
+  if (!strcmp(aTopic, NS_PRIVATE_BROWSING_SWITCH_TOPIC)) {
+    if (!nsCRT::strcmp(aData, NS_LITERAL_STRING(NS_PRIVATE_BROWSING_ENTER).get())) {
+      mInPrivateBrowsing = PR_TRUE;
+    } else {
+      mInPrivateBrowsing = PR_FALSE;
+    }
+  }
+  return NS_OK;
+}
+
+static nsPrivateBrowsingObserver *gPrivateBrowsingObserver = nsnull;
+
 // -------------------------------
 // CSS Style rule processor implementation
 //
@@ -793,7 +852,7 @@ nsCSSRuleProcessor::~nsCSSRuleProcessor()
 
 NS_IMPL_ISUPPORTS1(nsCSSRuleProcessor, nsIStyleRuleProcessor)
 
-/* static */ void
+/* static */ nsresult
 nsCSSRuleProcessor::Startup()
 {
   nsContentUtils::AddBoolPrefVarCache(VISITED_PSEUDO_PREF,
@@ -801,6 +860,13 @@ nsCSSRuleProcessor::Startup()
   // We want to default to true, not false as AddBoolPrefVarCache does.
   gSupportVisitedPseudo =
     nsContentUtils::GetBoolPref(VISITED_PSEUDO_PREF, PR_TRUE);
+
+  gPrivateBrowsingObserver = new nsPrivateBrowsingObserver();
+  NS_ENSURE_TRUE(gPrivateBrowsingObserver, NS_ERROR_OUT_OF_MEMORY);
+  NS_ADDREF(gPrivateBrowsingObserver);
+  gPrivateBrowsingObserver->Init();
+
+  return NS_OK;
 }
 
 static PRBool
@@ -890,6 +956,13 @@ nsCSSRuleProcessor::FreeSystemMetrics()
   sSystemMetrics = nsnull;
 }
 
+/* static */ void
+nsCSSRuleProcessor::Shutdown()
+{
+  FreeSystemMetrics();
+  NS_RELEASE(gPrivateBrowsingObserver);
+}
+
 /* static */ PRBool
 nsCSSRuleProcessor::HasSystemMetric(nsIAtom* aMetric)
 {
@@ -1037,7 +1110,9 @@ RuleProcessorData::ContentState()
 
     // If we are not supposed to mark visited links as such, be sure to flip the
     // bits appropriately.
-    if (!gSupportVisitedPseudo && (mContentState & NS_EVENT_STATE_VISITED)) {
+    if ((!gSupportVisitedPseudo ||
+        gPrivateBrowsingObserver->InPrivateBrowsing()) &&
+        (mContentState & NS_EVENT_STATE_VISITED)) {
       mContentState = (mContentState & ~PRUint32(NS_EVENT_STATE_VISITED)) |
                       NS_EVENT_STATE_UNVISITED;
     }

layout/style/nsCSSRuleProcessor.h

@@ -76,7 +76,8 @@ public:
 public:
   nsresult ClearRuleCascades();
 
-  static void Startup();
+  static nsresult Startup();
+  static void Shutdown();
   static void FreeSystemMetrics();
   static PRBool HasSystemMetric(nsIAtom* aMetric);
 

toolkit/components/places/tests/mochitest/bug_461710/Makefile.in

@@ -47,8 +47,6 @@ include $(topsrcdir)/config/rules.mk
 
 _HTTP_FILES	= \
 		visited_page.html \
-		visited_page-2.html \
-		visited_page-3.html \
 		link_page.html \
 		link_page-2.html \
 		link_page-3.html \

toolkit/components/places/tests/mochitest/bug_461710/visited_page-2.html

@@ -1,9 +0,0 @@
-<!DOCTYPE HTML>
-<html>
-  <head>
-    <title>Visited page 2</title>
-  </head>
-  <body>
-    <p>This second page is marked as visited</p>
-  </body>
-</html>

toolkit/components/places/tests/mochitest/bug_461710/visited_page-3.html

@@ -1,9 +0,0 @@
-<!DOCTYPE HTML>
-<html>
-  <head>
-    <title>Visited page 3</title>
-  </head>
-  <body>
-    <p>This third page is marked as visited</p>
-  </body>
-</html>

toolkit/components/places/tests/mochitest/test_bug_461710.html

@@ -22,6 +22,39 @@ netscape.security.PrivilegeManager.enablePrivilege('UniversalXPConnect');
 const Ci = Components.interfaces;
 const Cc = Components.classes;
 const Cr = Components.results;
+Components.utils.import("resource://gre/modules/NetUtil.jsm");
+
+const LAZY_ADD_TIMER = 3000;
+
+/**
+ * Helper function which waits until another function returns true, and
+ * then notifies a callback.
+ *
+ * Original function stolen from docshell/test/chrome/docshell_helpers.js.
+ *
+ * Parameters:
+ *
+ *    fn: a function which is evaluated repeatedly, and when it turns true,
+ *        the onWaitComplete callback is notified.
+ *
+ *    onWaitComplete:  a callback which will be notified when fn() returns
+ *        true.
+ */
+function waitForTrue(fn, onWaitComplete) {
+  var start = new Date().valueOf();
+
+  // Loop until the test function returns true, or until a timeout occurs,
+  // if a timeout is defined.
+  var intervalid =
+    setInterval(
+      function() {
+        if (fn.call()) {
+          // Stop calling the test function and notify the callback.
+          clearInterval(intervalid);
+          onWaitComplete.call();
+        }
+      }, 20);
+}
 
 const kRed = "rgb(255, 0, 0)";
 const kBlue = "rgb(0, 0, 255)";
@@ -30,11 +63,9 @@ var testpath = document.location.pathname + "/../bug_461710/";
 var prefix = "http://localhost:8888" + testpath;
 var subtests = [
                    "visited_page.html",   // 1
-                   "visited_page-2.html", // 2
+                   "link_page.html",      // 2
-                   "visited_page-3.html", // 3
+                   "link_page-2.html",    // 3
-                   "link_page.html",      // 4
+                   "link_page-3.html"     // 4
-                   "link_page-2.html",    // 5
-                   "link_page-3.html"     // 6
                ];
 
 
@@ -49,23 +80,15 @@ function loadNextTest() {
       break;
 
     case 2:
-      // nothing to do here
-      break;
-
-    case 3:
-      // nothing to do here
-      break;
-
-    case 4:
       ok(!pb.privateBrowsingEnabled, "Test #" + testNum + " should be run outside of private mode");
       break;
 
-    case 5:
+    case 3:
       pb.privateBrowsingEnabled = true;
       ok(pb.privateBrowsingEnabled, "Test #" + testNum + " should be run inside of private mode");
       break;
 
-    case 6:
+    case 4:
       pb.privateBrowsingEnabled = false;
       ok(!pb.privateBrowsingEnabled, "Test #" + testNum + " should be run outside of private mode");
       break;
@@ -74,6 +97,18 @@ function loadNextTest() {
       ok(false, "Unexpected call to loadNextTest for test #" + testNum);
   }
 
+  if (testNum == 1) {
+    // Because of LAZY_ADD, the page won't be marked as visited until three seconds,
+    // so wait for four seconds to be safe
+    setTimeout(handleLoad, LAZY_ADD_TIMER * 2);
+  } else {
+    observer.expectURL(prefix + subtests[0]);
+    waitForTrue(function() observer.resolved, function() {
+      // And the nodes get notified after the "link-visited" topic, so
+      // we need to execute soon...
+      SimpleTest.executeSoon(handleLoad);
+    });
+  }
   iframe.src = prefix + subtests[testNum-1];
 }
 
@@ -85,14 +120,6 @@ function checkTest() {
       break;
 
     case 2:
-      // nothing to do here, we just want to mark the page as visited
-      break;
-
-    case 3:
-      // nothing to do here, we just want to mark the page as visited
-      break;
-
-    case 4:
       // run outside of private mode, link should appear as visited
       var doc = iframe.contentDocument;
       var win = doc.defaultView;
@@ -100,7 +127,7 @@ function checkTest() {
       is(style.getPropertyValue("color"), kRed, "Visited link coloring should work outside of private mode");
       break;
 
-    case 5:
+    case 3:
       // run inside of private mode, link should appear as not visited
       var doc = iframe.contentDocument;
       var win = doc.defaultView;
@@ -108,7 +135,7 @@ function checkTest() {
       is(style.getPropertyValue("color"), kBlue, "Visited link coloring should not work inside of private mode");
       break;
 
-    case 6:
+    case 4:
       // run outside of private mode, link should appear as visited
       var doc = iframe.contentDocument;
       var win = doc.defaultView;
@@ -137,8 +164,7 @@ function get_PBSvc() {
 }
 
 
-var ignoreLoad = false;
+function handleLoad() {
-function handleLoad(aEvent) {
   netscape.security.PrivilegeManager.enablePrivilege('UniversalXPConnect');
 
   checkTest();
@@ -151,6 +177,31 @@ function handleLoad(aEvent) {
   }
 }
 
+const URI_VISITED_RESOLUTION_TOPIC = "visited-status-resolution";
+var os, observer = {
+  uri: null,
+  resolved: true,
+  observe: function (aSubject, aTopic, aData) {
+    SimpleTest.is(aTopic, URI_VISITED_RESOLUTION_TOPIC, "Unexpected topic");
+
+    netscape.security.PrivilegeManager.enablePrivilege('UniversalXPConnect');
+
+    if (this.uri.equals(aSubject.QueryInterface(Ci.nsIURI))) {
+      this.resolved = true;
+
+      os.removeObserver(this, URI_VISITED_RESOLUTION_TOPIC);
+    }
+  },
+  expectURL: function (url) {
+    ok(this.resolved, "Can't set the expected URL when another is yet to be resolved");
+    this.resolved = false;
+
+    netscape.security.PrivilegeManager.enablePrivilege('UniversalXPConnect');
+
+    this.uri = NetUtil.newURI(url);
+    os.addObserver(this, URI_VISITED_RESOLUTION_TOPIC, false);
+  }
+};
 
 var pb = get_PBSvc();
 if (!pb) { // Private Browsing might not be available
@@ -163,8 +214,10 @@ if (!pb) { // Private Browsing might not be available
                    getService(Ci.nsIPrefBranch);
   prefBranch.setBoolPref("browser.privatebrowsing.keep_current_session", true);
 
+  os = Cc["@mozilla.org/observer-service;1"].
+           getService(Ci.nsIObserverService);
+
   var iframe = document.getElementById("iframe");
-  iframe.onload = handleLoad;
 
   SimpleTest.waitForExplicitFinish();