<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[196980] trunk/Source</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.webkit.org/projects/webkit/changeset/196980">196980</a></dd>
<dt>Author</dt> <dd>bburg@apple.com</dd>
<dt>Date</dt> <dd>2016-02-23 09:40:20 -0800 (Tue, 23 Feb 2016)</dd>
</dl>
<h3>Log Message</h3>
<pre>Connect WebAutomationSession to its backend dispatcher as if it were an agent and add stub implementations
https://bugs.webkit.org/show_bug.cgi?id=154518
<rdar://problem/24761096>
Reviewed by Timothy Hatcher.
Source/JavaScriptCore:
* inspector/InspectorBackendDispatcher.h:
Export all the classes since they are used by WebKit::WebAutomationSession.
Source/WebKit2:
Add a domain dispatcher for the 'Automation' domain, and register the
WebAutomationSession itself as the handler for Automation commands.
Stub out these command implementations so the code will compile.
* UIProcess/Automation/Automation.json:
Fix the createWindow command's parameters and description.
Add an ErrorMessage string enumeration and document how it can be used
to signal well-known errors to the frontend.
* UIProcess/Automation/WebAutomationSession.cpp:
(WebKit::WebAutomationSession::WebAutomationSession):
Add the domain backend dispatcher. It further parses commands that were deemed
valid by the generic dispatcher and match the 'Automation' domain prefix.
(WebKit::WebAutomationSession::getWindows):
(WebKit::WebAutomationSession::openWindow):
(WebKit::WebAutomationSession::closeWindow):
Stub these out with our new ErrorMessage enumeration and a macro to
make this code pattern more readable.
* UIProcess/Automation/WebAutomationSession.h:
Add new declarations and members.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkSourceJavaScriptCoreChangeLog">trunk/Source/JavaScriptCore/ChangeLog</a></li>
<li><a href="#trunkSourceJavaScriptCoreinspectorInspectorBackendDispatcherh">trunk/Source/JavaScriptCore/inspector/InspectorBackendDispatcher.h</a></li>
<li><a href="#trunkSourceWebKit2ChangeLog">trunk/Source/WebKit2/ChangeLog</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAutomationAutomationjson">trunk/Source/WebKit2/UIProcess/Automation/Automation.json</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAutomationWebAutomationSessioncpp">trunk/Source/WebKit2/UIProcess/Automation/WebAutomationSession.cpp</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAutomationWebAutomationSessionh">trunk/Source/WebKit2/UIProcess/Automation/WebAutomationSession.h</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkSourceJavaScriptCoreChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Source/JavaScriptCore/ChangeLog (196979 => 196980)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/JavaScriptCore/ChangeLog 2016-02-23 17:38:38 UTC (rev 196979)
+++ trunk/Source/JavaScriptCore/ChangeLog 2016-02-23 17:40:20 UTC (rev 196980)
</span><span class="lines">@@ -1,3 +1,14 @@
</span><ins>+2016-02-23 Brian Burg <bburg@apple.com>
+
+ Connect WebAutomationSession to its backend dispatcher as if it were an agent and add stub implementations
+ https://bugs.webkit.org/show_bug.cgi?id=154518
+ <rdar://problem/24761096>
+
+ Reviewed by Timothy Hatcher.
+
+ * inspector/InspectorBackendDispatcher.h:
+ Export all the classes since they are used by WebKit::WebAutomationSession.
+
</ins><span class="cx"> 2016-02-22 Brian Burg <bburg@apple.com>
</span><span class="cx">
</span><span class="cx"> Web Inspector: add 'Automation' protocol domain and generate its backend classes separately in WebKit2
</span></span></pre></div>
<a id="trunkSourceJavaScriptCoreinspectorInspectorBackendDispatcherh"></a>
<div class="modfile"><h4>Modified: trunk/Source/JavaScriptCore/inspector/InspectorBackendDispatcher.h (196979 => 196980)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/JavaScriptCore/inspector/InspectorBackendDispatcher.h 2016-02-23 17:38:38 UTC (rev 196979)
+++ trunk/Source/JavaScriptCore/inspector/InspectorBackendDispatcher.h 2016-02-23 17:40:20 UTC (rev 196980)
</span><span class="lines">@@ -39,7 +39,7 @@
</span><span class="cx">
</span><span class="cx"> typedef String ErrorString;
</span><span class="cx">
</span><del>-class SupplementalBackendDispatcher : public RefCounted<SupplementalBackendDispatcher> {
</del><ins>+class JS_EXPORT_PRIVATE SupplementalBackendDispatcher : public RefCounted<SupplementalBackendDispatcher> {
</ins><span class="cx"> public:
</span><span class="cx"> SupplementalBackendDispatcher(BackendDispatcher&);
</span><span class="cx"> virtual ~SupplementalBackendDispatcher();
</span><span class="lines">@@ -48,9 +48,9 @@
</span><span class="cx"> Ref<BackendDispatcher> m_backendDispatcher;
</span><span class="cx"> };
</span><span class="cx">
</span><del>-class BackendDispatcher : public RefCounted<BackendDispatcher> {
</del><ins>+class JS_EXPORT_PRIVATE BackendDispatcher : public RefCounted<BackendDispatcher> {
</ins><span class="cx"> public:
</span><del>- JS_EXPORT_PRIVATE static Ref<BackendDispatcher> create(Ref<FrontendRouter>&&);
</del><ins>+ static Ref<BackendDispatcher> create(Ref<FrontendRouter>&&);
</ins><span class="cx">
</span><span class="cx"> class JS_EXPORT_PRIVATE CallbackBase : public RefCounted<CallbackBase> {
</span><span class="cx"> public:
</span><span class="lines">@@ -82,13 +82,13 @@
</span><span class="cx"> };
</span><span class="cx">
</span><span class="cx"> void registerDispatcherForDomain(const String& domain, SupplementalBackendDispatcher*);
</span><del>- JS_EXPORT_PRIVATE void dispatch(const String& message);
</del><ins>+ void dispatch(const String& message);
</ins><span class="cx">
</span><del>- JS_EXPORT_PRIVATE void sendResponse(long requestId, RefPtr<InspectorObject>&& result);
- JS_EXPORT_PRIVATE void sendPendingErrors();
</del><ins>+ void sendResponse(long requestId, RefPtr<InspectorObject>&& result);
+ void sendPendingErrors();
</ins><span class="cx">
</span><span class="cx"> void reportProtocolError(CommonErrorCode, const String& errorMessage);
</span><del>- JS_EXPORT_PRIVATE void reportProtocolError(Optional<long> relatedRequestId, CommonErrorCode, const String& errorMessage);
</del><ins>+ void reportProtocolError(Optional<long> relatedRequestId, CommonErrorCode, const String& errorMessage);
</ins><span class="cx">
</span><span class="cx"> template<typename T>
</span><span class="cx"> T getPropertyValue(InspectorObject*, const String& name, bool* out_optionalValueFound, T defaultValue, std::function<bool(InspectorValue&, T&)>, const char* typeName);
</span></span></pre></div>
<a id="trunkSourceWebKit2ChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/ChangeLog (196979 => 196980)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/ChangeLog 2016-02-23 17:38:38 UTC (rev 196979)
+++ trunk/Source/WebKit2/ChangeLog 2016-02-23 17:40:20 UTC (rev 196980)
</span><span class="lines">@@ -1,3 +1,34 @@
</span><ins>+2016-02-23 Brian Burg <bburg@apple.com>
+
+ Connect WebAutomationSession to its backend dispatcher as if it were an agent and add stub implementations
+ https://bugs.webkit.org/show_bug.cgi?id=154518
+ <rdar://problem/24761096>
+
+ Reviewed by Timothy Hatcher.
+
+ Add a domain dispatcher for the 'Automation' domain, and register the
+ WebAutomationSession itself as the handler for Automation commands.
+ Stub out these command implementations so the code will compile.
+
+ * UIProcess/Automation/Automation.json:
+ Fix the createWindow command's parameters and description.
+ Add an ErrorMessage string enumeration and document how it can be used
+ to signal well-known errors to the frontend.
+
+ * UIProcess/Automation/WebAutomationSession.cpp:
+ (WebKit::WebAutomationSession::WebAutomationSession):
+ Add the domain backend dispatcher. It further parses commands that were deemed
+ valid by the generic dispatcher and match the 'Automation' domain prefix.
+
+ (WebKit::WebAutomationSession::getWindows):
+ (WebKit::WebAutomationSession::openWindow):
+ (WebKit::WebAutomationSession::closeWindow):
+ Stub these out with our new ErrorMessage enumeration and a macro to
+ make this code pattern more readable.
+
+ * UIProcess/Automation/WebAutomationSession.h:
+ Add new declarations and members.
+
</ins><span class="cx"> 2016-02-23 Antti Koivisto <antti@apple.com>
</span><span class="cx">
</span><span class="cx"> Remove tab suspension code
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAutomationAutomationjson"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/Automation/Automation.json (196979 => 196980)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/Automation/Automation.json 2016-02-23 17:38:38 UTC (rev 196979)
+++ trunk/Source/WebKit2/UIProcess/Automation/Automation.json 2016-02-23 17:40:20 UTC (rev 196980)
</span><span class="lines">@@ -8,6 +8,14 @@
</span><span class="cx"> "description": "An opaque identifier for a window."
</span><span class="cx"> },
</span><span class="cx"> {
</span><ins>+ "id": "ErrorMessage",
+ "type": "string",
+ "enum": [
+ "NotImplemented"
+ ],
+ "description": "This enum contains predefined error messages that can be used to signal a well-defined error condition, such as a missing implementation, unknown window handle, and so forth. The backend signals one of these errors by using it as a prefix of the commands's error message (the errorString argument in generated C++ backend dispatchers). This will be reported to the frontend as a protocol error with a JSON-RPC error code of 'ServerError'. It is up to the frontend whether and how to deal with errors."
+ },
+ {
</ins><span class="cx"> "id": "BrowsingWindow",
</span><span class="cx"> "type": "object",
</span><span class="cx"> "description": "A handle representing an open window or tab in the automation session.",
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAutomationWebAutomationSessioncpp"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/Automation/WebAutomationSession.cpp (196979 => 196980)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/Automation/WebAutomationSession.cpp 2016-02-23 17:38:38 UTC (rev 196979)
+++ trunk/Source/WebKit2/UIProcess/Automation/WebAutomationSession.cpp 2016-02-23 17:40:20 UTC (rev 196980)
</span><span class="lines">@@ -27,20 +27,27 @@
</span><span class="cx"> #include "WebAutomationSession.h"
</span><span class="cx">
</span><span class="cx"> #include "APIAutomationSessionClient.h"
</span><ins>+#include "InspectorProtocolObjects.h"
</ins><span class="cx"> #include <JavaScriptCore/InspectorBackendDispatcher.h>
</span><span class="cx"> #include <JavaScriptCore/InspectorFrontendRouter.h>
</span><span class="cx">
</span><span class="cx"> using namespace Inspector;
</span><span class="cx">
</span><ins>+#define FAIL_WITH_PREDEFINED_ERROR_MESSAGE(messageName) \
+do { \
+ auto enumValue = Inspector::Protocol::Automation::ErrorMessage::messageName; \
+ errorString = Inspector::Protocol::getEnumConstantValue(enumValue); \
+ return; \
+} while (false)
+
</ins><span class="cx"> namespace WebKit {
</span><span class="cx">
</span><span class="cx"> WebAutomationSession::WebAutomationSession()
</span><span class="cx"> : m_client(std::make_unique<API::AutomationSessionClient>())
</span><span class="cx"> , m_frontendRouter(FrontendRouter::create())
</span><span class="cx"> , m_backendDispatcher(BackendDispatcher::create(m_frontendRouter.copyRef()))
</span><ins>+ , m_domainDispatcher(AutomationBackendDispatcher::create(m_backendDispatcher, this))
</ins><span class="cx"> {
</span><del>- // FIXME: to actually handle incoming commands, an agent needs to be created
- // and registered with the backend dispatcher in the constructor.
</del><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> WebAutomationSession::~WebAutomationSession()
</span><span class="lines">@@ -90,4 +97,21 @@
</span><span class="cx">
</span><span class="cx"> #endif // ENABLE(REMOTE_INSPECTOR)
</span><span class="cx">
</span><ins>+// Inspector::AutomationBackendDispatcherHandler API
+
+void WebAutomationSession::getWindows(Inspector::ErrorString& errorString, RefPtr<Inspector::Protocol::Array<Inspector::Protocol::Automation::BrowsingWindow>>& out_windows)
+{
+ FAIL_WITH_PREDEFINED_ERROR_MESSAGE(NotImplemented);
+}
+
+void WebAutomationSession::openWindow(Inspector::ErrorString& errorString)
+{
+ FAIL_WITH_PREDEFINED_ERROR_MESSAGE(NotImplemented);
+}
+
+void WebAutomationSession::closeWindow(Inspector::ErrorString& errorString, const String& in_handle)
+{
+ FAIL_WITH_PREDEFINED_ERROR_MESSAGE(NotImplemented);
+}
+
</ins><span class="cx"> } // namespace WebKit
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAutomationWebAutomationSessionh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/Automation/WebAutomationSession.h (196979 => 196980)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/Automation/WebAutomationSession.h 2016-02-23 17:38:38 UTC (rev 196979)
+++ trunk/Source/WebKit2/UIProcess/Automation/WebAutomationSession.h 2016-02-23 17:40:20 UTC (rev 196980)
</span><span class="lines">@@ -27,6 +27,7 @@
</span><span class="cx"> #define WebAutomationSession_h
</span><span class="cx">
</span><span class="cx"> #include "APIObject.h"
</span><ins>+#include "InspectorBackendDispatchers.h"
</ins><span class="cx"> #include <wtf/Forward.h>
</span><span class="cx">
</span><span class="cx"> #if ENABLE(REMOTE_INSPECTOR)
</span><span class="lines">@@ -50,6 +51,7 @@
</span><span class="cx"> #if ENABLE(REMOTE_INSPECTOR)
</span><span class="cx"> , public Inspector::RemoteAutomationTarget
</span><span class="cx"> #endif
</span><ins>+ , public Inspector::AutomationBackendDispatcherHandler
</ins><span class="cx"> {
</span><span class="cx"> public:
</span><span class="cx"> WebAutomationSession();
</span><span class="lines">@@ -68,11 +70,17 @@
</span><span class="cx"> virtual void disconnect(Inspector::FrontendChannel*) override;
</span><span class="cx"> #endif
</span><span class="cx">
</span><ins>+ // Inspector::AutomationBackendDispatcherHandler API
+ virtual void getWindows(Inspector::ErrorString&, RefPtr<Inspector::Protocol::Array<Inspector::Protocol::Automation::BrowsingWindow>>& out_windows) override;
+ virtual void openWindow(Inspector::ErrorString&) override;
+ virtual void closeWindow(Inspector::ErrorString&, const String& in_handle) override;
+
</ins><span class="cx"> private:
</span><span class="cx"> std::unique_ptr<API::AutomationSessionClient> m_client;
</span><span class="cx"> String m_sessionIdentifier { ASCIILiteral("Untitled Session") };
</span><span class="cx"> Ref<Inspector::FrontendRouter> m_frontendRouter;
</span><span class="cx"> Ref<Inspector::BackendDispatcher> m_backendDispatcher;
</span><ins>+ Ref<Inspector::AutomationBackendDispatcher> m_domainDispatcher;
</ins><span class="cx">
</span><span class="cx"> #if ENABLE(REMOTE_INSPECTOR)
</span><span class="cx"> Inspector::FrontendChannel* m_remoteChannel { nullptr };
</span></span></pre>
</div>
</div>
</body>
</html>