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
|
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/page_image_service/image_service_consent_helper.h"
#include "base/feature_list.h"
#include "base/metrics/field_trial_params.h"
#include "base/metrics/histogram_functions.h"
#include "components/page_image_service/features.h"
#include "components/page_image_service/metrics_util.h"
#include "components/sync/service/sync_service.h"
#include "components/unified_consent/consent_throttle.h"
#include "components/unified_consent/url_keyed_data_collection_consent_helper.h"
namespace page_image_service {
namespace {
void RunConsentThrottleCallback(
base::OnceCallback<void(PageImageServiceConsentStatus)> callback,
bool success) {
std::move(callback).Run(success ? PageImageServiceConsentStatus::kSuccess
: PageImageServiceConsentStatus::kFailure);
}
PageImageServiceConsentStatus ConsentStatusToUmaStatus(
absl::optional<bool> consent_status) {
if (!consent_status) {
return PageImageServiceConsentStatus::kTimedOut;
}
return consent_status.value() ? PageImageServiceConsentStatus::kSuccess
: PageImageServiceConsentStatus::kFailure;
}
} // namespace
ImageServiceConsentHelper::ImageServiceConsentHelper(
syncer::SyncService* sync_service,
syncer::ModelType model_type)
: sync_service_(sync_service),
model_type_(model_type),
timeout_duration_(base::Seconds(GetFieldTrialParamByFeatureAsInt(
kImageServiceObserveSyncDownloadStatus,
"timeout_seconds",
10))) {
if (base::FeatureList::IsEnabled(kImageServiceObserveSyncDownloadStatus)) {
sync_service_observer_.Observe(sync_service);
} else if (model_type == syncer::ModelType::BOOKMARKS) {
// TODO(crbug.com/1463438): Migrate to require_sync_feature_enabled = false.
consent_throttle_ = std::make_unique<unified_consent::ConsentThrottle>(
unified_consent::UrlKeyedDataCollectionConsentHelper::
NewPersonalizedBookmarksDataCollectionConsentHelper(
sync_service,
/*require_sync_feature_enabled=*/true),
timeout_duration_);
} else if (model_type == syncer::ModelType::HISTORY_DELETE_DIRECTIVES) {
consent_throttle_ = std::make_unique<unified_consent::ConsentThrottle>(
unified_consent::UrlKeyedDataCollectionConsentHelper::
NewPersonalizedDataCollectionConsentHelper(sync_service),
timeout_duration_);
} else {
NOTREACHED();
}
}
ImageServiceConsentHelper::~ImageServiceConsentHelper() = default;
void ImageServiceConsentHelper::EnqueueRequest(
base::OnceCallback<void(PageImageServiceConsentStatus)> callback,
mojom::ClientId client_id) {
base::UmaHistogramBoolean("PageImageService.ConsentStatusRequestCount", true);
if (consent_throttle_) {
consent_throttle_->EnqueueRequest(
base::BindOnce(&RunConsentThrottleCallback, std::move(callback)));
return;
}
absl::optional<bool> consent_status = GetConsentStatus();
if (consent_status.has_value()) {
std::move(callback).Run(*consent_status
? PageImageServiceConsentStatus::kSuccess
: PageImageServiceConsentStatus::kFailure);
return;
}
enqueued_request_callbacks_.emplace_back(std::move(callback), client_id);
if (!request_processing_timer_.IsRunning()) {
request_processing_timer_.Start(
FROM_HERE, timeout_duration_,
base::BindOnce(&ImageServiceConsentHelper::OnTimeoutExpired,
weak_ptr_factory_.GetWeakPtr()));
}
}
void ImageServiceConsentHelper::OnStateChanged(
syncer::SyncService* sync_service) {
CHECK_EQ(sync_service_, sync_service);
CHECK(base::FeatureList::IsEnabled(kImageServiceObserveSyncDownloadStatus));
absl::optional<bool> consent_status = GetConsentStatus();
if (!consent_status.has_value()) {
return;
}
for (auto& request_callback_with_client_id : enqueued_request_callbacks_) {
std::move(request_callback_with_client_id.first)
.Run(*consent_status ? PageImageServiceConsentStatus::kSuccess
: PageImageServiceConsentStatus::kFailure);
}
enqueued_request_callbacks_.clear();
request_processing_timer_.Stop();
}
void ImageServiceConsentHelper::OnSyncShutdown(
syncer::SyncService* sync_service) {
CHECK_EQ(sync_service_, sync_service);
CHECK(base::FeatureList::IsEnabled(kImageServiceObserveSyncDownloadStatus));
sync_service_observer_.Reset();
}
absl::optional<bool> ImageServiceConsentHelper::GetConsentStatus() {
CHECK(base::FeatureList::IsEnabled(kImageServiceObserveSyncDownloadStatus));
syncer::SyncService::ModelTypeDownloadStatus download_status =
sync_service_->GetDownloadStatusFor(model_type_);
switch (download_status) {
case syncer::SyncService::ModelTypeDownloadStatus::kWaitingForUpdates:
return absl::nullopt;
case syncer::SyncService::ModelTypeDownloadStatus::kUpToDate:
return true;
case syncer::SyncService::ModelTypeDownloadStatus::kError:
return false;
}
}
void ImageServiceConsentHelper::OnTimeoutExpired() {
for (auto& request_callback_with_client_id : enqueued_request_callbacks_) {
// Report consent status on timeout for each request to compare against the
// number of all requests.
base::UmaHistogramEnumeration("PageImageService.ConsentStatusOnTimeout",
ConsentStatusToUmaStatus(GetConsentStatus()));
sync_service_->RecordReasonIfWaitingForUpdates(
model_type_, kConsentTimeoutReasonHistogramName);
sync_service_->RecordReasonIfWaitingForUpdates(
model_type_,
std::string(kConsentTimeoutReasonHistogramName) + "." +
ClientIdToString(request_callback_with_client_id.second));
std::move(request_callback_with_client_id.first)
.Run(PageImageServiceConsentStatus::kTimedOut);
}
enqueued_request_callbacks_.clear();
}
} // namespace page_image_service
|
