ec6430a6d8d3bb87cfcefa4d5182f9510091fc09
[WebKit-https.git] / Source / WebDriver / Session.h
1 /*
2  * Copyright (C) 2017 Igalia S.L.
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 "Actions.h"
29 #include "Capabilities.h"
30 #include <wtf/Forward.h>
31 #include <wtf/Function.h>
32 #include <wtf/JSONValues.h>
33 #include <wtf/OptionSet.h>
34 #include <wtf/RefCounted.h>
35 #include <wtf/text/WTFString.h>
36
37 namespace WebDriver {
38
39 class CommandResult;
40 class SessionHost;
41
42 class Session : public RefCounted<Session> {
43 public:
44     static Ref<Session> create(std::unique_ptr<SessionHost>&& host)
45     {
46         return adoptRef(*new Session(WTFMove(host)));
47     }
48     ~Session();
49
50     const String& id() const;
51     const Capabilities& capabilities() const;
52     bool isConnected() const;
53     Seconds scriptTimeout() const  { return m_scriptTimeout; }
54     Seconds pageLoadTimeout() const { return m_pageLoadTimeout; }
55     Seconds implicitWaitTimeout() const { return m_implicitWaitTimeout; }
56     static const String& webElementIdentifier();
57
58     enum class FindElementsMode { Single, Multiple };
59     enum class ExecuteScriptMode { Sync, Async };
60
61     struct Cookie {
62         String name;
63         String value;
64         std::optional<String> path;
65         std::optional<String> domain;
66         std::optional<bool> secure;
67         std::optional<bool> httpOnly;
68         std::optional<uint64_t> expiry;
69     };
70
71     InputSource& getOrCreateInputSource(const String& id, InputSource::Type, std::optional<PointerType>);
72
73     void waitForNavigationToComplete(Function<void (CommandResult&&)>&&);
74     void createTopLevelBrowsingContext(Function<void (CommandResult&&)>&&);
75     void close(Function<void (CommandResult&&)>&&);
76     void getTimeouts(Function<void (CommandResult&&)>&&);
77     void setTimeouts(const Timeouts&, Function<void (CommandResult&&)>&&);
78
79     void go(const String& url, Function<void (CommandResult&&)>&&);
80     void getCurrentURL(Function<void (CommandResult&&)>&&);
81     void back(Function<void (CommandResult&&)>&&);
82     void forward(Function<void (CommandResult&&)>&&);
83     void refresh(Function<void (CommandResult&&)>&&);
84     void getTitle(Function<void (CommandResult&&)>&&);
85     void getWindowHandle(Function<void (CommandResult&&)>&&);
86     void closeWindow(Function<void (CommandResult&&)>&&);
87     void switchToWindow(const String& windowHandle, Function<void (CommandResult&&)>&&);
88     void getWindowHandles(Function<void (CommandResult&&)>&&);
89     void switchToFrame(RefPtr<JSON::Value>&&, Function<void (CommandResult&&)>&&);
90     void switchToParentFrame(Function<void (CommandResult&&)>&&);
91     void getWindowRect(Function<void (CommandResult&&)>&&);
92     void setWindowRect(std::optional<double> x, std::optional<double> y, std::optional<double> width, std::optional<double> height, Function<void (CommandResult&&)>&&);
93     void findElements(const String& strategy, const String& selector, FindElementsMode, const String& rootElementID, Function<void (CommandResult&&)>&&);
94     void getActiveElement(Function<void (CommandResult&&)>&&);
95     void isElementSelected(const String& elementID, Function<void (CommandResult&&)>&&);
96     void getElementAttribute(const String& elementID, const String& attribute, Function<void (CommandResult&&)>&&);
97     void getElementProperty(const String& elementID, const String& attribute, Function<void (CommandResult&&)>&&);
98     void getElementCSSValue(const String& elementID, const String& cssProperty, Function<void (CommandResult&&)>&&);
99     void getElementText(const String& elementID, Function<void (CommandResult&&)>&&);
100     void getElementTagName(const String& elementID, Function<void (CommandResult&&)>&&);
101     void getElementRect(const String& elementID, Function<void (CommandResult&&)>&&);
102     void isElementEnabled(const String& elementID, Function<void (CommandResult&&)>&&);
103     void isElementDisplayed(const String& elementID, Function<void (CommandResult&&)>&&);
104     void elementClick(const String& elementID, Function<void (CommandResult&&)>&&);
105     void elementClear(const String& elementID, Function<void (CommandResult&&)>&&);
106     void elementSendKeys(const String& elementID, Vector<String>&& keys, Function<void (CommandResult&&)>&&);
107     void executeScript(const String& script, RefPtr<JSON::Array>&& arguments, ExecuteScriptMode, Function<void (CommandResult&&)>&&);
108     void getAllCookies(Function<void (CommandResult&&)>&&);
109     void getNamedCookie(const String& name, Function<void (CommandResult&&)>&&);
110     void addCookie(const Cookie&, Function<void (CommandResult&&)>&&);
111     void deleteCookie(const String& name, Function<void (CommandResult&&)>&&);
112     void deleteAllCookies(Function<void (CommandResult&&)>&&);
113     void performActions(Vector<Vector<Action>>&&, Function<void (CommandResult&&)>&&);
114     void releaseActions(Function<void (CommandResult&&)>&&);
115     void dismissAlert(Function<void (CommandResult&&)>&&);
116     void acceptAlert(Function<void (CommandResult&&)>&&);
117     void getAlertText(Function<void (CommandResult&&)>&&);
118     void sendAlertText(const String&, Function<void (CommandResult&&)>&&);
119     void takeScreenshot(std::optional<String> elementID, std::optional<bool> scrollIntoView, Function<void (CommandResult&&)>&&);
120
121 private:
122     Session(std::unique_ptr<SessionHost>&&);
123
124     void switchToTopLevelBrowsingContext(std::optional<String>);
125     void switchToBrowsingContext(std::optional<String>);
126     void closeTopLevelBrowsingContext(const String& toplevelBrowsingContext, Function<void (CommandResult&&)>&&);
127     void closeAllToplevelBrowsingContexts(const String& toplevelBrowsingContext, Function<void (CommandResult&&)>&&);
128
129     void getToplevelBrowsingContextRect(Function<void (CommandResult&&)>&&);
130
131     std::optional<String> pageLoadStrategyString() const;
132
133     void handleUserPrompts(Function<void (CommandResult&&)>&&);
134     void handleUnexpectedAlertOpen(Function<void (CommandResult&&)>&&);
135     void dismissAndNotifyAlert(Function<void (CommandResult&&)>&&);
136     void acceptAndNotifyAlert(Function<void (CommandResult&&)>&&);
137     void reportUnexpectedAlertOpen(Function<void (CommandResult&&)>&&);
138
139     RefPtr<JSON::Object> createElement(RefPtr<JSON::Value>&&);
140     RefPtr<JSON::Object> createElement(const String& elementID);
141     RefPtr<JSON::Object> extractElement(JSON::Value&);
142     String extractElementID(JSON::Value&);
143     RefPtr<JSON::Value> handleScriptResult(RefPtr<JSON::Value>&&);
144
145     struct Point {
146         int x { 0 };
147         int y { 0 };
148     };
149
150     struct Size {
151         int width { 0 };
152         int height { 0 };
153     };
154
155     struct Rect {
156         Point origin;
157         Size size;
158     };
159
160     enum class ElementLayoutOption {
161         ScrollIntoViewIfNeeded = 1 << 0,
162         UseViewportCoordinates = 1 << 1,
163     };
164     void computeElementLayout(const String& elementID, OptionSet<ElementLayoutOption>, Function<void (std::optional<Rect>&&, std::optional<Point>&&, bool, RefPtr<JSON::Object>&&)>&&);
165
166     void selectOptionElement(const String& elementID, Function<void (CommandResult&&)>&&);
167
168     enum class MouseInteraction { Move, Down, Up, SingleClick, DoubleClick };
169     void performMouseInteraction(int x, int y, MouseButton, MouseInteraction, Function<void (CommandResult&&)>&&);
170
171     enum class KeyboardInteractionType { KeyPress, KeyRelease, InsertByKey };
172     struct KeyboardInteraction {
173         KeyboardInteractionType type { KeyboardInteractionType::InsertByKey };
174         std::optional<String> text;
175         std::optional<String> key;
176     };
177     enum KeyModifier {
178         None = 0,
179         Shift = 1 << 0,
180         Control = 1 << 1,
181         Alternate = 1 << 2,
182         Meta = 1 << 3,
183     };
184     String virtualKeyForKeySequence(const String& keySequence, KeyModifier&);
185     void performKeyboardInteractions(Vector<KeyboardInteraction>&&, Function<void (CommandResult&&)>&&);
186
187     struct InputSourceState {
188         enum class Type { Null, Key, Pointer };
189
190         Type type;
191         String subtype;
192         std::optional<MouseButton> pressedButton;
193         std::optional<String> pressedKey;
194         std::optional<String> pressedVirtualKey;
195     };
196     InputSourceState& inputSourceState(const String& id);
197
198     std::unique_ptr<SessionHost> m_host;
199     Seconds m_scriptTimeout;
200     Seconds m_pageLoadTimeout;
201     Seconds m_implicitWaitTimeout;
202     std::optional<String> m_toplevelBrowsingContext;
203     std::optional<String> m_currentBrowsingContext;
204     HashMap<String, InputSource> m_activeInputSources;
205     HashMap<String, InputSourceState> m_inputStateTable;
206 };
207
208 } // WebDriver