Web Automation: add command to asynchronously load the Web Inspector frontend in the background
https://bugs.webkit.org/show_bug.cgi?id=157509
Reviewed by Timothy Hatcher and Joseph Pecoraro.
In order to make it easier to debug code that executes as a result of an automation
command, this patch adds a new Automation command to asynchronously load the debugger
and Inspector frontend. It is designed for use by automation clients to implement an
auto-inspection feature to aid in debugging automation scripts.
* UIProcess/Automation/Automation.json: Add new command.
* UIProcess/Automation/WebAutomationSession.cpp:
(WebKit::WebAutomationSession::inspectBrowsingContext): Added.
(WebKit::WebAutomationSession::inspectorFrontendLoaded): Added.
This message is forwarded by WebInspectorProxy to the inspected page's session.
* UIProcess/Automation/WebAutomationSession.h:
* UIProcess/Cocoa/WebAutomationSessionCocoa.mm:
(WebKit::WebAutomationSession::sendSynthesizedEventsToPage):
Force the active automation window to become key and bring to front prior to
sending each NSEvent. This way, if the Inspector pauses while a command executes,
the automation window will get back focus when the Inspector unpauses just before
the next synthesized mouse or keyboard NSEvent is sent to its NSWindow.
* UIProcess/WebInspectorProxy.cpp:
(WebKit::WebInspectorProxy::frontendLoaded):
Forward to the inspected page's session.
* UIProcess/WebInspectorProxy.h:
* UIProcess/WebInspectorProxy.messages.in: Add notification of the frontend's load.
* WebProcess/WebPage/WebInspectorUI.cpp:
(WebKit::WebInspectorUI::frontendLoaded):
Kick off notifying the automation session in UIProcess that the inspector loaded.
(WebKit::WebInspectorUI::closeWindow):
In some circumstances, the Web Inspector can be loaded without showing
the window. If this hidden page closes, make sure the frontend host gets
a chance to disconnect its InspectorFrontendClient. Normally this happens
when the window closes, but unshown Inspectors do not get window instances.
git-svn-id: http://svn.webkit.org/repository/webkit/trunk@200702 268f45cc-cd09-0410-ab3c-d52691b4dbfc
diff --git a/Source/WebKit2/UIProcess/Automation/Automation.json b/Source/WebKit2/UIProcess/Automation/Automation.json
index 8e5b6fc..e1f58fc 100644
--- a/Source/WebKit2/UIProcess/Automation/Automation.json
+++ b/Source/WebKit2/UIProcess/Automation/Automation.json
@@ -294,6 +294,14 @@
"async": true
},
{
+ "name": "inspectBrowsingContext",
+ "description": "Inspect the specified browsing context using Web Inspector.",
+ "parameters": [
+ { "name": "handle", "$ref": "BrowsingContextHandle", "description": "The handle for the browsing context that should be inspected." }
+ ],
+ "async": true
+ },
+ {
"name": "evaluateJavaScriptFunction",
"description": "Evaluates a script function in a browsing context and calls it with the supplied arguments.",
"parameters": [
diff --git a/Source/WebKit2/UIProcess/Automation/WebAutomationSession.cpp b/Source/WebKit2/UIProcess/Automation/WebAutomationSession.cpp
index 079cb1a..4716f7a 100644
--- a/Source/WebKit2/UIProcess/Automation/WebAutomationSession.cpp
+++ b/Source/WebKit2/UIProcess/Automation/WebAutomationSession.cpp
@@ -31,6 +31,7 @@
#include "WebAutomationSessionMessages.h"
#include "WebAutomationSessionProxyMessages.h"
#include "WebCookieManagerProxy.h"
+#include "WebInspectorProxy.h"
#include "WebProcessPool.h"
#include <JavaScriptCore/InspectorBackendDispatcher.h>
#include <JavaScriptCore/InspectorFrontendRouter.h>
@@ -432,12 +433,34 @@
page->reload(reloadFromOrigin, contentBlockersEnabled);
}
+void WebAutomationSession::inspectBrowsingContext(Inspector::ErrorString& errorString, const String& handle, Ref<InspectBrowsingContextCallback>&& callback)
+{
+ WebPageProxy* page = webPageProxyForHandle(handle);
+ if (!page)
+ FAIL_WITH_PREDEFINED_ERROR(WindowNotFound);
+
+ if (auto callback = m_pendingInspectorCallbacksPerPage.take(page->pageID()))
+ callback->sendFailure(STRING_FOR_PREDEFINED_ERROR_NAME(Timeout));
+ m_pendingInspectorCallbacksPerPage.set(page->pageID(), WTFMove(callback));
+
+ // Don't bring the inspector to front since this may be done automatically.
+ // We just want it loaded so it can pause if a breakpoint is hit during a command.
+ if (page->inspector())
+ page->inspector()->connect();
+}
+
void WebAutomationSession::navigationOccurredForPage(const WebPageProxy& page)
{
if (auto callback = m_pendingNavigationInBrowsingContextCallbacksPerPage.take(page.pageID()))
callback->sendSuccess(InspectorObject::create());
}
+void WebAutomationSession::inspectorFrontendLoaded(const WebPageProxy& page)
+{
+ if (auto callback = m_pendingInspectorCallbacksPerPage.take(page.pageID()))
+ callback->sendSuccess(InspectorObject::create());
+}
+
void WebAutomationSession::evaluateJavaScriptFunction(Inspector::ErrorString& errorString, const String& browsingContextHandle, const String* optionalFrameHandle, const String& function, const Inspector::InspectorArray& arguments, const bool* optionalExpectsImplicitCallbackArgument, const int* optionalCallbackTimeout, Ref<EvaluateJavaScriptFunctionCallback>&& callback)
{
WebPageProxy* page = webPageProxyForHandle(browsingContextHandle);
diff --git a/Source/WebKit2/UIProcess/Automation/WebAutomationSession.h b/Source/WebKit2/UIProcess/Automation/WebAutomationSession.h
index e5afd33..7ca6a1e 100644
--- a/Source/WebKit2/UIProcess/Automation/WebAutomationSession.h
+++ b/Source/WebKit2/UIProcess/Automation/WebAutomationSession.h
@@ -83,6 +83,7 @@
void setProcessPool(WebProcessPool*);
void navigationOccurredForPage(const WebPageProxy&);
+ void inspectorFrontendLoaded(const WebPageProxy&);
#if ENABLE(REMOTE_INSPECTOR)
// Inspector::RemoteAutomationTarget API
@@ -104,6 +105,7 @@
void goBackInBrowsingContext(Inspector::ErrorString&, const String&, Ref<GoBackInBrowsingContextCallback>&&) override;
void goForwardInBrowsingContext(Inspector::ErrorString&, const String&, Ref<GoForwardInBrowsingContextCallback>&&) override;
void reloadBrowsingContext(Inspector::ErrorString&, const String&, Ref<ReloadBrowsingContextCallback>&&) override;
+ void inspectBrowsingContext(Inspector::ErrorString&, const String&, Ref<InspectBrowsingContextCallback>&&) override;
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;
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;
void performKeyboardInteractions(Inspector::ErrorString&, const String& handle, const Inspector::InspectorArray& interactions) override;
@@ -176,6 +178,8 @@
HashMap<uint64_t, RefPtr<Inspector::BackendDispatcher::CallbackBase>> m_pendingNavigationInBrowsingContextCallbacksPerPage;
+ HashMap<uint64_t, RefPtr<Inspector::BackendDispatcher::CallbackBase>> m_pendingInspectorCallbacksPerPage;
+
uint64_t m_nextEvaluateJavaScriptCallbackID { 1 };
HashMap<uint64_t, RefPtr<Inspector::AutomationBackendDispatcherHandler::EvaluateJavaScriptFunctionCallback>> m_evaluateJavaScriptFunctionCallbacks;
diff --git a/Source/WebKit2/UIProcess/Cocoa/WebAutomationSessionCocoa.mm b/Source/WebKit2/UIProcess/Cocoa/WebAutomationSessionCocoa.mm
index cd89caa..8069cc2 100644
--- a/Source/WebKit2/UIProcess/Cocoa/WebAutomationSessionCocoa.mm
+++ b/Source/WebKit2/UIProcess/Cocoa/WebAutomationSessionCocoa.mm
@@ -51,6 +51,10 @@
NSWindow *window = page.platformWindow();
for (NSEvent *event in eventsToSend) {
+ // Take focus back in case the Inspector became focused while the prior command or
+ // NSEvent was delivered to the window.
+ [window makeKeyAndOrderFront:nil];
+
markEventAsSynthesizedForAutomation(event);
[window sendEvent:event];
}
diff --git a/Source/WebKit2/UIProcess/WebInspectorProxy.cpp b/Source/WebKit2/UIProcess/WebInspectorProxy.cpp
index bb0a6dd..bc36ea3 100644
--- a/Source/WebKit2/UIProcess/WebInspectorProxy.cpp
+++ b/Source/WebKit2/UIProcess/WebInspectorProxy.cpp
@@ -32,6 +32,7 @@
#include "WKArray.h"
#include "WKContextMenuItem.h"
#include "WKMutableArray.h"
+#include "WebAutomationSession.h"
#include "WebFramePolicyListenerProxy.h"
#include "WebFrameProxy.h"
#include "WebInspectorMessages.h"
@@ -601,6 +602,12 @@
platformDidClose();
}
+void WebInspectorProxy::frontendLoaded()
+{
+ if (auto* automationSession = m_inspectedPage->process().processPool().automationSession())
+ automationSession->inspectorFrontendLoaded(*m_inspectedPage);
+}
+
void WebInspectorProxy::bringToFront()
{
// WebCore::InspectorFrontendClientLocal tells us to do this on load. We want to
diff --git a/Source/WebKit2/UIProcess/WebInspectorProxy.h b/Source/WebKit2/UIProcess/WebInspectorProxy.h
index c6bcea0..97ed29a 100644
--- a/Source/WebKit2/UIProcess/WebInspectorProxy.h
+++ b/Source/WebKit2/UIProcess/WebInspectorProxy.h
@@ -190,6 +190,7 @@
// Called by WebInspectorProxy messages
void createInspectorPage(IPC::Attachment, bool canAttach, bool underTest);
+ void frontendLoaded();
void didClose();
void bringToFront();
void attachAvailabilityChanged(bool);
diff --git a/Source/WebKit2/UIProcess/WebInspectorProxy.messages.in b/Source/WebKit2/UIProcess/WebInspectorProxy.messages.in
index 0193b72..c2ed782 100644
--- a/Source/WebKit2/UIProcess/WebInspectorProxy.messages.in
+++ b/Source/WebKit2/UIProcess/WebInspectorProxy.messages.in
@@ -23,6 +23,7 @@
messages -> WebInspectorProxy {
CreateInspectorPage(IPC::Attachment connectionIdentifier, bool canAttach, bool underTest)
+ FrontendLoaded()
DidClose()
BringToFront()
