bug 819734 - Token Bucket for Network Requests [a/b test] r=honzab

Author: mcmanus

docshell/base/nsDocShell.cpp

@@ -94,7 +94,7 @@
 // so we can associate the document URI with the load group.
 // until this point, we have an evil hack:
 #include "nsIHttpChannelInternal.h"  
-
+#include "nsPILoadGroupInternal.h"
 
 // Local Includes
 #include "nsDocShellLoadInfo.h"
@@ -6548,10 +6548,15 @@ nsDocShell::EndPageLoad(nsIWebProgress * aProgress,
     if (timingChannel) {
         TimeStamp channelCreationTime;
         rv = timingChannel->GetChannelCreation(&channelCreationTime);
-        if (NS_SUCCEEDED(rv) && !channelCreationTime.IsNull())
+        if (NS_SUCCEEDED(rv) && !channelCreationTime.IsNull()) {
             Telemetry::AccumulateTimeDelta(
                 Telemetry::TOTAL_CONTENT_PAGE_LOAD_TIME,
                 channelCreationTime);
+            nsCOMPtr<nsPILoadGroupInternal> internalLoadGroup =
+                do_QueryInterface(mLoadGroup);
+            if (internalLoadGroup)
+                internalLoadGroup->OnEndPageLoad(aChannel);
+        }
     }
 
     // Timing is picked up by the window, we don't need it anymore

modules/libpref/src/init/all.js

@@ -1003,7 +1003,13 @@ pref("network.http.spdy.send-buffer-size", 131072);
 
 pref("network.http.diagnostics", false);
 
+#ifdef RELEASE_BUILD
 pref("network.http.pacing.requests.enabled", false);
+pref("network.http.pacing.requests.abtest", false);
+#else
+pref("network.http.pacing.requests.enabled", true);
+pref("network.http.pacing.requests.abtest", true);
+#endif
 pref("network.http.pacing.requests.min-parallelism", 6);
 pref("network.http.pacing.requests.hz", 100);
 pref("network.http.pacing.requests.burst", 32);

netwerk/base/public/moz.build

@@ -108,6 +108,7 @@ XPIDL_SOURCES += [
     'nsIUploadChannel.idl',
     'nsIUploadChannel2.idl',
     'nsPISocketTransportService.idl',
+    'nsPILoadGroupInternal.idl',
 ]
 
 if CONFIG['MOZ_TOOLKIT_SEARCH']:

netwerk/base/public/nsPILoadGroupInternal.idl

@@ -0,0 +1,28 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#include "nsISupports.idl"
+
+interface nsIChannel;
+
+/**
+ * Dumping ground for load group experimental work.
+ * This interface will never be frozen.  If you are
+ * using any feature exposed by this interface, be aware that this interface
+ * will change and you will be broken.  You have been warned.
+ */
+[scriptable, uuid(6ef2f8ac-9584-48f3-957a-0c94fff0c8c7)]
+interface nsPILoadGroupInternal : nsISupports
+{
+
+    /**
+     * Called when the load group has loaded main page and
+     * subresources. (i.e.essentially DOMComplete)
+     *
+     * @param aDefaultChanel
+     *        The request channel for the base apge
+     */
+    void OnEndPageLoad(in nsIChannel aDefaultChannel);
+};

netwerk/base/src/nsLoadGroup.cpp

@@ -21,6 +21,7 @@
 #include "nsReadableUtils.h"
 #include "nsString.h"
 #include "nsTArray.h"
+#include "nsIHttpChannelInternal.h"
 #include "mozilla/Telemetry.h"
 
 using namespace mozilla;
@@ -117,6 +118,7 @@ nsLoadGroup::nsLoadGroup(nsISupports* outer)
     , mDefaultLoadIsTimed(false)
     , mTimedRequests(0)
     , mCachedRequests(0)
+    , mTimedNonCachedRequestsUntilOnEndPageLoad(0)
 {
     NS_INIT_AGGREGATED(outer);
 
@@ -155,6 +157,7 @@ nsLoadGroup::~nsLoadGroup()
 NS_IMPL_AGGREGATED(nsLoadGroup)
 NS_INTERFACE_MAP_BEGIN_AGGREGATED(nsLoadGroup)
     NS_INTERFACE_MAP_ENTRY(nsILoadGroup)
+    NS_INTERFACE_MAP_ENTRY(nsPILoadGroupInternal)
     NS_INTERFACE_MAP_ENTRY(nsILoadGroupChild)
     NS_INTERFACE_MAP_ENTRY(nsIRequest)
     NS_INTERFACE_MAP_ENTRY(nsISupportsPriority)
@@ -631,8 +634,12 @@ nsLoadGroup::RemoveRequest(nsIRequest *request, nsISupports* ctxt,
             ++mTimedRequests;
             TimeStamp timeStamp;
             rv = timedChannel->GetCacheReadStart(&timeStamp);
-            if (NS_SUCCEEDED(rv) && !timeStamp.IsNull())
+            if (NS_SUCCEEDED(rv) && !timeStamp.IsNull()) {
                 ++mCachedRequests;
+            }
+            else {
+                mTimedNonCachedRequestsUntilOnEndPageLoad++;
+            }
 
             rv = timedChannel->GetAsyncOpen(&timeStamp);
             if (NS_SUCCEEDED(rv) && !timeStamp.IsNull()) {
@@ -812,6 +819,52 @@ nsLoadGroup::GetRootLoadGroup(nsILoadGroup * *aRootLoadGroup)
     return NS_OK;
 }
 
+////////////////////////////////////////////////////////////////////////////////
+// nsPILoadGroupInternal methods:
+
+NS_IMETHODIMP
+nsLoadGroup::OnEndPageLoad(nsIChannel *aDefaultChannel)
+{
+    // On page load of a page with at least 32 resources we want to record
+    // telemetry on which rate pacing algorithm was used to load the page and
+    // the page load time.
+    uint32_t requests = mTimedNonCachedRequestsUntilOnEndPageLoad;
+    mTimedNonCachedRequestsUntilOnEndPageLoad = 0;
+
+    nsCOMPtr<nsITimedChannel> timedChannel =
+        do_QueryInterface(aDefaultChannel);
+    if (!timedChannel)
+        return NS_OK;
+
+    nsCOMPtr<nsIHttpChannelInternal> internalHttpChannel =
+        do_QueryInterface(timedChannel);
+    if (!internalHttpChannel)
+        return NS_OK;
+
+    TimeStamp cacheReadStart;
+    TimeStamp asyncOpen;
+    uint32_t telemetryID;
+    nsresult rv = timedChannel->GetCacheReadStart(&cacheReadStart);
+    if (NS_SUCCEEDED(rv))
+        rv = timedChannel->GetAsyncOpen(&asyncOpen);
+    if (NS_SUCCEEDED(rv))
+        rv = internalHttpChannel->GetPacingTelemetryID(&telemetryID);
+    if (NS_FAILED(rv))
+        return NS_OK;
+
+    // Nothing to do if we don't have a start time or this was
+    // from the cache or we don't know what profile was used
+    if (asyncOpen.IsNull() || !cacheReadStart.IsNull() || !telemetryID)
+        return NS_OK;
+
+    if (requests < 32)
+        return NS_OK;
+
+    Telemetry::AccumulateTimeDelta(static_cast<Telemetry::ID>(telemetryID),
+                                   asyncOpen);
+    return NS_OK;
+}
+
 ////////////////////////////////////////////////////////////////////////////////
 // nsISupportsPriority methods:
 

netwerk/base/src/nsLoadGroup.h

@@ -8,6 +8,7 @@
 
 #include "nsILoadGroup.h"
 #include "nsILoadGroupChild.h"
+#include "nsPILoadGroupInternal.h"
 #include "nsIChannel.h"
 #include "nsIStreamListener.h"
 #include "nsAgg.h"
@@ -26,7 +27,8 @@ class  nsILoadGroupConnectionInfo;
 class nsLoadGroup : public nsILoadGroup,
                     public nsILoadGroupChild,
                     public nsISupportsPriority,
-                    public nsSupportsWeakReference
+                    public nsSupportsWeakReference,
+                    public nsPILoadGroupInternal
 {
 public:
     NS_DECL_AGGREGATED
@@ -38,6 +40,7 @@ class nsLoadGroup : public nsILoadGroup,
     ////////////////////////////////////////////////////////////////////////////
     // nsILoadGroup methods:
     NS_DECL_NSILOADGROUP
+    NS_DECL_NSPILOADGROUPINTERNAL
 
     ////////////////////////////////////////////////////////////////////////////
     // nsILoadGroupChild methods:
@@ -87,6 +90,9 @@ class nsLoadGroup : public nsILoadGroup,
     bool                            mDefaultLoadIsTimed;
     uint32_t                        mTimedRequests;
     uint32_t                        mCachedRequests;
+
+    /* For nsPILoadGroupInternal */
+    uint32_t                        mTimedNonCachedRequestsUntilOnEndPageLoad;
 };
 
 #endif // nsLoadGroup_h__

netwerk/protocol/http/HttpBaseChannel.cpp

@@ -1399,6 +1399,17 @@ HttpBaseChannel::SetLoadUnblocked(bool aLoadUnblocked)
   return NS_OK;
 }
 
+NS_IMETHODIMP
+HttpBaseChannel::GetPacingTelemetryID(uint32_t *aID)
+{
+  *aID = 0;
+  // Don't record pacing algorithm for spdy because it is effectively
+  // bypassed by the protocol mux
+  if (!mResponseHead || !mResponseHead->PeekHeader(nsHttp::X_Firefox_Spdy))
+    *aID = gHttpHandler->PacingTelemetryID();
+  return NS_OK;
+}
+
 //-----------------------------------------------------------------------------
 // HttpBaseChannel::nsISupportsPriority
 //-----------------------------------------------------------------------------

netwerk/protocol/http/HttpBaseChannel.h

@@ -149,6 +149,7 @@ class HttpBaseChannel : public nsHashPropertyBag
   NS_IMETHOD SetLoadAsBlocking(bool aLoadAsBlocking);
   NS_IMETHOD GetLoadUnblocked(bool *aLoadUnblocked);
   NS_IMETHOD SetLoadUnblocked(bool aLoadUnblocked);
+  NS_IMETHOD GetPacingTelemetryID(uint32_t *aID);
 
   inline void CleanRedirectCacheChainIfNecessary()
   {

netwerk/protocol/http/nsHttpAtomList.h

@@ -85,6 +85,7 @@ HTTP_ATOM(Vary,                      "Vary")
 HTTP_ATOM(Version,                   "Version")
 HTTP_ATOM(WWW_Authenticate,          "WWW-Authenticate")
 HTTP_ATOM(Warning,                   "Warning")
+HTTP_ATOM(X_Firefox_Spdy,            "X-Firefox-Spdy")
 
 // methods are atoms too.
 //