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
|
// Copyright 2025 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/sync/service/device_statistics_request_impl.h"
#include <utility>
#include "components/signin/public/base/oauth_consumer_id.h"
#include "components/signin/public/identity_manager/access_token_fetcher.h"
#include "components/signin/public/identity_manager/access_token_info.h"
#include "components/signin/public/identity_manager/identity_manager.h"
#include "components/sync/base/data_type.h"
#include "components/sync/protocol/data_type_progress_marker.pb.h"
#include "components/sync/protocol/sync.pb.h"
#include "google_apis/credentials_mode.h"
#include "google_apis/google_api_keys.h"
#include "net/base/load_flags.h"
#include "net/http/http_status_code.h"
#include "services/network/public/cpp/resource_request.h"
#include "services/network/public/cpp/shared_url_loader_factory.h"
#include "services/network/public/cpp/simple_url_loader.h"
#include "services/network/public/mojom/url_response_head.mojom.h"
#include "third_party/zlib/google/compression_utils.h"
namespace syncer {
DeviceStatisticsRequestImpl::DeviceStatisticsRequestImpl(
signin::IdentityManager* identity_manager,
scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory,
std::string_view user_agent,
const CoreAccountInfo& account,
const GURL& url)
: account_(account),
identity_manager_(identity_manager),
url_loader_factory_(std::move(url_loader_factory)),
url_(url),
user_agent_(user_agent) {
CHECK(identity_manager_);
CHECK(url_loader_factory_);
// This class must only be used if there is a primary account (though it's
// allowed that `account` isn't the primary one). If this ever changes, also
// update the network traffic annotation.
CHECK(identity_manager_->HasPrimaryAccount(signin::ConsentLevel::kSignin));
}
DeviceStatisticsRequestImpl::~DeviceStatisticsRequestImpl() = default;
void DeviceStatisticsRequestImpl::Start(base::OnceClosure callback) {
CHECK(callback);
CHECK_EQ(state_, State::kNotStarted);
state_ = State::kInProgress;
callback_ = std::move(callback);
// Unretained() is safe because destroying `access_token_fetcher_` will also
// cancel any in-flight operations.
access_token_fetcher_ = identity_manager_->CreateAccessTokenFetcherForAccount(
account_.account_id,
signin::OAuthConsumerId::kSyncDeviceStatisticsMetrics,
base::BindOnce(&DeviceStatisticsRequestImpl::AccessTokenFetchComplete,
base::Unretained(this)),
signin::AccessTokenFetcher::Mode::kImmediate);
}
DeviceStatisticsRequest::State DeviceStatisticsRequestImpl::GetState() const {
return state_;
}
const std::vector<sync_pb::SyncEntity>&
DeviceStatisticsRequestImpl::GetResults() const {
return results_;
}
void DeviceStatisticsRequestImpl::AccessTokenFetchComplete(
GoogleServiceAuthError error,
signin::AccessTokenInfo access_token_info) {
access_token_fetcher_.reset();
if (error.state() != GoogleServiceAuthError::NONE) {
UpdateStateAndNotify(State::kFailed);
// It is valid for the callback to delete `this`, so do not access any
// members below here.
return;
}
// Got an access token -- start the actual API request.
net::NetworkTrafficAnnotationTag traffic_annotation =
net::DefineNetworkTrafficAnnotation("sync_device_statistics_metrics", R"(
semantics {
sender: "Chrome Sync"
description:
"Chrome sends this on profile startup, to collect metrics on both "
"the primary and any non-primary accounts."
trigger:
"Sign-in to Chrome, or profile startup while already signed-in."
data: "The user identifier."
destination: GOOGLE_OWNED_SERVICE
internal {
contacts {
email: "treib@chromium.org"
}
contacts {
owners: "//components/sync/OWNERS"
}
}
user_data {
type: ACCESS_TOKEN
}
last_reviewed: "2025-12-15"
}
policy {
cookies_allowed: NO
setting:
"Users can disable these requests by turning off 'Help improve "
"Chrome's features and performance' in Chrome settings, or by "
"signing out of Chrome."
chrome_policy {
SyncDisabled {
policy_options {mode: MANDATORY}
SyncDisabled: true
}
}
})");
auto resource_request = std::make_unique<network::ResourceRequest>();
resource_request->url = url_;
resource_request->method = "POST";
resource_request->load_flags =
net::LOAD_BYPASS_CACHE | net::LOAD_DISABLE_CACHE;
resource_request->credentials_mode =
google_apis::GetOmitCredentialsModeForGaiaRequests();
resource_request->headers.SetHeader(net::HttpRequestHeaders::kAuthorization,
"Bearer " + access_token_info.token);
resource_request->headers.SetHeader("Content-Encoding", "gzip");
resource_request->headers.SetHeader(net::HttpRequestHeaders::kUserAgent,
user_agent_);
simple_url_loader_ = network::SimpleURLLoader::Create(
std::move(resource_request), traffic_annotation);
// Populate the GetUpdates message.
sync_pb::ClientToServerMessage msg;
msg.set_protocol_version(
sync_pb::ClientToServerMessage::default_instance().protocol_version());
*msg.mutable_bag_of_chips() = sync_pb::ChipBag();
msg.mutable_client_status()->set_is_sync_feature_enabled(false);
msg.set_api_key(google_apis::GetAPIKey());
msg.set_share(account_.email);
msg.set_message_contents(sync_pb::ClientToServerMessage_Contents_GET_UPDATES);
sync_pb::GetUpdatesMessage& get_updates = *msg.mutable_get_updates();
get_updates.set_fetch_folders(true);
get_updates.set_need_encryption_key(false);
get_updates.mutable_caller_info()->set_notifications_enabled(false);
get_updates.set_get_updates_origin(
sync_pb::SyncEnums::GetUpdatesOrigin::
SyncEnums_GetUpdatesOrigin_DEVICE_STATISTICS_METRICS);
sync_pb::DataTypeProgressMarker& progress =
*get_updates.add_from_progress_marker();
progress.set_data_type_id(
GetSpecificsFieldNumberFromDataType(syncer::DEVICE_INFO));
progress.mutable_get_update_triggers()->set_initial_sync_in_progress(true);
// Serialize and gzip the message.
std::string serialized_msg;
msg.SerializeToString(&serialized_msg);
std::string request_to_send;
compression::GzipCompress(serialized_msg, &request_to_send);
simple_url_loader_->AttachStringForUpload(request_to_send,
"application/octet-stream");
simple_url_loader_->SetAllowHttpErrorResults(true);
// Unretained() is safe because destroying `simple_url_loader_` will cancel
// any in-flight operations.
simple_url_loader_->DownloadToStringOfUnboundedSizeUntilCrashAndDie(
url_loader_factory_.get(),
base::BindOnce(&DeviceStatisticsRequestImpl::SimpleLoaderComplete,
base::Unretained(this), access_token_info));
}
void DeviceStatisticsRequestImpl::SimpleLoaderComplete(
signin::AccessTokenInfo access_token_info,
std::optional<std::string> response_body) {
int response_code = -1;
if (simple_url_loader_->ResponseInfo() &&
simple_url_loader_->ResponseInfo()->headers) {
response_code =
simple_url_loader_->ResponseInfo()->headers->response_code();
}
simple_url_loader_.reset();
// If the response code indicates that the token might not be valid,
// invalidate the token and try again.
if (response_code == net::HTTP_UNAUTHORIZED && !has_retried_authorization_) {
identity_manager_->RemoveAccessTokenFromCache(
account_.account_id, signin::OAuthConsumerId::kWebHistoryService,
access_token_info.token);
has_retried_authorization_ = true;
state_ = State::kNotStarted; // Avoid CHECK() in Start().
Start(std::move(callback_));
return;
}
if (response_code != net::HTTP_OK) {
UpdateStateAndNotify(State::kFailed);
return;
}
if (!response_body) {
UpdateStateAndNotify(State::kFailed);
return;
}
sync_pb::ClientToServerResponse response;
if (!response.ParseFromString(response_body.value())) {
UpdateStateAndNotify(State::kFailed);
return;
}
for (const sync_pb::SyncEntity& entity : response.get_updates().entries()) {
results_.push_back(entity);
}
UpdateStateAndNotify(State::kComplete);
// It is valid for the callback to delete `this`, so do not access any
// members below here.
}
void DeviceStatisticsRequestImpl::UpdateStateAndNotify(State state) {
CHECK(state == State::kComplete || state == State::kFailed);
CHECK(callback_);
state_ = state;
std::move(callback_).Run();
}
} // namespace syncer
|