summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTobias Christiansen <tobyase@serenityos.org>2022-10-19 13:21:38 +0200
committerLinus Groh <mail@linusgroh.de>2022-10-19 15:32:31 +0200
commit063bd663a7f598ab5143106d13b0328b0c73fd62 (patch)
tree004a59be3ec5266f1b6067ff04b843a9bbd6229a
parente6f71d5e053d59ac187c91367c3ac4e594f1fa08 (diff)
downloadserenity-063bd663a7f598ab5143106d13b0328b0c73fd62.zip
WebDriver: Implement `POST /session/{id}/elements` endpoint
-rw-r--r--Userland/Services/WebDriver/Client.cpp14
-rw-r--r--Userland/Services/WebDriver/Client.h1
-rw-r--r--Userland/Services/WebDriver/Session.cpp52
-rw-r--r--Userland/Services/WebDriver/Session.h1
4 files changed, 68 insertions, 0 deletions
diff --git a/Userland/Services/WebDriver/Client.cpp b/Userland/Services/WebDriver/Client.cpp
index e9ab92d4b1..3ed1710398 100644
--- a/Userland/Services/WebDriver/Client.cpp
+++ b/Userland/Services/WebDriver/Client.cpp
@@ -33,6 +33,7 @@ Vector<Client::Route> Client::s_routes = {
{ HTTP::HttpRequest::Method::GET, { "session", ":session_id", "window" }, &Client::handle_get_window_handle },
{ HTTP::HttpRequest::Method::DELETE, { "session", ":session_id", "window" }, &Client::handle_close_window },
{ HTTP::HttpRequest::Method::POST, { "session", ":session_id", "element" }, &Client::handle_find_element },
+ { HTTP::HttpRequest::Method::POST, { "session", ":session_id", "elements" }, &Client::handle_find_elements },
{ HTTP::HttpRequest::Method::GET, { "session", ":session_id", "cookie" }, &Client::handle_get_all_cookies },
{ HTTP::HttpRequest::Method::GET, { "session", ":session_id", "cookie", ":name" }, &Client::handle_get_named_cookie },
{ HTTP::HttpRequest::Method::POST, { "session", ":session_id", "cookie" }, &Client::handle_add_cookie },
@@ -537,6 +538,19 @@ ErrorOr<JsonValue, HttpError> Client::handle_find_element(Vector<StringView> con
return make_json_value(result);
}
+// 12.3.3 Find Elements, https://w3c.github.io/webdriver/#dfn-find-elements
+// POST /session/{session id}/elements
+ErrorOr<JsonValue, HttpError> Client::handle_find_elements(Vector<StringView> const& parameters, JsonValue const& payload)
+{
+ dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/elements");
+ auto* session = TRY(find_session_with_id(parameters[0]));
+
+ // NOTE: Spec steps handled in Session::find_elements().
+ auto result = TRY(session->find_elements(payload));
+
+ return make_json_value(result);
+}
+
// 14.1 Get All Cookies, https://w3c.github.io/webdriver/#dfn-get-all-cookies
// GET /session/{session id}/cookie
ErrorOr<JsonValue, HttpError> Client::handle_get_all_cookies(Vector<StringView> const& parameters, JsonValue const&)
diff --git a/Userland/Services/WebDriver/Client.h b/Userland/Services/WebDriver/Client.h
index c3ee278353..fd0340ba59 100644
--- a/Userland/Services/WebDriver/Client.h
+++ b/Userland/Services/WebDriver/Client.h
@@ -58,6 +58,7 @@ private:
ErrorOr<JsonValue, HttpError> handle_get_window_handle(Vector<StringView> const&, JsonValue const& payload);
ErrorOr<JsonValue, HttpError> handle_close_window(Vector<StringView> const&, JsonValue const& payload);
ErrorOr<JsonValue, HttpError> handle_find_element(Vector<StringView> const&, JsonValue const& payload);
+ ErrorOr<JsonValue, HttpError> handle_find_elements(Vector<StringView> const&, JsonValue const& payload);
ErrorOr<JsonValue, HttpError> handle_get_all_cookies(Vector<StringView> const&, JsonValue const& payload);
ErrorOr<JsonValue, HttpError> handle_get_named_cookie(Vector<StringView> const&, JsonValue const& payload);
ErrorOr<JsonValue, HttpError> handle_add_cookie(Vector<StringView> const&, JsonValue const& payload);
diff --git a/Userland/Services/WebDriver/Session.cpp b/Userland/Services/WebDriver/Session.cpp
index 486cdc144c..675b3fc054 100644
--- a/Userland/Services/WebDriver/Session.cpp
+++ b/Userland/Services/WebDriver/Session.cpp
@@ -414,6 +414,58 @@ ErrorOr<JsonValue, HttpError> Session::find_element(JsonValue const& payload)
return JsonValue(result.at(0));
}
+// 12.3.3 Find Elements, https://w3c.github.io/webdriver/#dfn-find-elements
+ErrorOr<JsonValue, HttpError> Session::find_elements(JsonValue const& payload)
+{
+ if (!payload.is_object())
+ return HttpError { 400, "invalid argument", "Payload is not a JSON object" };
+
+ auto const& properties = payload.as_object();
+ // 1. Let location strategy be the result of getting a property called "using".
+ if (!properties.has("using"sv))
+ return HttpError { 400, "invalid argument", "No property called 'using' present" };
+ auto const& maybe_location_strategy = properties.get("using"sv);
+ if (!maybe_location_strategy.is_string())
+ return HttpError { 400, "invalid argument", "Property 'using' is not a String" };
+
+ auto location_strategy = maybe_location_strategy.to_string();
+
+ // 2. If location strategy is not present as a keyword in the table of location strategies, return error with error code invalid argument.
+ if (!s_locator_strategies.first_matching([&](LocatorStrategy const& match) { return match.name == location_strategy; }).has_value())
+ return HttpError { 400, "invalid argument", "No valid location strategy" };
+
+ // 3. Let selector be the result of getting a property called "value".
+ // 4. If selector is undefined, return error with error code invalid argument.
+ if (!properties.has("value"sv))
+ return HttpError { 400, "invalid argument", "No property called 'value' present" };
+ auto const& maybe_selector = properties.get("value"sv);
+ if (!maybe_selector.is_string())
+ return HttpError { 400, "invalid argument", "Property 'value' is not a String" };
+
+ auto selector = maybe_selector.to_string();
+
+ // 5. If the current browsing context is no longer open, return error with error code no such window.
+ auto current_window = get_window_object();
+ if (!current_window.has_value())
+ return HttpError { 404, "no such window", "Window not found" };
+
+ // FIXME: 6. Handle any user prompts and return its value if it is an error.
+
+ // 7. Let start node be the current browsing context’s document element.
+ auto maybe_start_node_id = m_browser_connection->get_document_element();
+
+ // 8. If start node is null, return error with error code no such element.
+ if (!maybe_start_node_id.has_value())
+ return HttpError { 404, "no such element", "document element does not exist" };
+
+ auto start_node_id = maybe_start_node_id.release_value();
+ LocalElement start_node = { start_node_id };
+
+ // 9. Return the result of trying to Find with start node, location strategy, and selector.
+ auto result = TRY(find(start_node, location_strategy, selector));
+ return JsonValue(result);
+}
+
// https://w3c.github.io/webdriver/#dfn-serialized-cookie
static JsonObject serialize_cookie(Web::Cookie::Cookie const& cookie)
{
diff --git a/Userland/Services/WebDriver/Session.h b/Userland/Services/WebDriver/Session.h
index 91c4a4b9eb..d22997aa96 100644
--- a/Userland/Services/WebDriver/Session.h
+++ b/Userland/Services/WebDriver/Session.h
@@ -44,6 +44,7 @@ public:
ErrorOr<JsonValue, HttpError> refresh();
ErrorOr<JsonValue, HttpError> get_title();
ErrorOr<JsonValue, HttpError> find_element(JsonValue const& payload);
+ ErrorOr<JsonValue, HttpError> find_elements(JsonValue const& payload);
ErrorOr<void, Variant<HttpError, Error>> close_window();
ErrorOr<JsonValue, HttpError> get_all_cookies();
ErrorOr<JsonValue, HttpError> get_named_cookie(String const& name);