Support auto-reload on errors.

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/location.h"
 #include "base/metrics/histogram.h"
 #include "chrome/common/localized_error.h"
 #include "net/base/escape.h"
 #include "net/base/net_errors.h"
 #include "third_party/WebKit/public/platform/WebString.h"
 #include "third_party/WebKit/public/platform/WebURLError.h"
 #include "url/gurl.h"
 
 namespace {
 
+base::TimeDelta GetAutoReloadTime(size_t reload_count) {
+  static const int kDelaysMs[] = {
+    0, 5000, 30000, 60000, 300000, 600000, 1800000
+  };
+  if (reload_count >= arraysize(kDelaysMs))
+    reload_count = arraysize(kDelaysMs) - 1;
+  return base::TimeDelta::FromMilliseconds(kDelaysMs[reload_count]);
+}
+
 // Returns whether |net_error| is a DNS-related error (and therefore whether
 // the tab helper should start a DNS probe after receiving it.)
 bool IsDnsError(const blink::WebURLError& error) {
   return error.domain.utf8() == net::kErrorDomain &&
          (error.reason == net::ERR_NAME_NOT_RESOLVED ||
           error.reason == net::ERR_NAME_RESOLUTION_FAILED);
 }
 
+bool IsReloadableError(const blink::WebURLError& error) {
+  return error.domain.utf8() == net::kErrorDomain &&
+         error.reason != net::ERR_ABORTED;
+}
+
 // If an alternate error page should be retrieved remotely for a main frame load
 // that failed with |error|, returns true and sets |error_page_url| to the URL
 // of the remote error page.
 bool GetErrorPageURL(const blink::WebURLError& error,
                      const GURL& alt_error_page_url,
                      GURL* error_page_url) {
   if (!alt_error_page_url.is_valid())
     return false;
 
   // Parameter to send to the error page indicating the error type.
@@ skipping 70 matching lines @@
 
   // URL of an alternate error page to repace this error page with, if it's a
   // valid URL.  Request will be issued when the error page finishes loading.
   // This is done on load complete to ensure that there are two complete loads
   // for tests to wait for.
   GURL alternate_error_page_url;
 
   // True if a page has completed loading, at which point it can receive
   // updates.
   bool is_finished_loading;
+
+  int auto_reload_count;
+  bool can_auto_reload_page;
 };
 
-NetErrorHelperCore::NetErrorHelperCore(Delegate* delegate)
+NetErrorHelperCore::NetErrorHelperCore(Delegate* delegate,
+  scoped_ptr<MockableOneShotTimer> reload_timer)
     : delegate_(delegate),
-      last_probe_status_(chrome_common_net::DNS_PROBE_POSSIBLE) {
+      last_probe_status_(chrome_common_net::DNS_PROBE_POSSIBLE),
+      auto_reload_enabled_(false),
+      auto_reload_timer_(reload_timer.Pass()),
+      online_(true) {
 }
 
 NetErrorHelperCore::~NetErrorHelperCore() {
 }
 
-void NetErrorHelperCore::OnStop() {
-  // On stop, 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_)
+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_) {
+    committed_error_page_info_->can_auto_reload_page = false;

[mmenke, 2014/03/07 15:46:17]

Should probably do this for pending_error_page_info_, too.

[Elly Fong-Jones, 2014/03/10 19:46:51]

Done.

     committed_error_page_info_->alternate_error_page_url = GURL();
+  }
   if (pending_error_page_info_)
     pending_error_page_info_->alternate_error_page_url = GURL();
   delegate_->CancelFetchErrorPage();
+  auto_reload_timer_->Stop();
+}
+
+void NetErrorHelperCore::OnStop() {
+  CancelPendingFetches();
+  if (committed_error_page_info_ &&
+      committed_error_page_info_->can_auto_reload_page) {

[mmenke, 2014/03/07 15:46:17]

CancelPendingFetches() sets can_auto_reload_page to false now.

[Elly Fong-Jones, 2014/03/10 19:46:51]

Done.

+    UMA_HISTOGRAM_CUSTOM_ENUMERATION("Net.AutoReload.ErrorAtStop",
+                                     committed_error_page_info_->error.reason,
+                                     net::GetAllErrorCodesForUma());
+    UMA_HISTOGRAM_COUNTS("Net.AutoReload.CountAtStop",
+                         committed_error_page_info_->auto_reload_count);
+  }
+  committed_error_page_info_->auto_reload_count = 0;
+  committed_error_page_info_->can_auto_reload_page = false;
 }
 
 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) {
-    OnStop();
+    CancelPendingFetches();
   }
 }
 
 void NetErrorHelperCore::OnCommitLoad(FrameType frame_type) {
   if (frame_type != MAIN_FRAME)
     return;
 
+  if (committed_error_page_info_ && !pending_error_page_info_ &&
+      committed_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",
+                         committed_error_page_info_->auto_reload_count);
+    if (committed_error_page_info_->auto_reload_count == 1)
+      UMA_HISTOGRAM_CUSTOM_ENUMERATION("Net.AutoReload.ErrorAtFirstSuccess",
+                                       reason,
+                                       net::GetAllErrorCodesForUma());

[mmenke, 2014/03/07 15:46:17]

nit:  +braces

[Elly Fong-Jones, 2014/03/10 19:46:51]

Done.

+  }
+
   committed_error_page_info_.reset(pending_error_page_info_.release());
 }
 
 void NetErrorHelperCore::OnFinishLoad(FrameType frame_type) {
-  if (frame_type != MAIN_FRAME || !committed_error_page_info_)
+  if (frame_type != MAIN_FRAME)
+    return;
+
+  if (!committed_error_page_info_)
     return;
 
   committed_error_page_info_->is_finished_loading = true;
 
   if (committed_error_page_info_->alternate_error_page_url.is_valid()) {
     // If there is another pending error page load,
     // |replace_with_alternate_error_page| should have been set to false.
     DCHECK(!pending_error_page_info_);
     DCHECK(!committed_error_page_info_->needs_dns_updates);
     GURL error_page_url;
     delegate_->FetchErrorPage(
         committed_error_page_info_->alternate_error_page_url);
+  } else if (auto_reload_enabled_ &&
+             IsReloadableError(committed_error_page_info_->error) &&
+             !committed_error_page_info_->was_failed_post) {

[mmenke, 2014/03/07 15:46:17]

Optional:  May want to just pass "committed_error_page_info_" in to
IsReloadableError, and have it check was_failed_post, too.  Just suggest this
because you're duplicating the pair of checks here and below.

[Elly Fong-Jones, 2014/03/10 19:46:51]

Done.

+    committed_error_page_info_->can_auto_reload_page = true;
+    MaybeStartAutoReloadTimer();
   }
 
   if (!committed_error_page_info_->needs_dns_updates ||
       last_probe_status_ == chrome_common_net::DNS_PROBE_POSSIBLE) {
     return;
   }
   DVLOG(1) << "Error page finished loading; sending saved status.";
   UpdateErrorPage();
 }
 
@@ skipping 130 matching lines @@
 
   blink::WebURLError updated_error;
   updated_error.domain = blink::WebString::fromUTF8(
       chrome_common_net::kDnsProbeErrorDomain);
   updated_error.reason = last_probe_status_;
   updated_error.unreachableURL = error.unreachableURL;
   updated_error.staleCopyInCache = error.staleCopyInCache;
 
   return updated_error;
 }
+
+void NetErrorHelperCore::Reload() {
+  if (!committed_error_page_info_) {
+    return;
+  }
+  delegate_->ReloadPage();
+}
+
+bool NetErrorHelperCore::MaybeStartAutoReloadTimer() {
+  if (!committed_error_page_info_)
+    return false;
+
+  if (!committed_error_page_info_->can_auto_reload_page)
+    return false;

[mmenke, 2014/03/07 15:46:17]

optional:  Suggest just merging these two into one if.

[Elly Fong-Jones, 2014/03/10 19:46:51]

Done.

+
+  DCHECK(IsReloadableError(committed_error_page_info_->error));
+  DCHECK(!committed_error_page_info_->was_failed_post);
+
+  if (!online_)
+    return false;
+
+  StartAutoReloadTimer();
+  return true;
+}
+
+void NetErrorHelperCore::StartAutoReloadTimer() {

[mmenke, 2014/03/07 15:46:17]

optional:  DCHECK(committed_error_page_info_)?  We'll crash anyways, so just for
documentation purposes.

Could also DCHECK can_auto_reload.

[Elly Fong-Jones, 2014/03/10 19:46:51]

Done.

+  base::TimeDelta delay =
+      GetAutoReloadTime(committed_error_page_info_->auto_reload_count);
+  committed_error_page_info_->auto_reload_count++;
+  auto_reload_timer_->Stop();
+  auto_reload_timer_->Start(FROM_HERE, delay,
+      base::Bind(&NetErrorHelperCore::Reload,
+                 base::Unretained(this)));
+}
+
+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();
+    committed_error_page_info_->auto_reload_count = 0;
+  }
+
+  // If the network state changed to online, maybe start auto-reloading again.
+  if (online)
+    MaybeStartAutoReloadTimer();
+}
+
+bool NetErrorHelperCore::ShouldSuppressErrorPage(const GURL& url) {
+  // If |auto_reload_timer_| is still running, this error page isn't from an
+  // auto reload.
+  if (auto_reload_timer_->IsRunning())
+    return false;
+
+  // If there's no committed error page, this error page wasn't from an auto
+  // reload.
+  if (!committed_error_page_info_)
+    return false;
+
+  // Don't suppress errors if not auto-reloading.
+  if (!committed_error_page_info_->can_auto_reload_page)
+    return false;

[mmenke, 2014/03/07 15:46:17]

optional:  May want to merge this with the above check.

[Elly Fong-Jones, 2014/03/10 19:46:51]

Done.

+
+  GURL error_url = committed_error_page_info_->error.unreachableURL;
+  if (error_url != url)
+    return false;
+
+  MaybeStartAutoReloadTimer();
+  return true;
+}
+
+int NetErrorHelperCore::GetAutoReloadCount() const {
+  if (!committed_error_page_info_)
+    return -1;
+  return committed_error_page_info_->auto_reload_count;
+}