1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-27 20:57:35 +00:00

Browser+WebDriver: Remove the connection between Browser and WebDriver

WebDriver now only has an IPC connection to WebContent. WebDriver still
launches the browser, but now when the session ends, we simply send a
SIGTERM signal to the browser.
This commit is contained in:
Timothy Flynn 2022-11-11 14:14:58 -05:00 committed by Linus Groh
parent c64da0d00c
commit 7972916be7
11 changed files with 20 additions and 219 deletions

View file

@ -1,26 +0,0 @@
/*
* Copyright (c) 2022, Florent Castelli <florent.castelli@gmail.com>
* Copyright (c) 2022, Sam Atkins <atkinssj@serenityos.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#include "BrowserConnection.h"
#include "Client.h"
namespace WebDriver {
BrowserConnection::BrowserConnection(NonnullOwnPtr<Core::Stream::LocalSocket> socket, NonnullRefPtr<Client> client, unsigned session_id)
: IPC::ConnectionFromClient<WebDriverSessionClientEndpoint, WebDriverSessionServerEndpoint>(*this, move(socket), 1)
, m_client(move(client))
, m_session_id(session_id)
{
}
void BrowserConnection::die()
{
dbgln_if(WEBDRIVER_DEBUG, "Session {} was closed remotely. Shutting down...", m_session_id);
m_client->close_session(m_session_id);
}
}

View file

@ -1,34 +0,0 @@
/*
* Copyright (c) 2022, Florent Castelli <florent.castelli@gmail.com>
* Copyright (c) 2022, Sam Atkins <atkinssj@serenityos.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include <AK/Format.h>
#include <Applications/Browser/WebDriverSessionClientEndpoint.h>
#include <Applications/Browser/WebDriverSessionServerEndpoint.h>
#include <LibGUI/Application.h>
#include <LibIPC/ConnectionFromClient.h>
#include <LibIPC/Encoder.h>
namespace WebDriver {
class Client;
class BrowserConnection
: public IPC::ConnectionFromClient<WebDriverSessionClientEndpoint, WebDriverSessionServerEndpoint> {
C_OBJECT_ABSTRACT(BrowserConnection)
public:
BrowserConnection(NonnullOwnPtr<Core::Stream::LocalSocket> socket, NonnullRefPtr<Client> client, unsigned session_id);
virtual void die() override;
private:
NonnullRefPtr<Client> m_client;
unsigned m_session_id { 0 };
};
}

View file

@ -5,7 +5,6 @@ serenity_component(
)
set(SOURCES
BrowserConnection.cpp
Client.cpp
Session.cpp
TimeoutsConfiguration.cpp
@ -14,8 +13,6 @@ set(SOURCES
)
set(GENERATED_SOURCES
../../Applications/Browser/WebDriverSessionClientEndpoint.h
../../Applications/Browser/WebDriverSessionServerEndpoint.h
../../Services/WebContent/WebDriverClientEndpoint.h
../../Services/WebContent/WebDriverServerEndpoint.h
)

View file

@ -9,7 +9,6 @@
*/
#include "Session.h"
#include "BrowserConnection.h"
#include "Client.h"
#include <AK/JsonObject.h>
#include <AK/JsonParser.h>
@ -55,42 +54,24 @@ ErrorOr<void, Web::WebDriver::Error> Session::check_for_open_top_level_browsing_
return {};
}
ErrorOr<NonnullRefPtr<Core::LocalServer>> Session::create_server(String const& socket_path, ServerType type, NonnullRefPtr<ServerPromise> promise)
ErrorOr<NonnullRefPtr<Core::LocalServer>> Session::create_server(String const& socket_path, NonnullRefPtr<ServerPromise> promise)
{
dbgln("Listening for WebDriver connection on {}", socket_path);
auto server = TRY(Core::LocalServer::try_create());
server->listen(socket_path);
server->on_accept = [this, type, promise](auto client_socket) mutable {
switch (type) {
case ServerType::Browser: {
auto maybe_connection = adopt_nonnull_ref_or_enomem(new (nothrow) BrowserConnection(move(client_socket), m_client, session_id()));
if (maybe_connection.is_error()) {
promise->resolve(maybe_connection.release_error());
return;
}
dbgln("WebDriver is connected to Browser socket");
m_browser_connection = maybe_connection.release_value();
break;
server->on_accept = [this, promise](auto client_socket) mutable {
auto maybe_connection = adopt_nonnull_ref_or_enomem(new (nothrow) WebContentConnection(move(client_socket), m_client, session_id()));
if (maybe_connection.is_error()) {
promise->resolve(maybe_connection.release_error());
return;
}
case ServerType::WebContent: {
auto maybe_connection = adopt_nonnull_ref_or_enomem(new (nothrow) WebContentConnection(move(client_socket), m_client, session_id()));
if (maybe_connection.is_error()) {
promise->resolve(maybe_connection.release_error());
return;
}
dbgln("WebDriver is connected to WebContent socket");
m_web_content_connection = maybe_connection.release_value();
dbgln("WebDriver is connected to WebContent socket");
m_web_content_connection = maybe_connection.release_value();
break;
}
}
if (m_browser_connection && m_web_content_connection)
promise->resolve({});
promise->resolve({});
};
server->on_accept_error = [promise](auto error) mutable {
@ -104,22 +85,17 @@ ErrorOr<void> Session::start()
{
auto promise = TRY(ServerPromise::try_create());
auto browser_socket_path = String::formatted("/tmp/webdriver/browser_{}_{}", getpid(), m_id);
auto browser_server = TRY(create_server(browser_socket_path, ServerType::Browser, promise));
auto web_content_socket_path = String::formatted("/tmp/webdriver/content_{}_{}", getpid(), m_id);
auto web_content_server = TRY(create_server(web_content_socket_path, ServerType::WebContent, promise));
auto web_content_socket_path = String::formatted("/tmp/webdriver/session_{}_{}", getpid(), m_id);
auto web_content_server = TRY(create_server(web_content_socket_path, promise));
char const* argv[] = {
"/bin/Browser",
"--webdriver-browser-path",
browser_socket_path.characters(),
"--webdriver-content-path",
web_content_socket_path.characters(),
nullptr,
};
TRY(Core::System::posix_spawn("/bin/Browser"sv, nullptr, nullptr, const_cast<char**>(argv), environ));
m_browser_pid = TRY(Core::System::posix_spawn("/bin/Browser"sv, nullptr, nullptr, const_cast<char**>(argv), environ));
// FIXME: Allow this to be more asynchronous. For now, this at least allows us to propagate
// errors received while accepting the Browser and WebContent sockets.
@ -144,7 +120,11 @@ Web::WebDriver::Response Session::stop()
// NOTE: Handled by WebDriver::Client.
// 3. Perform any implementation-specific cleanup steps.
m_browser_connection->async_quit();
if (m_browser_pid.has_value()) {
MUST(Core::System::kill(*m_browser_pid, SIGTERM));
m_browser_pid = {};
}
m_started = false;
// 4. If an error has occurred in any of the steps above, return the error, otherwise return success with data null.

View file

@ -14,7 +14,6 @@
#include <LibCore/Promise.h>
#include <LibWeb/WebDriver/Error.h>
#include <LibWeb/WebDriver/Response.h>
#include <WebDriver/BrowserConnection.h>
#include <WebDriver/TimeoutsConfiguration.h>
#include <WebDriver/WebContentConnection.h>
#include <unistd.h>
@ -57,20 +56,16 @@ public:
Web::WebDriver::Response take_element_screenshot(StringView element_id);
private:
enum class ServerType {
Browser,
WebContent,
};
using ServerPromise = Core::Promise<ErrorOr<void>>;
ErrorOr<NonnullRefPtr<Core::LocalServer>> create_server(String const& socket_path, ServerType type, NonnullRefPtr<ServerPromise> promise);
ErrorOr<NonnullRefPtr<Core::LocalServer>> create_server(String const& socket_path, NonnullRefPtr<ServerPromise> promise);
NonnullRefPtr<Client> m_client;
bool m_started { false };
unsigned m_id { 0 };
HashMap<String, NonnullOwnPtr<Window>> m_windows;
String m_current_window_handle;
RefPtr<BrowserConnection> m_browser_connection;
RefPtr<WebContentConnection> m_web_content_connection;
Optional<pid_t> m_browser_pid;
// https://w3c.github.io/webdriver/#dfn-session-script-timeout
TimeoutsConfiguration m_timeouts_configuration;