[OBSOLETE] Reporting: Initial implementation.

components/reporting/core/browser/reporting_manager.h

+// Copyright 2016 The Chromium Authors. All rights reserved.

[Randy Smith (Not in Mondays), 2016/10/21 20:15:11]

Attaching a top-level comment at a random location: In your mind, what has to
happen for this CL to land?  

The question I'm actually concerned about is: What has to happen before we turn
this feature on?  But it looks to me as if, if this CL landed, the feature would
be up and running ("Now witness the power of ..." :-}).  But there's a lot in
the design doc you show as not yet implemented.  What aspects of that block
enabling this feature?  And how are you going to avoid enabling this feature
until those aspects are done (if you land this CL)?

[Julia Tuttle, 2016/11/02 20:44:39]

These need to happen before we turn it on: rudimentary report scheduling, a cap
on the number of endpoints/reports, histograms, Finch control and command-line
flags, unit tests, a browser test.

They don't have to happen in *this* CL, but if they don't, we'd need to nerf
this CL so it doesn't enable the feature half-baked. (Finch control defaulting
to off would do it.)

These can happen in later CLs: persistence of endpoints across sessions, wiring
to CSP or another client, fancier report scheduling, fancier garbage collection
policy.

These need to happen before beta/stable launch in parallel with development:
normal launch review stuff (privacy, security, etc.)

+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#ifndef COMPONENTS_REPORTING_CORE_BROWSER_REPORTING_MANAGER_H_
+#define COMPONENTS_REPORTING_CORE_BROWSER_REPORTING_MANAGER_H_
+
+#include <map>
+#include <unordered_set>
+
+#include "base/callback.h"
+#include "base/macros.h"
+#include "base/time/tick_clock.h"
+#include "base/time/time.h"
+#include "base/values.h"
+#include "components/reporting/core/browser/reporting_cache.h"
+#include "components/reporting/core/browser/reporting_client.h"
+#include "components/reporting/core/browser/reporting_endpoint.h"
+#include "components/reporting/core/browser/reporting_report.h"
+#include "components/reporting/core/browser/reporting_uploader.h"
+#include "components/reporting/core/common/reporting_export.h"
+#include "net/base/backoff_entry.h"
+#include "url/gurl.h"
+
+namespace reporting {
+
+struct ReportingDelivery {};
+
+class REPORTING_EXPORT ReportingManager {
+ public:
+  ReportingManager(std::unique_ptr<ReportingUploader> uploader,
+                   const base::Callback<bool(const GURL&)>& is_origin_secure);
+  ~ReportingManager();
+
+  // Section 4.1
+  void QueueReport(std::unique_ptr<ReportingReport> report);
+
+  // Section 3.2
+  void ProcessHeader(const GURL& origin, const std::string& header_value);
+
+  // Section 4.3 step 4.1.
+  void SendReports();
+
+  const ReportingCache& GetReportingCacheForTesting() const { return cache_; }
+
+ private:
+  // Section 3.3
+  struct EndpointTuple {
+    GURL url;
+    bool subdomains;
+    base::TimeDelta ttl;
+    std::string group;
+
+    // Section 3.3, step 3.3.
+    static bool FromDictionary(const base::DictionaryValue& dictionary,
+                               EndpointTuple* tuple_out,
+                               std::string* error_out);
+    static std::vector<EndpointTuple> FromHeader(
+        const std::string& header,
+        const base::Callback<bool(const GURL&)>& is_origin_secure,
+        std::vector<std::string>* errors_out);
+
+    std::string ToString() const;
+  };
+
+  // Context for Section 4.3 step 4, for convenience.
+  struct Delivery {
+    Delivery(
+        const std::unique_ptr<ReportingEndpoint>& endpoint,
+        const std::vector<const std::unique_ptr<ReportingReport>*>& reports);
+    ~Delivery();
+
+    const std::unique_ptr<ReportingEndpoint>& endpoint;
+    std::vector<const std::unique_ptr<ReportingReport>*> reports;
+  };
+
+  // Section 3.2, step 5.1-4
+  void ProcessEndpoint(const GURL& origin, const EndpointTuple& tuple);
+
+  // Section 4.2
+  bool DoesEndpointMatchReport(const ReportingEndpoint& endpoint,
+                               const ReportingReport& report);
+
+  // Section 4.3 step 4.2.
+  void OnDeliveryAttemptComplete(const std::unique_ptr<Delivery>& delivery,
+                                 ReportingUploader::Outcome outcome);
+
+  // Section 4.4 steps 1-2.
+  std::string SerializeReports(
+      const std::vector<const std::unique_ptr<ReportingReport>*>& reports);
+
+  // Section 5.2
+  void CollectGarbage();
+
+  base::Callback<bool(const GURL&)> is_origin_secure_;
+  std::unique_ptr<base::TickClock> clock_;
+  net::BackoffEntry::Policy backoff_policy_;
+  ReportingCache cache_;
+  std::unique_ptr<ReportingUploader> uploader_;
+};
+
+}  // namespace reporting
+
+#endif  // COMPONENTS_REPORTING_REPORTING_MANAGER_H_