mirror of
https://github.com/RGBCube/serenity
synced 2025-05-31 18:28:12 +00:00
61de50c7fd
Note that this does nothing to "fix" how element references are created. We continue to return the element ID because, otherwise, all other element WebDriver endpoints would break. On the bright side, we avoid several IPC round trips now that we perform the entire 'find' operation in the WebContent process; and we are able to work directly on DOM nodes.
120 lines
5.1 KiB
C++
120 lines
5.1 KiB
C++
/*
|
|
* Copyright (c) 2022, Florent Castelli <florent.castelli@gmail.com>
|
|
* Copyright (c) 2022, Linus Groh <linusg@serenityos.org>
|
|
* Copyright (c) 2022, Tim Flynn <trflynn89@serenityos.org>
|
|
*
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <AK/Error.h>
|
|
#include <AK/JsonValue.h>
|
|
#include <AK/RefPtr.h>
|
|
#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>
|
|
|
|
namespace WebDriver {
|
|
|
|
class Session {
|
|
public:
|
|
Session(unsigned session_id, NonnullRefPtr<Client> client);
|
|
~Session();
|
|
|
|
unsigned session_id() const { return m_id; }
|
|
|
|
struct Window {
|
|
String handle;
|
|
bool is_open;
|
|
};
|
|
|
|
struct LocalElement {
|
|
i32 id;
|
|
};
|
|
|
|
ErrorOr<Window*, Web::WebDriver::Error> current_window();
|
|
ErrorOr<void, Web::WebDriver::Error> check_for_open_top_level_browsing_context_or_return_error();
|
|
String const& current_window_handle() { return m_current_window_handle; }
|
|
|
|
WebContentConnection& web_content_connection()
|
|
{
|
|
VERIFY(m_web_content_connection);
|
|
return *m_web_content_connection;
|
|
}
|
|
|
|
ErrorOr<void> start();
|
|
Web::WebDriver::Response stop();
|
|
JsonObject get_timeouts();
|
|
Web::WebDriver::Response set_timeouts(JsonValue const& payload);
|
|
Web::WebDriver::Response back();
|
|
Web::WebDriver::Response forward();
|
|
Web::WebDriver::Response refresh();
|
|
Web::WebDriver::Response get_title();
|
|
Web::WebDriver::Response get_window_handle();
|
|
ErrorOr<void, Variant<Web::WebDriver::Error, Error>> close_window();
|
|
Web::WebDriver::Response get_window_handles() const;
|
|
Web::WebDriver::Response find_elements(JsonValue const& payload);
|
|
Web::WebDriver::Response find_element_from_element(JsonValue const& payload, StringView parameter_element_id);
|
|
Web::WebDriver::Response find_elements_from_element(JsonValue const& payload, StringView parameter_element_id);
|
|
Web::WebDriver::Response is_element_selected(StringView element_id);
|
|
Web::WebDriver::Response get_element_attribute(JsonValue const& payload, StringView element_id, StringView name);
|
|
Web::WebDriver::Response get_element_property(JsonValue const& payload, StringView element_id, StringView name);
|
|
Web::WebDriver::Response get_element_css_value(JsonValue const& payload, StringView element_id, StringView property_name);
|
|
Web::WebDriver::Response get_element_text(JsonValue const& payload, StringView element_id);
|
|
Web::WebDriver::Response get_element_tag_name(JsonValue const& payload, StringView element_id);
|
|
Web::WebDriver::Response get_element_rect(StringView element_id);
|
|
Web::WebDriver::Response is_element_enabled(StringView element_id);
|
|
Web::WebDriver::Response get_source();
|
|
Web::WebDriver::Response execute_script(JsonValue const& payload);
|
|
Web::WebDriver::Response execute_async_script(JsonValue const& payload);
|
|
Web::WebDriver::Response get_all_cookies();
|
|
Web::WebDriver::Response get_named_cookie(String const& name);
|
|
Web::WebDriver::Response add_cookie(JsonValue const& payload);
|
|
Web::WebDriver::Response delete_cookie(StringView name);
|
|
Web::WebDriver::Response delete_all_cookies();
|
|
Web::WebDriver::Response take_screenshot();
|
|
Web::WebDriver::Response take_element_screenshot(StringView element_id);
|
|
|
|
private:
|
|
void delete_cookies(Optional<StringView> const& name = {});
|
|
ErrorOr<JsonArray, Web::WebDriver::Error> find(LocalElement const& start_node, StringView location_strategy, StringView selector);
|
|
|
|
using ElementLocationStrategyHandler = ErrorOr<Vector<LocalElement>, Web::WebDriver::Error> (Session::*)(LocalElement const&, StringView);
|
|
struct LocatorStrategy {
|
|
String name;
|
|
ElementLocationStrategyHandler handler;
|
|
};
|
|
|
|
static Vector<LocatorStrategy> s_locator_strategies;
|
|
|
|
ErrorOr<Vector<LocalElement>, Web::WebDriver::Error> locator_strategy_css_selectors(LocalElement const&, StringView);
|
|
ErrorOr<Vector<LocalElement>, Web::WebDriver::Error> locator_strategy_link_text(LocalElement const&, StringView);
|
|
ErrorOr<Vector<LocalElement>, Web::WebDriver::Error> locator_strategy_partial_link_text(LocalElement const&, StringView);
|
|
ErrorOr<Vector<LocalElement>, Web::WebDriver::Error> locator_strategy_tag_name(LocalElement const&, StringView);
|
|
ErrorOr<Vector<LocalElement>, Web::WebDriver::Error> locator_strategy_x_path(LocalElement const&, StringView);
|
|
|
|
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);
|
|
|
|
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;
|
|
|
|
// https://w3c.github.io/webdriver/#dfn-session-script-timeout
|
|
TimeoutsConfiguration m_timeouts_configuration;
|
|
};
|
|
|
|
}
|