WebDriverConnection.h 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110
  1. /*
  2. * Copyright (c) 2022, Florent Castelli <florent.castelli@gmail.com>
  3. * Copyright (c) 2022, Linus Groh <linusg@serenityos.org>
  4. * Copyright (c) 2022, Tim Flynn <trflynn89@serenityos.org>
  5. *
  6. * SPDX-License-Identifier: BSD-2-Clause
  7. */
  8. #pragma once
  9. #include <AK/HashMap.h>
  10. #include <AK/String.h>
  11. #include <LibIPC/ConnectionToServer.h>
  12. #include <LibJS/Forward.h>
  13. #include <LibJS/Heap/MarkedVector.h>
  14. #include <LibWeb/Forward.h>
  15. #include <LibWeb/WebDriver/ElementLocationStrategies.h>
  16. #include <LibWeb/WebDriver/Response.h>
  17. #include <LibWeb/WebDriver/TimeoutsConfiguration.h>
  18. #include <WebContent/Forward.h>
  19. #include <WebContent/WebDriverClientEndpoint.h>
  20. #include <WebContent/WebDriverServerEndpoint.h>
  21. namespace WebContent {
  22. class WebDriverConnection final
  23. : public IPC::ConnectionToServer<WebDriverClientEndpoint, WebDriverServerEndpoint> {
  24. C_OBJECT(WebDriverConnection)
  25. public:
  26. static ErrorOr<NonnullRefPtr<WebDriverConnection>> connect(ConnectionFromClient& web_content_client, PageHost& page_host, String const& webdriver_ipc_path);
  27. virtual ~WebDriverConnection() = default;
  28. private:
  29. WebDriverConnection(NonnullOwnPtr<Core::Stream::LocalSocket> socket, ConnectionFromClient& web_content_client, PageHost& page_host);
  30. virtual void die() override { }
  31. virtual void close_session() override;
  32. virtual void set_is_webdriver_active(bool) override;
  33. virtual Messages::WebDriverClient::GetTimeoutsResponse get_timeouts() override;
  34. virtual Messages::WebDriverClient::SetTimeoutsResponse set_timeouts(JsonValue const& payload) override;
  35. virtual Messages::WebDriverClient::NavigateToResponse navigate_to(JsonValue const& payload) override;
  36. virtual Messages::WebDriverClient::GetCurrentUrlResponse get_current_url() override;
  37. virtual Messages::WebDriverClient::BackResponse back() override;
  38. virtual Messages::WebDriverClient::ForwardResponse forward() override;
  39. virtual Messages::WebDriverClient::RefreshResponse refresh() override;
  40. virtual Messages::WebDriverClient::GetTitleResponse get_title() override;
  41. virtual Messages::WebDriverClient::GetWindowHandleResponse get_window_handle() override;
  42. virtual Messages::WebDriverClient::CloseWindowResponse close_window() override;
  43. virtual Messages::WebDriverClient::GetWindowHandlesResponse get_window_handles() override;
  44. virtual Messages::WebDriverClient::GetWindowRectResponse get_window_rect() override;
  45. virtual Messages::WebDriverClient::SetWindowRectResponse set_window_rect(JsonValue const& payload) override;
  46. virtual Messages::WebDriverClient::MaximizeWindowResponse maximize_window() override;
  47. virtual Messages::WebDriverClient::MinimizeWindowResponse minimize_window() override;
  48. virtual Messages::WebDriverClient::FullscreenWindowResponse fullscreen_window() override;
  49. virtual Messages::WebDriverClient::FindElementResponse find_element(JsonValue const& payload) override;
  50. virtual Messages::WebDriverClient::FindElementsResponse find_elements(JsonValue const& payload) override;
  51. virtual Messages::WebDriverClient::FindElementFromElementResponse find_element_from_element(JsonValue const& payload, String const& element_id) override;
  52. virtual Messages::WebDriverClient::FindElementsFromElementResponse find_elements_from_element(JsonValue const& payload, String const& element_id) override;
  53. virtual Messages::WebDriverClient::FindElementFromShadowRootResponse find_element_from_shadow_root(JsonValue const& payload, String const& shadow_id) override;
  54. virtual Messages::WebDriverClient::GetActiveElementResponse get_active_element() override;
  55. virtual Messages::WebDriverClient::GetElementShadowRootResponse get_element_shadow_root(String const& element_id) override;
  56. virtual Messages::WebDriverClient::IsElementSelectedResponse is_element_selected(String const& element_id) override;
  57. virtual Messages::WebDriverClient::GetElementAttributeResponse get_element_attribute(String const& element_id, String const& name) override;
  58. virtual Messages::WebDriverClient::GetElementPropertyResponse get_element_property(String const& element_id, String const& name) override;
  59. virtual Messages::WebDriverClient::GetElementCssValueResponse get_element_css_value(String const& element_id, String const& name) override;
  60. virtual Messages::WebDriverClient::GetElementTextResponse get_element_text(String const& element_id) override;
  61. virtual Messages::WebDriverClient::GetElementTagNameResponse get_element_tag_name(String const& element_id) override;
  62. virtual Messages::WebDriverClient::GetElementRectResponse get_element_rect(String const& element_id) override;
  63. virtual Messages::WebDriverClient::IsElementEnabledResponse is_element_enabled(String const& element_id) override;
  64. virtual Messages::WebDriverClient::GetSourceResponse get_source() override;
  65. virtual Messages::WebDriverClient::ExecuteScriptResponse execute_script(JsonValue const& payload) override;
  66. virtual Messages::WebDriverClient::ExecuteAsyncScriptResponse execute_async_script(JsonValue const& payload) override;
  67. virtual Messages::WebDriverClient::GetAllCookiesResponse get_all_cookies() override;
  68. virtual Messages::WebDriverClient::GetNamedCookieResponse get_named_cookie(String const& name) override;
  69. virtual Messages::WebDriverClient::AddCookieResponse add_cookie(JsonValue const& payload) override;
  70. virtual Messages::WebDriverClient::DeleteCookieResponse delete_cookie(String const& name) override;
  71. virtual Messages::WebDriverClient::DeleteAllCookiesResponse delete_all_cookies() override;
  72. virtual Messages::WebDriverClient::TakeScreenshotResponse take_screenshot() override;
  73. virtual Messages::WebDriverClient::TakeElementScreenshotResponse take_element_screenshot(String const& element_id) override;
  74. ErrorOr<void, Web::WebDriver::Error> ensure_open_top_level_browsing_context();
  75. void restore_the_window();
  76. Gfx::IntRect maximize_the_window();
  77. Gfx::IntRect iconify_the_window();
  78. ErrorOr<JsonArray, Web::WebDriver::Error> find(Web::DOM::ParentNode& start_node, Web::WebDriver::LocationStrategy using_, StringView value);
  79. struct ScriptArguments {
  80. String script;
  81. JS::MarkedVector<JS::Value> arguments;
  82. };
  83. ErrorOr<ScriptArguments, Web::WebDriver::Error> extract_the_script_arguments_from_a_request(JsonValue const& payload);
  84. void delete_cookies(Optional<StringView> const& name = {});
  85. ConnectionFromClient& m_web_content_client;
  86. PageHost& m_page_host;
  87. // https://w3c.github.io/webdriver/#dfn-session-script-timeout
  88. Web::WebDriver::TimeoutsConfiguration m_timeouts_configuration;
  89. struct Window {
  90. String handle;
  91. bool is_open { false };
  92. };
  93. HashMap<String, Window> m_windows;
  94. String m_current_window_handle;
  95. };
  96. }