beenull/ladybird
1
0
Fork 0
mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2024-11-22 15:40:19 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6
ladybird/Services/WebDriver/Client.h

114 lines
8.9 KiB
C
Raw Normal View History

WebDriver: Add new WebDriver service WebDriver aims to implement the WebDriver specification found at https://w3c.github.io/webdriver/webdriver-spec.html . It's an HTTP server that can create Browser sessions and control them. Co-authored-by: Florent Castelli <florent.castelli@gmail.com>
2022-10-12 10:14:59 +00:00
/*
* Copyright (c) 2022, Florent Castelli <florent.castelli@gmail.com>
WebDriver: Implement `GET /session/{session id}/timeouts` endpoint
2022-10-19 15:46:31 +00:00
* Copyright (c) 2022, Linus Groh <linusg@serenityos.org>
WebDriver+Browser: Implement `GET /session/{id}/element/{id}/enabled`
2022-11-03 17:31:08 +00:00
* Copyright (c) 2022, Tim Flynn <trflynn89@serenityos.org>
WebDriver: Add new WebDriver service WebDriver aims to implement the WebDriver specification found at https://w3c.github.io/webdriver/webdriver-spec.html . It's an HTTP server that can create Browser sessions and control them. Co-authored-by: Florent Castelli <florent.castelli@gmail.com>
2022-10-12 10:14:59 +00:00
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
WebDriver: Specify callbacks for clients to launch browser windows This moves the actual launching of browser windows to the WebDriver main file. This will allow Ladybird to specify its own callback and re-use Serenity's Session class.
2022-12-15 13:46:01 +00:00
#include <AK/Function.h>
WebDriver: Reference-count WebDriver Session objects When some WebDriver spec steps are implemented a bit more literally, we will end up in a situation where we remove a session from its client's active session map, but still have more steps to perform. Currently, when we remove the session, it is immediately destroyed because it is stored in an OwnPtr. Instead, we can store it as a RefPtr, which will let the caller to such steps keep the session alive until the subsequent steps are complete. While here, this also changes the storage of active sessions to a HashMap, as all lookups into it are currently a linear search.
2023-03-07 15:36:39 +00:00
#include <AK/NonnullRefPtr.h>
Userland: Rename Core::Object to Core::EventReceiver This is a more precise description of what this class actually does.
2023-08-06 16:09:39 +00:00
#include <LibCore/EventReceiver.h>
WebDriver: Port the WebDriver client to be a Web::WebDriver::Client
2022-11-13 04:37:58 +00:00
#include <LibWeb/WebDriver/Client.h>
LibWeb+WebDriver: Move WebDriverError to Web::WebDriver::Error This is to prepare for WebContent becoming the WebDriver client.
2022-11-08 15:10:27 +00:00
#include <LibWeb/WebDriver/Error.h>
LibWeb+WebDriver: Add an IPC-transferable Web::WebDriver::Response class This is essentially an ErrorOr<JsonValue, Web::WebDriver::Error> class. Unfortunately, that ErrorOr would not be default-constructible, which is required for the generated IPC classes. So this is a thin wrapper around a Variant<JsonValue, Web::WebDriver::Error> to emulate ErrorOr.
2022-11-08 14:42:36 +00:00
#include <LibWeb/WebDriver/Response.h>
WebDriver: Add new WebDriver service WebDriver aims to implement the WebDriver specification found at https://w3c.github.io/webdriver/webdriver-spec.html . It's an HTTP server that can create Browser sessions and control them. Co-authored-by: Florent Castelli <florent.castelli@gmail.com>
2022-10-12 10:14:59 +00:00
#include <WebDriver/Session.h>
namespace WebDriver {
WebDriver: Specify callbacks for clients to launch browser windows This moves the actual launching of browser windows to the WebDriver main file. This will allow Ladybird to specify its own callback and re-use Serenity's Session class.
2022-12-15 13:46:01 +00:00
struct LaunchBrowserCallbacks {
LibCore/Process: Make all `spawn` overloads return ErrorOr<Process>
2024-11-17 15:11:13 +00:00
Function<ErrorOr<Core::Process>(ByteString const&)> launch_browser;
Function<ErrorOr<Core::Process>(ByteString const&)> launch_headless_browser;
WebDriver: Specify callbacks for clients to launch browser windows This moves the actual launching of browser windows to the WebDriver main file. This will allow Ladybird to specify its own callback and re-use Serenity's Session class.
2022-12-15 13:46:01 +00:00
};
WebDriver: Port the WebDriver client to be a Web::WebDriver::Client
2022-11-13 04:37:58 +00:00
class Client final : public Web::WebDriver::Client {
C_OBJECT_ABSTRACT(Client);
WebDriver: Add new WebDriver service WebDriver aims to implement the WebDriver specification found at https://w3c.github.io/webdriver/webdriver-spec.html . It's an HTTP server that can create Browser sessions and control them. Co-authored-by: Florent Castelli <florent.castelli@gmail.com>
2022-10-12 10:14:59 +00:00
public:
Userland: Rename Core::Object to Core::EventReceiver This is a more precise description of what this class actually does.
2023-08-06 16:09:39 +00:00
static ErrorOr<NonnullRefPtr<Client>> try_create(NonnullOwnPtr<Core::BufferedTCPSocket>, LaunchBrowserCallbacks, Core::EventReceiver* parent);
WebDriver: Port the WebDriver client to be a Web::WebDriver::Client
2022-11-13 04:37:58 +00:00
virtual ~Client() override;
WebDriver: Add new WebDriver service WebDriver aims to implement the WebDriver specification found at https://w3c.github.io/webdriver/webdriver-spec.html . It's an HTTP server that can create Browser sessions and control them. Co-authored-by: Florent Castelli <florent.castelli@gmail.com>
2022-10-12 10:14:59 +00:00
void close_session(unsigned session_id);
private:
Userland: Rename Core::Object to Core::EventReceiver This is a more precise description of what this class actually does.
2023-08-06 16:09:39 +00:00
Client(NonnullOwnPtr<Core::BufferedTCPSocket>, LaunchBrowserCallbacks, Core::EventReceiver* parent);
WebDriver: Add new WebDriver service WebDriver aims to implement the WebDriver specification found at https://w3c.github.io/webdriver/webdriver-spec.html . It's an HTTP server that can create Browser sessions and control them. Co-authored-by: Florent Castelli <florent.castelli@gmail.com>
2022-10-12 10:14:59 +00:00
WebDriver: Ensure that the session's current window handle is valid After closing a window, it is the client's job to switch to another window before executing any other command. Currently, we will crash if that did not happen when we try to send an IPC to a window handle that we no longer hold. This patch makes us return a "no such window" error instead. The exceptions to this new check are the "Switch to Window" and "Get Window Handles" commands.
2024-09-27 20:53:29 +00:00
enum class AllowInvalidWindowHandle {
No,
Yes,
};
ErrorOr<NonnullRefPtr<Session>, Web::WebDriver::Error> find_session_with_id(StringView session_id, AllowInvalidWindowHandle = AllowInvalidWindowHandle::No);
WebDriver: Add new WebDriver service WebDriver aims to implement the WebDriver specification found at https://w3c.github.io/webdriver/webdriver-spec.html . It's an HTTP server that can create Browser sessions and control them. Co-authored-by: Florent Castelli <florent.castelli@gmail.com>
2022-10-12 10:14:59 +00:00
WebDriver: Port the WebDriver client to be a Web::WebDriver::Client
2022-11-13 04:37:58 +00:00
virtual Web::WebDriver::Response new_session(Web::WebDriver::Parameters parameters, JsonValue payload) override;
virtual Web::WebDriver::Response delete_session(Web::WebDriver::Parameters parameters, JsonValue payload) override;
virtual Web::WebDriver::Response get_status(Web::WebDriver::Parameters parameters, JsonValue payload) override;
virtual Web::WebDriver::Response get_timeouts(Web::WebDriver::Parameters parameters, JsonValue payload) override;
virtual Web::WebDriver::Response set_timeouts(Web::WebDriver::Parameters parameters, JsonValue payload) override;
virtual Web::WebDriver::Response navigate_to(Web::WebDriver::Parameters parameters, JsonValue payload) override;
virtual Web::WebDriver::Response get_current_url(Web::WebDriver::Parameters parameters, JsonValue payload) override;
virtual Web::WebDriver::Response back(Web::WebDriver::Parameters parameters, JsonValue payload) override;
virtual Web::WebDriver::Response forward(Web::WebDriver::Parameters parameters, JsonValue payload) override;
virtual Web::WebDriver::Response refresh(Web::WebDriver::Parameters parameters, JsonValue payload) override;
virtual Web::WebDriver::Response get_title(Web::WebDriver::Parameters parameters, JsonValue payload) override;
virtual Web::WebDriver::Response get_window_handle(Web::WebDriver::Parameters parameters, JsonValue payload) override;
virtual Web::WebDriver::Response close_window(Web::WebDriver::Parameters parameters, JsonValue payload) override;
WebContent+WebDriver: Implement `POST /session/{id}/window` endpoint
2022-11-25 02:32:53 +00:00
virtual Web::WebDriver::Response switch_to_window(Web::WebDriver::Parameters parameters, JsonValue payload) override;
WebDriver: Port the WebDriver client to be a Web::WebDriver::Client
2022-11-13 04:37:58 +00:00
virtual Web::WebDriver::Response get_window_handles(Web::WebDriver::Parameters parameters, JsonValue payload) override;
LibWeb+WebContent+WebDriver: Add WebDriver endpoint to open new window
2023-03-14 11:09:50 +00:00
virtual Web::WebDriver::Response new_window(Web::WebDriver::Parameters parameters, JsonValue payload) override;
WebDriver: Add Routes, IPC definitions, and boilerplates Added the following Routes, IPC definitions, and boilerplates for the missing endpoints: - Switch To Frame - Switch To Parent Frame - Element Clear - Element Send Keys
2024-09-07 19:41:54 +00:00
virtual Web::WebDriver::Response switch_to_frame(Web::WebDriver::Parameters parameters, JsonValue payload) override;
virtual Web::WebDriver::Response switch_to_parent_frame(Web::WebDriver::Parameters parameters, JsonValue payload) override;
WebDriver: Port the WebDriver client to be a Web::WebDriver::Client
2022-11-13 04:37:58 +00:00
virtual Web::WebDriver::Response get_window_rect(Web::WebDriver::Parameters parameters, JsonValue payload) override;
virtual Web::WebDriver::Response set_window_rect(Web::WebDriver::Parameters parameters, JsonValue payload) override;
virtual Web::WebDriver::Response maximize_window(Web::WebDriver::Parameters parameters, JsonValue payload) override;
virtual Web::WebDriver::Response minimize_window(Web::WebDriver::Parameters parameters, JsonValue payload) override;
virtual Web::WebDriver::Response fullscreen_window(Web::WebDriver::Parameters parameters, JsonValue payload) override;
WebDriver+WebContent: Add /session/:id:/window/consume-user-activation This extension to the WebDriver spec is defined in the HTML spec, how fun.
2024-05-29 17:14:42 +00:00
virtual Web::WebDriver::Response consume_user_activation(Web::WebDriver::Parameters parameters, JsonValue payload) override;
WebDriver: Port the WebDriver client to be a Web::WebDriver::Client
2022-11-13 04:37:58 +00:00
virtual Web::WebDriver::Response find_element(Web::WebDriver::Parameters parameters, JsonValue payload) override;
virtual Web::WebDriver::Response find_elements(Web::WebDriver::Parameters parameters, JsonValue payload) override;
virtual Web::WebDriver::Response find_element_from_element(Web::WebDriver::Parameters parameters, JsonValue payload) override;
virtual Web::WebDriver::Response find_elements_from_element(Web::WebDriver::Parameters parameters, JsonValue payload) override;
LibWeb+WebContent+WebDriver: Implement Find Element From Shadow Root
2022-11-15 00:48:48 +00:00
virtual Web::WebDriver::Response find_element_from_shadow_root(Web::WebDriver::Parameters parameters, JsonValue payload) override;
LibWeb+WebContent+WebDriver: Implement Find Elements From Shadow Root
2022-11-15 00:54:17 +00:00
virtual Web::WebDriver::Response find_elements_from_shadow_root(Web::WebDriver::Parameters parameters, JsonValue payload) override;
LibWeb+WebContent+WebDriver: Implement Get Active Element Unfortunately, nothing ever calls DOM::Document::set_active_element at the moment, so this will always return ErrorCode::NoSuchElement.
2022-11-15 00:02:23 +00:00
virtual Web::WebDriver::Response get_active_element(Web::WebDriver::Parameters parameters, JsonValue payload) override;
LibWeb+WebContent+WebDriver: Implement Get Element Shadow Root
2022-11-15 00:27:11 +00:00
virtual Web::WebDriver::Response get_element_shadow_root(Web::WebDriver::Parameters parameters, JsonValue payload) override;
WebDriver: Port the WebDriver client to be a Web::WebDriver::Client
2022-11-13 04:37:58 +00:00
virtual Web::WebDriver::Response is_element_selected(Web::WebDriver::Parameters parameters, JsonValue payload) override;
virtual Web::WebDriver::Response get_element_attribute(Web::WebDriver::Parameters parameters, JsonValue payload) override;
virtual Web::WebDriver::Response get_element_property(Web::WebDriver::Parameters parameters, JsonValue payload) override;
virtual Web::WebDriver::Response get_element_css_value(Web::WebDriver::Parameters parameters, JsonValue payload) override;
virtual Web::WebDriver::Response get_element_text(Web::WebDriver::Parameters parameters, JsonValue payload) override;
virtual Web::WebDriver::Response get_element_tag_name(Web::WebDriver::Parameters parameters, JsonValue payload) override;
virtual Web::WebDriver::Response get_element_rect(Web::WebDriver::Parameters parameters, JsonValue payload) override;
virtual Web::WebDriver::Response is_element_enabled(Web::WebDriver::Parameters parameters, JsonValue payload) override;
WebDriver: Add computedrole endpoint
2023-01-15 16:26:08 +00:00
virtual Web::WebDriver::Response get_computed_role(Web::WebDriver::Parameters parameters, JsonValue payload) override;
WebDriver: Add computedlabel endpoint
2023-02-19 17:36:08 +00:00
virtual Web::WebDriver::Response get_computed_label(Web::WebDriver::Parameters parameters, JsonValue payload) override;
WebDriver+LibWeb: Rename "click" to "element_click" This matches the name used in the spec, and is unambiguous.
2023-01-26 14:11:54 +00:00
virtual Web::WebDriver::Response element_click(Web::WebDriver::Parameters parameters, JsonValue payload) override;
WebDriver: Add Routes, IPC definitions, and boilerplates Added the following Routes, IPC definitions, and boilerplates for the missing endpoints: - Switch To Frame - Switch To Parent Frame - Element Clear - Element Send Keys
2024-09-07 19:41:54 +00:00
virtual Web::WebDriver::Response element_clear(Web::WebDriver::Parameters parameters, JsonValue payload) override;
virtual Web::WebDriver::Response element_send_keys(Web::WebDriver::Parameters parameters, JsonValue payload) override;
WebDriver: Port the WebDriver client to be a Web::WebDriver::Client
2022-11-13 04:37:58 +00:00
virtual Web::WebDriver::Response get_source(Web::WebDriver::Parameters parameters, JsonValue payload) override;
virtual Web::WebDriver::Response execute_script(Web::WebDriver::Parameters parameters, JsonValue payload) override;
virtual Web::WebDriver::Response execute_async_script(Web::WebDriver::Parameters parameters, JsonValue payload) override;
virtual Web::WebDriver::Response get_all_cookies(Web::WebDriver::Parameters parameters, JsonValue payload) override;
virtual Web::WebDriver::Response get_named_cookie(Web::WebDriver::Parameters parameters, JsonValue payload) override;
virtual Web::WebDriver::Response add_cookie(Web::WebDriver::Parameters parameters, JsonValue payload) override;
virtual Web::WebDriver::Response delete_cookie(Web::WebDriver::Parameters parameters, JsonValue payload) override;
virtual Web::WebDriver::Response delete_all_cookies(Web::WebDriver::Parameters parameters, JsonValue payload) override;
WebDriver: Add boilerplate for endpoint 15.7 Perform Actions Following the structure of the ReleaseActions endpoints, define analogous classes and methods for PerformActions
2024-09-02 18:41:24 +00:00
virtual Web::WebDriver::Response perform_actions(Web::WebDriver::Parameters parameters, JsonValue payload) override;
LibWeb: Stub out `Release Actions` This allows WPT to open the browser, and it no longer instantly crashes
2023-06-17 15:36:00 +00:00
virtual Web::WebDriver::Response release_actions(Web::WebDriver::Parameters parameters, JsonValue payload) override;
LibWeb+WebContent+WebDriver: Implement Dismiss Alert
2022-11-16 12:15:57 +00:00
virtual Web::WebDriver::Response dismiss_alert(Web::WebDriver::Parameters parameters, JsonValue payload) override;
LibWeb+WebContent+WebDriver: Implement Accept Alert
2022-11-16 12:24:22 +00:00
virtual Web::WebDriver::Response accept_alert(Web::WebDriver::Parameters parameters, JsonValue payload) override;
LibWeb+WebContent+WebDriver: Implement Get Alert Text
2022-11-16 13:26:48 +00:00
virtual Web::WebDriver::Response get_alert_text(Web::WebDriver::Parameters parameters, JsonValue payload) override;
LibWeb+LibWebView+WebContent+WebDriver: Implement Send Alert Text
2022-11-16 13:57:05 +00:00
virtual Web::WebDriver::Response send_alert_text(Web::WebDriver::Parameters parameters, JsonValue payload) override;
WebDriver: Port the WebDriver client to be a Web::WebDriver::Client
2022-11-13 04:37:58 +00:00
virtual Web::WebDriver::Response take_screenshot(Web::WebDriver::Parameters parameters, JsonValue payload) override;
virtual Web::WebDriver::Response take_element_screenshot(Web::WebDriver::Parameters parameters, JsonValue payload) override;
WebDriver: Implement stub for /session/{id}/print
2022-11-26 23:30:03 +00:00
virtual Web::WebDriver::Response print_page(Web::WebDriver::Parameters parameters, JsonValue payload) override;
WebDriver: Add new WebDriver service WebDriver aims to implement the WebDriver specification found at https://w3c.github.io/webdriver/webdriver-spec.html . It's an HTTP server that can create Browser sessions and control them. Co-authored-by: Florent Castelli <florent.castelli@gmail.com>
2022-10-12 10:14:59 +00:00
WebDriver: Reference-count WebDriver Session objects When some WebDriver spec steps are implemented a bit more literally, we will end up in a situation where we remove a session from its client's active session map, but still have more steps to perform. Currently, when we remove the session, it is immediately destroyed because it is stored in an OwnPtr. Instead, we can store it as a RefPtr, which will let the caller to such steps keep the session alive until the subsequent steps are complete. While here, this also changes the storage of active sessions to a HashMap, as all lookups into it are currently a linear search.
2023-03-07 15:36:39 +00:00
static HashMap<unsigned, NonnullRefPtr<Session>> s_sessions;
WebDriver: Add new WebDriver service WebDriver aims to implement the WebDriver specification found at https://w3c.github.io/webdriver/webdriver-spec.html . It's an HTTP server that can create Browser sessions and control them. Co-authored-by: Florent Castelli <florent.castelli@gmail.com>
2022-10-12 10:14:59 +00:00
static Atomic<unsigned> s_next_session_id;
WebDriver: Specify callbacks for clients to launch browser windows This moves the actual launching of browser windows to the WebDriver main file. This will allow Ladybird to specify its own callback and re-use Serenity's Session class.
2022-12-15 13:46:01 +00:00
LaunchBrowserCallbacks m_callbacks;
WebDriver: Add new WebDriver service WebDriver aims to implement the WebDriver specification found at https://w3c.github.io/webdriver/webdriver-spec.html . It's an HTTP server that can create Browser sessions and control them. Co-authored-by: Florent Castelli <florent.castelli@gmail.com>
2022-10-12 10:14:59 +00:00
};
}
Reference in a new issue Copy permalink