mirror of
https://github.com/LadybirdBrowser/ladybird.git
synced 2025-07-15 21:41:58 +00:00
c011dc766f
We currently create a separate headless-browser application to serve two purposes: 1. Allow headless browsing to take a screenshot of a page or print its layout tree / internal text. 2. Run the LibWeb test framework. This patch migrates (1) to the main Ladybird executable. The --headless flag enables this mode. This matches the behavior of other browsers, and means we have one less executable to ship at distribution time. We want to avoid creating too many AppKit / Qt facilities in headless mode. So this involves some shuffling of application init to ensure we don't create them until after we've parsed the command line arguments. Namely, we avoid creating the NSApp in AppKit and QCoreApplication in Qt. Doing so also requires that we don't create the application event loop until we've parsed the command line as well, because the loop we create depends on whether we're creating those UI facilities.
113 lines
3.8 KiB
C++
113 lines
3.8 KiB
C++
/*
|
|
* Copyright (c) 2022, Florent Castelli <florent.castelli@gmail.com>
|
|
* Copyright (c) 2022, Linus Groh <linusg@serenityos.org>
|
|
* Copyright (c) 2022-2025, Tim Flynn <trflynn89@ladybird.org>
|
|
*
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <AK/Error.h>
|
|
#include <AK/JsonValue.h>
|
|
#include <AK/RefCounted.h>
|
|
#include <AK/RefPtr.h>
|
|
#include <AK/ScopeGuard.h>
|
|
#include <AK/String.h>
|
|
#include <LibCore/EventLoop.h>
|
|
#include <LibCore/Process.h>
|
|
#include <LibCore/Promise.h>
|
|
#include <LibWeb/WebDriver/Capabilities.h>
|
|
#include <LibWeb/WebDriver/Error.h>
|
|
#include <LibWeb/WebDriver/Response.h>
|
|
#include <WebDriver/Client.h>
|
|
#include <WebDriver/WebContentConnection.h>
|
|
#include <unistd.h>
|
|
|
|
namespace WebDriver {
|
|
|
|
class Session : public RefCounted<Session> {
|
|
public:
|
|
static ErrorOr<NonnullRefPtr<Session>> create(NonnullRefPtr<Client> client, JsonObject& capabilities, Web::WebDriver::SessionFlags flags);
|
|
~Session();
|
|
|
|
enum class AllowInvalidWindowHandle {
|
|
No,
|
|
Yes,
|
|
};
|
|
static ErrorOr<NonnullRefPtr<Session>, Web::WebDriver::Error> find_session(StringView session_id, Web::WebDriver::SessionFlags = Web::WebDriver::SessionFlags::Default, AllowInvalidWindowHandle = AllowInvalidWindowHandle::No);
|
|
static size_t session_count(Web::WebDriver::SessionFlags);
|
|
|
|
struct Window {
|
|
String handle;
|
|
NonnullRefPtr<WebContentConnection> web_content_connection;
|
|
};
|
|
|
|
WebContentConnection& web_content_connection() const
|
|
{
|
|
auto current_window = m_windows.get(m_current_window_handle);
|
|
VERIFY(current_window.has_value());
|
|
|
|
return current_window->web_content_connection;
|
|
}
|
|
|
|
void close();
|
|
|
|
String session_id() const { return m_session_id; }
|
|
Web::WebDriver::SessionFlags session_flags() const { return m_session_flags; }
|
|
String const& current_window_handle() const { return m_current_window_handle; }
|
|
|
|
bool has_window_handle(StringView handle) const { return m_windows.contains(handle); }
|
|
|
|
Web::WebDriver::Response set_timeouts(JsonValue);
|
|
Web::WebDriver::Response close_window();
|
|
Web::WebDriver::Response switch_to_window(StringView);
|
|
Web::WebDriver::Response get_window_handles() const;
|
|
ErrorOr<void, Web::WebDriver::Error> ensure_current_window_handle_is_valid() const;
|
|
|
|
template<typename Action>
|
|
Web::WebDriver::Response perform_async_action(Action&& action)
|
|
{
|
|
Optional<Web::WebDriver::Response> response;
|
|
auto& connection = web_content_connection();
|
|
|
|
ScopeGuard guard { [&]() { connection.on_driver_execution_complete = nullptr; } };
|
|
connection.on_driver_execution_complete = [&](auto result) { response = move(result); };
|
|
|
|
TRY(action(connection));
|
|
|
|
Core::EventLoop::current().spin_until([&]() {
|
|
return response.has_value();
|
|
});
|
|
|
|
return response.release_value();
|
|
}
|
|
|
|
private:
|
|
Session(NonnullRefPtr<Client> client, JsonObject const& capabilities, String session_id, Web::WebDriver::SessionFlags flags);
|
|
|
|
ErrorOr<void> start(LaunchBrowserCallback const&);
|
|
|
|
using ServerPromise = Core::Promise<ErrorOr<void>>;
|
|
ErrorOr<NonnullRefPtr<Core::LocalServer>> create_server(NonnullRefPtr<ServerPromise> promise);
|
|
|
|
NonnullRefPtr<Client> m_client;
|
|
Web::WebDriver::LadybirdOptions m_options;
|
|
|
|
String m_session_id;
|
|
Web::WebDriver::SessionFlags m_session_flags { Web::WebDriver::SessionFlags::Default };
|
|
|
|
HashMap<String, Window> m_windows;
|
|
String m_current_window_handle;
|
|
|
|
Optional<ByteString> m_web_content_socket_path;
|
|
Optional<Core::Process> m_browser_process;
|
|
|
|
RefPtr<Core::LocalServer> m_web_content_server;
|
|
|
|
Web::WebDriver::PageLoadStrategy m_page_load_strategy { Web::WebDriver::PageLoadStrategy::Normal };
|
|
Optional<JsonValue> m_timeouts_configuration;
|
|
bool m_strict_file_interactiblity { false };
|
|
};
|
|
|
|
}
|