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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
|
/*
* Copyright (C) 2017 Igalia S.L.
*
* 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 "Actions.h"
#include "Capabilities.h"
#include "SessionHost.h"
#include <wtf/Forward.h>
#include <wtf/Function.h>
#include <wtf/HashSet.h>
#include <wtf/JSONValues.h>
#include <wtf/OptionSet.h>
#include <wtf/RefCounted.h>
#include <wtf/StdLibExtras.h>
#include <wtf/WeakPtr.h>
#include <wtf/text/WTFString.h>
#if ENABLE(WEBDRIVER_BIDI)
#include "WebSocketServer.h"
#endif
namespace WebDriver {
class CommandResult;
class SessionHost;
class Session :
#if ENABLE(WEBDRIVER_BIDI)
public BiDiEventHandler // Inherits RefCounted
#else
public RefCounted<Session>
#endif
{
public:
static Ref<Session> create(Ref<SessionHost>&& host)
{
return adoptRef(*new Session(WTFMove(host)));
}
#if ENABLE(WEBDRIVER_BIDI)
static Ref<Session> create(Ref<SessionHost>&& host, WeakPtr<WebSocketServer> bidiServer)
{
return adoptRef(*new Session(WTFMove(host), WTFMove(bidiServer)));
}
#endif
virtual ~Session();
const String& id() const;
const Capabilities& capabilities() const;
bool isConnected() const;
#if ENABLE(WEBDRIVER_BIDI)
bool hasBiDiEnabled() const { return m_hasBiDiEnabled; };
void setHasBiDiEnabled(bool flag) { m_hasBiDiEnabled = flag; }
#endif
double scriptTimeout() const { return m_scriptTimeout; }
double pageLoadTimeout() const { return m_pageLoadTimeout; }
double implicitWaitTimeout() const { return m_implicitWaitTimeout; }
static const String& webElementIdentifier();
static const String& shadowRootIdentifier();
enum class FindElementsMode { Single,
Multiple };
enum class ExecuteScriptMode { Sync,
Async };
enum class ElementIsShadowRoot : bool { No,
Yes };
struct Cookie {
String name;
String value;
std::optional<String> path;
std::optional<String> domain;
std::optional<bool> secure;
std::optional<bool> httpOnly;
std::optional<uint64_t> expiry;
std::optional<String> sameSite;
};
InputSource& getOrCreateInputSource(const String& id, InputSource::Type, std::optional<PointerType>);
void waitForNavigationToComplete(Function<void(CommandResult&&)>&&);
void createTopLevelBrowsingContext(Function<void(CommandResult&&)>&&);
void close(Function<void(CommandResult&&)>&&);
void getTimeouts(Function<void(CommandResult&&)>&&);
void setTimeouts(const Timeouts&, Function<void(CommandResult&&)>&&);
void go(const String& url, Function<void(CommandResult&&)>&&);
void getCurrentURL(Function<void(CommandResult&&)>&&);
void back(Function<void(CommandResult&&)>&&);
void forward(Function<void(CommandResult&&)>&&);
void refresh(Function<void(CommandResult&&)>&&);
void getTitle(Function<void(CommandResult&&)>&&);
void getWindowHandle(Function<void(CommandResult&&)>&&);
void closeWindow(Function<void(CommandResult&&)>&&);
void switchToWindow(const String& windowHandle, Function<void(CommandResult&&)>&&);
void getWindowHandles(Function<void(CommandResult&&)>&&);
void newWindow(std::optional<String> typeHint, Function<void(CommandResult&&)>&&);
void switchToFrame(RefPtr<JSON::Value>&&, Function<void(CommandResult&&)>&&);
void switchToParentFrame(Function<void(CommandResult&&)>&&);
void getWindowRect(Function<void(CommandResult&&)>&&);
void setWindowRect(std::optional<double> x, std::optional<double> y, std::optional<double> width, std::optional<double> height, Function<void(CommandResult&&)>&&);
void maximizeWindow(Function<void(CommandResult&&)>&&);
void minimizeWindow(Function<void(CommandResult&&)>&&);
void fullscreenWindow(Function<void(CommandResult&&)>&&);
void findElements(const String& strategy, const String& selector, FindElementsMode, const String& rootElementID, ElementIsShadowRoot, Function<void(CommandResult&&)>&&);
void getActiveElement(Function<void(CommandResult&&)>&&);
void getElementShadowRoot(const String& elementID, Function<void(CommandResult&&)>&&);
void isElementSelected(const String& elementID, Function<void(CommandResult&&)>&&);
void getElementAttribute(const String& elementID, const String& attribute, Function<void(CommandResult&&)>&&);
void getElementProperty(const String& elementID, const String& attribute, Function<void(CommandResult&&)>&&);
void getElementCSSValue(const String& elementID, const String& cssProperty, Function<void(CommandResult&&)>&&);
void getElementText(const String& elementID, Function<void(CommandResult&&)>&&);
void getElementTagName(const String& elementID, Function<void(CommandResult&&)>&&);
void getElementRect(const String& elementID, Function<void(CommandResult&&)>&&);
void isElementEnabled(const String& elementID, Function<void(CommandResult&&)>&&);
void getComputedRole(const String& elementID, Function<void(CommandResult&&)>&&);
void getComputedLabel(const String& elementID, Function<void(CommandResult&&)>&&);
void isElementDisplayed(const String& elementID, Function<void(CommandResult&&)>&&);
void elementClick(const String& elementID, Function<void(CommandResult&&)>&&);
void elementClear(const String& elementID, Function<void(CommandResult&&)>&&);
void elementSendKeys(const String& elementID, const String& text, Function<void(CommandResult&&)>&&);
void getPageSource(Function<void(CommandResult&&)>&&);
void executeScript(const String& script, RefPtr<JSON::Array>&& arguments, ExecuteScriptMode, Function<void(CommandResult&&)>&&);
void getAllCookies(Function<void(CommandResult&&)>&&);
void getNamedCookie(const String& name, Function<void(CommandResult&&)>&&);
void addCookie(const Cookie&, Function<void(CommandResult&&)>&&);
void deleteCookie(const String& name, Function<void(CommandResult&&)>&&);
void deleteAllCookies(Function<void(CommandResult&&)>&&);
void performActions(Vector<Vector<Action>>&&, Function<void(CommandResult&&)>&&);
void releaseActions(Function<void(CommandResult&&)>&&);
void dismissAlert(Function<void(CommandResult&&)>&&);
void acceptAlert(Function<void(CommandResult&&)>&&);
void getAlertText(Function<void(CommandResult&&)>&&);
void sendAlertText(const String&, Function<void(CommandResult&&)>&&);
void takeScreenshot(std::optional<String> elementID, std::optional<bool> scrollIntoView, Function<void(CommandResult&&)>&&);
#if ENABLE(WEBDRIVER_BIDI)
void enableGlobalEvent(const String&);
void disableGlobalEvent(const String&);
void dispatchEvent(RefPtr<JSON::Object>&&);
#endif
private:
Session(Ref<SessionHost>&&);
#if ENABLE(WEBDRIVER_BIDI)
Session(Ref<SessionHost>&&, WeakPtr<WebSocketServer>&&);
#endif
void switchToTopLevelBrowsingContext(const String&);
void switchToBrowsingContext(const String&, Function<void(CommandResult&&)>&&);
void switchToBrowsingContext(const String& toplevelBrowsingContext, const String& browsingContext, Function<void(CommandResult&&)>&&);
void closeTopLevelBrowsingContext(const String& toplevelBrowsingContext, Function<void(CommandResult&&)>&&);
void closeAllToplevelBrowsingContexts(const String& toplevelBrowsingContext, Function<void(CommandResult&&)>&&);
void getToplevelBrowsingContextRect(Function<void(CommandResult&&)>&&);
std::optional<String> pageLoadStrategyString() const;
void handleUserPrompts(Function<void(CommandResult&&)>&&);
void handleUnexpectedAlertOpen(Function<void(CommandResult&&)>&&);
void dismissAndNotifyAlert(Function<void(CommandResult&&)>&&);
void acceptAndNotifyAlert(Function<void(CommandResult&&)>&&);
void reportUnexpectedAlertOpen(Function<void(CommandResult&&)>&&);
RefPtr<JSON::Object> createElement(RefPtr<JSON::Value>&&);
Ref<JSON::Object> createElement(const String& elementID);
RefPtr<JSON::Object> createShadowRoot(RefPtr<JSON::Value>&&);
RefPtr<JSON::Object> extractElement(JSON::Value&);
String extractElementID(JSON::Value&);
Ref<JSON::Value> handleScriptResult(Ref<JSON::Value>&&);
void elementIsEditable(const String& elementID, Function<void(CommandResult&&)>&&);
struct Point {
int x { 0 };
int y { 0 };
};
struct Size {
int width { 0 };
int height { 0 };
};
struct Rect {
Point origin;
Size size;
};
enum class ElementLayoutOption {
ScrollIntoViewIfNeeded = 1 << 0,
UseViewportCoordinates = 1 << 1,
};
void computeElementLayout(const String& elementID, OptionSet<ElementLayoutOption>, Function<void(std::optional<Rect>&&, std::optional<Point>&&, bool, RefPtr<JSON::Object>&&)>&&);
void elementIsFileUpload(const String& elementID, Function<void(CommandResult&&)>&&);
enum class FileUploadType { Single,
Multiple };
std::optional<FileUploadType> parseElementIsFileUploadResult(const RefPtr<JSON::Value>&);
void selectOptionElement(const String& elementID, Function<void(CommandResult&&)>&&);
void setInputFileUploadFiles(const String& elementID, const String& text, bool multiple, Function<void(CommandResult&&)>&&);
void didSetInputFileUploadFiles(bool wasCancelled);
enum class MouseInteraction { Move,
Down,
Up,
SingleClick,
DoubleClick };
void performMouseInteraction(int x, int y, MouseButton, MouseInteraction, Function<void(CommandResult&&)>&&);
enum class KeyboardInteractionType { KeyPress,
KeyRelease,
InsertByKey };
struct KeyboardInteraction {
KeyboardInteractionType type { KeyboardInteractionType::InsertByKey };
std::optional<String> text;
std::optional<String> key;
};
enum KeyModifier {
None = 0,
Shift = 1 << 0,
Control = 1 << 1,
Alternate = 1 << 2,
Meta = 1 << 3,
};
String virtualKeyForKey(UChar, KeyModifier&);
void performKeyboardInteractions(Vector<KeyboardInteraction>&&, Function<void(CommandResult&&)>&&);
struct InputSourceState {
enum class Type { Null,
Key,
Pointer };
Type type;
String subtype;
std::optional<MouseButton> pressedButton;
std::optional<String> pressedKey;
HashSet<String> pressedVirtualKeys;
};
InputSourceState& inputSourceState(const String& id);
RefPtr<SessionHost> m_host;
double m_scriptTimeout;
double m_pageLoadTimeout;
double m_implicitWaitTimeout;
std::optional<String> m_toplevelBrowsingContext;
std::optional<String> m_currentBrowsingContext;
std::optional<String> m_currentParentBrowsingContext;
HashMap<String, InputSource> m_activeInputSources;
HashMap<String, InputSourceState> m_inputStateTable;
#if ENABLE(WEBDRIVER_BIDI)
bool m_hasBiDiEnabled { false };
// https://w3c.github.io/webdriver-bidi/#events
HashSet<String> m_globalEventSet;
WeakPtr<WebSocketServer> m_bidiServer;
bool eventIsEnabled(const String&, const Vector<String>&);
void emitEvent(const String&, RefPtr<JSON::Object>&&);
String toInternalEventName(const String&);
// Actual event handlers
void doLogEntryAdded(RefPtr<JSON::Object>&&);
#endif
};
} // WebDriver
|
