[ZPS] Adds optional cache duration query param to zero-prefix requests
This CL adds an optional cache duration query string param (ccttl or
client cache time to live) to the zero suggest request urls; if a
positive value is specified via TemplateURLRef::SearchTermsArgs.
If this query string param is present, the server will respond with
the appropriate cache headers in the HTTP response in order to cache
the response for the given number of seconds.
Bug: 1262373
Change-Id: I7c2f690dc2a1324f0e27fc1bcb8f0f1130710af3
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/3293528
Reviewed-by: Orin Jaworski <[email protected]>
Commit-Queue: Moe Ahmadi <[email protected]>
Cr-Commit-Position: refs/heads/main@{#943691}
diff --git a/components/search_engines/prepopulated_engines.json b/components/search_engines/prepopulated_engines.json
index 60366b8..d683def 100644
--- a/components/search_engines/prepopulated_engines.json
+++ b/components/search_engines/prepopulated_engines.json
@@ -28,7 +28,7 @@
// Increment this if you change the data in ways that mean users with
// existing data should get a new version. Otherwise, existing data may
// continue to be used and updates made here will not always appear.
- "kCurrentDataVersion": 126
+ "kCurrentDataVersion": 127
},
// The following engines are included in country lists and are added to the
@@ -117,7 +117,7 @@
"keyword": "google.com",
"favicon_url": "https://www.google.com/images/branding/product/ico/googleg_lodp.ico",
"search_url": "{google:baseURL}search?q={searchTerms}&{google:RLZ}{google:originalQueryForSuggestion}{google:assistedQueryStats}{google:searchFieldtrialParameter}{google:iOSSearchLanguage}{google:prefetchSource}{google:searchClient}{google:sourceId}{google:contextualSearchVersion}ie={inputEncoding}",
- "suggest_url": "{google:baseSuggestURL}search?{google:searchFieldtrialParameter}client={google:suggestClient}&gs_ri={google:suggestRid}&xssi=t&q={searchTerms}&{google:inputType}{google:omniboxFocusType}{google:cursorPosition}{google:currentPageUrl}{google:pageClassification}{google:searchVersion}{google:sessionToken}{google:prefetchQuery}sugkey={google:suggestAPIKeyParameter}",
+ "suggest_url": "{google:baseSuggestURL}search?{google:searchFieldtrialParameter}client={google:suggestClient}&gs_ri={google:suggestRid}&xssi=t&q={searchTerms}&{google:inputType}{google:omniboxFocusType}{google:cursorPosition}{google:currentPageUrl}{google:pageClassification}{google:clientCacheTimeToLive}{google:searchVersion}{google:sessionToken}{google:prefetchQuery}sugkey={google:suggestAPIKeyParameter}",
"image_url": "{google:baseSearchByImageURL}upload",
"contextual_search_url": "{google:baseURL}_/contextualsearch?{google:contextualSearchVersion}{google:contextualSearchContextData}",
"image_url_post_params": "encoded_image={google:imageThumbnail},image_url={google:imageURL},sbisrc={google:imageSearchSource},original_width={google:imageOriginalWidth},original_height={google:imageOriginalHeight}",
diff --git a/components/search_engines/template_url.cc b/components/search_engines/template_url.cc
index d0bf950..36e25919 100644
--- a/components/search_engines/template_url.cc
+++ b/components/search_engines/template_url.cc
@@ -714,6 +714,9 @@
start));
} else if (parameter == "google:pageClassification") {
replacements->push_back(Replacement(GOOGLE_PAGE_CLASSIFICATION, start));
+ } else if (parameter == "google:clientCacheTimeToLive") {
+ replacements->push_back(
+ Replacement(GOOGLE_CLIENT_CACHE_TIME_TO_LIVE, start));
} else if (parameter == "google:pathWildcard") {
// Do nothing, we just want the path wildcard removed from the URL.
} else if (parameter == "google:prefetchQuery") {
@@ -1133,6 +1136,17 @@
}
break;
+ case GOOGLE_CLIENT_CACHE_TIME_TO_LIVE:
+ if (search_terms_args.search_terms.size() == 0 &&
+ search_terms_args.zero_suggest_cache_duration_sec > 0) {
+ HandleReplacement(
+ "ccttl",
+ base::NumberToString(
+ search_terms_args.zero_suggest_cache_duration_sec),
+ *i, &url);
+ }
+ break;
+
case GOOGLE_PREFETCH_QUERY: {
const std::string& query = search_terms_args.prefetch_query;
const std::string& type = search_terms_args.prefetch_query_type;
diff --git a/components/search_engines/template_url.h b/components/search_engines/template_url.h
index 23d8de5a..b104d5ca 100644
--- a/components/search_engines/template_url.h
+++ b/components/search_engines/template_url.h
@@ -252,6 +252,10 @@
bool is_prefetch = false;
ContextualSearchParams contextual_search_params;
+
+ // The cache duration to be sent as a query string parameter in the zero
+ // suggest requests, if non-zero.
+ uint32_t zero_suggest_cache_duration_sec = 0;
};
TemplateURLRef(const TemplateURL* owner, Type type);
@@ -379,18 +383,19 @@
enum ReplacementType {
ENCODING,
GOOGLE_ASSISTED_QUERY_STATS,
- GOOGLE_BASE_URL,
GOOGLE_BASE_SEARCH_BY_IMAGE_URL,
GOOGLE_BASE_SUGGEST_URL,
- GOOGLE_CONTEXTUAL_SEARCH_VERSION,
+ GOOGLE_BASE_URL,
+ GOOGLE_CLIENT_CACHE_TIME_TO_LIVE,
GOOGLE_CONTEXTUAL_SEARCH_CONTEXT_DATA,
+ GOOGLE_CONTEXTUAL_SEARCH_VERSION,
GOOGLE_CURRENT_PAGE_URL,
GOOGLE_CURSOR_POSITION,
GOOGLE_IMAGE_ORIGINAL_HEIGHT,
GOOGLE_IMAGE_ORIGINAL_WIDTH,
GOOGLE_IMAGE_SEARCH_SOURCE,
- GOOGLE_IMAGE_THUMBNAIL,
GOOGLE_IMAGE_THUMBNAIL_BASE64,
+ GOOGLE_IMAGE_THUMBNAIL,
GOOGLE_IMAGE_URL,
GOOGLE_INPUT_TYPE,
GOOGLE_IOS_SEARCH_LANGUAGE,
diff --git a/components/search_engines/template_url_unittest.cc b/components/search_engines/template_url_unittest.cc
index cf14fd08..109f13f 100644
--- a/components/search_engines/template_url_unittest.cc
+++ b/components/search_engines/template_url_unittest.cc
@@ -1152,6 +1152,57 @@
EXPECT_EQ("http://google.com/?client=suggest_client", result_2.spec());
}
+TEST_F(TemplateURLTest, ZeroSuggestCacheDuration) {
+ const std::string base_url_str("http://google.com/?");
+ const std::string query_params_str("{google:clientCacheTimeToLive}");
+ const std::string full_url_str = base_url_str + query_params_str;
+ search_terms_data_.set_google_base_url(base_url_str);
+ TemplateURLData data;
+ data.SetURL(full_url_str);
+ TemplateURL url(data);
+ EXPECT_TRUE(url.url_ref().IsValid(search_terms_data_));
+ ASSERT_FALSE(url.url_ref().SupportsReplacement(search_terms_data_));
+
+ {
+ // 'ccttl' query param should not be present if no cache duration is given.
+ TemplateURLRef::SearchTermsArgs search_terms_args;
+ GURL result(url.url_ref().ReplaceSearchTerms(search_terms_args,
+ search_terms_data_));
+ ASSERT_TRUE(result.is_valid());
+ EXPECT_EQ("http://google.com/?", result.spec());
+ }
+ {
+ // 'ccttl' query param should be present if a positive cache duration is
+ // given.
+ TemplateURLRef::SearchTermsArgs search_terms_args;
+ search_terms_args.zero_suggest_cache_duration_sec = 300;
+ GURL result(url.url_ref().ReplaceSearchTerms(search_terms_args,
+ search_terms_data_));
+ ASSERT_TRUE(result.is_valid());
+ EXPECT_EQ("http://google.com/?ccttl=300&", result.spec());
+ }
+ {
+ // 'ccttl' query param shouldn't be present if a zero cache duration is
+ // given.
+ TemplateURLRef::SearchTermsArgs search_terms_args;
+ search_terms_args.zero_suggest_cache_duration_sec = 0;
+ GURL result(url.url_ref().ReplaceSearchTerms(search_terms_args,
+ search_terms_data_));
+ ASSERT_TRUE(result.is_valid());
+ EXPECT_EQ("http://google.com/?", result.spec());
+ }
+ {
+ // 'ccttl' query param should not be present if the request is not a
+ // zero-prefix request.
+ TemplateURLRef::SearchTermsArgs search_terms_args(u"foo");
+ search_terms_args.zero_suggest_cache_duration_sec = 300;
+ GURL result(url.url_ref().ReplaceSearchTerms(search_terms_args,
+ search_terms_data_));
+ ASSERT_TRUE(result.is_valid());
+ EXPECT_EQ("http://google.com/?", result.spec());
+ }
+}
+
TEST_F(TemplateURLTest, GetURLNoSuggestionsURL) {
TemplateURLData data;
data.SetURL("http://google.com/?q={searchTerms}");
