Implement throttling logic for fetching affiliation information.

components/password_manager/core/browser/affiliation_fetch_throttler.cc

+// Copyright 2015 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 "components/password_manager/core/browser/affiliation_fetch_throttler.h"
+
+#include <stdint.h>
+
+#include "base/logging.h"
+#include "base/rand_util.h"
+#include "base/thread_task_runner_handle.h"
+#include "base/time/tick_clock.h"
+#include "base/time/time.h"
+#include "components/password_manager/core/browser/affiliation_fetch_throttler_delegate.h"
+
+namespace password_manager {
+
+namespace {
+
+// Implementation of net::BackoffEntry that allows mocking its tick source.
+class BackoffEntryImpl : public net::BackoffEntry {
+ public:
+  // |tick_clock| must outlive this instance.
+  explicit BackoffEntryImpl(const net::BackoffEntry::Policy* const policy,
+                            base::TickClock* tick_clock)
+      : BackoffEntry(policy), tick_clock_(tick_clock) {}
+  ~BackoffEntryImpl() override {}
+
+ private:
+  // net::BackoffEntry:
+  base::TimeTicks ImplGetTimeNow() const override {
+    return tick_clock_->NowTicks();
+  }
+
+  base::TickClock* tick_clock_;
+
+  DISALLOW_COPY_AND_ASSIGN(BackoffEntryImpl);
+};
+
+}  // namespace
+
+// static
+const net::BackoffEntry::Policy AffiliationFetchThrottler::kBackoffPolicy = {
+    // Number of initial errors (in sequence) to ignore before going into
+    // exponential backoff.
+    0,
+
+    // Initial delay (in ms) once backoff starts.
+    10 * 1000,  // 10 seconds
+
+    // Factor by which the delay will be multiplied on each subsequent
+    // failure.
+    4,
+
+    // Fuzzing percentage: 50% will spread delays randomly between 50%--100%
+    // of
+    // the nominal time.
+    .5,  // 50%
+
+    // Maximum delay (in ms) during exponential backoff.
+    6 * 3600 * 1000,  // 6 hours
+
+    // Time to keep an entry from being discarded even when it has no
+    // significant state, -1 to never discard. (Not applicable.)
+    -1,
+
+    // False means that initial_delay_ms is the first delay once we start
+    // exponential backoff, i.e., there is no delay after subsequent
+    // successful
+    // requests.
+    false,
+};
+
+// static
+const int64_t AffiliationFetchThrottler::kGracePeriodAfterReconnectMs =
+    10 * 1000;  // 10 seconds
+
+AffiliationFetchThrottler::AffiliationFetchThrottler(
+    AffiliationFetchThrottlerDelegate* delegate,
+    const scoped_refptr<base::SingleThreadTaskRunner>& task_runner,
+    scoped_ptr<base::TickClock> tick_clock)
+    : delegate_(delegate),
+      task_runner_(task_runner),
+      state_(IDLE),
+      has_network_connectivity_(false),
+      is_fetch_scheduled_(false),
+      tick_clock_(tick_clock.Pass()),
+      exponential_backoff_(
+          new BackoffEntryImpl(&kBackoffPolicy, tick_clock_.get())),
+      weak_ptr_factory_(this) {
+  DCHECK(delegate);
+  // Start observing before querying the current connectivity state, so that if
+  // the state changes concurrently in-between, it will not go unnoticed.
+  net::NetworkChangeNotifier::AddConnectionTypeObserver(this);
+  has_network_connectivity_ = !net::NetworkChangeNotifier::IsOffline();
+}
+
+AffiliationFetchThrottler::~AffiliationFetchThrottler() {
+  net::NetworkChangeNotifier::RemoveConnectionTypeObserver(this);
+}
+
+void AffiliationFetchThrottler::SignalNetworkRequestNeeded() {
+  if (state_ != IDLE)
+    return;
+
+  state_ = FETCH_NEEDED;
+  if (has_network_connectivity_)
+    EnsureCallbackIsScheduled();
+}
+
+void AffiliationFetchThrottler::InformOfNetworkRequestComplete(bool success) {
+  DCHECK_EQ(state_, FETCH_IN_FLIGHT);
+  state_ = IDLE;
+  exponential_backoff_->InformOfRequest(success);
+}
+
+void AffiliationFetchThrottler::EnsureCallbackIsScheduled() {
+  DCHECK_EQ(state_, FETCH_NEEDED);
+  DCHECK(has_network_connectivity_);
+
+  if (is_fetch_scheduled_)
+    return;
+
+  is_fetch_scheduled_ = true;
+  task_runner_->PostDelayedTask(
+      FROM_HERE,
+      base::Bind(&AffiliationFetchThrottler::OnBackoffDelayExpiredCallback,
+                 weak_ptr_factory_.GetWeakPtr()),
+      exponential_backoff_->GetTimeUntilRelease());
+}
+
+void AffiliationFetchThrottler::OnBackoffDelayExpiredCallback() {
+  DCHECK_EQ(state_, FETCH_NEEDED);
+  DCHECK(is_fetch_scheduled_);
+  is_fetch_scheduled_ = false;
+
+  // Do nothing if network connectivity was lost while this callback was in the
+  // task queue. The callback will be posted in the OnConnectionTypeChanged
+  // handler once again.
+  if (!has_network_connectivity_)
+    return;
+
+  // The release time might have been increased if network connectivity was lost
+  // and restored while this callback was in the task queue. If so, reschedule.
+  if (exponential_backoff_->ShouldRejectRequest())
+    EnsureCallbackIsScheduled();
+  else
+    state_ = delegate_->OnCanSendNetworkRequest() ? FETCH_IN_FLIGHT : IDLE;
+}
+
+void AffiliationFetchThrottler::OnConnectionTypeChanged(
+    net::NetworkChangeNotifier::ConnectionType type) {
+  bool old_has_network_connectivity = has_network_connectivity_;
+  has_network_connectivity_ =
+      (type != net::NetworkChangeNotifier::CONNECTION_NONE);
+
+  // Only react when network connectivity has been reestablished.
+  if (!has_network_connectivity_ || old_has_network_connectivity)
+    return;
+
+  double grace_ms = kGracePeriodAfterReconnectMs *
+                    (1 - base::RandDouble() * kBackoffPolicy.jitter_factor);
+  exponential_backoff_->SetCustomReleaseTime(std::max(
+      exponential_backoff_->GetReleaseTime(),
+      tick_clock_->NowTicks() + base::TimeDelta::FromMillisecondsD(grace_ms)));
+
+  if (state_ == FETCH_NEEDED)
+    EnsureCallbackIsScheduled();
+}
+
+}  // namespace password_manager