OLD | NEW |
1 // Copyright 2017 The Chromium Authors. All rights reserved. | 1 // Copyright 2017 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef NET_REPORTING_REPORTING_DELIVERY_AGENT_H_ | 5 #ifndef NET_REPORTING_REPORTING_DELIVERY_AGENT_H_ |
6 #define NET_REPORTING_REPORTING_DELIVERY_AGENT_H_ | 6 #define NET_REPORTING_REPORTING_DELIVERY_AGENT_H_ |
7 | 7 |
8 #include <memory> | 8 #include <memory> |
9 #include <set> | 9 #include <set> |
10 #include <string> | 10 #include <string> |
11 #include <utility> | 11 #include <utility> |
12 | 12 |
13 #include "base/macros.h" | 13 #include "base/macros.h" |
14 #include "base/memory/weak_ptr.h" | 14 #include "base/memory/weak_ptr.h" |
15 #include "net/base/backoff_entry.h" | 15 #include "net/base/backoff_entry.h" |
16 #include "net/base/net_export.h" | 16 #include "net/base/net_export.h" |
17 #include "net/reporting/reporting_endpoint_manager.h" | 17 #include "net/reporting/reporting_context.h" |
18 #include "net/reporting/reporting_uploader.h" | 18 #include "net/reporting/reporting_uploader.h" |
19 #include "url/gurl.h" | 19 #include "url/gurl.h" |
20 #include "url/origin.h" | 20 #include "url/origin.h" |
21 | 21 |
22 namespace base { | 22 namespace base { |
23 class TickClock; | 23 class TickClock; |
24 } // namespace base | 24 } // namespace base |
25 | 25 |
26 namespace net { | 26 namespace net { |
27 | 27 |
28 class ReportingCache; | 28 class ReportingCache; |
| 29 class ReportingEndpointManager; |
29 | 30 |
30 // Takes reports from the ReportingCache, assembles reports into deliveries to | 31 // Takes reports from the ReportingCache, assembles reports into deliveries to |
31 // endpoints, and sends those deliveries using ReportingUploader. | 32 // endpoints, and sends those deliveries using ReportingUploader. |
32 // | 33 // |
33 // Since the Reporting spec is completely silent on issues of concurrency, the | 34 // Since the Reporting spec is completely silent on issues of concurrency, the |
34 // delivery agent handles it as so: | 35 // delivery agent handles it as so: |
35 // | 36 // |
36 // 1. An individual report can only be included in one delivery at once -- if | 37 // 1. An individual report can only be included in one delivery at once -- if |
37 // SendReports is called again while a report is being delivered, it won't | 38 // SendReports is called again while a report is being delivered, it won't |
38 // be included in another delivery during that call to SendReports. (This is, | 39 // be included in another delivery during that call to SendReports. (This is, |
(...skipping 10 matching lines...) Expand all Loading... |
49 // group), they won't be included in any delivery during that call to | 50 // group), they won't be included in any delivery during that call to |
50 // SendReports. (This prevents the agent from getting around rule 2 by using | 51 // SendReports. (This prevents the agent from getting around rule 2 by using |
51 // other endpoints.) | 52 // other endpoints.) |
52 // | 53 // |
53 // 4. Reports for the same origin *can* be included in multiple parallel | 54 // 4. Reports for the same origin *can* be included in multiple parallel |
54 // deliveries if they are in different groups within that origin. | 55 // deliveries if they are in different groups within that origin. |
55 // | 56 // |
56 // (Note that a single delivery can contain an infinite number of reports.) | 57 // (Note that a single delivery can contain an infinite number of reports.) |
57 class NET_EXPORT ReportingDeliveryAgent { | 58 class NET_EXPORT ReportingDeliveryAgent { |
58 public: | 59 public: |
59 // |clock|, |cache|, |uploader|, and |endpoint_backoff_policy| must all | 60 // |context| must outlive the ReportingDeliveryAgent. |
60 // outlive the ReportingDeliveryAgent. | 61 ReportingDeliveryAgent(ReportingContext* context); |
61 ReportingDeliveryAgent(base::TickClock* clock, | |
62 ReportingCache* cache, | |
63 ReportingUploader* uploader, | |
64 const BackoffEntry::Policy* endpoint_backoff_policy); | |
65 ~ReportingDeliveryAgent(); | 62 ~ReportingDeliveryAgent(); |
66 | 63 |
67 // Tries to deliver all of the reports in the cache. Reports that are already | 64 // Tries to deliver all of the reports in the cache. Reports that are already |
68 // being delivered will not be attempted a second time, and reports that do | 65 // being delivered will not be attempted a second time, and reports that do |
69 // not have a viable endpoint will be neither attempted nor removed. | 66 // not have a viable endpoint will be neither attempted nor removed. |
70 void SendReports(); | 67 void SendReports(); |
71 | 68 |
72 private: | 69 private: |
73 class Delivery; | 70 class Delivery; |
74 | 71 |
75 using OriginGroup = std::pair<url::Origin, std::string>; | 72 using OriginGroup = std::pair<url::Origin, std::string>; |
76 | 73 |
77 void OnUploadComplete(const std::unique_ptr<Delivery>& delivery, | 74 void OnUploadComplete(const std::unique_ptr<Delivery>& delivery, |
78 ReportingUploader::Outcome outcome); | 75 ReportingUploader::Outcome outcome); |
79 | 76 |
80 base::TickClock* clock_; | 77 base::TickClock* tick_clock() { return context_->tick_clock(); } |
81 ReportingCache* cache_; | 78 ReportingCache* cache() { return context_->cache(); } |
82 ReportingUploader* uploader_; | 79 ReportingUploader* uploader() { return context_->uploader(); } |
| 80 ReportingEndpointManager* endpoint_manager() { |
| 81 return context_->endpoint_manager(); |
| 82 } |
83 | 83 |
84 ReportingEndpointManager endpoint_manager_; | 84 ReportingContext* context_; |
85 | 85 |
86 // Tracks OriginGroup tuples for which there is a pending delivery running. | 86 // Tracks OriginGroup tuples for which there is a pending delivery running. |
87 // (Would be an unordered_set, but there's no hash on pair.) | 87 // (Would be an unordered_set, but there's no hash on pair.) |
88 std::set<OriginGroup> pending_origin_groups_; | 88 std::set<OriginGroup> pending_origin_groups_; |
89 | 89 |
90 base::WeakPtrFactory<ReportingDeliveryAgent> weak_factory_; | 90 base::WeakPtrFactory<ReportingDeliveryAgent> weak_factory_; |
91 | 91 |
92 DISALLOW_COPY_AND_ASSIGN(ReportingDeliveryAgent); | 92 DISALLOW_COPY_AND_ASSIGN(ReportingDeliveryAgent); |
93 }; | 93 }; |
94 | 94 |
95 } // namespace net | 95 } // namespace net |
96 | 96 |
97 #endif // NET_REPORTING_REPORTING_DELIVERY_AGENT_H_ | 97 #endif // NET_REPORTING_REPORTING_DELIVERY_AGENT_H_ |
OLD | NEW |