ladybird/Services/WebDriver/Session.h
Timothy Flynn d95be7d88c WebDriver: Move session management to the Session class
Session management is a bit awkward right now in that the list of active
sessions is managed by Client, resulting in operations like closing a
session being split between several functions in Client and Session.

This patch moves all session management to the Session class. Closing a
session is now entirely in Session::close().

This will make managing a separate HTTP session list a bit simpler.
2025-02-10 11:33:53 -05:00

112 lines
3.5 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/WebContentConnection.h>
#include <unistd.h>
namespace WebDriver {
struct LaunchBrowserCallbacks;
class Session : public RefCounted<Session> {
public:
static ErrorOr<NonnullRefPtr<Session>> create(NonnullRefPtr<Client> client, JsonObject& capabilities, ReadonlySpan<StringView> flags);
~Session();
enum class AllowInvalidWindowHandle {
No,
Yes,
};
static ErrorOr<NonnullRefPtr<Session>, Web::WebDriver::Error> find_session(StringView session_id, AllowInvalidWindowHandle = AllowInvalidWindowHandle::No);
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; }
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, bool http);
ErrorOr<void> start(LaunchBrowserCallbacks 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;
bool m_http { false };
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 };
};
}