WebDriver: Implement page load strategy
[WebKit-https.git] / Source / WebKit / UIProcess / Automation / WebAutomationSession.h
1 /*
2  * Copyright (C) 2016, 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 "APIObject.h"
29 #include "AutomationBackendDispatchers.h"
30 #include "AutomationFrontendDispatchers.h"
31 #include "Connection.h"
32 #include "ShareableBitmap.h"
33 #include "WebEvent.h"
34 #include <wtf/Forward.h>
35 #include <wtf/RunLoop.h>
36
37 #if ENABLE(REMOTE_INSPECTOR)
38 #include <JavaScriptCore/RemoteAutomationTarget.h>
39 #endif
40
41 namespace API {
42 class AutomationSessionClient;
43 }
44
45 namespace Inspector {
46 class BackendDispatcher;
47 class FrontendRouter;
48 }
49
50 namespace WebCore {
51 class IntPoint;
52 class IntRect;
53
54 struct Cookie;
55 }
56
57 #if PLATFORM(COCOA)
58 OBJC_CLASS NSArray;
59 typedef unsigned short unichar;
60 #endif
61
62 #if USE(APPKIT)
63 OBJC_CLASS NSEvent;
64 #endif
65
66 namespace API {
67 class OpenPanelParameters;
68 }
69
70 namespace WebKit {
71
72 class WebAutomationSessionClient;
73 class WebFrameProxy;
74 class WebOpenPanelResultListenerProxy;
75 class WebPageProxy;
76 class WebProcessPool;
77
78 class WebAutomationSession final : public API::ObjectImpl<API::Object::Type::AutomationSession>, public IPC::MessageReceiver
79 #if ENABLE(REMOTE_INSPECTOR)
80     , public Inspector::RemoteAutomationTarget
81 #endif
82     , public Inspector::AutomationBackendDispatcherHandler
83 {
84 public:
85     WebAutomationSession();
86     ~WebAutomationSession();
87
88     void setClient(std::unique_ptr<API::AutomationSessionClient>&&);
89
90     void setSessionIdentifier(const String& sessionIdentifier) { m_sessionIdentifier = sessionIdentifier; }
91     String sessionIdentifier() const { return m_sessionIdentifier; }
92
93     WebProcessPool* processPool() const { return m_processPool; }
94     void setProcessPool(WebProcessPool*);
95
96     void navigationOccurredForFrame(const WebFrameProxy&);
97     void documentLoadedForFrame(const WebFrameProxy&);
98     void inspectorFrontendLoaded(const WebPageProxy&);
99     void keyboardEventsFlushedForPage(const WebPageProxy&);
100     void willClosePage(const WebPageProxy&);
101     void handleRunOpenPanel(const WebPageProxy&, const WebFrameProxy&, const API::OpenPanelParameters&, WebOpenPanelResultListenerProxy&);
102
103 #if ENABLE(REMOTE_INSPECTOR)
104     // Inspector::RemoteAutomationTarget API
105     String name() const override { return m_sessionIdentifier; }
106     void dispatchMessageFromRemote(const String& message) override;
107     void connect(Inspector::FrontendChannel*, bool isAutomaticConnection = false, bool immediatelyPause = false) override;
108     void disconnect(Inspector::FrontendChannel*) override;
109 #endif
110     void terminate();
111
112     // Inspector::AutomationBackendDispatcherHandler API
113     // NOTE: the set of declarations included in this interface depend on the "platform" property in Automation.json
114     // and the --platform argument passed to the protocol bindings generator.
115
116     // Platform: Generic
117     void getBrowsingContexts(Inspector::ErrorString&, RefPtr<Inspector::Protocol::Array<Inspector::Protocol::Automation::BrowsingContext>>&) override;
118     void getBrowsingContext(Inspector::ErrorString&, const String&, RefPtr<Inspector::Protocol::Automation::BrowsingContext>&) override;
119     void createBrowsingContext(Inspector::ErrorString&, String*) override;
120     void closeBrowsingContext(Inspector::ErrorString&, const String&) override;
121     void switchToBrowsingContext(Inspector::ErrorString&, const String& browsingContextHandle, const String* optionalFrameHandle) override;
122     void resizeWindowOfBrowsingContext(Inspector::ErrorString&, const String& handle, const Inspector::InspectorObject& size) override;
123     void moveWindowOfBrowsingContext(Inspector::ErrorString&, const String& handle, const Inspector::InspectorObject& position) override;
124     void navigateBrowsingContext(Inspector::ErrorString&, const String& handle, const String& url, const String* optionalPageLoadStrategyString, const int* optionalPageLoadTimeout, Ref<NavigateBrowsingContextCallback>&&) override;
125     void goBackInBrowsingContext(Inspector::ErrorString&, const String&, const String* optionalPageLoadStrategyString, const int* optionalPageLoadTimeout, Ref<GoBackInBrowsingContextCallback>&&) override;
126     void goForwardInBrowsingContext(Inspector::ErrorString&, const String&, const String* optionalPageLoadStrategyString, const int* optionalPageLoadTimeout, Ref<GoForwardInBrowsingContextCallback>&&) override;
127     void reloadBrowsingContext(Inspector::ErrorString&, const String&, const String* optionalPageLoadStrategyString, const int* optionalPageLoadTimeout, Ref<ReloadBrowsingContextCallback>&&) override;
128     void waitForNavigationToComplete(Inspector::ErrorString&, const String& browsingContextHandle, const String* optionalFrameHandle, const String* optionalPageLoadStrategyString, const int* optionalPageLoadTimeout, Ref<WaitForNavigationToCompleteCallback>&&) override;
129     void evaluateJavaScriptFunction(Inspector::ErrorString&, const String& browsingContextHandle, const String* optionalFrameHandle, const String& function, const Inspector::InspectorArray& arguments, const bool* optionalExpectsImplicitCallbackArgument, const int* optionalCallbackTimeout, Ref<Inspector::AutomationBackendDispatcherHandler::EvaluateJavaScriptFunctionCallback>&&) override;
130     void performMouseInteraction(Inspector::ErrorString&, const String& handle, const Inspector::InspectorObject& requestedPosition, const String& mouseButton, const String& mouseInteraction, const Inspector::InspectorArray& keyModifiers, RefPtr<Inspector::Protocol::Automation::Point>& updatedPosition) override;
131     void performKeyboardInteractions(Inspector::ErrorString&, const String& handle, const Inspector::InspectorArray& interactions, Ref<PerformKeyboardInteractionsCallback>&&) override;
132     void takeScreenshot(Inspector::ErrorString&, const String& handle, Ref<Inspector::AutomationBackendDispatcherHandler::TakeScreenshotCallback>&&) override;
133     void resolveChildFrameHandle(Inspector::ErrorString&, const String& browsingContextHandle, const String* optionalFrameHandle, const int* optionalOrdinal, const String* optionalName, const String* optionalNodeHandle, Ref<ResolveChildFrameHandleCallback>&&) override;
134     void resolveParentFrameHandle(Inspector::ErrorString&, const String& browsingContextHandle, const String& frameHandle, Ref<ResolveParentFrameHandleCallback>&&) override;
135     void computeElementLayout(Inspector::ErrorString&, const String& browsingContextHandle, const String& frameHandle, const String& nodeHandle, const bool* optionalScrollIntoViewIfNeeded, const bool* useViewportCoordinates, Ref<Inspector::AutomationBackendDispatcherHandler::ComputeElementLayoutCallback>&&) override;
136     void isShowingJavaScriptDialog(Inspector::ErrorString&, const String& browsingContextHandle, bool* result) override;
137     void dismissCurrentJavaScriptDialog(Inspector::ErrorString&, const String& browsingContextHandle) override;
138     void acceptCurrentJavaScriptDialog(Inspector::ErrorString&, const String& browsingContextHandle) override;
139     void messageOfCurrentJavaScriptDialog(Inspector::ErrorString&, const String& browsingContextHandle, String* text) override;
140     void setUserInputForCurrentJavaScriptPrompt(Inspector::ErrorString&, const String& browsingContextHandle, const String& text) override;
141     void setFilesToSelectForFileUpload(Inspector::ErrorString&, const String& browsingContextHandle, const Inspector::InspectorArray& filenames) override;
142     void getAllCookies(Inspector::ErrorString&, const String& browsingContextHandle, Ref<GetAllCookiesCallback>&&) override;
143     void deleteSingleCookie(Inspector::ErrorString&, const String& browsingContextHandle, const String& cookieName, Ref<DeleteSingleCookieCallback>&&) override;
144     void addSingleCookie(Inspector::ErrorString&, const String& browsingContextHandle, const Inspector::InspectorObject& cookie, Ref<AddSingleCookieCallback>&&) override;
145     void deleteAllCookies(Inspector::ErrorString&, const String& browsingContextHandle) override;
146
147     // Platform: macOS
148 #if PLATFORM(MAC)
149     void inspectBrowsingContext(Inspector::ErrorString&, const String&, const bool* optionalEnableAutoCapturing, Ref<InspectBrowsingContextCallback>&&) override;
150 #endif
151
152     // Event Simulation Support.
153 #if PLATFORM(MAC)
154     bool wasEventSynthesizedForAutomation(NSEvent *);
155     void markEventAsSynthesizedForAutomation(NSEvent *);
156 #endif
157
158 private:
159     WebPageProxy* webPageProxyForHandle(const String&);
160     String handleForWebPageProxy(const WebPageProxy&);
161     RefPtr<Inspector::Protocol::Automation::BrowsingContext> buildBrowsingContextForPage(WebPageProxy&);
162
163     std::optional<uint64_t> webFrameIDForHandle(const String&);
164     String handleForWebFrameID(uint64_t frameID);
165     String handleForWebFrameProxy(const WebFrameProxy&);
166
167     void waitForNavigationToCompleteOnPage(WebPageProxy&, Inspector::Protocol::Automation::PageLoadStrategy, Seconds, Ref<Inspector::BackendDispatcher::CallbackBase>&&);
168     void waitForNavigationToCompleteOnFrame(WebFrameProxy&, Inspector::Protocol::Automation::PageLoadStrategy, Seconds, Ref<Inspector::BackendDispatcher::CallbackBase>&&);
169     void loadTimerFired();
170
171     // Implemented in generated WebAutomationSessionMessageReceiver.cpp.
172     void didReceiveMessage(IPC::Connection&, IPC::Decoder&) override;
173
174     // Called by WebAutomationSession messages.
175     void didEvaluateJavaScriptFunction(uint64_t callbackID, const String& result, const String& errorType);
176     void didResolveChildFrame(uint64_t callbackID, uint64_t frameID, const String& errorType);
177     void didResolveParentFrame(uint64_t callbackID, uint64_t frameID, const String& errorType);
178     void didComputeElementLayout(uint64_t callbackID, WebCore::IntRect, std::optional<WebCore::IntPoint>, bool isObscured, const String& errorType);
179     void didTakeScreenshot(uint64_t callbackID, const ShareableBitmap::Handle&, const String& errorType);
180     void didGetCookiesForFrame(uint64_t callbackID, Vector<WebCore::Cookie>, const String& errorType);
181     void didDeleteCookie(uint64_t callbackID, const String& errorType);
182
183     // Platform-dependent implementations.
184     void platformSimulateMouseInteraction(WebPageProxy&, const WebCore::IntPoint& viewPosition, Inspector::Protocol::Automation::MouseInteraction, Inspector::Protocol::Automation::MouseButton, WebEvent::Modifiers);
185     // Simulates a single virtual key being pressed, such as Control, F-keys, Numpad keys, etc. as allowed by the protocol.
186     void platformSimulateKeyStroke(WebPageProxy&, Inspector::Protocol::Automation::KeyboardInteractionType, Inspector::Protocol::Automation::VirtualKey);
187     // Simulates key presses to produce the codepoints in a string. One or more code points are delivered atomically at grapheme cluster boundaries.
188     void platformSimulateKeySequence(WebPageProxy&, const String&);
189     // Get base64 encoded PNG data from a bitmap.
190     std::optional<String> platformGetBase64EncodedPNGData(const ShareableBitmap::Handle&);
191
192 #if PLATFORM(COCOA)
193     // The type parameter of the NSArray argument is platform-dependent.
194     void sendSynthesizedEventsToPage(WebPageProxy&, NSArray *eventsToSend);
195
196     std::optional<unichar> charCodeForVirtualKey(Inspector::Protocol::Automation::VirtualKey) const;
197     std::optional<unichar> charCodeIgnoringModifiersForVirtualKey(Inspector::Protocol::Automation::VirtualKey) const;
198 #endif
199
200     WebProcessPool* m_processPool { nullptr };
201
202     std::unique_ptr<API::AutomationSessionClient> m_client;
203     String m_sessionIdentifier { ASCIILiteral("Untitled Session") };
204     Ref<Inspector::FrontendRouter> m_frontendRouter;
205     Ref<Inspector::BackendDispatcher> m_backendDispatcher;
206     Ref<Inspector::AutomationBackendDispatcher> m_domainDispatcher;
207     std::unique_ptr<Inspector::AutomationFrontendDispatcher> m_domainNotifier;
208
209     HashMap<uint64_t, String> m_webPageHandleMap;
210     HashMap<String, uint64_t> m_handleWebPageMap;
211     String m_activeBrowsingContextHandle;
212
213     HashMap<uint64_t, String> m_webFrameHandleMap;
214     HashMap<String, uint64_t> m_handleWebFrameMap;
215
216     HashMap<uint64_t, RefPtr<Inspector::BackendDispatcher::CallbackBase>> m_pendingNormalNavigationInBrowsingContextCallbacksPerPage;
217     HashMap<uint64_t, RefPtr<Inspector::BackendDispatcher::CallbackBase>> m_pendingEagerNavigationInBrowsingContextCallbacksPerPage;
218     HashMap<uint64_t, RefPtr<Inspector::BackendDispatcher::CallbackBase>> m_pendingNormalNavigationInBrowsingContextCallbacksPerFrame;
219     HashMap<uint64_t, RefPtr<Inspector::BackendDispatcher::CallbackBase>> m_pendingEagerNavigationInBrowsingContextCallbacksPerFrame;
220     HashMap<uint64_t, RefPtr<Inspector::BackendDispatcher::CallbackBase>> m_pendingInspectorCallbacksPerPage;
221     HashMap<uint64_t, RefPtr<Inspector::BackendDispatcher::CallbackBase>> m_pendingKeyboardEventsFlushedCallbacksPerPage;
222
223     uint64_t m_nextEvaluateJavaScriptCallbackID { 1 };
224     HashMap<uint64_t, RefPtr<Inspector::AutomationBackendDispatcherHandler::EvaluateJavaScriptFunctionCallback>> m_evaluateJavaScriptFunctionCallbacks;
225
226     uint64_t m_nextResolveFrameCallbackID { 1 };
227     HashMap<uint64_t, RefPtr<Inspector::AutomationBackendDispatcherHandler::ResolveChildFrameHandleCallback>> m_resolveChildFrameHandleCallbacks;
228
229     uint64_t m_nextResolveParentFrameCallbackID { 1 };
230     HashMap<uint64_t, RefPtr<Inspector::AutomationBackendDispatcherHandler::ResolveParentFrameHandleCallback>> m_resolveParentFrameHandleCallbacks;
231
232     uint64_t m_nextComputeElementLayoutCallbackID { 1 };
233     HashMap<uint64_t, RefPtr<Inspector::AutomationBackendDispatcherHandler::ComputeElementLayoutCallback>> m_computeElementLayoutCallbacks;
234
235     uint64_t m_nextScreenshotCallbackID { 1 };
236     HashMap<uint64_t, RefPtr<Inspector::AutomationBackendDispatcherHandler::TakeScreenshotCallback>> m_screenshotCallbacks;
237
238     uint64_t m_nextGetCookiesCallbackID { 1 };
239     HashMap<uint64_t, RefPtr<Inspector::AutomationBackendDispatcherHandler::GetAllCookiesCallback>> m_getCookieCallbacks;
240
241     uint64_t m_nextDeleteCookieCallbackID { 1 };
242     HashMap<uint64_t, RefPtr<Inspector::AutomationBackendDispatcherHandler::DeleteSingleCookieCallback>> m_deleteCookieCallbacks;
243
244     RunLoop::Timer<WebAutomationSession> m_loadTimer;
245     Vector<String> m_filesToSelectForFileUpload;
246
247 #if ENABLE(REMOTE_INSPECTOR)
248     Inspector::FrontendChannel* m_remoteChannel { nullptr };
249 #endif
250
251 #if PLATFORM(IOS) || PLATFORM(GTK)
252     // Keep track of currently active modifiers across multiple keystrokes.
253     // We don't synthesize platform keyboard events on iOS, so we need to track it ourselves.
254     // GTK+ doesn't keep track of the active modifiers when using synthesized events.
255     unsigned m_currentModifiers { 0 };
256 #endif
257 };
258
259 } // namespace WebKit