state_serializer_unittest.cc 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299
  1. // Copyright 2014 The Chromium Authors. All rights reserved.
  2. // Use of this source code is governed by a BSD-style license that can be
  3. // found in the LICENSE file.
  4. #include "android_webview/browser/state_serializer.h"
  5. #include <memory>
  6. #include <string>
  7. #include "base/pickle.h"
  8. #include "base/strings/utf_string_conversions.h"
  9. #include "base/time/time.h"
  10. #include "content/public/browser/content_browser_client.h"
  11. #include "content/public/browser/navigation_entry.h"
  12. #include "content/public/browser/navigation_entry_restore_context.h"
  13. #include "content/public/common/content_client.h"
  14. #include "services/network/public/mojom/referrer_policy.mojom-shared.h"
  15. #include "testing/gtest/include/gtest/gtest.h"
  16. #include "third_party/blink/public/common/page_state/page_state.h"
  17. #include "url/gurl.h"
  18. using std::string;
  19. namespace android_webview {
  20. namespace {
  21. std::unique_ptr<content::NavigationEntry> CreateNavigationEntry() {
  22. std::unique_ptr<content::NavigationEntry> entry(
  23. content::NavigationEntry::Create());
  24. const GURL url("http://url");
  25. const GURL virtual_url("http://virtual_url");
  26. content::Referrer referrer;
  27. referrer.url = GURL("http://referrer_url");
  28. referrer.policy = network::mojom::ReferrerPolicy::kOrigin;
  29. const std::u16string title(u"title");
  30. const bool has_post_data = true;
  31. const GURL original_request_url("http://original_request_url");
  32. const GURL base_url_for_data_url("http://base_url");
  33. const string data_url_as_string("data:text/html;charset=utf-8;base64,");
  34. const bool is_overriding_user_agent = true;
  35. const base::Time timestamp = base::Time::FromInternalValue(12345);
  36. const int http_status_code = 404;
  37. entry->SetURL(url);
  38. entry->SetVirtualURL(virtual_url);
  39. entry->SetReferrer(referrer);
  40. entry->SetTitle(title);
  41. entry->SetHasPostData(has_post_data);
  42. entry->SetOriginalRequestURL(original_request_url);
  43. entry->SetBaseURLForDataURL(base_url_for_data_url);
  44. {
  45. scoped_refptr<base::RefCountedString> s = new base::RefCountedString();
  46. s->data().assign(data_url_as_string);
  47. entry->SetDataURLAsString(s);
  48. }
  49. entry->SetIsOverridingUserAgent(is_overriding_user_agent);
  50. entry->SetTimestamp(timestamp);
  51. entry->SetHttpStatusCode(http_status_code);
  52. return entry;
  53. }
  54. class AndroidWebViewStateSerializerTest : public testing::Test {
  55. public:
  56. AndroidWebViewStateSerializerTest() {
  57. content::SetContentClient(&content_client_);
  58. content::SetBrowserClientForTesting(&browser_client_);
  59. }
  60. AndroidWebViewStateSerializerTest(const AndroidWebViewStateSerializerTest&) =
  61. delete;
  62. AndroidWebViewStateSerializerTest& operator=(
  63. const AndroidWebViewStateSerializerTest&) = delete;
  64. ~AndroidWebViewStateSerializerTest() override {
  65. content::SetBrowserClientForTesting(nullptr);
  66. content::SetContentClient(nullptr);
  67. }
  68. private:
  69. content::ContentClient content_client_;
  70. content::ContentBrowserClient browser_client_;
  71. };
  72. } // namespace
  73. TEST_F(AndroidWebViewStateSerializerTest, TestHeaderSerialization) {
  74. base::Pickle pickle;
  75. internal::WriteHeaderToPickle(&pickle);
  76. base::PickleIterator iterator(pickle);
  77. uint32_t version = internal::RestoreHeaderFromPickle(&iterator);
  78. EXPECT_GT(version, 0U);
  79. }
  80. TEST_F(AndroidWebViewStateSerializerTest,
  81. TestLegacyVersionHeaderSerialization) {
  82. base::Pickle pickle;
  83. internal::WriteHeaderToPickle(internal::AW_STATE_VERSION_INITIAL, &pickle);
  84. base::PickleIterator iterator(pickle);
  85. uint32_t version = internal::RestoreHeaderFromPickle(&iterator);
  86. EXPECT_EQ(version, internal::AW_STATE_VERSION_INITIAL);
  87. }
  88. TEST_F(AndroidWebViewStateSerializerTest,
  89. TestUnsupportedVersionHeaderSerialization) {
  90. base::Pickle pickle;
  91. internal::WriteHeaderToPickle(20000101, &pickle);
  92. base::PickleIterator iterator(pickle);
  93. uint32_t version = internal::RestoreHeaderFromPickle(&iterator);
  94. EXPECT_EQ(version, 0U);
  95. }
  96. TEST_F(AndroidWebViewStateSerializerTest, TestNavigationEntrySerialization) {
  97. std::unique_ptr<content::NavigationEntry> entry(CreateNavigationEntry());
  98. base::Pickle pickle;
  99. internal::WriteNavigationEntryToPickle(*entry, &pickle);
  100. std::unique_ptr<content::NavigationEntry> copy(
  101. content::NavigationEntry::Create());
  102. base::PickleIterator iterator(pickle);
  103. std::unique_ptr<content::NavigationEntryRestoreContext> context =
  104. content::NavigationEntryRestoreContext::Create();
  105. bool result = internal::RestoreNavigationEntryFromPickle(
  106. &iterator, copy.get(), context.get());
  107. EXPECT_TRUE(result);
  108. EXPECT_EQ(entry->GetURL(), copy->GetURL());
  109. EXPECT_EQ(entry->GetVirtualURL(), copy->GetVirtualURL());
  110. EXPECT_EQ(entry->GetReferrer().url, copy->GetReferrer().url);
  111. EXPECT_EQ(entry->GetReferrer().policy, copy->GetReferrer().policy);
  112. EXPECT_EQ(entry->GetTitle(), copy->GetTitle());
  113. EXPECT_EQ(entry->GetPageState(), copy->GetPageState());
  114. EXPECT_EQ(entry->GetHasPostData(), copy->GetHasPostData());
  115. EXPECT_EQ(entry->GetOriginalRequestURL(), copy->GetOriginalRequestURL());
  116. EXPECT_EQ(entry->GetBaseURLForDataURL(), copy->GetBaseURLForDataURL());
  117. EXPECT_EQ(entry->GetDataURLAsString()->data(),
  118. copy->GetDataURLAsString()->data());
  119. EXPECT_EQ(entry->GetIsOverridingUserAgent(),
  120. copy->GetIsOverridingUserAgent());
  121. EXPECT_EQ(entry->GetTimestamp(), copy->GetTimestamp());
  122. EXPECT_EQ(entry->GetHttpStatusCode(), copy->GetHttpStatusCode());
  123. }
  124. TEST_F(AndroidWebViewStateSerializerTest,
  125. TestLegacyNavigationEntrySerialization) {
  126. std::unique_ptr<content::NavigationEntry> entry(CreateNavigationEntry());
  127. base::Pickle pickle;
  128. internal::WriteNavigationEntryToPickle(internal::AW_STATE_VERSION_INITIAL,
  129. *entry, &pickle);
  130. std::unique_ptr<content::NavigationEntry> copy(
  131. content::NavigationEntry::Create());
  132. base::PickleIterator iterator(pickle);
  133. std::unique_ptr<content::NavigationEntryRestoreContext> context =
  134. content::NavigationEntryRestoreContext::Create();
  135. bool result = internal::RestoreNavigationEntryFromPickle(
  136. internal::AW_STATE_VERSION_INITIAL, &iterator, copy.get(), context.get());
  137. EXPECT_TRUE(result);
  138. EXPECT_EQ(entry->GetURL(), copy->GetURL());
  139. EXPECT_EQ(entry->GetVirtualURL(), copy->GetVirtualURL());
  140. EXPECT_EQ(entry->GetReferrer().url, copy->GetReferrer().url);
  141. EXPECT_EQ(entry->GetReferrer().policy, copy->GetReferrer().policy);
  142. EXPECT_EQ(entry->GetTitle(), copy->GetTitle());
  143. EXPECT_EQ(entry->GetPageState(), copy->GetPageState());
  144. EXPECT_EQ(entry->GetHasPostData(), copy->GetHasPostData());
  145. EXPECT_EQ(entry->GetOriginalRequestURL(), copy->GetOriginalRequestURL());
  146. EXPECT_EQ(entry->GetBaseURLForDataURL(), copy->GetBaseURLForDataURL());
  147. // DataURL not supported by 20130814 format
  148. EXPECT_FALSE(copy->GetDataURLAsString());
  149. EXPECT_EQ(entry->GetIsOverridingUserAgent(),
  150. copy->GetIsOverridingUserAgent());
  151. EXPECT_EQ(entry->GetTimestamp(), copy->GetTimestamp());
  152. EXPECT_EQ(entry->GetHttpStatusCode(), copy->GetHttpStatusCode());
  153. }
  154. // This is a regression test for https://crbug.com/999078 - it checks that code
  155. // is able to safely restore entries that were serialized with an empty
  156. // PageState.
  157. TEST_F(AndroidWebViewStateSerializerTest,
  158. TestDeserialization_20151204_EmptyPageState) {
  159. // Test data.
  160. GURL url("data:text/html,main_url");
  161. GURL virtual_url("https://example.com/virtual_url");
  162. content::Referrer referrer(GURL("https://example.com/referrer"),
  163. network::mojom::ReferrerPolicy::kDefault);
  164. std::u16string title = u"title";
  165. std::string empty_encoded_page_state = "";
  166. bool has_post_data = false;
  167. GURL original_request_url("https://example.com/original");
  168. GURL base_url_for_data_url("https://example.com/base_url_for_data_url");
  169. bool is_overriding_user_agent = false;
  170. int64_t timestamp = 123456;
  171. int http_status_code = 404;
  172. // Write data to |pickle| in a way that would trigger https://crbug.com/999078
  173. // in the past. The serialization format used below is based on version
  174. // 20151204 (aka AW_STATE_VERSION_DATA_URL).
  175. base::Pickle pickle;
  176. pickle.WriteString(url.spec());
  177. pickle.WriteString(virtual_url.spec());
  178. pickle.WriteString(referrer.url.spec());
  179. pickle.WriteInt(static_cast<int>(referrer.policy));
  180. pickle.WriteString16(title);
  181. pickle.WriteString(empty_encoded_page_state);
  182. pickle.WriteBool(has_post_data);
  183. pickle.WriteString(original_request_url.spec());
  184. pickle.WriteString(base_url_for_data_url.spec());
  185. pickle.WriteData(nullptr, 0); // data_url_as_string
  186. pickle.WriteBool(is_overriding_user_agent);
  187. pickle.WriteInt64(timestamp);
  188. pickle.WriteInt(http_status_code);
  189. // Deserialize the |pickle|.
  190. base::PickleIterator iterator(pickle);
  191. std::unique_ptr<content::NavigationEntry> copy =
  192. content::NavigationEntry::Create();
  193. std::unique_ptr<content::NavigationEntryRestoreContext> context =
  194. content::NavigationEntryRestoreContext::Create();
  195. bool result = internal::RestoreNavigationEntryFromPickle(
  196. &iterator, copy.get(), context.get());
  197. EXPECT_TRUE(result);
  198. // In https://crbug.com/999078, the empty PageState would clobber the URL
  199. // leading to renderer-side CHECKs later on. Code should replace the empty
  200. // PageState from the |pickle| with a real PageState that preserves the URL.
  201. // Additionally, the referrer needs to be restored in the NavigationEntry
  202. // (but not necessarily in the PageState - this preserves old behavior).
  203. EXPECT_EQ(url, copy->GetURL());
  204. EXPECT_FALSE(copy->GetPageState().ToEncodedData().empty());
  205. EXPECT_EQ(referrer.url, copy->GetReferrer().url);
  206. EXPECT_EQ(referrer.policy, copy->GetReferrer().policy);
  207. // Verify that other properties have deserialized as expected.
  208. EXPECT_EQ(virtual_url, copy->GetVirtualURL());
  209. EXPECT_EQ(referrer.policy, copy->GetReferrer().policy);
  210. EXPECT_EQ(title, copy->GetTitle());
  211. EXPECT_EQ(has_post_data, copy->GetHasPostData());
  212. EXPECT_EQ(original_request_url, copy->GetOriginalRequestURL());
  213. EXPECT_EQ(base_url_for_data_url, copy->GetBaseURLForDataURL());
  214. EXPECT_FALSE(copy->GetDataURLAsString());
  215. EXPECT_EQ(is_overriding_user_agent, copy->GetIsOverridingUserAgent());
  216. EXPECT_EQ(
  217. base::Time::FromDeltaSinceWindowsEpoch(base::Microseconds(timestamp)),
  218. copy->GetTimestamp());
  219. EXPECT_EQ(http_status_code, copy->GetHttpStatusCode());
  220. }
  221. TEST_F(AndroidWebViewStateSerializerTest, TestEmptyDataURLSerialization) {
  222. std::unique_ptr<content::NavigationEntry> entry(
  223. content::NavigationEntry::Create());
  224. EXPECT_FALSE(entry->GetDataURLAsString());
  225. base::Pickle pickle;
  226. internal::WriteNavigationEntryToPickle(*entry, &pickle);
  227. std::unique_ptr<content::NavigationEntry> copy(
  228. content::NavigationEntry::Create());
  229. base::PickleIterator iterator(pickle);
  230. std::unique_ptr<content::NavigationEntryRestoreContext> context =
  231. content::NavigationEntryRestoreContext::Create();
  232. bool result = internal::RestoreNavigationEntryFromPickle(
  233. &iterator, copy.get(), context.get());
  234. EXPECT_TRUE(result);
  235. EXPECT_FALSE(entry->GetDataURLAsString());
  236. }
  237. TEST_F(AndroidWebViewStateSerializerTest, TestHugeDataURLSerialization) {
  238. std::unique_ptr<content::NavigationEntry> entry(
  239. content::NavigationEntry::Create());
  240. string huge_data_url(1024 * 1024 * 20 - 1, 'd');
  241. huge_data_url.replace(0, strlen(url::kDataScheme), url::kDataScheme);
  242. {
  243. scoped_refptr<base::RefCountedString> s = new base::RefCountedString();
  244. s->data().assign(huge_data_url);
  245. entry->SetDataURLAsString(s);
  246. }
  247. base::Pickle pickle;
  248. internal::WriteNavigationEntryToPickle(*entry, &pickle);
  249. std::unique_ptr<content::NavigationEntry> copy(
  250. content::NavigationEntry::Create());
  251. base::PickleIterator iterator(pickle);
  252. std::unique_ptr<content::NavigationEntryRestoreContext> context =
  253. content::NavigationEntryRestoreContext::Create();
  254. bool result = internal::RestoreNavigationEntryFromPickle(
  255. &iterator, copy.get(), context.get());
  256. EXPECT_TRUE(result);
  257. EXPECT_EQ(huge_data_url, copy->GetDataURLAsString()->data());
  258. }
  259. } // namespace android_webview