[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/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}");
