Domain Reliability: Don't upload when metrics reporting is off.

components/domain_reliability/monitor.h

 // Copyright 2014 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.
 
 #ifndef COMPONENTS_DOMAIN_RELIABILITY_MONITOR_H_
 #define COMPONENTS_DOMAIN_RELIABILITY_MONITOR_H_
 
 #include <map>
 
 #include "base/memory/ref_counted.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/memory/weak_ptr.h"
+#include "base/prefs/pref_member.h"
 #include "base/time/time.h"
 #include "components/domain_reliability/beacon.h"
 #include "components/domain_reliability/clear_mode.h"
 #include "components/domain_reliability/config.h"
 #include "components/domain_reliability/context.h"
 #include "components/domain_reliability/dispatcher.h"
 #include "components/domain_reliability/domain_reliability_export.h"
 #include "components/domain_reliability/scheduler.h"
 #include "components/domain_reliability/uploader.h"
 #include "components/domain_reliability/util.h"
 #include "net/base/load_timing_info.h"
 #include "net/http/http_response_info.h"
 #include "net/url_request/url_request_status.h"
 
+class PrefService;
+
 namespace base {
 class SingleThreadTaskRunner;
 class ThreadChecker;
 class Value;
 }  // namespace base
 
 namespace net {
 class URLRequest;
 class URLRequestContext;
 class URLRequestContextGetter;
 }  // namespace net
 
 namespace domain_reliability {
 
 // The top-level object that measures requests and hands off the measurements
 // to the proper |DomainReliabilityContext|.
 class DOMAIN_RELIABILITY_EXPORT DomainReliabilityMonitor {
  public:
-  explicit DomainReliabilityMonitor(const std::string& upload_reporter_string);
+  // Creates a Monitor. |InitReportingPref| and |InitURLRequestContext| must be
+  // called (in that order) before any other methods are called. (See those
+  // methods for further threading details.)
+  DomainReliabilityMonitor(const std::string& upload_reporter_string);
   DomainReliabilityMonitor(const std::string& upload_reporter_string,
                            scoped_ptr<MockableTime> time);
   ~DomainReliabilityMonitor();
 
-  // Initializes the Monitor.
-  void Init(
+  // Begins monitoring |reporting_pref_name| in |local_state_pref_service| to
+  // let the user control whether Domain Reliability uploads are sent. (When the
+  // pref is true, they are sent; when it is false, they are discarded.)
+  //
+  // Must be called before |InitURLRequestContext|, on the thread that owns
+  // |local_state_pref_service|. |network_task_runner| must be a task runner
+  // for the thread on which the URLRequestContext passed later lives.
+  void InitReportingPref(
+      PrefService* local_state_pref_service,
+      const char* reporting_pref_name,
+      const scoped_refptr<base::SingleThreadTaskRunner>&
+          network_task_runner);
+
+  // Initializes the Monitor's URLRequestContextGetter.
+  //
+  // Must be called after |InitReportingPref|, on the thread that owns
+  // |url_request_context|. |task_runner| must be a task runner on that
+  // (current) thread.
+  void InitURLRequestContext(
       net::URLRequestContext* url_request_context,
       const scoped_refptr<base::SingleThreadTaskRunner>& task_runner);
 
   // Same, but for unittests where the Getter is readily available.
-  void Init(
+  void InitURLRequestContext(
       scoped_refptr<net::URLRequestContextGetter> url_request_context_getter);
 
+  // Must be called from the same thread as |InitReportingPref|.
+  void DestroyReportingPref();
+
   // Populates the monitor with contexts that were configured at compile time.
   void AddBakedInConfigs();
 
   // Should be called when |request| is about to follow a redirect. Will
   // examine and possibly log the redirect request.
   void OnBeforeRedirect(net::URLRequest* request);
 
   // Should be called when |request| is complete. Will examine and possibly
   // log the (final) request. (|started| should be true if the request was
   // actually started before it was terminated.)
@@ skipping 36 matching lines @@
   };
 
   // Creates a context, adds it to the monitor, and returns a pointer to it.
   // (The pointer is only valid until the Monitor is destroyed.)
   DomainReliabilityContext* AddContext(
       scoped_ptr<const DomainReliabilityConfig> config);
   // Deletes all contexts from |contexts_| and clears the map.
   void ClearContexts();
   void OnRequestLegComplete(const RequestInfo& info);
 
+  void OnReportingPrefChanged();
+
   DomainReliabilityContext* GetContextForHost(const std::string& host) const;
 
   base::WeakPtr<DomainReliabilityMonitor> MakeWeakPtr();
 
   scoped_ptr<base::ThreadChecker> thread_checker_;
   scoped_ptr<MockableTime> time_;
   const std::string upload_reporter_string_;
   DomainReliabilityScheduler::Params scheduler_params_;
   DomainReliabilityDispatcher dispatcher_;
   scoped_ptr<DomainReliabilityUploader> uploader_;
   ContextMap contexts_;
 
+  BooleanPrefMember reporting_pref_;
+  bool reporting_pref_initialized_;
+
   base::WeakPtrFactory<DomainReliabilityMonitor> weak_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(DomainReliabilityMonitor);
 };
 
 }  // namespace domain_reliability
 
 #endif  // COMPONENTS_DOMAIN_RELIABILITY_MONITOR_H_