[CacheStorage] Pad and bin opaque resource sizes.

content/browser/cache_storage/cache_storage_cache_unittest.cc

 // Copyright 2014 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 "content/browser/cache_storage/cache_storage_cache.h"
 
 #include <stddef.h>
 #include <stdint.h>
 
 #include <memory>
@@ skipping 11 matching lines @@
 #include "base/threading/thread_task_runner_handle.h"
 #include "content/browser/blob_storage/chrome_blob_storage_context.h"
 #include "content/browser/cache_storage/cache_storage_cache_handle.h"
 #include "content/common/cache_storage/cache_storage_types.h"
 #include "content/common/service_worker/service_worker_types.h"
 #include "content/public/browser/browser_thread.h"
 #include "content/public/browser/storage_partition.h"
 #include "content/public/common/referrer.h"
 #include "content/public/test/test_browser_context.h"
 #include "content/public/test/test_browser_thread_bundle.h"
+#include "crypto/symmetric_key.h"
 #include "net/base/test_completion_callback.h"
 #include "net/url_request/url_request_context.h"
 #include "net/url_request/url_request_context_getter.h"
 #include "net/url_request/url_request_job_factory_impl.h"
 #include "storage/browser/blob/blob_data_builder.h"
 #include "storage/browser/blob/blob_data_handle.h"
 #include "storage/browser/blob/blob_data_snapshot.h"
 #include "storage/browser/blob/blob_storage_context.h"
 #include "storage/browser/blob/blob_url_request_job_factory.h"
 #include "storage/browser/quota/quota_manager_proxy.h"
@@ skipping 13 matching lines @@
 std::unique_ptr<storage::BlobProtocolHandler> CreateMockBlobProtocolHandler(
     storage::BlobStorageContext* blob_storage_context) {
   return base::WrapUnique(
       new storage::BlobProtocolHandler(blob_storage_context, nullptr));
 }
 
 // A disk_cache::Backend wrapper that can delay operations.
 class DelayableBackend : public disk_cache::Backend {
  public:
   explicit DelayableBackend(std::unique_ptr<disk_cache::Backend> backend)
-      : backend_(std::move(backend)), delay_doom_(false) {}
+      : backend_(std::move(backend)), delay_open_entry_(false) {}
 
   // disk_cache::Backend overrides
   net::CacheType GetCacheType() const override {
     return backend_->GetCacheType();
   }
   int32_t GetEntryCount() const override { return backend_->GetEntryCount(); }
   int OpenEntry(const std::string& key,
                 disk_cache::Entry** entry,
                 const CompletionCallback& callback) override {
+    if (delay_open_entry_ && open_entry_callback_.is_null()) {
+      open_entry_callback_ = base::BindOnce(
+          &DelayableBackend::OpenEntryDelayedImpl, base::Unretained(this), key,
+          base::Unretained(entry), callback);
+      return net::ERR_IO_PENDING;
+    }
     return backend_->OpenEntry(key, entry, callback);
   }
 
   int CreateEntry(const std::string& key,
                   disk_cache::Entry** entry,
                   const CompletionCallback& callback) override {
     return backend_->CreateEntry(key, entry, callback);
   }
   int DoomEntry(const std::string& key,
                 const CompletionCallback& callback) override {
-    if (delay_doom_) {
-      doom_entry_callback_ =
-          base::BindOnce(&DelayableBackend::DoomEntryDelayedImpl,
-                         base::Unretained(this), key, callback);
-      return net::ERR_IO_PENDING;
-    }
-
     return backend_->DoomEntry(key, callback);
   }
   int DoomAllEntries(const CompletionCallback& callback) override {
     return backend_->DoomAllEntries(callback);
   }
   int DoomEntriesBetween(base::Time initial_time,
                          base::Time end_time,
                          const CompletionCallback& callback) override {
     return backend_->DoomEntriesBetween(initial_time, end_time, callback);
   }
@@ skipping 15 matching lines @@
     return backend_->OnExternalCacheHit(key);
   }
 
   size_t DumpMemoryStats(
       base::trace_event::ProcessMemoryDump* pmd,
       const std::string& parent_absolute_name) const override {
     NOTREACHED();
     return 0u;
   }
 
-  // Call to continue a delayed doom.
-  void DoomEntryContinue() {
-    EXPECT_FALSE(doom_entry_callback_.is_null());
-    std::move(doom_entry_callback_).Run();
+  // Call to continue a delayed call to OpenEntry.
+  bool OpenEntryContinue() {
+    if (open_entry_callback_.is_null())
+      return false;
+    std::move(open_entry_callback_).Run();
+    return true;
   }
 
-  void set_delay_doom(bool value) { delay_doom_ = value; }
+  void set_delay_open_entry(bool value) { delay_open_entry_ = value; }
 
  private:
-  void DoomEntryDelayedImpl(const std::string& key,
+  void OpenEntryDelayedImpl(const std::string& key,
+                            disk_cache::Entry** entry,
                             const CompletionCallback& callback) {
-    int rv = backend_->DoomEntry(key, callback);
+    int rv = backend_->OpenEntry(key, entry, callback);
     if (rv != net::ERR_IO_PENDING)
       callback.Run(rv);
   }
 
   std::unique_ptr<disk_cache::Backend> backend_;
-  bool delay_doom_;
-  base::OnceClosure doom_entry_callback_;
+  bool delay_open_entry_;
+  base::OnceClosure open_entry_callback_;
 };
 
 void CopyBody(const storage::BlobDataHandle& blob_handle, std::string* output) {
   *output = std::string();
   std::unique_ptr<storage::BlobDataSnapshot> data =
       blob_handle.CreateSnapshot();
   const auto& items = data->items();
   for (const auto& item : items) {
     switch (item->type()) {
       case storage::DataElement::TYPE_BYTES: {
@@ skipping 106 matching lines @@
   return expected_side_data == actual_body;
 }
 
 ServiceWorkerResponse SetCacheName(const ServiceWorkerResponse& original) {
   ServiceWorkerResponse result(original);
   result.is_in_cache_storage = true;
   result.cache_storage_cache_name = kCacheName;
   return result;
 }
 
+std::unique_ptr<crypto::SymmetricKey> CreateTestPaddingKey() {
+  return crypto::SymmetricKey::Import(crypto::SymmetricKey::HMAC_SHA1,
+                                      "abc123");
+}
+
 }  // namespace
 
 // A CacheStorageCache that can optionally delay during backend creation.
 class TestCacheStorageCache : public CacheStorageCache {
  public:
   TestCacheStorageCache(
       const GURL& origin,
       const std::string& cache_name,
       const base::FilePath& path,
       CacheStorage* cache_storage,
       const scoped_refptr<net::URLRequestContextGetter>& request_context_getter,
       const scoped_refptr<storage::QuotaManagerProxy>& quota_manager_proxy,
       base::WeakPtr<storage::BlobStorageContext> blob_context)
       : CacheStorageCache(origin,
                           cache_name,
                           path,
                           cache_storage,
                           request_context_getter,
                           quota_manager_proxy,
                           blob_context,
-                          0 /* cache_size */),
+                          0 /* cache_size */,
+                          0 /* cache_padding */,
+                          CreateTestPaddingKey()),
         delay_backend_creation_(false) {}
 
   void CreateBackend(ErrorCallback callback) override {
     backend_creation_callback_ = std::move(callback);
     if (delay_backend_creation_)
       return;
     ContinueCreateBackend();
   }
 
   void ContinueCreateBackend() {
@@ skipping 1283 matching lines @@
   EXPECT_TRUE(Delete(no_body_request_));
   EXPECT_EQ(0, Size());
 
   EXPECT_TRUE(Put(body_request_, body_response_));
   EXPECT_LT(no_body_size, Size());
 
   EXPECT_TRUE(Delete(body_request_));
   EXPECT_EQ(0, Size());
 }
 
+TEST_F(CacheStorageCacheTest, VerifyOpaqueSizePadding) {
+  base::Time response_time(base::Time::Now());
+
+  ServiceWorkerFetchRequest non_opaque_request(body_request_);
+  non_opaque_request.url = GURL("http://example.com/no-pad.html");
+  ServiceWorkerResponse non_opaque_response(body_response_);
+  non_opaque_response.response_time = response_time;
+  EXPECT_EQ(0, CacheStorageCache::CalculateResponsePadding(
+                   non_opaque_response, CreateTestPaddingKey().get(),
+                   0 /* side_data_size */));
+  EXPECT_TRUE(Put(non_opaque_request, non_opaque_response));
+  int64_t unpadded_no_data_cache_size = Size();
+
+  // Now write some side data to that cache.
+  const std::string expected_side_data = "TheSideData";
+  scoped_refptr<net::IOBuffer> side_data_buffer(
+      new net::StringIOBuffer(expected_side_data));
+  EXPECT_TRUE(WriteSideData(non_opaque_request.url, response_time,
+                            side_data_buffer, expected_side_data.length()));
+  int64_t unpadded_total_resource_size = Size();
+  int64_t unpadded_side_data_size =
+      unpadded_total_resource_size - unpadded_no_data_cache_size;
+  EXPECT_EQ(expected_side_data.size(),
+            static_cast<size_t>(unpadded_side_data_size));
+  EXPECT_EQ(0, CacheStorageCache::CalculateResponsePadding(
+                   non_opaque_response, CreateTestPaddingKey().get(),
+                   unpadded_side_data_size));
+
+  // Now write an identically sized opaque response.
+  ServiceWorkerFetchRequest opaque_request(non_opaque_request);
+  opaque_request.url = GURL("http://example.com/opaque.html");
+  // Same URL length means same cache sizes (ignoring padding).
+  EXPECT_EQ(opaque_request.url.spec().length(),
+            non_opaque_request.url.spec().length());
+  ServiceWorkerResponse opaque_response(non_opaque_response);
+  opaque_response.response_type = blink::mojom::FetchResponseType::kOpaque;
+  opaque_response.response_time = response_time;
+
+  EXPECT_TRUE(Put(opaque_request, opaque_response));
+  // This test is fragile. Right now it deterministically adds non-zero padding.
+  // But if the url, padding key, or padding algorithm change it might become
+  // zero.
+  int64_t size_after_opaque_put = Size();
+  int64_t opaque_padding = size_after_opaque_put -
+                           2 * unpadded_no_data_cache_size -
+                           unpadded_side_data_size;
+  EXPECT_GT(opaque_padding, 0);

[jkarlin, 2017/07/31 14:03:24]

Let's make this an ASSERT

[cmumford, 2017/08/10 16:37:11]

Done.

+
+  // Now write side data and expect to see the padding change.
+  EXPECT_TRUE(WriteSideData(opaque_request.url, response_time, side_data_buffer,
+                            expected_side_data.length()));
+  int64_t current_padding = Size() - 2 * unpadded_total_resource_size;
+  EXPECT_NE(current_padding, opaque_padding);

[jkarlin, 2017/07/31 14:03:24]

swap the argument order to the EXPECT

[cmumford, 2017/08/10 16:37:11]

Done.

+
+  // Now reset opaque side data back to zero.
+  const std::string expected_side_data2 = "";
+  scoped_refptr<net::IOBuffer> buffer2(
+      new net::StringIOBuffer(expected_side_data2));
+  EXPECT_TRUE(WriteSideData(opaque_request.url, response_time, buffer2,
+                            expected_side_data2.length()));
+  EXPECT_EQ(size_after_opaque_put, Size());
+
+  // And delete the opaque response entirely.
+  EXPECT_TRUE(Delete(opaque_request));
+  EXPECT_EQ(unpadded_total_resource_size, Size());
+}
+
+TEST_F(CacheStorageCacheTest, TestDifferentOpaqueSideDataSizes) {
+  ServiceWorkerFetchRequest request(body_request_);
+
+  ServiceWorkerResponse response(body_response_);
+  response.response_type = blink::mojom::FetchResponseType::kOpaque;
+  base::Time response_time(base::Time::Now());
+  response.response_time = response_time;
+  EXPECT_TRUE(Put(request, response));
+  int64_t opaque_cache_size_no_side_data = Size();
+
+  const std::string small_side_data = "SmallSideData";
+  scoped_refptr<net::IOBuffer> buffer1(
+      new net::StringIOBuffer(small_side_data));
+  EXPECT_TRUE(WriteSideData(request.url, response_time, buffer1,
+                            small_side_data.length()));
+  int64_t opaque_cache_size_with_side_data = Size();
+  EXPECT_NE(opaque_cache_size_with_side_data, opaque_cache_size_no_side_data);
+
+  // Write side data of a different size. The size should not affect the padding
+  // at all.
+  const std::string large_side_data = "LargerSideDataString";
+  EXPECT_NE(large_side_data.length(), small_side_data.length());
+  scoped_refptr<net::IOBuffer> buffer2(
+      new net::StringIOBuffer(large_side_data));
+  EXPECT_TRUE(WriteSideData(request.url, response_time, buffer2,
+                            large_side_data.length()));
+  int side_data_delta = large_side_data.length() - small_side_data.length();
+  EXPECT_EQ(opaque_cache_size_with_side_data + side_data_delta, Size());
+}
+
+TEST_F(CacheStorageCacheTest, TestDoubleOpaquePut) {
+  ServiceWorkerFetchRequest request(body_request_);
+
+  base::Time response_time(base::Time::Now());
+
+  ServiceWorkerResponse response(body_response_);
+  response.response_type = blink::mojom::FetchResponseType::kOpaque;
+  response.response_time = response_time;
+  EXPECT_TRUE(Put(request, response));
+  int64_t size_after_first_put = Size();
+
+  ServiceWorkerFetchRequest request2(body_request_);
+  ServiceWorkerResponse response2(body_response_);
+  response2.response_type = blink::mojom::FetchResponseType::kOpaque;
+  response2.response_time = response_time;
+  EXPECT_TRUE(Put(request2, response2));
+
+  EXPECT_EQ(size_after_first_put, Size());
+}
+
 TEST_P(CacheStorageCacheTestP, GetSizeThenClose) {
   EXPECT_TRUE(Put(body_request_, body_response_));
   int64_t cache_size = Size();
   EXPECT_EQ(cache_size, GetSizeThenClose());
   VerifyAllOpsFail();
 }
 
 TEST_P(CacheStorageCacheTestP, OpsFailOnClosedBackend) {
   // Create the backend and put something in it.
   EXPECT_TRUE(Put(body_request_, body_response_));
   EXPECT_TRUE(Close());
   VerifyAllOpsFail();
 }
 
 TEST_P(CacheStorageCacheTestP, VerifySerialScheduling) {
   // Start two operations, the first one is delayed but the second isn't. The
   // second should wait for the first.
   EXPECT_TRUE(Keys());  // Opens the backend.
   DelayableBackend* delayable_backend = cache_->UseDelayableBackend();
-  delayable_backend->set_delay_doom(true);
+  delayable_backend->set_delay_open_entry(true);
 
   int sequence_out = -1;
 
   CacheStorageBatchOperation operation1;
   operation1.operation_type = CACHE_STORAGE_CACHE_OPERATION_TYPE_PUT;
   operation1.request = body_request_;
   operation1.response = body_response_;
 
   std::unique_ptr<base::RunLoop> close_loop1(new base::RunLoop());
   cache_->BatchOperation(
       std::vector<CacheStorageBatchOperation>(1, operation1),
       base::BindOnce(&CacheStorageCacheTest::SequenceCallback,
                      base::Unretained(this), 1, &sequence_out,
                      close_loop1.get()));
 
   // Blocks on creating the cache entry.
   base::RunLoop().RunUntilIdle();
 
   CacheStorageBatchOperation operation2;
   operation2.operation_type = CACHE_STORAGE_CACHE_OPERATION_TYPE_PUT;
   operation2.request = body_request_;
   operation2.response = body_response_;
 
-  delayable_backend->set_delay_doom(false);
+  delayable_backend->set_delay_open_entry(false);
   std::unique_ptr<base::RunLoop> close_loop2(new base::RunLoop());
   cache_->BatchOperation(
       std::vector<CacheStorageBatchOperation>(1, operation2),
       base::BindOnce(&CacheStorageCacheTest::SequenceCallback,
                      base::Unretained(this), 2, &sequence_out,
                      close_loop2.get()));
 
   // The second put operation should wait for the first to complete.
   base::RunLoop().RunUntilIdle();
   EXPECT_FALSE(callback_response_);
 
-  delayable_backend->DoomEntryContinue();
+  EXPECT_TRUE(delayable_backend->OpenEntryContinue());
   close_loop1->Run();
   EXPECT_EQ(1, sequence_out);
   close_loop2->Run();
   EXPECT_EQ(2, sequence_out);
 }
 
 INSTANTIATE_TEST_CASE_P(CacheStorageCacheTest,
                         CacheStorageCacheTestP,
                         ::testing::Values(false, true));
 
 }  // namespace content