[GTK][WPE] Add API to provide browser information required by automation

https://bugs.webkit.org/show_bug.cgi?id=175130

Source/JavaScriptCore:

Reviewed by Brian Burg.

Add browserName and browserVersion to RemoteInspector::Client::Capabilities and virtual methods to the Client to
get them.

* inspector/remote/RemoteInspector.cpp:
(Inspector::RemoteInspector::updateClientCapabilities): Update also browserName and browserVersion.
* inspector/remote/RemoteInspector.h:
* inspector/remote/glib/RemoteInspectorGlib.cpp:
(Inspector::RemoteInspector::requestAutomationSession): Call updateClientCapabilities() after the session is
requested to ensure they are updated before StartAutomationSession reply is sent.
* inspector/remote/glib/RemoteInspectorServer.cpp: Add browserName and browserVersion as return values of
StartAutomationSession mesasage.

Source/WebDriver:

Reviewed by Brian Burg.

* Session.cpp:
(WebDriver::Session::createTopLevelBrowsingContext): Check if startAutomationSession and complete the command
with error in that case.
* SessionHost.h:
* glib/SessionHostGlib.cpp:
(WebDriver::SessionHost::matchCapabilities): Match the capabilities that are known only after the browser has
been launched.
(WebDriver::SessionHost::startAutomationSession): Handle the StartAutomationSession response, extracting the
capabilities and calling matchCapabilities() to match them.
(WebDriver::SessionHost::setTargetList): Return early if the session was rejected before due to invalid
capabilities.

Source/WebKit:

Reviewed by Michael Catanzaro.

When a new automation session is started, the web driver receives some required capabilities from the client,
like browser name and version. The session should be rejected if those required capabilities don't match with
the actual browser that is launched. We don't know that information in WebKit, so we need to add API so that
users can provide it when a new session request is made. This patch adds boxed object WebKitApplicationInfo that
can be used to set the application name and version. This object can be set to a WebKitAutomationSession when
WebKitWebContext::automation-started signal is emitted.

* PlatformGTK.cmake:
* PlatformWPE.cmake:
* UIProcess/API/glib/WebKitApplicationInfo.cpp: Added.
(webkit_application_info_new):
(webkit_application_info_ref):
(webkit_application_info_unref):
(webkit_application_info_set_name):
(webkit_application_info_get_name):
(webkit_application_info_set_version):
(webkit_application_info_get_version):
* UIProcess/API/glib/WebKitAutomationSession.cpp:
(webkitAutomationSessionDispose):
(webkit_automation_session_class_init):
(webkitAutomationSessionGetBrowserName):
(webkitAutomationSessionGetBrowserVersion):
(webkit_automation_session_set_application_info):
(webkit_automation_session_get_application_info):
* UIProcess/API/glib/WebKitAutomationSessionPrivate.h:
* UIProcess/API/glib/WebKitWebContext.cpp:
* UIProcess/API/gtk/WebKitApplicationInfo.h: Added.
* UIProcess/API/gtk/WebKitAutomationSession.h:
* UIProcess/API/gtk/docs/webkit2gtk-4.0-sections.txt:
* UIProcess/API/gtk/docs/webkit2gtk-docs.sgml:
* UIProcess/API/gtk/webkit2.h:
* UIProcess/API/wpe/WebKitApplicationInfo.h: Added.
* UIProcess/API/wpe/WebKitAutomationSession.h:
* UIProcess/API/wpe/webkit.h:

Tools:

Reviewed by Michael Catanzaro.

* MiniBrowser/gtk/main.c:
(automationStartedCallback): Set browser information when a new automation session is started.
* TestWebKitAPI/Tests/WebKitGLib/TestAutomationSession.cpp:
(testAutomationSessionApplicationInfo):
(beforeAll):

git-svn-id: http://svn.webkit.org/repository/webkit/trunk@220329 268f45cc-cd09-0410-ab3c-d52691b4dbfc

Author: [email protected]

Source/JavaScriptCore/ChangeLog

@@ -1,3 +1,22 @@
+2017-08-05  Carlos Garcia Campos  <[email protected]>
+
+        [GTK][WPE] Add API to provide browser information required by automation
+        https://bugs.webkit.org/show_bug.cgi?id=175130
+
+        Reviewed by Brian Burg.
+
+        Add browserName and browserVersion to RemoteInspector::Client::Capabilities and virtual methods to the Client to
+        get them.
+
+        * inspector/remote/RemoteInspector.cpp:
+        (Inspector::RemoteInspector::updateClientCapabilities): Update also browserName and browserVersion.
+        * inspector/remote/RemoteInspector.h:
+        * inspector/remote/glib/RemoteInspectorGlib.cpp:
+        (Inspector::RemoteInspector::requestAutomationSession): Call updateClientCapabilities() after the session is
+        requested to ensure they are updated before StartAutomationSession reply is sent.
+        * inspector/remote/glib/RemoteInspectorServer.cpp: Add browserName and browserVersion as return values of
+        StartAutomationSession mesasage.
+
 2017-08-06  Yusuke Suzuki  <[email protected]>
 
         Promise resolve and reject function should have length = 1

Source/JavaScriptCore/inspector/remote/RemoteInspector.cpp

@@ -133,7 +133,9 @@ void RemoteInspector::updateClientCapabilities()
         m_clientCapabilities = std::nullopt;
     else {
         RemoteInspector::Client::Capabilities updatedCapabilities = {
-            m_client->remoteAutomationAllowed() // remoteAutomationAllowed
+            m_client->remoteAutomationAllowed(),
+            m_client->browserName(),
+            m_client->browserVersion()
         };
 
         m_clientCapabilities = updatedCapabilities;

Source/JavaScriptCore/inspector/remote/RemoteInspector.h

@@ -30,6 +30,7 @@
 #include <wtf/Forward.h>
 #include <wtf/HashMap.h>
 #include <wtf/Lock.h>
+#include <wtf/text/WTFString.h>
 
 #if PLATFORM(COCOA)
 #include "RemoteInspectorXPCConnection.h"
@@ -66,10 +67,14 @@ class JS_EXPORT_PRIVATE RemoteInspector final
     public:
         struct Capabilities {
             bool remoteAutomationAllowed : 1;
+            String browserName;
+            String browserVersion;
         };
 
         virtual ~Client() { }
         virtual bool remoteAutomationAllowed() const = 0;
+        virtual String browserName() const { return { }; }
+        virtual String browserVersion() const { return { }; }
         virtual void requestAutomationSession(const String& sessionIdentifier) = 0;
     };
 
@@ -85,6 +90,7 @@ class JS_EXPORT_PRIVATE RemoteInspector final
     RemoteInspector::Client* client() const { return m_client; }
     void setClient(RemoteInspector::Client*);
     void clientCapabilitiesDidChange();
+    std::optional<RemoteInspector::Client::Capabilities> clientCapabilities() const { return m_clientCapabilities; }
 
     void setupFailed(unsigned targetIdentifier);
     void setupCompleted(unsigned targetIdentifier);

Source/JavaScriptCore/inspector/remote/glib/RemoteInspectorGlib.cpp

@@ -355,6 +355,7 @@ void RemoteInspector::requestAutomationSession(const char* sessionID)
         return;
 
     m_client->requestAutomationSession(String::fromUTF8(sessionID));
+    updateClientCapabilities();
 }
 
 } // namespace Inspector

Source/JavaScriptCore/inspector/remote/glib/RemoteInspectorServer.cpp

@@ -79,6 +79,8 @@ static const char introspectionXML[] =
     "    </method>"
     "    <method name='StartAutomationSession'>"
     "      <arg type='s' name='sessionID' direction='in'/>"
+    "      <arg type='s' name='browserName' direction='out'/>"
+    "      <arg type='s' name='browserVersion' direction='out'/>"
     "    </method>"
     "  </interface>"
     "</node>";
@@ -121,7 +123,10 @@ const GDBusInterfaceVTable RemoteInspectorServer::s_interfaceVTable = {
             const char* sessionID;
             g_variant_get(parameters, "(&s)", &sessionID);
             inspectorServer->startAutomationSession(connection, sessionID);
-            g_dbus_method_invocation_return_value(invocation, nullptr);
+            auto capabilities = RemoteInspector::singleton().clientCapabilities();
+            g_dbus_method_invocation_return_value(invocation, g_variant_new("(ss)",
+                capabilities ? capabilities->browserName.utf8().data() : "",
+                capabilities ? capabilities->browserVersion.utf8().data() : ""));
         } else
             g_dbus_method_invocation_return_value(invocation, nullptr);
     },

Source/WebDriver/ChangeLog

@@ -1,3 +1,22 @@
+2017-08-05  Carlos Garcia Campos  <[email protected]>
+
+        [GTK][WPE] Add API to provide browser information required by automation
+        https://bugs.webkit.org/show_bug.cgi?id=175130
+
+        Reviewed by Brian Burg.
+
+        * Session.cpp:
+        (WebDriver::Session::createTopLevelBrowsingContext): Check if startAutomationSession and complete the command
+        with error in that case.
+        * SessionHost.h:
+        * glib/SessionHostGlib.cpp:
+        (WebDriver::SessionHost::matchCapabilities): Match the capabilities that are known only after the browser has
+        been launched.
+        (WebDriver::SessionHost::startAutomationSession): Handle the StartAutomationSession response, extracting the
+        capabilities and calling matchCapabilities() to match them.
+        (WebDriver::SessionHost::setTargetList): Return early if the session was rejected before due to invalid
+        capabilities.
+
 2017-08-05  Carlos Garcia Campos  <[email protected]>
 
         WebDriver: Implement page load strategy

Source/WebDriver/Session.cpp

@@ -122,7 +122,11 @@ std::optional<String> Session::pageLoadStrategyString() const
 void Session::createTopLevelBrowsingContext(Function<void (CommandResult&&)>&& completionHandler)
 {
     ASSERT(!m_toplevelBrowsingContext.value());
-    m_host->startAutomationSession(m_id, [this, protectedThis = makeRef(*this), completionHandler = WTFMove(completionHandler)]() mutable {
+    m_host->startAutomationSession(m_id, [this, protectedThis = makeRef(*this), completionHandler = WTFMove(completionHandler)](std::optional<String> errorMessage) mutable {
+        if (errorMessage) {
+            completionHandler(CommandResult::fail(CommandResult::ErrorCode::UnknownError, errorMessage.value()));
+            return;
+        }
         m_host->sendCommandToBackend(ASCIILiteral("createBrowsingContext"), nullptr, [this, protectedThis = makeRef(*this), completionHandler = WTFMove(completionHandler)](SessionHost::CommandResponse&& response) mutable {
             if (response.isError || !response.responseObject) {
                 completionHandler(CommandResult::fail(WTFMove(response.responseObject)));

Source/WebDriver/SessionHost.h

@@ -56,7 +56,7 @@ class SessionHost {
 
     enum class Succeeded { No, Yes };
     void connectToBrowser(Function<void (Succeeded)>&&);
-    void startAutomationSession(const String& sessionID, Function<void ()>&&);
+    void startAutomationSession(const String& sessionID, Function<void (std::optional<String>)>&&);
 
     struct CommandResponse {
         RefPtr<Inspector::InspectorObject> responseObject;
@@ -80,6 +80,7 @@ class SessionHost {
     static const GDBusInterfaceVTable s_interfaceVTable;
     void launchBrowser(Function<void (Succeeded)>&&);
     void connectToBrowser(std::unique_ptr<ConnectToBrowserAsyncData>&&);
+    std::optional<String> matchCapabilities(GVariant*);
     void setupConnection(GRefPtr<GDBusConnection>&&, Function<void (Succeeded)>&&);
     void setTargetList(uint64_t connectionID, Vector<Target>&&);
     void sendMessageToFrontend(uint64_t connectionID, uint64_t targetID, const char* message);
@@ -94,7 +95,7 @@ class SessionHost {
     long m_closeMessageID { 0 };
 
 #if USE(GLIB)
-    Function<void ()> m_startSessionCompletionHandler;
+    Function<void (std::optional<String>)> m_startSessionCompletionHandler;
     GRefPtr<GSubprocess> m_browser;
     GRefPtr<GDBusConnection> m_dbusConnection;
     GRefPtr<GCancellable> m_cancellable;

Source/WebDriver/glib/SessionHostGlib.cpp

@@ -26,6 +26,7 @@
 #include "config.h"
 #include "SessionHost.h"
 
+#include "WebDriverService.h"
 #include <gio/gio.h>
 #include <wtf/RunLoop.h>
 #include <wtf/glib/GUniquePtr.h>
@@ -220,19 +221,59 @@ void SessionHost::setupConnection(GRefPtr<GDBusConnection>&& connection, Functio
     completionHandler(Succeeded::Yes);
 }
 
-void SessionHost::startAutomationSession(const String& sessionID, Function<void ()>&& completionHandler)
+std::optional<String> SessionHost::matchCapabilities(GVariant* capabilities)
+{
+    const char* browserName;
+    const char* browserVersion;
+    g_variant_get(capabilities, "(&s&s)", &browserName, &browserVersion);
+
+    if (m_capabilities.browserName) {
+        if (m_capabilities.browserName.value() != browserName)
+            return makeString("expected browserName ", m_capabilities.browserName.value(), " but got ", browserName);
+    } else
+        m_capabilities.browserName = String(browserName);
+
+    if (m_capabilities.browserVersion) {
+        if (!WebDriverService::platformCompareBrowserVersions(m_capabilities.browserVersion.value(), browserVersion))
+            return makeString("requested browserVersion is ", m_capabilities.browserVersion.value(), " but actual version is ", browserVersion);
+    } else
+        m_capabilities.browserVersion = String(browserVersion);
+
+    return std::nullopt;
+}
+
+void SessionHost::startAutomationSession(const String& sessionID, Function<void (std::optional<String>)>&& completionHandler)
 {
     ASSERT(m_dbusConnection);
     ASSERT(!m_startSessionCompletionHandler);
-    // FIXME: Make StartAutomationSession return browser information and we use it to match capabilities.
     m_startSessionCompletionHandler = WTFMove(completionHandler);
     g_dbus_connection_call(m_dbusConnection.get(), nullptr,
         INSPECTOR_DBUS_OBJECT_PATH,
         INSPECTOR_DBUS_INTERFACE,
         "StartAutomationSession",
         g_variant_new("(s)", sessionID.utf8().data()),
         nullptr, G_DBUS_CALL_FLAGS_NO_AUTO_START,
-        -1, m_cancellable.get(), dbusConnectionCallAsyncReadyCallback, nullptr);
+        -1, m_cancellable.get(), [](GObject* source, GAsyncResult* result, gpointer userData) {
+            GUniqueOutPtr<GError> error;
+            GRefPtr<GVariant> resultVariant = adoptGRef(g_dbus_connection_call_finish(G_DBUS_CONNECTION(source), result, &error.outPtr()));
+            if (!resultVariant && g_error_matches(error.get(), G_IO_ERROR, G_IO_ERROR_CANCELLED))
+                return;
+
+            auto sessionHost = static_cast<SessionHost*>(userData);
+            if (!resultVariant) {
+                auto completionHandler = std::exchange(sessionHost->m_startSessionCompletionHandler, nullptr);
+                completionHandler(String("Failed to start automation session"));
+                return;
+            }
+
+            auto errorString = sessionHost->matchCapabilities(resultVariant.get());
+            if (errorString) {
+                auto completionHandler = std::exchange(sessionHost->m_startSessionCompletionHandler, nullptr);
+                completionHandler(errorString);
+                return;
+            }
+        }, this
+    );
 }
 
 void SessionHost::setTargetList(uint64_t connectionID, Vector<Target>&& targetList)
@@ -255,6 +296,11 @@ void SessionHost::setTargetList(uint64_t connectionID, Vector<Target>&& targetLi
         return;
     }
 
+    if (!m_startSessionCompletionHandler) {
+        // Session creation was already rejected.
+        return;
+    }
+
     m_connectionID = connectionID;
     g_dbus_connection_call(m_dbusConnection.get(), nullptr,
         INSPECTOR_DBUS_OBJECT_PATH,
@@ -265,7 +311,7 @@ void SessionHost::setTargetList(uint64_t connectionID, Vector<Target>&& targetLi
         -1, m_cancellable.get(), dbusConnectionCallAsyncReadyCallback, nullptr);
 
     auto startSessionCompletionHandler = std::exchange(m_startSessionCompletionHandler, nullptr);
-    startSessionCompletionHandler();
+    startSessionCompletionHandler(std::nullopt);
 }
 
 void SessionHost::sendMessageToFrontend(uint64_t connectionID, uint64_t targetID, const char* message)

Source/WebKit/ChangeLog

@@ -1,3 +1,45 @@
+2017-08-05  Carlos Garcia Campos  <[email protected]>
+
+        [GTK][WPE] Add API to provide browser information required by automation
+        https://bugs.webkit.org/show_bug.cgi?id=175130
+
+        Reviewed by Michael Catanzaro.
+
+        When a new automation session is started, the web driver receives some required capabilities from the client,
+        like browser name and version. The session should be rejected if those required capabilities don't match with
+        the actual browser that is launched. We don't know that information in WebKit, so we need to add API so that
+        users can provide it when a new session request is made. This patch adds boxed object WebKitApplicationInfo that
+        can be used to set the application name and version. This object can be set to a WebKitAutomationSession when
+        WebKitWebContext::automation-started signal is emitted.
+
+        * PlatformGTK.cmake:
+        * PlatformWPE.cmake:
+        * UIProcess/API/glib/WebKitApplicationInfo.cpp: Added.
+        (webkit_application_info_new):
+        (webkit_application_info_ref):
+        (webkit_application_info_unref):
+        (webkit_application_info_set_name):
+        (webkit_application_info_get_name):
+        (webkit_application_info_set_version):
+        (webkit_application_info_get_version):
+        * UIProcess/API/glib/WebKitAutomationSession.cpp:
+        (webkitAutomationSessionDispose):
+        (webkit_automation_session_class_init):
+        (webkitAutomationSessionGetBrowserName):
+        (webkitAutomationSessionGetBrowserVersion):
+        (webkit_automation_session_set_application_info):
+        (webkit_automation_session_get_application_info):
+        * UIProcess/API/glib/WebKitAutomationSessionPrivate.h:
+        * UIProcess/API/glib/WebKitWebContext.cpp:
+        * UIProcess/API/gtk/WebKitApplicationInfo.h: Added.
+        * UIProcess/API/gtk/WebKitAutomationSession.h:
+        * UIProcess/API/gtk/docs/webkit2gtk-4.0-sections.txt:
+        * UIProcess/API/gtk/docs/webkit2gtk-docs.sgml:
+        * UIProcess/API/gtk/webkit2.h:
+        * UIProcess/API/wpe/WebKitApplicationInfo.h: Added.
+        * UIProcess/API/wpe/WebKitAutomationSession.h:
+        * UIProcess/API/wpe/webkit.h:
+
 2017-08-06  Carlos Alberto Lopez Perez  <[email protected]>
 
         [GTK][WPE] CFLAGS from pkg-config for (E)GL are not passed to WebKit

Source/WebKit/PlatformGTK.cmake

@@ -117,6 +117,7 @@ list(APPEND WebKit2_SOURCES
     UIProcess/API/C/gtk/WKView.cpp
 
     UIProcess/API/glib/IconDatabase.cpp
+    UIProcess/API/glib/WebKitApplicationInfo.cpp
     UIProcess/API/glib/WebKitAuthenticationRequest.cpp
     UIProcess/API/glib/WebKitAutomationSession.cpp
     UIProcess/API/glib/WebKitBackForwardList.cpp
@@ -417,6 +418,7 @@ endif ()
 set(WebKit2GTK_INSTALLED_HEADERS
     ${DERIVED_SOURCES_WEBKIT2GTK_API_DIR}/WebKitEnumTypes.h
     ${DERIVED_SOURCES_WEBKIT2GTK_API_DIR}/WebKitVersion.h
+    ${WEBKIT2_DIR}/UIProcess/API/gtk/WebKitApplicationInfo.h
     ${WEBKIT2_DIR}/UIProcess/API/gtk/WebKitAuthenticationRequest.h
     ${WEBKIT2_DIR}/UIProcess/API/gtk/WebKitAutocleanups.h
     ${WEBKIT2_DIR}/UIProcess/API/gtk/WebKitAutomationSession.h

Source/WebKit/PlatformWPE.cmake

@@ -132,6 +132,7 @@ list(APPEND WebKit2_SOURCES
     UIProcess/API/C/wpe/WKView.cpp
 
     UIProcess/API/glib/IconDatabase.cpp
+    UIProcess/API/glib/WebKitApplicationInfo.cpp
     UIProcess/API/glib/WebKitAuthenticationRequest.cpp
     UIProcess/API/glib/WebKitAutomationSession.cpp
     UIProcess/API/glib/WebKitBackForwardList.cpp
@@ -275,6 +276,7 @@ list(APPEND WebKit2_DERIVED_SOURCES
 
 set(WPE_API_INSTALLED_HEADERS
     ${DERIVED_SOURCES_WPE_API_DIR}/WebKitEnumTypes.h
+    ${WEBKIT2_DIR}/UIProcess/API/gtk/WebKitApplicationInfo.h
     ${WEBKIT2_DIR}/UIProcess/API/wpe/WebKitAuthenticationRequest.h
     ${WEBKIT2_DIR}/UIProcess/API/wpe/WebKitAutomationSession.h
     ${WEBKIT2_DIR}/UIProcess/API/wpe/WebKitBackForwardList.h