123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430 |
- // Copyright 2017 The Chromium Authors. All rights reserved.
- // Use of this source code is governed by a BSD-style license that can be
- // found in the LICENSE file.
- #include "components/ntp_snippets/remote/remote_suggestions_fetcher_impl.h"
- #include "base/bind.h"
- #include "base/metrics/histogram_functions.h"
- #include "base/metrics/histogram_macros.h"
- #include "base/strings/stringprintf.h"
- #include "base/strings/utf_string_conversions.h"
- #include "base/time/default_clock.h"
- #include "base/time/time.h"
- #include "base/values.h"
- #include "components/language/core/browser/url_language_histogram.h"
- #include "components/ntp_snippets/category.h"
- #include "components/ntp_snippets/features.h"
- #include "components/ntp_snippets/ntp_snippets_constants.h"
- #include "components/ntp_snippets/user_classifier.h"
- #include "components/signin/public/identity_manager/identity_manager.h"
- #include "components/signin/public/identity_manager/primary_account_access_token_fetcher.h"
- #include "components/signin/public/identity_manager/scope_set.h"
- #include "components/variations/variations_associated_data.h"
- #include "net/base/url_util.h"
- #include "services/network/public/cpp/shared_url_loader_factory.h"
- using language::UrlLanguageHistogram;
- namespace ntp_snippets {
- using internal::FetchResult;
- using internal::JsonRequest;
- namespace {
- const char kApiKeyQueryParam[] = "key";
- const char kPriorityQueryParam[] = "priority";
- const char kInteractivePriority[] = "user_action";
- const char kNonInteractivePriority[] = "background_prefetch";
- const char kAuthorizationRequestHeaderFormat[] = "Bearer %s";
- const int kFetchTimeHistogramResolution = 5;
- // Enables appending request priority as a query parameter to the fetch url,
- // when fetching article suggestions.
- const char kAppendRequestPriorityAsQueryParameterParamName[] =
- "append_request_priority_as_query_parameter";
- const bool kAppendRequestPriorityAsQueryParameterParamDefault = true;
- bool IsAppendingRequestPriorityAsQueryParameterEnabled() {
- return variations::GetVariationParamByFeatureAsBool(
- ntp_snippets::kArticleSuggestionsFeature,
- kAppendRequestPriorityAsQueryParameterParamName,
- kAppendRequestPriorityAsQueryParameterParamDefault);
- }
- GURL AppendPriorityQueryParameterIfEnabled(const GURL& url,
- bool is_interactive_request) {
- if (IsAppendingRequestPriorityAsQueryParameterEnabled()) {
- return net::AppendQueryParameter(url, kPriorityQueryParam,
- is_interactive_request
- ? kInteractivePriority
- : kNonInteractivePriority);
- }
- return url;
- }
- std::string FetchResultToString(FetchResult result) {
- switch (result) {
- case FetchResult::SUCCESS:
- return "OK";
- case FetchResult::URL_REQUEST_STATUS_ERROR:
- return "URLRequestStatus error";
- case FetchResult::HTTP_ERROR:
- return "HTTP error";
- case FetchResult::JSON_PARSE_ERROR:
- return "Received invalid JSON";
- case FetchResult::INVALID_SNIPPET_CONTENT_ERROR:
- return "Invalid / empty list.";
- case FetchResult::OAUTH_TOKEN_ERROR:
- return "Error in obtaining an OAuth2 access token.";
- case FetchResult::MISSING_API_KEY:
- return "No API key available.";
- case FetchResult::HTTP_ERROR_UNAUTHORIZED:
- return "Access token invalid";
- case FetchResult::RESULT_MAX:
- break;
- }
- NOTREACHED();
- return "Unknown error";
- }
- Status FetchResultToStatus(FetchResult result) {
- switch (result) {
- case FetchResult::SUCCESS:
- return Status::Success();
- // Permanent errors occur if it is more likely that the error originated
- // from the client.
- case FetchResult::OAUTH_TOKEN_ERROR:
- case FetchResult::MISSING_API_KEY:
- return Status(StatusCode::PERMANENT_ERROR, FetchResultToString(result));
- // Temporary errors occur if it's more likely that the client behaved
- // correctly but the server failed to respond as expected.
- // TODO(fhorschig): Revisit HTTP_ERROR once the rescheduling was reworked.
- case FetchResult::HTTP_ERROR:
- case FetchResult::HTTP_ERROR_UNAUTHORIZED:
- case FetchResult::URL_REQUEST_STATUS_ERROR:
- case FetchResult::INVALID_SNIPPET_CONTENT_ERROR:
- case FetchResult::JSON_PARSE_ERROR:
- return Status(StatusCode::TEMPORARY_ERROR, FetchResultToString(result));
- case FetchResult::RESULT_MAX:
- break;
- }
- NOTREACHED();
- return Status(StatusCode::PERMANENT_ERROR, std::string());
- }
- int GetMinuteOfTheDay(bool local_time,
- bool reduced_resolution,
- const base::Clock* clock) {
- base::Time now(clock->Now());
- base::Time::Exploded now_exploded{};
- local_time ? now.LocalExplode(&now_exploded) : now.UTCExplode(&now_exploded);
- int now_minute = reduced_resolution
- ? now_exploded.minute / kFetchTimeHistogramResolution *
- kFetchTimeHistogramResolution
- : now_exploded.minute;
- return now_exploded.hour * 60 + now_minute;
- }
- // The response from the backend might include suggestions from multiple
- // categories. If only a single category was requested, this function filters
- // all other categories out.
- void FilterCategories(FetchedCategoriesVector* categories,
- absl::optional<Category> exclusive_category) {
- if (!exclusive_category.has_value()) {
- return;
- }
- Category exclusive = exclusive_category.value();
- auto category_it =
- std::find_if(categories->begin(), categories->end(),
- [&exclusive](const FetchedCategory& c) -> bool {
- return c.category == exclusive;
- });
- if (category_it == categories->end()) {
- categories->clear();
- return;
- }
- FetchedCategory category = std::move(*category_it);
- categories->clear();
- categories->push_back(std::move(category));
- }
- } // namespace
- bool RemoteSuggestionsFetcherImpl::skip_api_key_check_for_testing_ = false;
- RemoteSuggestionsFetcherImpl::RemoteSuggestionsFetcherImpl(
- signin::IdentityManager* identity_manager,
- scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory,
- PrefService* pref_service,
- UrlLanguageHistogram* language_histogram,
- const ParseJSONCallback& parse_json_callback,
- const GURL& api_endpoint,
- const std::string& api_key,
- const UserClassifier* user_classifier)
- : identity_manager_(identity_manager),
- url_loader_factory_(std::move(url_loader_factory)),
- language_histogram_(language_histogram),
- parse_json_callback_(parse_json_callback),
- fetch_url_(api_endpoint),
- api_key_(api_key),
- clock_(base::DefaultClock::GetInstance()),
- user_classifier_(user_classifier),
- last_fetch_authenticated_(false) {}
- RemoteSuggestionsFetcherImpl::~RemoteSuggestionsFetcherImpl() = default;
- const std::string& RemoteSuggestionsFetcherImpl::GetLastStatusForDebugging()
- const {
- return last_status_;
- }
- const std::string& RemoteSuggestionsFetcherImpl::GetLastJsonForDebugging()
- const {
- return last_fetch_json_;
- }
- bool RemoteSuggestionsFetcherImpl::WasLastFetchAuthenticatedForDebugging()
- const {
- return last_fetch_authenticated_;
- }
- const GURL& RemoteSuggestionsFetcherImpl::GetFetchUrlForDebugging() const {
- return fetch_url_;
- }
- void RemoteSuggestionsFetcherImpl::FetchSnippets(
- const RequestParams& params,
- SnippetsAvailableCallback callback) {
- SnippetsAvailableCallback wrapped_callback = base::BindOnce(
- &RemoteSuggestionsFetcherImpl::EmitDurationAndInvokeCallback,
- base::Unretained(this), base::Time::Now(), std::move(callback));
- if (!params.interactive_request) {
- base::UmaHistogramSparse(
- "NewTabPage.Snippets.FetchTimeLocal",
- GetMinuteOfTheDay(/*local_time=*/true,
- /*reduced_resolution=*/true, clock_));
- base::UmaHistogramSparse(
- "NewTabPage.Snippets.FetchTimeUTC",
- GetMinuteOfTheDay(/*local_time=*/false,
- /*reduced_resolution=*/true, clock_));
- }
- JsonRequest::Builder builder;
- builder.SetLanguageHistogram(language_histogram_)
- .SetParams(params)
- .SetParseJsonCallback(parse_json_callback_)
- .SetClock(clock_)
- .SetUrlLoaderFactory(url_loader_factory_)
- .SetUserClassifier(*user_classifier_)
- .SetOptionalImagesCapability(true);
- if (identity_manager_->HasPrimaryAccount(signin::ConsentLevel::kSync)) {
- // Signed-in: get OAuth token --> fetch suggestions.
- pending_requests_.emplace(std::move(builder), std::move(wrapped_callback));
- StartTokenRequest();
- } else {
- // Not signed in: fetch suggestions (without authentication).
- FetchSnippetsNonAuthenticated(std::move(builder),
- std::move(wrapped_callback));
- }
- }
- void RemoteSuggestionsFetcherImpl::FetchSnippetsNonAuthenticated(
- JsonRequest::Builder builder,
- SnippetsAvailableCallback callback) {
- if (api_key_.empty() && !skip_api_key_check_for_testing_) {
- // If we don't have an API key, don't even try.
- FetchFinished(OptionalFetchedCategories(), std::move(callback),
- FetchResult::MISSING_API_KEY, std::string(),
- /*is_authenticated=*/false, std::string());
- return;
- }
- // When not providing OAuth token, we need to pass the Google API key.
- GURL url = net::AppendQueryParameter(fetch_url_, kApiKeyQueryParam, api_key_);
- url = AppendPriorityQueryParameterIfEnabled(url,
- builder.is_interactive_request());
- builder.SetUrl(url);
- StartRequest(std::move(builder), std::move(callback),
- /*is_authenticated=*/false, std::string());
- }
- void RemoteSuggestionsFetcherImpl::FetchSnippetsAuthenticated(
- JsonRequest::Builder builder,
- SnippetsAvailableCallback callback,
- const std::string& oauth_access_token) {
- GURL url = AppendPriorityQueryParameterIfEnabled(
- fetch_url_, builder.is_interactive_request());
- builder.SetUrl(url).SetAuthentication(
- base::StringPrintf(kAuthorizationRequestHeaderFormat,
- oauth_access_token.c_str()));
- StartRequest(std::move(builder), std::move(callback),
- /*is_authenticated=*/true, oauth_access_token);
- }
- void RemoteSuggestionsFetcherImpl::StartRequest(
- JsonRequest::Builder builder,
- SnippetsAvailableCallback callback,
- bool is_authenticated,
- std::string access_token) {
- std::unique_ptr<JsonRequest> request = builder.Build();
- JsonRequest* raw_request = request.get();
- raw_request->Start(base::BindOnce(
- &RemoteSuggestionsFetcherImpl::JsonRequestDone, base::Unretained(this),
- std::move(request), std::move(callback), is_authenticated, access_token));
- }
- void RemoteSuggestionsFetcherImpl::StartTokenRequest() {
- // If there is already an ongoing token request, just wait for that.
- if (token_fetcher_) {
- return;
- }
- base::Time token_start_time = clock_->Now();
- signin::ScopeSet scopes{kContentSuggestionsApiScope};
- token_fetcher_ = std::make_unique<signin::PrimaryAccountAccessTokenFetcher>(
- "ntp_snippets", identity_manager_, scopes,
- base::BindOnce(&RemoteSuggestionsFetcherImpl::AccessTokenFetchFinished,
- base::Unretained(this), token_start_time),
- signin::PrimaryAccountAccessTokenFetcher::Mode::kWaitUntilAvailable);
- }
- void RemoteSuggestionsFetcherImpl::AccessTokenFetchFinished(
- base::Time token_start_time,
- GoogleServiceAuthError error,
- signin::AccessTokenInfo access_token_info) {
- DCHECK(token_fetcher_);
- token_fetcher_.reset();
- UMA_HISTOGRAM_ENUMERATION("ContentSuggestions.Feed.Network.TokenFetchStatus",
- error.state(), GoogleServiceAuthError::NUM_STATES);
- base::TimeDelta token_duration = clock_->Now() - token_start_time;
- UMA_HISTOGRAM_MEDIUM_TIMES("ContentSuggestions.Feed.Network.TokenDuration",
- token_duration);
- if (error.state() != GoogleServiceAuthError::NONE) {
- AccessTokenError(error);
- return;
- }
- DCHECK(!access_token_info.token.empty());
- while (!pending_requests_.empty()) {
- std::pair<JsonRequest::Builder, SnippetsAvailableCallback>
- builder_and_callback = std::move(pending_requests_.front());
- pending_requests_.pop();
- FetchSnippetsAuthenticated(std::move(builder_and_callback.first),
- std::move(builder_and_callback.second),
- access_token_info.token);
- }
- }
- void RemoteSuggestionsFetcherImpl::AccessTokenError(
- const GoogleServiceAuthError& error) {
- DCHECK_NE(error.state(), GoogleServiceAuthError::NONE);
- DLOG(ERROR) << "Unable to get token: " << error.ToString();
- while (!pending_requests_.empty()) {
- std::pair<JsonRequest::Builder, SnippetsAvailableCallback>
- builder_and_callback = std::move(pending_requests_.front());
- FetchFinished(OptionalFetchedCategories(),
- std::move(builder_and_callback.second),
- FetchResult::OAUTH_TOKEN_ERROR,
- /*error_details=*/
- base::StringPrintf(" (%s)", error.ToString().c_str()),
- /*is_authenticated=*/true, std::string());
- pending_requests_.pop();
- }
- }
- void RemoteSuggestionsFetcherImpl::JsonRequestDone(
- std::unique_ptr<JsonRequest> request,
- SnippetsAvailableCallback callback,
- bool is_authenticated,
- std::string access_token,
- base::Value result,
- FetchResult status_code,
- const std::string& error_details) {
- DCHECK(request);
- // Record the time when request for fetching remote content snippets finished.
- const base::Time fetch_time = clock_->Now();
- last_fetch_json_ = request->GetResponseString();
- UMA_HISTOGRAM_TIMES("NewTabPage.Snippets.FetchTime",
- request->GetFetchDuration());
- if (result.is_none()) {
- FetchFinished(OptionalFetchedCategories(), std::move(callback), status_code,
- error_details, is_authenticated, access_token);
- return;
- }
- FetchedCategoriesVector categories;
- if (!JsonToCategories(result, &categories, fetch_time)) {
- LOG(WARNING) << "Received invalid snippets: " << last_fetch_json_;
- FetchFinished(OptionalFetchedCategories(), std::move(callback),
- FetchResult::INVALID_SNIPPET_CONTENT_ERROR, std::string(),
- is_authenticated, access_token);
- return;
- }
- // Filter out unwanted categories if necessary.
- // TODO(fhorschig): As soon as the server supports filtering by category,
- // adjust the request instead of over-fetching and filtering here.
- FilterCategories(&categories, request->exclusive_category());
- FetchFinished(std::move(categories), std::move(callback),
- FetchResult::SUCCESS, std::string(), is_authenticated,
- access_token);
- }
- void RemoteSuggestionsFetcherImpl::FetchFinished(
- OptionalFetchedCategories categories,
- SnippetsAvailableCallback callback,
- FetchResult fetch_result,
- const std::string& error_details,
- bool is_authenticated,
- std::string access_token) {
- DCHECK(fetch_result == FetchResult::SUCCESS || !categories.has_value());
- if (fetch_result == FetchResult::HTTP_ERROR_UNAUTHORIZED) {
- signin::ScopeSet scopes{kContentSuggestionsApiScope};
- CoreAccountId account_id =
- identity_manager_->GetPrimaryAccountId(signin::ConsentLevel::kSync);
- identity_manager_->RemoveAccessTokenFromCache(account_id, scopes,
- access_token);
- }
- last_status_ = FetchResultToString(fetch_result) + error_details;
- last_fetch_authenticated_ = is_authenticated;
- UMA_HISTOGRAM_ENUMERATION("NewTabPage.Snippets.FetchResult",
- static_cast<int>(fetch_result),
- static_cast<int>(FetchResult::RESULT_MAX));
- DVLOG(1) << "Fetch finished: " << last_status_;
- std::move(callback).Run(FetchResultToStatus(fetch_result),
- std::move(categories));
- }
- void RemoteSuggestionsFetcherImpl::EmitDurationAndInvokeCallback(
- base::Time start_time,
- SnippetsAvailableCallback callback,
- Status status,
- OptionalFetchedCategories fetched_categories) {
- base::TimeDelta duration = clock_->Now() - start_time;
- UMA_HISTOGRAM_MEDIUM_TIMES("ContentSuggestions.Feed.Network.Duration",
- duration);
- std::move(callback).Run(status, std::move(fetched_categories));
- }
- // static
- void RemoteSuggestionsFetcherImpl::set_skip_api_key_check_for_testing() {
- skip_api_key_check_for_testing_ = true;
- }
- } // namespace ntp_snippets
|