Add a DOMPromiseDeferred method to handle ExceptionOr<> results
[WebKit-https.git] / Source / WebCore / Modules / cache / CacheStorageConnection.h
1
2 /*
3  * Copyright (C) 2017 Apple Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
15  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
16  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
18  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
22  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
23  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
24  * THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #pragma once
28
29 #include "FetchHeaders.h"
30 #include "FetchOptions.h"
31 #include "ResourceRequest.h"
32 #include "ResourceResponse.h"
33 #include <wtf/HashMap.h>
34 #include <wtf/ThreadSafeRefCounted.h>
35
36 namespace WebCore {
37
38 struct CacheQueryOptions;
39
40 class CacheStorageConnection : public ThreadSafeRefCounted<CacheStorageConnection> {
41 public:
42     static Ref<CacheStorageConnection> create() { return adoptRef(*new CacheStorageConnection()); }
43     virtual ~CacheStorageConnection() = default;
44
45     enum class Error {
46         None,
47         NotImplemented,
48     };
49
50     static ExceptionOr<void> errorToException(Error);
51     template<typename T> static ExceptionOr<T> exceptionOrResult(T&& value, Error error)
52     {
53         auto result = errorToException(error);
54         if (result.hasException())
55             return result.releaseException();
56         return std::forward<T>(value);
57     }
58
59     WEBCORE_EXPORT static bool queryCacheMatch(const ResourceRequest& request, const ResourceRequest& cachedRequest, const ResourceResponse&, const CacheQueryOptions&);
60
61     struct Record {
62         uint64_t identifier;
63
64         FetchHeaders::Guard requestHeadersGuard;
65         ResourceRequest request;
66         FetchOptions options;
67         String referrer;
68
69         FetchHeaders::Guard responseHeadersGuard;
70         ResourceResponse response;
71     };
72
73     struct CacheInfo {
74         uint64_t identifier;
75         String name;
76     };
77
78     using OpenRemoveCallback = WTF::Function<void(uint64_t, Error)>;
79     using CachesCallback = WTF::Function<void(Vector<CacheInfo>&&)>;
80     using RecordsCallback = WTF::Function<void(Vector<Record>&&)>;
81     using BatchOperationCallback = WTF::Function<void(Vector<uint64_t>&&, Error)>;
82
83     void open(const String& /* origin */, const String& /* cacheName */, OpenRemoveCallback&&);
84     void remove(uint64_t /* cacheIdentifier */, OpenRemoveCallback&&);
85     void retrieveCaches(const String& /* origin */, CachesCallback&&);
86
87     void retrieveRecords(uint64_t /* cacheIdentifier */, RecordsCallback&&);
88     void batchDeleteOperation(uint64_t /* cacheIdentifier */, const ResourceRequest&, CacheQueryOptions&&, BatchOperationCallback&&);
89     void batchPutOperation(uint64_t /* cacheIdentifier */, Vector<Record>&&, BatchOperationCallback&&);
90
91 protected:
92     CacheStorageConnection() =  default;
93
94     void openCompleted(uint64_t identifier, uint64_t cacheIdentifier, Error error) { openOrRemoveCompleted(identifier, cacheIdentifier, error); }
95     void removeCompleted(uint64_t identifier, uint64_t cacheIdentifier, Error error) { openOrRemoveCompleted(identifier, cacheIdentifier, error); }
96     WEBCORE_EXPORT void updateCaches(uint64_t requestIdentifier, Vector<CacheInfo>&&);
97
98     WEBCORE_EXPORT void updateRecords(uint64_t requestIdentifier, Vector<Record>&&);
99     WEBCORE_EXPORT void deleteRecordsCompleted(uint64_t requestIdentifier, Vector<uint64_t>&&, Error);
100     WEBCORE_EXPORT void putRecordsCompleted(uint64_t requestIdentifier, Vector<uint64_t>&&, Error);
101
102 private:
103     virtual void doOpen(uint64_t requestIdentifier, const String& /* origin */, const String& /* cacheName */) { openCompleted(requestIdentifier, 0, Error::NotImplemented); }
104     virtual void doRemove(uint64_t requestIdentifier, uint64_t /* cacheIdentifier */) { removeCompleted(requestIdentifier, 0, Error::NotImplemented); }
105     virtual void doRetrieveCaches(uint64_t requestIdentifier, const String& /* origin */) { updateCaches(requestIdentifier, { }); }
106
107     virtual void doRetrieveRecords(uint64_t requestIdentifier, uint64_t /* cacheIdentifier */) { updateRecords(requestIdentifier, { }); }
108     virtual void doBatchDeleteOperation(uint64_t requestIdentifier, uint64_t /* cacheIdentifier */, const ResourceRequest&, CacheQueryOptions&&) { deleteRecordsCompleted(requestIdentifier, { }, Error::NotImplemented); }
109     virtual void doBatchPutOperation(uint64_t requestIdentifier, uint64_t /* cacheIdentifier */, Vector<Record>&&) { putRecordsCompleted(requestIdentifier, { }, Error::NotImplemented); }
110
111     WEBCORE_EXPORT void openOrRemoveCompleted(uint64_t requestIdentifier, uint64_t cacheIdentifier, Error);
112
113     HashMap<uint64_t, OpenRemoveCallback> m_openAndRemoveCachePendingRequests;
114     HashMap<uint64_t, CachesCallback> m_retrieveCachesPendingRequests;
115     HashMap<uint64_t, RecordsCallback> m_retrieveRecordsPendingRequests;
116     HashMap<uint64_t, BatchOperationCallback> m_batchDeleteAndPutPendingRequests;
117
118     uint64_t m_lastRequestIdentifier { 0 };
119 };
120
121 } // namespace WebCore
122