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
content / browser / attribution_reporting / attribution_observer.h [blame]
// 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_ATTRIBUTION_REPORTING_ATTRIBUTION_OBSERVER_H_
#define CONTENT_BROWSER_ATTRIBUTION_REPORTING_ATTRIBUTION_OBSERVER_H_
#include <stdint.h>
#include <optional>
#include "base/observer_list_types.h"
#include "base/time/time.h"
#include "base/values.h"
#include "content/browser/attribution_reporting/attribution_reporting.mojom-forward.h"
#include "content/browser/attribution_reporting/process_aggregatable_debug_report_result.mojom-forward.h"
#include "content/browser/attribution_reporting/store_source_result.mojom-forward.h"
namespace attribution_reporting {
struct OsRegistrationItem;
} // namespace attribution_reporting
namespace url {
class Origin;
} // namespace url
namespace content {
class AggregatableDebugReport;
class AttributionDebugReport;
class AttributionReport;
class CreateReportResult;
class StorableSource;
struct SendAggregatableDebugReportResult;
struct SendResult;
// Observes events in the Attribution Reporting API. Observers are registered on
// `AttributionManager`.
class AttributionObserver : public base::CheckedObserver {
public:
~AttributionObserver() override = default;
// Called when sources in storage change.
virtual void OnSourcesChanged() {}
// Called when reports in storage change.
virtual void OnReportsChanged() {}
// Called when a source is registered, regardless of success.
virtual void OnSourceHandled(
const StorableSource& source,
base::Time source_time,
std::optional<uint64_t> cleared_debug_key,
attribution_reporting::mojom::StoreSourceResult) {}
// Called when a report is sent, regardless of success, but not for attempts
// that will be retried.
virtual void OnReportSent(const AttributionReport& report,
bool is_debug_report,
const SendResult& info) {}
// Called when a verbose debug report is sent, regardless of success.
// If `status` is positive, it is the HTTP response code. Otherwise, it is the
// network error.
virtual void OnDebugReportSent(const AttributionDebugReport&,
int status,
base::Time) {}
// Called when an aggregatable debug report is assembled and sent, regardless
// of success.
virtual void OnAggregatableDebugReportSent(
const AggregatableDebugReport&,
base::ValueView report_body,
attribution_reporting::mojom::ProcessAggregatableDebugReportResult,
const SendAggregatableDebugReportResult&) {}
// Called when a trigger is registered, regardless of success.
virtual void OnTriggerHandled(std::optional<uint64_t> cleared_debug_key,
const CreateReportResult& result) {}
// Called when an OS source or trigger registration is handled, regardless of
// success.
virtual void OnOsRegistration(
base::Time time,
const attribution_reporting::OsRegistrationItem&,
const url::Origin& top_level_origin,
attribution_reporting::mojom::RegistrationType,
bool is_debug_key_allowed,
attribution_reporting::mojom::OsRegistrationResult) {}
virtual void OnDebugModeChanged(bool debug_mode) {}
};
} // namespace content
#endif // CONTENT_BROWSER_ATTRIBUTION_REPORTING_ATTRIBUTION_OBSERVER_H_