API Test TestWebKitAPI.WebKit.DefaultQuota is very flaky on High Sierra
[WebKit-https.git] / Source / WebCore / Modules / cache / DOMCacheStorage.h
1 /*
2  * Copyright (C) 2017 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "CacheStorageConnection.h"
29 #include "DOMCache.h"
30 #include "FetchRequest.h"
31 #include <wtf/Forward.h>
32
33 namespace WebCore {
34
35 class SuspendableTaskQueue;
36
37 class DOMCacheStorage : public RefCounted<DOMCacheStorage>, public ActiveDOMObject {
38 public:
39     static Ref<DOMCacheStorage> create(ScriptExecutionContext& context, Ref<CacheStorageConnection>&& connection) { return adoptRef(*new DOMCacheStorage(context, WTFMove(connection))); }
40     ~DOMCacheStorage();
41
42     using KeysPromise = DOMPromiseDeferred<IDLSequence<IDLDOMString>>;
43
44     void match(DOMCache::RequestInfo&&, CacheQueryOptions&&, Ref<DeferredPromise>&&);
45     void has(const String&, DOMPromiseDeferred<IDLBoolean>&&);
46     void open(const String&, DOMPromiseDeferred<IDLInterface<DOMCache>>&&);
47     void remove(const String&, DOMPromiseDeferred<IDLBoolean>&&);
48     void keys(KeysPromise&&);
49
50     // ActiveDOMObject
51     bool hasPendingActivity() const final;
52
53 private:
54     DOMCacheStorage(ScriptExecutionContext&, Ref<CacheStorageConnection>&&);
55
56     // ActiveDOMObject
57     void stop() final;
58     const char* activeDOMObjectName() const final;
59     bool canSuspendForDocumentSuspension() const final;
60
61     void doOpen(const String& name, DOMPromiseDeferred<IDLInterface<DOMCache>>&&);
62     void doRemove(const String&, DOMPromiseDeferred<IDLBoolean>&&);
63     void doSequentialMatch(DOMCache::RequestInfo&&, CacheQueryOptions&&, Ref<DeferredPromise>&&);
64     void retrieveCaches(WTF::Function<void(Optional<Exception>&&)>&&);
65     Ref<DOMCache> findCacheOrCreate(DOMCacheEngine::CacheInfo&&);
66     Optional<ClientOrigin> origin() const;
67
68     Vector<Ref<DOMCache>> m_caches;
69     uint64_t m_updateCounter { 0 };
70     Ref<CacheStorageConnection> m_connection;
71     UniqueRef<SuspendableTaskQueue> m_taskQueue;
72     bool m_isStopped { false };
73 };
74
75 } // namespace WebCore