1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
/*
* Copyright (C) 2015, 2016 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include "EventTarget.h"
#include "ExceptionOr.h"
#include "IDBActiveDOMObject.h"
#include "IDBError.h"
#include "IDBGetAllResult.h"
#include "IDBGetResult.h"
#include "IDBIndexIdentifier.h"
#include "IDBKeyData.h"
#include "IDBObjectStoreIdentifier.h"
#include "IDBResourceIdentifier.h"
#include "IDBValue.h"
#include "IndexedDB.h"
#include "JSValueInWrappedObject.h"
#include <JavaScriptCore/Strong.h>
#include <optional>
#include <wtf/Function.h>
#include <wtf/Scope.h>
#include <wtf/TZoneMalloc.h>
#include <wtf/ThreadSafeRefCounted.h>
#include <wtf/WeakPtr.h>
namespace WebCore {
class DOMException;
class Event;
class IDBCursor;
class IDBDatabase;
class IDBIndex;
class IDBObjectStore;
class IDBResultData;
class IDBTransaction;
class ThreadSafeDataBuffer;
class WebCoreOpaqueRoot;
namespace IDBClient {
class IDBConnectionProxy;
class IDBConnectionToServer;
}
class IDBRequest : public EventTarget, public IDBActiveDOMObject, public ThreadSafeRefCounted<IDBRequest> {
WTF_MAKE_TZONE_OR_ISO_ALLOCATED(IDBRequest);
public:
enum class NullResultType {
Empty,
Undefined
};
static Ref<IDBRequest> create(ScriptExecutionContext&, IDBObjectStore&, IDBTransaction&);
static Ref<IDBRequest> create(ScriptExecutionContext&, IDBCursor&, IDBTransaction&);
static Ref<IDBRequest> create(ScriptExecutionContext&, IDBIndex&, IDBTransaction&);
static Ref<IDBRequest> createObjectStoreGet(ScriptExecutionContext&, IDBObjectStore&, IndexedDB::ObjectStoreRecordType, IDBTransaction&);
static Ref<IDBRequest> createIndexGet(ScriptExecutionContext&, IDBIndex&, IndexedDB::IndexRecordType, IDBTransaction&);
const IDBResourceIdentifier& resourceIdentifier() const { return m_resourceIdentifier; }
virtual ~IDBRequest();
using Result = std::variant<RefPtr<IDBCursor>, RefPtr<IDBDatabase>, IDBKeyData, Vector<IDBKeyData>, IDBGetResult, IDBGetAllResult, uint64_t, NullResultType>;
ExceptionOr<Result> result() const;
JSValueInWrappedObject& resultWrapper() { return m_resultWrapper; }
using Source = std::variant<RefPtr<IDBObjectStore>, RefPtr<IDBIndex>, RefPtr<IDBCursor>>;
const std::optional<Source>& source() const { return m_source; }
ExceptionOr<DOMException*> error() const;
RefPtr<IDBTransaction> transaction() const;
enum class ReadyState { Pending, Done };
ReadyState readyState() const { return m_readyState; }
bool isDone() const { return m_readyState == ReadyState::Done; }
std::optional<IDBObjectStoreIdentifier> sourceObjectStoreIdentifier() const;
std::optional<IDBIndexIdentifier> sourceIndexIdentifier() const;
IndexedDB::ObjectStoreRecordType requestedObjectStoreRecordType() const;
IndexedDB::IndexRecordType requestedIndexRecordType() const;
ScriptExecutionContext* scriptExecutionContext() const final { return ActiveDOMObject::scriptExecutionContext(); }
// ActiveDOMObject.
void ref() const final { ThreadSafeRefCounted::ref(); }
void deref() const final { ThreadSafeRefCounted::deref(); }
void completeRequestAndDispatchEvent(const IDBResultData&);
void setResult(const IDBKeyData&);
void setResult(const Vector<IDBKeyData>&);
void setResultToStructuredClone(const IDBGetResult&);
void setResult(const IDBGetAllResult&);
void setResult(uint64_t);
void setResultToUndefined();
void willIterateCursor(IDBCursor&);
void didOpenOrIterateCursor(const IDBResultData&);
IDBCursor* pendingCursor() const { return m_pendingCursor ? m_pendingCursor.get() : nullptr; }
void setSource(IDBCursor&);
void setVersionChangeTransaction(IDBTransaction&);
IndexedDB::RequestType requestType() const { return m_requestType; }
void setTransactionOperationID(uint64_t transactionOperationID) { m_currentTransactionOperationID = transactionOperationID; }
bool willAbortTransactionAfterDispatchingEvent() const;
void transactionTransitionedToFinishing();
bool isEventBeingDispatched() const { return !!m_eventBeingDispatched; }
protected:
IDBRequest(ScriptExecutionContext&, IDBClient::IDBConnectionProxy&, IndexedDB::RequestType);
void enqueueEvent(Ref<Event>&&);
void dispatchEvent(Event&) override;
void setResult(Ref<IDBDatabase>&&);
void setReadyState(ReadyState state) { m_readyState = state; }
void setShouldExposeTransactionToDOM(bool shouldExposeTransactionToDOM) { m_shouldExposeTransactionToDOM = shouldExposeTransactionToDOM; }
IDBClient::IDBConnectionProxy& connectionProxy() { return m_connectionProxy.get(); }
private:
IDBRequest(ScriptExecutionContext&, IDBObjectStore&, IDBTransaction&);
IDBRequest(ScriptExecutionContext&, IDBCursor&, IDBTransaction&);
IDBRequest(ScriptExecutionContext&, IDBIndex&, IDBTransaction&);
IDBRequest(ScriptExecutionContext&, IDBObjectStore&, IndexedDB::ObjectStoreRecordType, IDBTransaction&);
IDBRequest(ScriptExecutionContext&, IDBIndex&, IndexedDB::IndexRecordType, IDBTransaction&);
enum EventTargetInterfaceType eventTargetInterface() const override;
// ActiveDOMObject.
bool virtualHasPendingActivity() const final;
void stop() final;
virtual void cancelForStop();
// EventTarget
void refEventTarget() final { ref(); }
void derefEventTarget() final { deref(); }
void uncaughtExceptionInEventHandler() final;
virtual bool isOpenDBRequest() const { return false; }
void onError();
void onSuccess();
void clearWrappers();
protected:
// FIXME: Protected data members aren't great for maintainability.
// Consider adding protected helper functions and making these private.
RefPtr<IDBTransaction> m_transaction;
RefPtr<DOMException> m_domError;
WeakPtr<Event> m_openDatabaseSuccessEvent;
private:
IDBCursor* resultCursor();
IDBError m_idbError;
IDBResourceIdentifier m_resourceIdentifier;
JSValueInWrappedObject m_resultWrapper;
uint64_t m_currentTransactionOperationID { 0 };
Result m_result;
std::optional<Source> m_source;
RefPtr<IDBCursor> m_pendingCursor;
Ref<IDBClient::IDBConnectionProxy> m_connectionProxy;
ReadyState m_readyState { ReadyState::Pending };
IndexedDB::RequestType m_requestType { IndexedDB::RequestType::Other };
IndexedDB::ObjectStoreRecordType m_requestedObjectStoreRecordType { IndexedDB::ObjectStoreRecordType::ValueOnly };
IndexedDB::IndexRecordType m_requestedIndexRecordType { IndexedDB::IndexRecordType::Key };
bool m_shouldExposeTransactionToDOM { true };
enum class PendingActivityType : uint8_t { EndingEvent, CursorIteration, None };
PendingActivityType m_pendingActivity { PendingActivityType::EndingEvent };
bool m_hasUncaughtException { false };
RefPtr<Event> m_eventBeingDispatched;
};
WebCoreOpaqueRoot root(IDBRequest*);
} // namespace WebCore
|
