[Storage] Cache storage inspection on all the frames!

Source/modules/cachestorage/InspectorCacheStorageAgent.cpp

 // 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 "config.h"
 #include "modules/cachestorage/InspectorCacheStorageAgent.h"
 
 #include "core/InspectorBackendDispatcher.h"
 #include "core/InspectorTypeBuilder.h"
-#include "modules/serviceworkers/ServiceWorkerGlobalScope.h"
 #include "platform/JSONValues.h"
 #include "platform/heap/Handle.h"
 #include "platform/weborigin/DatabaseIdentifier.h"
+#include "platform/weborigin/SecurityOrigin.h"
 #include "public/platform/Platform.h"
 #include "public/platform/WebServiceWorkerCache.h"
 #include "public/platform/WebServiceWorkerCacheError.h"
 #include "public/platform/WebServiceWorkerCacheStorage.h"
 #include "public/platform/WebServiceWorkerRequest.h"
 #include "public/platform/WebServiceWorkerResponse.h"
 #include "public/platform/WebString.h"
 #include "public/platform/WebURL.h"
 #include "public/platform/WebVector.h"
 #include "wtf/Noncopyable.h"
 #include "wtf/OwnPtr.h"
 #include "wtf/PassRefPtr.h"
 #include "wtf/RefCounted.h"
 #include "wtf/RefPtr.h"
 #include "wtf/Vector.h"
 #include "wtf/text/StringBuilder.h"
 
 #include <algorithm>
 
 using blink::TypeBuilder::Array;
-using blink::TypeBuilder::ServiceWorkerCache::DataEntry;
+using blink::TypeBuilder::CacheStorage::Cache;
+using blink::TypeBuilder::CacheStorage::DataEntry;
 
-typedef blink::InspectorBackendDispatcher::ServiceWorkerCacheCommandHandler::DeleteCacheCallback DeleteCacheCallback;
-typedef blink::InspectorBackendDispatcher::ServiceWorkerCacheCommandHandler::RequestCacheNamesCallback RequestCacheNamesCallback;
-typedef blink::InspectorBackendDispatcher::ServiceWorkerCacheCommandHandler::RequestEntriesCallback RequestEntriesCallback;
+typedef blink::InspectorBackendDispatcher::CacheStorageCommandHandler::DeleteCacheCallback DeleteCacheCallback;
+typedef blink::InspectorBackendDispatcher::CacheStorageCommandHandler::RequestCacheNamesCallback RequestCacheNamesCallback;
+typedef blink::InspectorBackendDispatcher::CacheStorageCommandHandler::RequestEntriesCallback RequestEntriesCallback;
 typedef blink::InspectorBackendDispatcher::CallbackBase RequestCallback;
 
 namespace blink {
 
 namespace {
 
-PassOwnPtr<WebServiceWorkerCacheStorage> assertCacheStorage(ErrorString* errorString, ServiceWorkerGlobalScope* globalScope)
+String composeCacheId(const String& securityOrigin, const String& cacheName)

[pfeldman, 2015/04/20 18:14:31]

super nit: we typically use build* and parse*, but that's fine.

[dmurph, 2015/04/20 20:58:17]

Done.

 {
-    String identifier = createDatabaseIdentifierFromSecurityOrigin(globalScope->securityOrigin());
-    OwnPtr<WebServiceWorkerCacheStorage> caches = adoptPtr(Platform::current()->cacheStorage(identifier));
-    if (!caches) {
-        *errorString = "Cache Storage not available in global scope.";
-        return nullptr;
+    String id(securityOrigin);
+    id.append("|");
+    id.append(cacheName);
+    return id;
+}
+
+bool decomposeCacheId(ErrorString* errorString, const String& id, String* securityOrigin, String* cacheName)
+{
+    size_t pipe = id.find('|');
+    if (pipe == WTF::kNotFound) {
+        *errorString = "Cannot find the | character to decompose the cache id";

[pfeldman, 2015/04/20 18:14:31]

nit: you can just say that this was a poor id, no need to expose the fact that
we concatenate strings.

[dmurph, 2015/04/20 20:58:17]

Done.

+        return false;
     }
-    return caches.release();
+    *securityOrigin = id.substring(0, pipe);
+    *cacheName = id.substring(pipe + 1);
+    return true;
+}
+
+PassOwnPtr<WebServiceWorkerCacheStorage> assertCacheStorage(ErrorString* errorString, const String& securityOrigin)
+{
+    RefPtr<SecurityOrigin> secOrigin = SecurityOrigin::createFromString(securityOrigin);
+    String identifier = createDatabaseIdentifierFromSecurityOrigin(secOrigin.get());
+    WebServiceWorkerCacheStorage* cache = Platform::current()->cacheStorage(identifier);

[pfeldman, 2015/04/20 18:14:31]

Adopt right away, you'll still be able to check for nullptr the same way below.

[dmurph, 2015/04/20 20:58:17]

Done.

+    if (!cache)
+        *errorString = "Could not find cache storage.";
+    return adoptPtr(cache);
 }
 
 CString serviceWorkerCacheErrorString(WebServiceWorkerCacheError* error)
 {
     switch (*error) {
     case WebServiceWorkerCacheErrorNotImplemented:
         return CString("not implemented.");
         break;
     case WebServiceWorkerCacheErrorNotFound:
         return CString("not found.");
         break;
     case WebServiceWorkerCacheErrorExists:
         return CString("cache already exists.");
         break;
     default:
         return CString("unknown error.");
         break;
     }
 }
 
 class RequestCacheNames
     : public WebServiceWorkerCacheStorage::CacheStorageKeysCallbacks {
     WTF_MAKE_NONCOPYABLE(RequestCacheNames);
 
 public:
-    RequestCacheNames(PassRefPtrWillBeRawPtr<RequestCacheNamesCallback> callback)
-        : m_callback(callback)
+    RequestCacheNames(const String& securityOrigin, PassRefPtrWillBeRawPtr<RequestCacheNamesCallback> callback)
+        : m_securityOrigin(securityOrigin)
+        , m_callback(callback)
     {
     }
 
     virtual ~RequestCacheNames() { }
 
     void onSuccess(WebVector<WebString>* caches)
     {
-        RefPtr<TypeBuilder::Array<String>> array = TypeBuilder::Array<String>::create();
+        RefPtr<Array<Cache>> array = Array<Cache>::create();
         for (size_t i = 0; i < caches->size(); i++) {
-            array->addItem(String((*caches)[i]));
+            String name = String((*caches)[i]);
+            RefPtr<Cache> entry = Cache::create()
+                .setSecurityOrigin(m_securityOrigin)
+                .setCacheName(name)
+                .setCacheId(composeCacheId(m_securityOrigin, name));
+            array->addItem(entry);
         }
         m_callback->sendSuccess(array);
     }
 
     void onError(WebServiceWorkerCacheError* error)
     {
         m_callback->sendFailure(String::format("Error requesting cache names: %s", serviceWorkerCacheErrorString(error).data()));
     }
 
 private:
+    String m_securityOrigin;
     RefPtrWillBePersistent<RequestCacheNamesCallback> m_callback;
 };
 
 struct DataRequestParams {
     String cacheName;
     int skipCount;
     int pageSize;
 };
 
 struct RequestResponse {
@@ skipping 34 matching lines @@
             {
                 return WTF::codePointCompareLessThan(a.request, b.request);
             });
         if (m_params.skipCount > 0)
             m_responses.remove(0, m_params.skipCount);
         bool hasMore = false;
         if (static_cast<size_t>(m_params.pageSize) < m_responses.size()) {
             m_responses.remove(m_params.pageSize, m_responses.size() - m_params.pageSize);
             hasMore = true;
         }
-        RefPtr<TypeBuilder::Array<DataEntry>> array = TypeBuilder::Array<DataEntry>::create();
+        RefPtr<Array<DataEntry>> array = Array<DataEntry>::create();
         for (const auto& requestResponse : m_responses) {
             RefPtr<DataEntry> entry = DataEntry::create()
                 .setRequest(JSONString::create(requestResponse.request)->toJSONString())
                 .setResponse(JSONString::create(requestResponse.response)->toJSONString());
             array->addItem(entry);
         }
         m_callback->sendSuccess(array, hasMore);
     }
 
 private:
@@ skipping 42 matching lines @@
     GetCacheKeysForRequestData(const DataRequestParams& params, PassOwnPtr<WebServiceWorkerCache> cache, PassRefPtrWillBeRawPtr<RequestEntriesCallback> callback)
         : m_params(params)
         , m_cache(cache)
         , m_callback(callback)
     {
     }
     virtual ~GetCacheKeysForRequestData() { }
 
     void onSuccess(WebVector<WebServiceWorkerRequest>* requests)
     {
+        if (requests->isEmpty()) {
+            RefPtr<Array<DataEntry>> array = Array<DataEntry>::create();
+            m_callback->sendSuccess(array, false);
+            return;
+        }
         RefPtr<ResponsesAccumulator> accumulator = adoptRef(new ResponsesAccumulator(requests->size(), m_params, m_callback));
 
         for (size_t i = 0; i < requests->size(); i++) {
             const auto& request = (*requests)[i];
             auto* cacheRequest = new GetCacheResponsesForRequestData(m_params, request, accumulator, m_callback);
             m_cache->dispatchMatch(cacheRequest, request, WebServiceWorkerCache::QueryParams());
         }
     }
 
     void onError(WebServiceWorkerCacheError* error)
@@ skipping 54 matching lines @@
     {
         m_callback->sendFailure(String::format("Error requesting cache names: %s", serviceWorkerCacheErrorString(error).data()));
     }
 
 private:
     RefPtrWillBePersistent<DeleteCacheCallback> m_callback;
 };
 
 } // namespace
 
-InspectorCacheStorageAgent::InspectorCacheStorageAgent(ServiceWorkerGlobalScope* scope)
-    : InspectorBaseAgent<blink::InspectorCacheStorageAgent, InspectorFrontend::ServiceWorkerCache>("ServiceWorkerCache")
-    , m_globalScope(scope)
+InspectorCacheStorageAgent::InspectorCacheStorageAgent()
+    : InspectorBaseAgent<InspectorCacheStorageAgent, InspectorFrontend::CacheStorage>("CacheStorage")
 {
 }
 
 InspectorCacheStorageAgent::~InspectorCacheStorageAgent() { }
 
 DEFINE_TRACE(InspectorCacheStorageAgent)
 {
     InspectorBaseAgent::trace(visitor);
 }
 
-void InspectorCacheStorageAgent::requestCacheNames(ErrorString* errorString, PassRefPtrWillBeRawPtr<RequestCacheNamesCallback> callback)
+void InspectorCacheStorageAgent::requestCacheNames(ErrorString* errorString, const String& securityOrigin, PassRefPtrWillBeRawPtr<RequestCacheNamesCallback> callback)
 {
-    OwnPtr<WebServiceWorkerCacheStorage> cache = assertCacheStorage(errorString, m_globalScope);
+    OwnPtr<WebServiceWorkerCacheStorage> cache = assertCacheStorage(errorString, securityOrigin);
     if (!cache) {
         callback->sendFailure(*errorString);
         return;
     }
-    cache->dispatchKeys(new RequestCacheNames(callback));
+    cache->dispatchKeys(new RequestCacheNames(securityOrigin, callback));
 }
 
-
-void InspectorCacheStorageAgent::requestEntries(ErrorString* errorString, const String& cacheName, int skipCount, int pageSize, PassRefPtrWillBeRawPtr<RequestEntriesCallback> callback)
+void InspectorCacheStorageAgent::requestEntries(ErrorString* errorString, const String& cacheId, int skipCount, int pageSize, PassRefPtrWillBeRawPtr<RequestEntriesCallback> callback)
 {
-    OwnPtr<WebServiceWorkerCacheStorage> cache = assertCacheStorage(errorString, m_globalScope);
+    String securityOrigin, cacheName;

[pfeldman, 2015/04/20 18:14:31]

Declaration per line, please!

[dmurph, 2015/04/20 20:58:17]

Done.

+    if (!decomposeCacheId(errorString, cacheId, &securityOrigin, &cacheName)) {
+        callback->sendFailure(*errorString);
+        return;
+    }
+    OwnPtr<WebServiceWorkerCacheStorage> cache = assertCacheStorage(errorString, securityOrigin);

[pfeldman, 2015/04/20 18:14:31]

Extract assertCacheStorageForId(errorString, cacheId) ?

[dmurph, 2015/04/20 20:58:17]

Done.

     if (!cache) {
         callback->sendFailure(*errorString);
         return;
     }
     DataRequestParams params;
     params.cacheName = cacheName;
     params.pageSize = pageSize;
     params.skipCount = skipCount;
     cache->dispatchOpen(new GetCacheForRequestData(params, callback), WebString(cacheName));
 }
 
-void InspectorCacheStorageAgent::deleteCache(ErrorString* errorString, const String& cacheName, PassRefPtrWillBeRawPtr<DeleteCacheCallback> callback)
+void InspectorCacheStorageAgent::deleteCache(ErrorString* errorString, const String& cacheId, PassRefPtrWillBeRawPtr<DeleteCacheCallback> callback)
 {
-    OwnPtr<WebServiceWorkerCacheStorage> cache = assertCacheStorage(errorString, m_globalScope);
+    String securityOrigin, cacheName;
+    if (!decomposeCacheId(errorString, cacheId, &securityOrigin, &cacheName)) {
+        callback->sendFailure(*errorString);
+        return;
+    }
+    OwnPtr<WebServiceWorkerCacheStorage> cache = assertCacheStorage(errorString, securityOrigin);
     if (!cache) {
         callback->sendFailure(*errorString);
         return;
     }
     cache->dispatchDelete(new DeleteCache(callback), WebString(cacheName));
 }
 
 } // namespace blink