Introducing the WebServiceWorkerCache.

Source/modules/serviceworkers/Cache.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/serviceworkers/Cache.h"
 
+#include "bindings/core/v8/Dictionary.h"
 #include "bindings/core/v8/ScriptPromiseResolver.h"
 #include "bindings/core/v8/ScriptState.h"
+#include "bindings/core/v8/V8ThrowException.h"
+#include "core/dom/DOMException.h"
+#include "modules/serviceworkers/Request.h"
+#include "modules/serviceworkers/Response.h"
+#include "public/platform/WebServiceWorkerCache.h"
 
 namespace blink {
 
 namespace {
 
+WebServiceWorkerCache::QueryParams queryParamsFromDictionary(const Dictionary& dictionary)

[jsbell, 2014/09/18 21:45:00]

We can now use real Dictionary subclasses in modules but let's save that for a
follow-up CL and get this in!

+{
+    WebServiceWorkerCache::QueryParams queryParams;
+    DictionaryHelper::get(dictionary, "ignoreSearch", queryParams.ignoreSearch);
+    DictionaryHelper::get(dictionary, "ignoreMethod", queryParams.ignoreMethod);
+    DictionaryHelper::get(dictionary, "ignoreVary", queryParams.ignoreVary);
+    DictionaryHelper::get(dictionary, "prefixMatch", queryParams.prefixMatch);
+    {
+        String cacheName;
+        DictionaryHelper::get(dictionary, "cacheName", cacheName);
+        queryParams.cacheName = cacheName;
+    }
+    return queryParams;
+}
+
+class CacheMatchCallbacks : public WebServiceWorkerCache::CacheMatchCallbacks {

[jsbell, 2014/09/18 21:45:00]

As noted in a FIXME over in CacheStorage.cpp we should consider using
CallbackPromiseAdapter here and making this template-driven. But it's very
readable as-is and we can do a bulk-conversion later if we decide it's an
improvement.

+    WTF_MAKE_NONCOPYABLE(CacheMatchCallbacks);
+public:
+    CacheMatchCallbacks(PassRefPtr<ScriptPromiseResolver> resolver)
+        : m_resolver(resolver) { }
+
+    virtual void onSuccess(WebServiceWorkerResponse* webResponse) OVERRIDE
+    {
+        m_resolver->resolve(Response::create(m_resolver->scriptState()->executionContext(), *webResponse));
+        m_resolver.clear();
+    }
+
+    virtual void onError(WebServiceWorkerCacheError* reason) OVERRIDE
+    {
+        m_resolver->reject(Cache::domExceptionForCacheError(*reason));
+        m_resolver.clear();
+    }
+
+private:
+    RefPtr<ScriptPromiseResolver> m_resolver;
+};
+
+class CacheWithResponsesCallbacks : public WebServiceWorkerCache::CacheWithResponsesCallbacks {
+    WTF_MAKE_NONCOPYABLE(CacheWithResponsesCallbacks);
+public:
+    CacheWithResponsesCallbacks(PassRefPtr<ScriptPromiseResolver> resolver)
+        : m_resolver(resolver) { }
+
+    virtual void onSuccess(WebVector<WebServiceWorkerResponse>* webResponses) OVERRIDE
+    {
+        Vector<Response*> responses;
+        for (size_t i = 0; i < webResponses->size(); ++i)
+            responses.append(Response::create(m_resolver->scriptState()->executionContext(), (*webResponses)[i]));
+        m_resolver->resolve(responses);
+        m_resolver.clear();
+    }
+
+    virtual void onError(WebServiceWorkerCacheError* reason) OVERRIDE
+    {
+        m_resolver->reject(Cache::domExceptionForCacheError(*reason));
+        m_resolver.clear();
+    }
+
+private:
+    RefPtr<ScriptPromiseResolver> m_resolver;
+};
+
+class CacheWithRequestsCallbacks : public WebServiceWorkerCache::CacheWithRequestsCallbacks {
+    WTF_MAKE_NONCOPYABLE(CacheWithRequestsCallbacks);
+public:
+    CacheWithRequestsCallbacks(PassRefPtr<ScriptPromiseResolver> resolver)
+        : m_resolver(resolver) { }
+
+    virtual void onSuccess(WebVector<WebServiceWorkerRequest>* webRequests) OVERRIDE
+    {
+        Vector<Request*> requests;

[tkent, 2014/09/18 23:35:55]

This should be HeapVector<Member<Request>>. 

[gavinp, 2014/09/22 16:05:24]

Done. What about Vector<Response*> above?

[jsbell, 2014/09/22 16:42:50]

Might as well be consistent. :)

Oilpan protects objects referenced by pointers on the stack (so a local Foo* is
safe and doesn't need to be Member<Foo>), but since the Vector's contents are on
the heap they would not be protected.

That said... the Vector<Foo*> here is passed directly into a function
(ScriptPromiseResolver::resolve) which will wrap the objects before handing them
to script, and those wrappers should have Member<> refs. So Oilpan GC should
never get a chance to run before the vector's contents end up held safely.

So using HeapVector<Member<>> shouldn't hurt, but I'm not sure it's necessary
here. tkent@ - am I misunderstanding?

[jsbell, 2014/09/22 16:45:34]

And http://www.chromium.org/blink/blink-gc requires using HeapVector<Member<>>
anyway. So yes, you should convert them all.

[tkent, 2014/09/23 23:56:25]

Right.  We should use HeapVector<Member<Response>> too.

+        for (size_t i = 0; i < webRequests->size(); ++i)
+            requests.append(Request::create(m_resolver->scriptState()->executionContext(), (*webRequests)[i]));
+        m_resolver->resolve(requests);
+        m_resolver.clear();
+    }
+
+    virtual void onError(WebServiceWorkerCacheError* reason) OVERRIDE
+    {
+        m_resolver->reject(Cache::domExceptionForCacheError(*reason));
+        m_resolver.clear();
+    }
+
+private:
+    RefPtr<ScriptPromiseResolver> m_resolver;
+};
+
+ScriptPromise rejectForCacheError(ScriptState* scriptState, WebServiceWorkerCacheError error)
+{
+    return ScriptPromise::rejectWithDOMException(scriptState, Cache::domExceptionForCacheError(error));
+}
+
 ScriptPromise rejectAsNotImplemented(ScriptState* scriptState)
 {
+    return ScriptPromise::rejectWithDOMException(scriptState, DOMException::create(NotSupportedError, "Cache is not implemented"));
+}
+
+} // namespace
+
+Cache* Cache::fromWebServiceWorkerCache(WebServiceWorkerCache* webCache)
+{
+    if (Cache* cache = static_cast<Cache*>(webCache->proxyInterface()))
+        return cache;
+    return new Cache(webCache);
+}
+
+ScriptPromise Cache::match(ScriptState* scriptState, Request* originalRequest, const Dictionary& queryParamsDict)
+{
+    TrackExceptionState exceptionState;
+    Request* request = Request::create(scriptState->executionContext(), originalRequest, exceptionState);
+    if (exceptionState.hadException()) {
+        // FIXME: We should throw the caught error.
+        return rejectForCacheError(scriptState, WebServiceWorkerCacheErrorNotFound);
+    }
+    return matchImpl(scriptState, request, queryParamsDict);
+}
+
+ScriptPromise Cache::match(ScriptState* scriptState, const String& requestString, const Dictionary& queryParamsDict)
+{
+    TrackExceptionState exceptionState;
+    Request* request = Request::create(scriptState->executionContext(), requestString, exceptionState);
+    if (exceptionState.hadException()) {
+        // FIXME: We should throw the caught error.
+        return rejectForCacheError(scriptState, WebServiceWorkerCacheErrorNotFound);
+    }
+    return matchImpl(scriptState, request, queryParamsDict);
+}
+
+ScriptPromise Cache::matchAll(ScriptState* scriptState, Request* originalRequest, const Dictionary& queryParamsDict)
+{
+    TrackExceptionState exceptionState;
+    Request* request = Request::create(scriptState->executionContext(), originalRequest, exceptionState);
+    if (exceptionState.hadException()) {
+        // FIXME: We should throw the caught error.
+        return rejectForCacheError(scriptState, WebServiceWorkerCacheErrorNotFound);
+    }
+    return matchAllImpl(scriptState, request, queryParamsDict);
+}
+
+ScriptPromise Cache::matchAll(ScriptState* scriptState, const String& requestString, const Dictionary& queryParamsDict)
+{
+    TrackExceptionState exceptionState;
+    Request* request = Request::create(scriptState->executionContext(), requestString, exceptionState);
+    if (exceptionState.hadException()) {
+        // FIXME: We should throw the caught error.
+        return rejectForCacheError(scriptState, WebServiceWorkerCacheErrorNotFound);
+    }
+    return matchAllImpl(scriptState, request, queryParamsDict);
+}
+
+ScriptPromise Cache::add(ScriptState* scriptState, Request* originalRequest)
+{
+    TrackExceptionState exceptionState;
+    Request* request = Request::create(scriptState->executionContext(), originalRequest, exceptionState);
+    if (exceptionState.hadException()) {
+        // FIXME: We should throw the caught error.
+        return rejectForCacheError(scriptState, WebServiceWorkerCacheErrorNotFound);
+    }
+    return addImpl(scriptState, request);
+}
+
+ScriptPromise Cache::add(ScriptState* scriptState, const String& requestString)
+{
+    TrackExceptionState exceptionState;
+    Request* request = Request::create(scriptState->executionContext(), requestString, exceptionState);
+    if (exceptionState.hadException()) {
+        // FIXME: We should throw the caught error.
+        return rejectForCacheError(scriptState, WebServiceWorkerCacheErrorNotFound);
+    }
+    return addImpl(scriptState, request);
+}
+
+ScriptPromise Cache::addAll(ScriptState* scriptState, const Vector<ScriptValue>& rawRequests)
+{
+    // FIXME: Implement this.
+    return rejectAsNotImplemented(scriptState);
+}
+
+ScriptPromise Cache::deleteFunction(ScriptState* scriptState, Request* originalRequest, const Dictionary& queryParamsDict)
+{
+    TrackExceptionState exceptionState;
+    Request* request = Request::create(scriptState->executionContext(), originalRequest, exceptionState);
+    if (exceptionState.hadException()) {
+        // FIXME: We should throw the caught error.
+        return rejectForCacheError(scriptState, WebServiceWorkerCacheErrorNotFound);
+    }
+    return deleteImpl(scriptState, request, queryParamsDict);
+}
+
+ScriptPromise Cache::deleteFunction(ScriptState* scriptState, const String& requestString, const Dictionary& queryParamsDict)
+{
+    TrackExceptionState exceptionState;
+    Request* request = Request::create(scriptState->executionContext(), requestString, exceptionState);
+    if (exceptionState.hadException()) {
+        // FIXME: We should throw the caught error.
+        return rejectForCacheError(scriptState, WebServiceWorkerCacheErrorNotFound);
+    }
+    return deleteImpl(scriptState, request, queryParamsDict);
+}
+
+ScriptPromise Cache::put(ScriptState* scriptState, Request* originalRequest, const Response* response)
+{
+    TrackExceptionState exceptionState;
+    Request* request = Request::create(scriptState->executionContext(), originalRequest, exceptionState);
+    if (exceptionState.hadException()) {
+        // FIXME: We should throw the caught error.
+        return rejectForCacheError(scriptState, WebServiceWorkerCacheErrorNotFound);
+    }
+    return putImpl(scriptState, request, response);
+}
+
+ScriptPromise Cache::put(ScriptState* scriptState, const String& requestString, const Response* response)
+{
+    TrackExceptionState exceptionState;
+    Request* request = Request::create(scriptState->executionContext(), requestString, exceptionState);
+    if (exceptionState.hadException()) {
+        // FIXME: We should throw the caught error.
+        return rejectForCacheError(scriptState, WebServiceWorkerCacheErrorNotFound);
+    }
+    return putImpl(scriptState, request, response);
+}
+
+ScriptPromise Cache::keys(ScriptState* scriptState)
+{
+    return keysImpl(scriptState);
+}
+
+ScriptPromise Cache::keys(ScriptState* scriptState, Request* originalRequest, const Dictionary& queryParamsDict)
+{
+    TrackExceptionState exceptionState;
+    Request* request = Request::create(scriptState->executionContext(), originalRequest, exceptionState);
+    if (exceptionState.hadException()) {
+        // FIXME: We should throw the caught error.
+        return rejectForCacheError(scriptState, WebServiceWorkerCacheErrorNotFound);
+    }
+    return keysImpl(scriptState, request, queryParamsDict);
+}
+
+ScriptPromise Cache::keys(ScriptState* scriptState, const String& requestString, const Dictionary& queryParamsDict)
+{
+    TrackExceptionState exceptionState;
+    Request* request = Request::create(scriptState->executionContext(), requestString, exceptionState);
+    if (exceptionState.hadException()) {
+        // FIXME: We should throw the caught error.
+        return rejectForCacheError(scriptState, WebServiceWorkerCacheErrorNotFound);
+    }
+    return keysImpl(scriptState, request, queryParamsDict);
+}
+
+Cache::Cache(WebServiceWorkerCache* webCache)
+    : m_webCache(adoptPtr(webCache))
+{
+    ASSERT(!m_webCache->proxyInterface());
+    m_webCache->setProxyInterface(this);
+}
+
+Cache* Cache::create(WebServiceWorkerCache* webCache)
+{
+    return new Cache(webCache);
+}
+
+ScriptPromise Cache::matchImpl(ScriptState* scriptState, Request* request, const Dictionary& queryParamsDict)
+{
+    WebServiceWorkerRequest webRequest;
+    request->populateWebServiceWorkerRequest(webRequest);
+
     RefPtr<ScriptPromiseResolver> resolver = ScriptPromiseResolver::create(scriptState);
     const ScriptPromise promise = resolver->promise();
-    resolver->reject(DOMException::create(NotSupportedError, "Cache is not implemented"));
+    m_webCache->dispatchMatch(new CacheMatchCallbacks(resolver), webRequest, queryParamsFromDictionary(queryParamsDict));
     return promise;
 }
 
-}
-
-Cache* Cache::fromWebServiceWorkerCache(WebServiceWorkerCache* webCache)
-{
-    return new Cache(webCache);
-}
-
-// FIXME: Implement these methods.
-ScriptPromise Cache::match(ScriptState* scriptState, Request* request, const Dictionary& queryParams)
-{
+ScriptPromise Cache::matchAllImpl(ScriptState* scriptState, Request* request, const Dictionary& queryParamsDict)
+{
+    WebServiceWorkerRequest webRequest;
+    request->populateWebServiceWorkerRequest(webRequest);
+
+    RefPtr<ScriptPromiseResolver> resolver = ScriptPromiseResolver::create(scriptState);
+    const ScriptPromise promise = resolver->promise();
+    m_webCache->dispatchMatchAll(new CacheWithResponsesCallbacks(resolver), webRequest, queryParamsFromDictionary(queryParamsDict));
+    return promise;
+}
+
+ScriptPromise Cache::addImpl(ScriptState* scriptState, Request*)
+{
+    // FIXME: Implement this.
     return rejectAsNotImplemented(scriptState);
 }
 
-ScriptPromise Cache::match(ScriptState* scriptState, const String& requestString, const Dictionary& queryParams)
-{
+ScriptPromise Cache::addAllImpl(ScriptState* scriptState, Vector<Request*>)
+{
+    // FIXME: Implement this.
     return rejectAsNotImplemented(scriptState);
 }
 
-ScriptPromise Cache::matchAll(ScriptState* scriptState, Request* request, const Dictionary& queryParams)
-{
-    return rejectAsNotImplemented(scriptState);
-}
-
-ScriptPromise Cache::matchAll(ScriptState* scriptState, const String& requestString, const Dictionary& queryParams)
-{
-    return rejectAsNotImplemented(scriptState);
-}
-
-ScriptPromise Cache::add(ScriptState* scriptState, Request* request)
-{
-    return rejectAsNotImplemented(scriptState);
-}
-
-ScriptPromise Cache::add(ScriptState* scriptState, const String& requestString)
-{
-    return rejectAsNotImplemented(scriptState);
-}
-
-ScriptPromise Cache::addAll(ScriptState* scriptState, const Vector<ScriptValue>& rawRequests)
-{
-    return rejectAsNotImplemented(scriptState);
-}
-
-ScriptPromise Cache::deleteFunction(ScriptState* scriptState, Request* request, const Dictionary& queryParams)
-{
-    return rejectAsNotImplemented(scriptState);
-}
-
-ScriptPromise Cache::deleteFunction(ScriptState* scriptState, const String& requestString, const Dictionary& queryParams)
-{
-    return rejectAsNotImplemented(scriptState);
-}
-
-ScriptPromise Cache::put(ScriptState* scriptState, Request* request, Response*)
-{
-    return rejectAsNotImplemented(scriptState);
-}
-
-ScriptPromise Cache::put(ScriptState* scriptState, const String& requestString, Response*)
-{
-    return rejectAsNotImplemented(scriptState);
-}
-
-ScriptPromise Cache::keys(ScriptState* scriptState)
-{
-    return rejectAsNotImplemented(scriptState);
-}
-
-ScriptPromise Cache::keys(ScriptState* scriptState, Request* request, const Dictionary& queryParams)
-{
-    return rejectAsNotImplemented(scriptState);
-}
-
-ScriptPromise Cache::keys(ScriptState* scriptState, const String& requestString, const Dictionary& queryParams)
-{
-    return rejectAsNotImplemented(scriptState);
-}
-
 PassRefPtrWillBeRawPtr<DOMException> Cache::domExceptionForCacheError(WebServiceWorkerCacheError reason)
 {
     switch (reason) {
     case WebServiceWorkerCacheErrorNotImplemented:
         return DOMException::create(NotSupportedError, "Method is not implemented.");
     case WebServiceWorkerCacheErrorNotFound:
         return DOMException::create(NotFoundError, "Entry was not found.");
     case WebServiceWorkerCacheErrorExists:
         return DOMException::create(InvalidAccessError, "Entry already exists.");
     default:
         ASSERT_NOT_REACHED();
         return DOMException::create(NotSupportedError, "Unknown error.");
     }
 }
 
-Cache::Cache(WebServiceWorkerCache* webCache) : m_webCache(webCache)
+ScriptPromise Cache::deleteImpl(ScriptState* scriptState, Request* request, const Dictionary& queryParamsDict)
 {
+    WebVector<WebServiceWorkerCache::BatchOperation> batchOperations(size_t(1));
+    batchOperations[0].operationType = WebServiceWorkerCache::WebServiceWorkerCacheOperationTypeDelete;
+    request->populateWebServiceWorkerRequest(batchOperations[0].request);
+    batchOperations[0].matchParams = queryParamsFromDictionary(queryParamsDict);
+
+    RefPtr<ScriptPromiseResolver> resolver = ScriptPromiseResolver::create(scriptState);
+    const ScriptPromise promise = resolver->promise();
+    m_webCache->dispatchBatch(new CacheWithResponsesCallbacks(resolver), batchOperations);
+    return promise;
+}
+
+ScriptPromise Cache::putImpl(ScriptState* scriptState, Request* request, const Response* response)
+{
+    WebVector<WebServiceWorkerCache::BatchOperation> batchOperations(size_t(1));
+    batchOperations[0].operationType = WebServiceWorkerCache::WebServiceWorkerCacheOperationTypePut;
+    request->populateWebServiceWorkerRequest(batchOperations[0].request);
+    response->populateWebServiceWorkerResponse(batchOperations[0].response);
+
+    RefPtr<ScriptPromiseResolver> resolver = ScriptPromiseResolver::create(scriptState);
+    const ScriptPromise promise = resolver->promise();
+    m_webCache->dispatchBatch(new CacheWithResponsesCallbacks(resolver), batchOperations);
+    return promise;
+}
+
+ScriptPromise Cache::keysImpl(ScriptState* scriptState)
+{
+    RefPtr<ScriptPromiseResolver> resolver = ScriptPromiseResolver::create(scriptState);
+    const ScriptPromise promise = resolver->promise();
+    m_webCache->dispatchKeys(new CacheWithRequestsCallbacks(resolver), 0, WebServiceWorkerCache::QueryParams());
+    return promise;
+}
+
+ScriptPromise Cache::keysImpl(ScriptState* scriptState, Request* request, const Dictionary& queryParamsDict)
+{
+    WebServiceWorkerRequest webRequest;
+    request->populateWebServiceWorkerRequest(webRequest);
+
+    RefPtr<ScriptPromiseResolver> resolver = ScriptPromiseResolver::create(scriptState);
+    const ScriptPromise promise = resolver->promise();
+    m_webCache->dispatchKeys(new CacheWithRequestsCallbacks(resolver), 0, queryParamsFromDictionary(queryParamsDict));
+    return promise;
 }
 
 } // namespace blink