Fix auto-reload histograms.

chrome/renderer/net/net_error_helper_core.cc

 // Copyright 2013 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "chrome/renderer/net/net_error_helper_core.h"
 
 #include <string>
 
 #include "base/bind.h"
 #include "base/callback.h"
 #include "base/i18n/rtl.h"
 #include "base/json/json_reader.h"
 #include "base/json/json_writer.h"
 #include "base/location.h"
 #include "base/logging.h"
 #include "base/metrics/histogram.h"
 #include "base/strings/string16.h"
 #include "base/values.h"
 #include "chrome/common/localized_error.h"
+#include "content/public/common/url_constants.h"
 #include "grit/generated_resources.h"
 #include "net/base/escape.h"
 #include "net/base/net_errors.h"
 #include "net/base/net_util.h"
 #include "third_party/WebKit/public/platform/WebString.h"
 #include "third_party/WebKit/public/platform/WebURLError.h"
 #include "ui/base/l10n/l10n_util.h"
 #include "url/gurl.h"
 
 namespace {
@@ skipping 210 matching lines @@
     }
   }
 
   if (params->override_suggestions->empty() &&
       !params->search_url.is_valid()) {
     return NULL;
   }
   return params.release();
 }
 
+void ReportAutoReloadSuccess(const blink::WebURLError& error, size_t count) {
+  if (error.domain.utf8() != net::kErrorDomain)
+    return;
+  UMA_HISTOGRAM_CUSTOM_ENUMERATION("Net.AutoReload.ErrorAtSuccess",
+                                   -error.reason,
+                                   net::GetAllErrorCodesForUma());
+  UMA_HISTOGRAM_COUNTS("Net.AutoReload.CountAtSuccess", count);
+  if (count == 1) {
+    UMA_HISTOGRAM_CUSTOM_ENUMERATION("Net.AutoReload.ErrorAtFirstSuccess",
+                                     -error.reason,
+                                     net::GetAllErrorCodesForUma());
+  }
+}
+
+void ReportAutoReloadFailure(const blink::WebURLError& error, size_t count) {
+  if (error.domain.utf8() != net::kErrorDomain)
+    return;
+  UMA_HISTOGRAM_CUSTOM_ENUMERATION("Net.AutoReload.ErrorAtStop",
+                                   -error.reason,
+                                   net::GetAllErrorCodesForUma());
+  UMA_HISTOGRAM_COUNTS("Net.AutoReload.CountAtStop", count);
+}
+
 }  // namespace
 
 struct NetErrorHelperCore::ErrorPageInfo {
   ErrorPageInfo(blink::WebURLError error, bool was_failed_post)
       : error(error),
         was_failed_post(was_failed_post),
         needs_dns_updates(false),
         reload_button_in_page(false),
         load_stale_button_in_page(false),
-        is_finished_loading(false) {
+        is_finished_loading(false),
+        auto_reload_triggered(false) {
   }
 
   // Information about the failed page load.
   blink::WebURLError error;
   bool was_failed_post;
 
   // Information about the status of the error page.
 
   // True if a page is a DNS error page and has not yet received a final DNS
   // probe status.
@@ skipping 11 matching lines @@
   //                the blank page is loading, to get rid of these.
   std::string navigation_correction_request_body;
 
   // Track if specific buttons are included in an error page, for statistics.
   bool reload_button_in_page;
   bool load_stale_button_in_page;
 
   // True if a page has completed loading, at which point it can receive
   // updates.
   bool is_finished_loading;
+
+  // True if the auto-reload timer has fired and a reload is or has been in
+  // flight.
+  bool auto_reload_triggered;
 };
 
 bool NetErrorHelperCore::IsReloadableError(
     const NetErrorHelperCore::ErrorPageInfo& info) {
   return info.error.domain.utf8() == net::kErrorDomain &&
          info.error.reason != net::ERR_ABORTED &&
          !info.was_failed_post;
 }
 
 NetErrorHelperCore::NetErrorHelperCore(Delegate* delegate)
     : delegate_(delegate),
       last_probe_status_(chrome_common_net::DNS_PROBE_POSSIBLE),
       auto_reload_enabled_(false),
       auto_reload_timer_(new base::Timer(false, false)),
       // TODO(ellyjones): Make online_ accurate at object creation.
       online_(true),
       auto_reload_count_(0),
       can_auto_reload_page_(false),
       navigation_from_button_(NO_BUTTON) {
 }
 
 NetErrorHelperCore::~NetErrorHelperCore() {
   if (committed_error_page_info_ && can_auto_reload_page_) {
     UMA_HISTOGRAM_CUSTOM_ENUMERATION("Net.AutoReload.ErrorAtStop",

[Randy Smith (Not in Mondays), 2014/04/28 21:05:52]

Why isn't this using the helper functions?  That violates the principle of least
astonishment (i.e. a lazy code reviewer, like, say, me :-}, will find the helper
functions, scan for them in this file, and miss that there's a histogram entry
being created here).

Also, we aren't we checking auto_reload_triggered here?

                                      -committed_error_page_info_->error.reason,
                                      net::GetAllErrorCodesForUma());
     UMA_HISTOGRAM_COUNTS("Net.AutoReload.CountAtStop", auto_reload_count_);
   }
 }
 
 void NetErrorHelperCore::CancelPendingFetches() {
   // Cancel loading the alternate error page, and prevent any pending error page
   // load from starting a new error page load.  Swapping in the error page when
   // it's finished loading could abort the navigation, otherwise.
-  if (committed_error_page_info_ && can_auto_reload_page_) {
-    UMA_HISTOGRAM_CUSTOM_ENUMERATION("Net.AutoReload.ErrorAtStop",
-                                     -committed_error_page_info_->error.reason,
-                                     net::GetAllErrorCodesForUma());
-    UMA_HISTOGRAM_COUNTS("Net.AutoReload.CountAtStop", auto_reload_count_);
-  }
   if (committed_error_page_info_) {
     committed_error_page_info_->navigation_correction_url = GURL();
     committed_error_page_info_->navigation_correction_request_body.clear();
   }
   if (pending_error_page_info_) {
     pending_error_page_info_->navigation_correction_url = GURL();
     pending_error_page_info_->navigation_correction_request_body.clear();
   }
   delegate_->CancelFetchNavigationCorrections();
   auto_reload_timer_->Stop();
   can_auto_reload_page_ = false;
 }
 
 void NetErrorHelperCore::OnStop() {
+  if (committed_error_page_info_ &&
+      (committed_error_page_info_->auto_reload_triggered ||
+       auto_reload_timer_->IsRunning())) {
+    ReportAutoReloadFailure(committed_error_page_info_->error,
+                            auto_reload_count_);
+  }
   CancelPendingFetches();
   auto_reload_count_ = 0;
 }
 
 void NetErrorHelperCore::OnStartLoad(FrameType frame_type, PageType page_type) {
   if (frame_type != MAIN_FRAME)
     return;
 
   // If there's no pending error page information associated with the page load,
   // or the new page is not an error page, then reset pending error page state.
   if (!pending_error_page_info_ || page_type != ERROR_PAGE) {
     CancelPendingFetches();
   } else if (auto_reload_enabled_) {
     // If an error load is starting, the resulting error page is autoreloadable.
     can_auto_reload_page_ = IsReloadableError(*pending_error_page_info_);
   }
 }
 
-void NetErrorHelperCore::OnCommitLoad(FrameType frame_type) {
+void NetErrorHelperCore::OnCommitLoad(FrameType frame_type, const GURL& url) {
   if (frame_type != MAIN_FRAME)
     return;
 
   // Track if an error occurred due to a page button press.
   // This isn't perfect; if (for instance), the server is slow responding
   // to a request generated from the page reload button, and the user hits
   // the browser reload button, this code will still believe the
   // result is from the page reload button.
   if (committed_error_page_info_ && pending_error_page_info_ &&
       navigation_from_button_ != NO_BUTTON &&
       committed_error_page_info_->error.unreachableURL ==
           pending_error_page_info_->error.unreachableURL) {
     DCHECK(navigation_from_button_ == RELOAD_BUTTON ||
            navigation_from_button_ == LOAD_STALE_BUTTON);
     chrome_common_net::RecordEvent(
         navigation_from_button_ == RELOAD_BUTTON ?
             chrome_common_net::NETWORK_ERROR_PAGE_RELOAD_BUTTON_ERROR :
             chrome_common_net::NETWORK_ERROR_PAGE_LOAD_STALE_BUTTON_ERROR);
   }
   navigation_from_button_ = NO_BUTTON;
 
   if (committed_error_page_info_ && !pending_error_page_info_ &&
-      can_auto_reload_page_) {
-    int reason = committed_error_page_info_->error.reason;
-    UMA_HISTOGRAM_CUSTOM_ENUMERATION("Net.AutoReload.ErrorAtSuccess",
-                                     -reason,
-                                     net::GetAllErrorCodesForUma());
-    UMA_HISTOGRAM_COUNTS("Net.AutoReload.CountAtSuccess", auto_reload_count_);
-    if (auto_reload_count_ == 1) {
-      UMA_HISTOGRAM_CUSTOM_ENUMERATION("Net.AutoReload.ErrorAtFirstSuccess",
-                                       -reason,
-                                       net::GetAllErrorCodesForUma());
-    }
+      committed_error_page_info_->auto_reload_triggered) {

[mmenke, 2014/04/28 20:21:14]

Right...So whenever we destroy committed_error_page_info_, we update the stats
if auto_reload_triggered is true, unless we're committing another error page. 
Sounds good.

[Randy Smith (Not in Mondays), 2014/04/28 21:05:52]

Why aren't we recording a failure if we're committing another error page?

[Elly Fong-Jones, 2014/04/30 15:34:08]

Done.

[Elly Fong-Jones, 2014/04/30 15:34:08]

Because another error page is just a reload attempt that failed. An actual
auto-reload failure is when the user navigates somewhere else or closes the tab
because auto-reload didn't do its job.

+    const blink::WebURLError& error = committed_error_page_info_->error;
+    const GURL& error_url = error.unreachableURL;

[mmenke, 2014/04/28 20:21:14]

Does this work?  error.unreachableURL is a WebURL, not a GURL....

[Elly Fong-Jones, 2014/04/30 15:34:08]

Yes, because WebURL has a GURL operator() on it.

+    if (url == error_url)
+      ReportAutoReloadSuccess(error, auto_reload_count_);
+    else if (url != GURL(content::kUnreachableWebDataURL))

[Randy Smith (Not in Mondays), 2014/04/28 21:05:52]

What is the purpose of this test?

[Elly Fong-Jones, 2014/04/30 15:34:08]

To avoid logging a failure if we're just loading a new error page.

+      ReportAutoReloadFailure(error, auto_reload_count_);
   }
 
   committed_error_page_info_.reset(pending_error_page_info_.release());
 }
 
 void NetErrorHelperCore::OnFinishLoad(FrameType frame_type) {
   if (frame_type != MAIN_FRAME)
     return;
 
   if (!committed_error_page_info_) {
@@ skipping 221 matching lines @@
 bool NetErrorHelperCore::MaybeStartAutoReloadTimer() {
   if (!committed_error_page_info_ ||
       !committed_error_page_info_->is_finished_loading ||
       !can_auto_reload_page_ ||
       pending_error_page_info_) {
     return false;
   }
 
   DCHECK(IsReloadableError(*committed_error_page_info_));
 
+  committed_error_page_info_->auto_reload_triggered = true;

[mmenke, 2014/04/28 20:21:14]

So if we never reload because we're offline, but the user triggers a reload and
it works (while offline?  Hrm...), then we count it as a failure?  I don't think
that's a problem.

[Elly Fong-Jones, 2014/04/30 15:34:08]

Right.

+
   if (!online_)
     return false;
 
   StartAutoReloadTimer();
   return true;
 }
 
 void NetErrorHelperCore::StartAutoReloadTimer() {
   DCHECK(committed_error_page_info_);
   DCHECK(can_auto_reload_page_);
   base::TimeDelta delay = GetAutoReloadTime(auto_reload_count_);
-  auto_reload_count_++;
   auto_reload_timer_->Stop();
   auto_reload_timer_->Start(FROM_HERE, delay,
-      base::Bind(&NetErrorHelperCore::Reload,
+      base::Bind(&NetErrorHelperCore::AutoReloadTimerFired,
                  base::Unretained(this)));
 }
 
+void NetErrorHelperCore::AutoReloadTimerFired() {
+  auto_reload_count_++;
+  committed_error_page_info_->auto_reload_triggered = true;

[mmenke, 2014/04/28 20:21:14]

This isn't needed any more, is it?

[Elly Fong-Jones, 2014/04/30 15:34:08]

Done.

+  Reload();
+}
+
 void NetErrorHelperCore::NetworkStateChanged(bool online) {
   online_ = online;
   if (auto_reload_timer_->IsRunning()) {
     DCHECK(committed_error_page_info_);
     // If there's an existing timer running, stop it and reset the retry count.
     auto_reload_timer_->Stop();
     auto_reload_count_ = 0;
   }
 
   // If the network state changed to online, maybe start auto-reloading again.
@@ skipping 49 matching lines @@
       // Visual effects on page are handled in Javascript code.
       chrome_common_net::RecordEvent(
           chrome_common_net::NETWORK_ERROR_PAGE_MORE_BUTTON_CLICKED);
       return;
     case NO_BUTTON:
       NOTREACHED();
       return;
   }
 }