1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CONTENT_BROWSER_PRIVATE_AGGREGATION_PRIVATE_AGGREGATION_MANAGER_IMPL_H_
#define CONTENT_BROWSER_PRIVATE_AGGREGATION_PRIVATE_AGGREGATION_MANAGER_IMPL_H_
#include <stddef.h>
#include <stdint.h>
#include <map>
#include <memory>
#include <optional>
#include <string>
#include "base/functional/callback_forward.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/weak_ptr.h"
#include "base/time/time.h"
#include "content/browser/private_aggregation/private_aggregation_budget_key.h"
#include "content/browser/private_aggregation/private_aggregation_budgeter.h"
#include "content/browser/private_aggregation/private_aggregation_caller_api.h"
#include "content/browser/private_aggregation/private_aggregation_host.h"
#include "content/browser/private_aggregation/private_aggregation_manager.h"
#include "content/browser/private_aggregation/private_aggregation_pending_contributions.h"
#include "content/common/content_export.h"
#include "content/public/browser/private_aggregation_data_model.h"
#include "content/public/browser/storage_partition.h"
#include "mojo/public/cpp/bindings/pending_receiver.h"
#include "third_party/blink/public/mojom/private_aggregation/private_aggregation_host.mojom.h"
namespace base {
class FilePath;
}
namespace url {
class Origin;
}
namespace content {
class AggregationService;
class PrivateAggregationHost;
class StoragePartitionImpl;
// UI thread class that manages the lifetime of the other classes,
// coordinates report requests, and interfaces with other directories. Lifetime
// is bound to lifetime of the `StoragePartitionImpl`.
class CONTENT_EXPORT PrivateAggregationManagerImpl
: public PrivateAggregationManager,
public PrivateAggregationDataModel {
public:
// These values are persisted to logs. Entries should not be renumbered and
// numeric values should never be reused.
enum class RequestResult {
kSentWithContributions = 0,
kSentWithoutContributions = 1,
kSentButContributionsClearedDueToBudgetDenial = 2,
kNotSent = 3,
kMaxValue = kNotSent,
};
// `storage_partition` must outlive this.
PrivateAggregationManagerImpl(bool exclusively_run_in_memory,
const base::FilePath& user_data_directory,
StoragePartitionImpl* storage_partition);
PrivateAggregationManagerImpl(const PrivateAggregationManagerImpl&) = delete;
PrivateAggregationManagerImpl& operator=(
const PrivateAggregationManagerImpl&) = delete;
~PrivateAggregationManagerImpl() override;
// PrivateAggregationManager:
[[nodiscard]] bool BindNewReceiver(
url::Origin worklet_origin,
url::Origin top_frame_origin,
PrivateAggregationCallerApi caller_api,
std::optional<std::string> context_id,
std::optional<base::TimeDelta> timeout,
std::optional<url::Origin> aggregation_coordinator_origin,
size_t filtering_id_max_bytes,
std::optional<size_t> max_contributions,
mojo::PendingReceiver<blink::mojom::PrivateAggregationHost>
pending_receiver) override;
void ClearBudgetData(base::Time delete_begin,
base::Time delete_end,
StoragePartition::StorageKeyMatcherFunction filter,
base::OnceClosure done) override;
bool IsDebugModeAllowed(const url::Origin& top_frame_origin,
const url::Origin& reporting_origin) override;
// PrivateAggregationDataModel:
void GetAllDataKeys(
base::OnceCallback<void(std::set<DataKey>)> callback) override;
void RemovePendingDataKey(const DataKey& data_key,
base::OnceClosure callback) override;
protected:
// Protected for testing.
PrivateAggregationManagerImpl(
std::unique_ptr<PrivateAggregationBudgeter> budgeter,
std::unique_ptr<PrivateAggregationHost> host,
StoragePartitionImpl* storage_partition);
// Virtual for testing.
virtual AggregationService* GetAggregationService();
// Called when the `host_` has received and validated the information needed
// for report generation from a completed mojo pipe.
void OnReportRequestDetailsReceivedFromHost(
PrivateAggregationHost::ReportRequestGenerator report_request_generator,
PrivateAggregationPendingContributions::Wrapper contributions,
PrivateAggregationBudgetKey budget_key,
PrivateAggregationHost::NullReportBehavior null_report_behavior);
private:
struct InProgressBudgetRequest;
using BudgetRequestId = base::StrongAlias<class BudgetRequestIdTag, int64_t>;
// Called when the `budgeter_` has responded to a `ConsumeBudget()` call.
// Virtual for testing.
virtual void OnConsumeBudgetReturned(
PrivateAggregationHost::ReportRequestGenerator report_request_generator,
std::vector<blink::mojom::AggregatableReportHistogramContribution>
contributions,
PrivateAggregationCallerApi caller_api,
PrivateAggregationHost::NullReportBehavior null_report_behavior,
PrivateAggregationBudgeter::RequestResult request_result);
void OnTestBudgetAndLockReturned(
BudgetRequestId budget_request_id,
PrivateAggregationBudgeter::InspectBudgetCallResult result);
// TODO(crbug.com/381788013): Remove `WithLock` naming once
// `kPrivateAggregationApiErrorReporting` is fully launched and the flag is
// removed.
void OnConsumeBudgetWithLockReturned(
BudgetRequestId budget_request_id,
PrivateAggregationBudgeter::BudgetQueryResult result);
virtual void OnContributionsFinalized(
PrivateAggregationHost::ReportRequestGenerator report_request_generator,
std::vector<blink::mojom::AggregatableReportHistogramContribution>
contributions,
PrivateAggregationCallerApi caller_api);
virtual void OnBudgeterGetAllDataKeysReturned(
base::OnceCallback<void(std::set<DataKey>)> callback,
std::set<DataKey> all_keys);
std::unique_ptr<PrivateAggregationBudgeter> budgeter_;
std::unique_ptr<PrivateAggregationHost> host_;
// Used to track associated information for requests to the `budgeter_` that
// have not had their callbacks called yet. Only populated if
// `kPrivateAggregationApiErrorReporting` is enabled.
std::map<BudgetRequestId, InProgressBudgetRequest>
in_progress_budget_requests_;
// Used to vend keys for `in_progress_budget_requests_`. Only used if
// `kPrivateAggregationApiErrorReporting` is enabled.
int64_t num_requests_processed_ = 0;
// Can be nullptr in unit tests.
raw_ptr<StoragePartitionImpl> storage_partition_;
base::WeakPtrFactory<PrivateAggregationManagerImpl> weak_factory_{this};
};
} // namespace content
#endif // CONTENT_BROWSER_PRIVATE_AGGREGATION_PRIVATE_AGGREGATION_MANAGER_IMPL_H_
|
