Bug 1212842 - part 1 - BroadcastChannel should not remove the documen…

…t from bfcache when not used, r=smaug
mozilla-spidermonkey · Oct 13, 2015 · dbd7074 · dbd7074
1 parent 4548f88
commit dbd7074
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 11 deletions.
diff --git a/dom/base/nsIDocument.h b/dom/base/nsIDocument.h
@@ -661,6 +661,8 @@ class nsIDocument : public nsINode
     return GetBFCacheEntry() ? nullptr : mPresShell;
   }
 
+  // Instead using this method, what you probably want is
+  // RemoveFromBFCacheSync() as we do in MessagePort and BroadcastChannel.
   void DisallowBFCaching()
   {
     NS_ASSERTION(!mBFCacheEntry, "We're already in the bfcache!");

diff --git a/dom/broadcastchannel/BroadcastChannel.cpp b/dom/broadcastchannel/BroadcastChannel.cpp
@@ -16,6 +16,7 @@
 #include "WorkerPrivate.h"
 #include "WorkerRunnable.h"
 
+#include "nsIBFCacheEntry.h"
 #include "nsIDocument.h"
 #include "nsISupportsPrimitives.h"
 
@@ -127,9 +128,6 @@ class InitializeRunnable final : public WorkerMainThreadRunnable
     nsIDocument* doc = window->GetExtantDoc();
     if (doc) {
       mPrivateBrowsing = nsContentUtils::IsInPrivateBrowsing(doc);
-
-      // No bfcache when BroadcastChannel is used.
-      doc->DisallowBFCaching();
     }
 
     return true;
@@ -381,9 +379,6 @@ BroadcastChannel::Constructor(const GlobalObject& aGlobal,
     nsIDocument* doc = window->GetExtantDoc();
     if (doc) {
       privateBrowsing = nsContentUtils::IsInPrivateBrowsing(doc);
-
-      // No bfcache when BroadcastChannel is used.
-      doc->DisallowBFCaching();
     }
   } else {
     JSContext* cx = aGlobal.Context();
@@ -466,6 +461,8 @@ BroadcastChannel::PostMessageInternal(JSContext* aCx,
 void
 BroadcastChannel::PostMessageData(BroadcastChannelMessage* aData)
 {
+  RemoveDocFromBFCache();
+
   if (mActor) {
     nsRefPtr<BCPostMessageRunnable> runnable =
       new BCPostMessageRunnable(mActor, aData);
@@ -666,6 +663,31 @@ BroadcastChannel::Observe(nsISupports* aSubject, const char* aTopic,
   return NS_OK;
 }
 
+void
+BroadcastChannel::RemoveDocFromBFCache()
+{
+  if (!NS_IsMainThread()) {
+    return;
+  }
+
+  nsPIDOMWindow* window = GetOwner();
+  if (!window) {
+    return;
+  }
+
+  nsIDocument* doc = window->GetExtantDoc();
+  if (!doc) {
+    return;
+  }
+
+  nsCOMPtr<nsIBFCacheEntry> bfCacheEntry = doc->GetBFCacheEntry();
+  if (!bfCacheEntry) {
+    return;
+  }
+
+  bfCacheEntry->RemoveFromBFCacheSync();
+}
+
 NS_IMPL_CYCLE_COLLECTION_CLASS(BroadcastChannel)
 
 NS_IMPL_CYCLE_COLLECTION_TRAVERSE_BEGIN_INHERITED(BroadcastChannel,

diff --git a/dom/broadcastchannel/BroadcastChannel.h b/dom/broadcastchannel/BroadcastChannel.h
@@ -36,6 +36,8 @@ class BroadcastChannel final
   , public nsIIPCBackgroundChildCreateCallback
   , public nsIObserver
 {
+  friend class BroadcastChannelChild;
+
   NS_DECL_NSIIPCBACKGROUNDCHILDCREATECALLBACK
   NS_DECL_NSIOBSERVER
 
@@ -82,11 +84,6 @@ class BroadcastChannel final
 
   void Shutdown();
 
-  bool IsClosed() const
-  {
-    return mState != StateActive;
-  }
-
 private:
   BroadcastChannel(nsPIDOMWindow* aWindow,
                    const PrincipalInfo& aPrincipalInfo,
@@ -108,6 +105,13 @@ class BroadcastChannel final
     return mIsKeptAlive;
   }
 
+  bool IsClosed() const
+  {
+    return mState != StateActive;
+  }
+
+  void RemoveDocFromBFCache();
+
   nsRefPtr<BroadcastChannelChild> mActor;
   nsTArray<nsRefPtr<BroadcastChannelMessage>> mPendingMessages;
 

diff --git a/dom/broadcastchannel/BroadcastChannelChild.cpp b/dom/broadcastchannel/BroadcastChannelChild.cpp
@@ -69,6 +69,8 @@ BroadcastChannelChild::RecvNotify(const ClonedMessageData& aData)
     return true;
   }
 
+  mBC->RemoveDocFromBFCache();
+
   AutoJSAPI jsapi;
   nsCOMPtr<nsIGlobalObject> globalObject;