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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
|
// 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_SHARED_STORAGE_SHARED_STORAGE_EVENT_PARAMS_H_
#define CONTENT_BROWSER_SHARED_STORAGE_SHARED_STORAGE_EVENT_PARAMS_H_
#include <map>
#include <optional>
#include <ostream>
#include "content/common/content_export.h"
#include "third_party/blink/public/common/messaging/cloneable_message.h"
#include "third_party/blink/public/mojom/shared_storage/shared_storage.mojom.h"
#include "url/gurl.h"
#include "url/origin.h"
namespace content {
// Bundles the varying possible parameters for DevTools shared storage access
// events.
class CONTENT_EXPORT SharedStorageEventParams {
public:
// Wraps a `blink::mojom::PrivateAggregationConfig` for DevTools shared
// storage integration.
struct CONTENT_EXPORT PrivateAggregationConfigWrapper {
blink::mojom::PrivateAggregationConfigPtr config;
PrivateAggregationConfigWrapper();
PrivateAggregationConfigWrapper(
const std::optional<url::Origin>& aggregation_coordinator_origin,
const std::optional<std::string>& context_id,
uint32_t filtering_id_max_bytes,
std::optional<uint16_t> max_contributions);
explicit PrivateAggregationConfigWrapper(
const blink::mojom::PrivateAggregationConfigPtr& config);
PrivateAggregationConfigWrapper(
const PrivateAggregationConfigWrapper& other);
~PrivateAggregationConfigWrapper();
PrivateAggregationConfigWrapper& operator=(
const PrivateAggregationConfigWrapper& other);
bool operator==(const PrivateAggregationConfigWrapper&) const;
friend std::ostream& operator<<(
std::ostream& os,
const PrivateAggregationConfigWrapper& config);
};
// Bundles a URL's spec along with a map of any accompanying reporting
// metadata for DevTools integration.
struct CONTENT_EXPORT SharedStorageUrlSpecWithMetadata {
std::string url;
std::map<std::string, std::string> reporting_metadata;
SharedStorageUrlSpecWithMetadata();
SharedStorageUrlSpecWithMetadata(
const GURL& url,
std::map<std::string, std::string> reporting_metadata);
SharedStorageUrlSpecWithMetadata(const SharedStorageUrlSpecWithMetadata&);
~SharedStorageUrlSpecWithMetadata();
SharedStorageUrlSpecWithMetadata& operator=(
const SharedStorageUrlSpecWithMetadata&);
bool operator==(const SharedStorageUrlSpecWithMetadata&) const;
friend std::ostream& operator<<(
std::ostream& os,
const SharedStorageUrlSpecWithMetadata& url_with_metadata);
};
static SharedStorageEventParams CreateForAddModule(
const GURL& script_source_url,
int worklet_ordinal_id,
const base::UnguessableToken& worklet_devtools_token);
static SharedStorageEventParams CreateForCreateWorklet(
const GURL& script_source_url,
const std::string& data_origin,
int worklet_ordinal_id,
const base::UnguessableToken& worklet_devtools_token);
static SharedStorageEventParams CreateForRun(
const std::string& operation_name,
int operation_id,
bool keep_alive,
const blink::mojom::PrivateAggregationConfigPtr&
private_aggregation_config,
const blink::CloneableMessage& serialized_data,
int worklet_ordinal_id,
const base::UnguessableToken& worklet_devtools_token);
static SharedStorageEventParams CreateForRunForTesting(
const std::string& operation_name,
int operation_id,
bool keep_alive,
PrivateAggregationConfigWrapper config_wrapper,
const blink::CloneableMessage& serialized_data,
int worklet_ordinal_id,
const base::UnguessableToken& worklet_devtools_token);
static SharedStorageEventParams CreateForSelectURL(
const std::string& operation_name,
int operation_id,
bool keep_alive,
const blink::mojom::PrivateAggregationConfigPtr&
private_aggregation_config,
const blink::CloneableMessage& serialized_data,
std::vector<SharedStorageUrlSpecWithMetadata> urls_with_metadata,
bool resolve_to_config,
std::string saved_query,
const GURL& urn_uuid,
int worklet_ordinal_id,
const base::UnguessableToken& worklet_devtools_token);
static SharedStorageEventParams CreateForSelectURLForTesting(
const std::string& operation_name,
int operation_id,
bool keep_alive,
PrivateAggregationConfigWrapper config_wrapper,
const blink::CloneableMessage& serialized_data,
std::vector<SharedStorageUrlSpecWithMetadata> urls_with_metadata,
bool resolve_to_config,
std::string saved_query,
const GURL& urn_uuid,
int worklet_ordinal_id,
const base::UnguessableToken& worklet_devtools_token);
static SharedStorageEventParams CreateForSet(
const std::string& key,
const std::string& value,
bool ignore_if_present,
std::optional<int> worklet_ordinal_id = std::nullopt,
const base::UnguessableToken& worklet_devtools_token =
base::UnguessableToken::Null(),
std::optional<std::string> with_lock = std::nullopt,
std::optional<int> batch_update_id = std::nullopt);
static SharedStorageEventParams CreateForAppend(
const std::string& key,
const std::string& value,
std::optional<int> worklet_ordinal_id = std::nullopt,
const base::UnguessableToken& worklet_devtools_token =
base::UnguessableToken::Null(),
std::optional<std::string> with_lock = std::nullopt,
std::optional<int> batch_update_id = std::nullopt);
static SharedStorageEventParams CreateForDelete(
const std::string& key,
std::optional<int> worklet_ordinal_id = std::nullopt,
const base::UnguessableToken& worklet_devtools_token =
base::UnguessableToken::Null(),
std::optional<std::string> with_lock = std::nullopt,
std::optional<int> batch_update_id = std::nullopt);
static SharedStorageEventParams CreateForClear(
std::optional<int> worklet_ordinal_id = std::nullopt,
const base::UnguessableToken& worklet_devtools_token =
base::UnguessableToken::Null(),
std::optional<std::string> with_lock = std::nullopt,
std::optional<int> batch_update_id = std::nullopt);
static SharedStorageEventParams CreateForGet(
const std::string& key,
std::optional<int> worklet_ordinal_id = std::nullopt,
const base::UnguessableToken& worklet_devtools_token =
base::UnguessableToken::Null());
static SharedStorageEventParams CreateWithWorkletId(
int worklet_ordinal_id,
const base::UnguessableToken& worklet_devtools_token);
static SharedStorageEventParams CreateForBatchUpdate(
std::optional<int> worklet_ordinal_id,
const base::UnguessableToken& worklet_devtools_token,
std::optional<std::string> with_lock,
int batch_update_id,
size_t batch_size);
SharedStorageEventParams(const SharedStorageEventParams&);
~SharedStorageEventParams();
SharedStorageEventParams& operator=(const SharedStorageEventParams&);
std::optional<std::string> script_source_url;
std::optional<std::string> data_origin;
std::optional<std::string> operation_name;
std::optional<int> operation_id;
std::optional<bool> keep_alive;
std::optional<PrivateAggregationConfigWrapper> private_aggregation_config;
std::optional<std::string> serialized_data;
std::optional<std::vector<SharedStorageUrlSpecWithMetadata>>
urls_with_metadata;
std::optional<bool> resolve_to_config;
std::optional<std::string> saved_query;
std::optional<std::string> urn_uuid;
std::optional<std::string> key;
std::optional<std::string> value;
std::optional<bool> ignore_if_present;
std::optional<int> worklet_ordinal_id;
base::UnguessableToken worklet_devtools_token;
std::optional<std::string> with_lock;
std::optional<int> batch_update_id;
std::optional<int> batch_size;
private:
SharedStorageEventParams();
SharedStorageEventParams(
std::optional<std::string> script_source_url,
std::optional<std::string> data_origin,
std::optional<std::string> operation_name,
std::optional<int> operation_id,
std::optional<bool> keep_alive,
std::optional<PrivateAggregationConfigWrapper> private_aggregation_config,
std::optional<std::string> serialized_data,
std::optional<std::vector<SharedStorageUrlSpecWithMetadata>>
urls_with_metadata,
std::optional<bool> resolve_to_config,
std::optional<std::string> saved_query,
std::optional<std::string> urn_uuid,
std::optional<std::string> key,
std::optional<std::string> value,
std::optional<bool> ignore_if_present,
std::optional<int> worklet_ordinal_id,
const base::UnguessableToken& worklet_devtools_token,
std::optional<std::string> with_lock,
std::optional<int> batch_update_id,
std::optional<int> batch_size);
static SharedStorageEventParams CreateForWorkletCreation(
const GURL& script_source_url,
std::optional<std::string> data_origin,
int worklet_ordinal_id,
const base::UnguessableToken& worklet_devtools_token);
static SharedStorageEventParams CreateForWorkletOperation(
const std::string& operation_name,
int operation_id,
bool keep_alive,
const blink::mojom::PrivateAggregationConfigPtr&
private_aggregation_config,
const blink::CloneableMessage& serialized_data,
std::optional<std::vector<SharedStorageUrlSpecWithMetadata>>
urls_with_metadata,
std::optional<bool> resolve_to_config,
std::optional<std::string> saved_query,
std::optional<std::string> urn_uuid,
int worklet_ordinal_id,
const base::UnguessableToken& worklet_devtools_token);
static SharedStorageEventParams CreateForWorkletOperationForTesting(
const std::string& operation_name,
int operation_id,
bool keep_alive,
PrivateAggregationConfigWrapper config_wrapper,
const blink::CloneableMessage& serialized_data,
std::optional<std::vector<SharedStorageUrlSpecWithMetadata>>
urls_with_metadata,
std::optional<bool> resolve_to_config,
std::optional<std::string> saved_query,
std::optional<std::string> urn_uuid,
int worklet_ordinal_id,
const base::UnguessableToken& worklet_devtools_token);
static SharedStorageEventParams CreateForModifierMethod(
std::optional<std::string> key,
std::optional<std::string> value,
std::optional<bool> ignore_if_present,
std::optional<int> worklet_ordinal_id,
const base::UnguessableToken& worklet_devtools_token,
std::optional<std::string> with_lock,
std::optional<int> batch_update_id);
static SharedStorageEventParams CreateForGetterMethod(
std::optional<std::string> key,
std::optional<int> worklet_ordinal_id,
const base::UnguessableToken& worklet_devtools_token);
};
CONTENT_EXPORT bool operator==(const SharedStorageEventParams& lhs,
const SharedStorageEventParams& rhs);
CONTENT_EXPORT std::ostream& operator<<(std::ostream& os,
const SharedStorageEventParams& params);
} // namespace content
#endif // CONTENT_BROWSER_SHARED_STORAGE_SHARED_STORAGE_EVENT_PARAMS_H_
|
