Client.cpp 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759
  1. /*
  2. * Copyright (c) 2022, Florent Castelli <florent.castelli@gmail.com>
  3. * Copyright (c) 2022, Sam Atkins <atkinssj@serenityos.org>
  4. * Copyright (c) 2022, Tobias Christiansen <tobyase@serenityos.org>
  5. * Copyright (c) 2022, Linus Groh <linusg@serenityos.org>
  6. *
  7. * SPDX-License-Identifier: BSD-2-Clause
  8. */
  9. #include <AK/Debug.h>
  10. #include <AK/JsonParser.h>
  11. #include <LibCore/DateTime.h>
  12. #include <LibCore/MemoryStream.h>
  13. #include <LibHTTP/HttpRequest.h>
  14. #include <LibHTTP/HttpResponse.h>
  15. #include <WebDriver/Client.h>
  16. #include <WebDriver/Session.h>
  17. #include <WebDriver/TimeoutsConfiguration.h>
  18. namespace WebDriver {
  19. Atomic<unsigned> Client::s_next_session_id;
  20. NonnullOwnPtrVector<Session> Client::s_sessions;
  21. Vector<Client::Route> Client::s_routes = {
  22. { HTTP::HttpRequest::Method::POST, { "session" }, &Client::handle_new_session },
  23. { HTTP::HttpRequest::Method::DELETE, { "session", ":session_id" }, &Client::handle_delete_session },
  24. { HTTP::HttpRequest::Method::GET, { "status" }, &Client::handle_get_status },
  25. { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "timeouts" }, &Client::handle_get_timeouts },
  26. { HTTP::HttpRequest::Method::POST, { "session", ":session_id", "timeouts" }, &Client::handle_set_timeouts },
  27. { HTTP::HttpRequest::Method::POST, { "session", ":session_id", "url" }, &Client::handle_navigate_to },
  28. { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "url" }, &Client::handle_get_current_url },
  29. { HTTP::HttpRequest::Method::POST, { "session", ":session_id", "back" }, &Client::handle_back },
  30. { HTTP::HttpRequest::Method::POST, { "session", ":session_id", "forward" }, &Client::handle_forward },
  31. { HTTP::HttpRequest::Method::POST, { "session", ":session_id", "refresh" }, &Client::handle_refresh },
  32. { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "title" }, &Client::handle_get_title },
  33. { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "window" }, &Client::handle_get_window_handle },
  34. { HTTP::HttpRequest::Method::DELETE, { "session", ":session_id", "window" }, &Client::handle_close_window },
  35. { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "window", "handles" }, &Client::handle_get_window_handles },
  36. { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "window", "rect" }, &Client::handle_get_window_rect },
  37. { HTTP::HttpRequest::Method::POST, { "session", ":session_id", "window", "rect" }, &Client::handle_set_window_rect },
  38. { HTTP::HttpRequest::Method::POST, { "session", ":session_id", "window", "maximize" }, &Client::handle_maximize_window },
  39. { HTTP::HttpRequest::Method::POST, { "session", ":session_id", "window", "minimize" }, &Client::handle_minimize_window },
  40. { HTTP::HttpRequest::Method::POST, { "session", ":session_id", "element" }, &Client::handle_find_element },
  41. { HTTP::HttpRequest::Method::POST, { "session", ":session_id", "elements" }, &Client::handle_find_elements },
  42. { HTTP::HttpRequest::Method::POST, { "session", ":session_id", "element", ":element_id", "element" }, &Client::handle_find_element_from_element },
  43. { HTTP::HttpRequest::Method::POST, { "session", ":session_id", "element", ":element_id", "elements" }, &Client::handle_find_elements_from_element },
  44. { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "element", ":element_id", "attribute", ":name" }, &Client::handle_get_element_attribute },
  45. { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "element", ":element_id", "property", ":name" }, &Client::handle_get_element_property },
  46. { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "element", ":element_id", "css", ":property_name" }, &Client::handle_get_element_css_value },
  47. { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "element", ":element_id", "text" }, &Client::handle_get_element_text },
  48. { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "element", ":element_id", "name" }, &Client::handle_get_element_tag_name },
  49. { HTTP::HttpRequest::Method::POST, { "session", ":session_id", "execute", "sync" }, &Client::handle_execute_script },
  50. { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "cookie" }, &Client::handle_get_all_cookies },
  51. { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "cookie", ":name" }, &Client::handle_get_named_cookie },
  52. { HTTP::HttpRequest::Method::POST, { "session", ":session_id", "cookie" }, &Client::handle_add_cookie },
  53. { HTTP::HttpRequest::Method::DELETE, { "session", ":session_id", "cookie", ":name" }, &Client::handle_delete_cookie },
  54. { HTTP::HttpRequest::Method::DELETE, { "session", ":session_id", "cookie" }, &Client::handle_delete_all_cookies },
  55. { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "screenshot" }, &Client::handle_take_screenshot },
  56. };
  57. Client::Client(NonnullOwnPtr<Core::Stream::BufferedTCPSocket> socket, Core::Object* parent)
  58. : Core::Object(parent)
  59. , m_socket(move(socket))
  60. {
  61. }
  62. void Client::die()
  63. {
  64. m_socket->close();
  65. deferred_invoke([this] { remove_from_parent(); });
  66. }
  67. void Client::start()
  68. {
  69. m_socket->on_ready_to_read = [this] {
  70. StringBuilder builder;
  71. // FIXME: All this should be moved to LibHTTP and be made spec compliant
  72. auto maybe_buffer = ByteBuffer::create_uninitialized(m_socket->buffer_size());
  73. if (maybe_buffer.is_error()) {
  74. warnln("Could not create buffer for client: {}", maybe_buffer.error());
  75. die();
  76. return;
  77. }
  78. auto buffer = maybe_buffer.release_value();
  79. for (;;) {
  80. auto maybe_can_read = m_socket->can_read_without_blocking();
  81. if (maybe_can_read.is_error()) {
  82. warnln("Failed to get the blocking status for the socket: {}", maybe_can_read.error());
  83. die();
  84. return;
  85. }
  86. if (!maybe_can_read.value())
  87. break;
  88. auto maybe_data = m_socket->read(buffer);
  89. if (maybe_data.is_error()) {
  90. warnln("Failed to read data from the request: {}", maybe_data.error());
  91. die();
  92. return;
  93. }
  94. if (m_socket->is_eof()) {
  95. die();
  96. break;
  97. }
  98. builder.append(StringView(maybe_data.value()));
  99. }
  100. auto request = builder.to_byte_buffer();
  101. auto http_request_or_error = HTTP::HttpRequest::from_raw_request(request);
  102. if (!http_request_or_error.has_value())
  103. return;
  104. auto http_request = http_request_or_error.release_value();
  105. auto body_or_error = read_body_as_json(http_request);
  106. if (body_or_error.is_error()) {
  107. warnln("Failed to read the request body: {}", body_or_error.error());
  108. die();
  109. return;
  110. }
  111. auto maybe_did_handle = handle_request(http_request, body_or_error.value());
  112. if (maybe_did_handle.is_error()) {
  113. warnln("Failed to handle the request: {}", maybe_did_handle.error());
  114. }
  115. die();
  116. };
  117. }
  118. ErrorOr<JsonValue> Client::read_body_as_json(HTTP::HttpRequest const& request)
  119. {
  120. // If we received a multipart body here, this would fail badly.
  121. unsigned content_length = 0;
  122. for (auto const& header : request.headers()) {
  123. if (header.name.equals_ignoring_case("Content-Length"sv)) {
  124. content_length = header.value.to_int(TrimWhitespace::Yes).value_or(0);
  125. break;
  126. }
  127. }
  128. if (!content_length)
  129. return JsonValue();
  130. // FIXME: Check the Content-Type is actually application/json
  131. JsonParser json_parser(request.body());
  132. return json_parser.parse();
  133. }
  134. ErrorOr<bool> Client::handle_request(HTTP::HttpRequest const& request, JsonValue const& body)
  135. {
  136. if constexpr (WEBDRIVER_DEBUG) {
  137. dbgln("Got HTTP request: {} {}", request.method_name(), request.resource());
  138. if (!body.is_null())
  139. dbgln("Body: {}", body.to_string());
  140. }
  141. auto routing_result_match = match_route(request.method(), request.resource());
  142. if (routing_result_match.is_error()) {
  143. auto error = routing_result_match.release_error();
  144. dbgln_if(WEBDRIVER_DEBUG, "Failed to match route: {}", error);
  145. TRY(send_error_response(error, request));
  146. return false;
  147. }
  148. auto routing_result = routing_result_match.release_value();
  149. auto result = (this->*routing_result.handler)(routing_result.parameters, body);
  150. if (result.is_error()) {
  151. dbgln_if(WEBDRIVER_DEBUG, "Error in calling route handler: {}", result.error());
  152. TRY(send_error_response(result.release_error(), request));
  153. return false;
  154. }
  155. auto object = result.release_value();
  156. TRY(send_response(object.to_string(), request));
  157. return true;
  158. }
  159. // https://w3c.github.io/webdriver/#dfn-send-a-response
  160. ErrorOr<void> Client::send_response(StringView content, HTTP::HttpRequest const& request)
  161. {
  162. // FIXME: Implement to spec.
  163. StringBuilder builder;
  164. builder.append("HTTP/1.0 200 OK\r\n"sv);
  165. builder.append("Server: WebDriver (SerenityOS)\r\n"sv);
  166. builder.append("X-Frame-Options: SAMEORIGIN\r\n"sv);
  167. builder.append("X-Content-Type-Options: nosniff\r\n"sv);
  168. builder.append("Pragma: no-cache\r\n"sv);
  169. builder.append("Content-Type: application/json; charset=utf-8\r\n"sv);
  170. builder.appendff("Content-Length: {}\r\n", content.length());
  171. builder.append("\r\n"sv);
  172. auto builder_contents = builder.to_byte_buffer();
  173. TRY(m_socket->write(builder_contents));
  174. while (!content.is_empty()) {
  175. auto bytes_sent = TRY(m_socket->write(content.bytes()));
  176. content = content.substring_view(bytes_sent);
  177. }
  178. log_response(200, request);
  179. auto keep_alive = false;
  180. if (auto it = request.headers().find_if([](auto& header) { return header.name.equals_ignoring_case("Connection"sv); }); !it.is_end()) {
  181. if (it->value.trim_whitespace().equals_ignoring_case("keep-alive"sv))
  182. keep_alive = true;
  183. }
  184. if (!keep_alive)
  185. m_socket->close();
  186. return {};
  187. }
  188. // https://w3c.github.io/webdriver/#dfn-send-an-error
  189. ErrorOr<void> Client::send_error_response(WebDriverError const& error, HTTP::HttpRequest const& request)
  190. {
  191. // FIXME: Implement to spec.
  192. dbgln("send_error_response: {} {}: {}", error.http_status, error.error, error.message);
  193. auto reason_phrase = HTTP::HttpResponse::reason_phrase_for_code(error.http_status);
  194. auto result = JsonObject();
  195. result.set("error", error.error);
  196. result.set("message", error.message);
  197. result.set("stacktrace", "");
  198. if (error.data.has_value())
  199. result.set("data", *error.data);
  200. StringBuilder content_builder;
  201. result.serialize(content_builder);
  202. StringBuilder header_builder;
  203. header_builder.appendff("HTTP/1.0 {} ", error.http_status);
  204. header_builder.append(reason_phrase);
  205. header_builder.append("\r\n"sv);
  206. header_builder.append("Content-Type: application/json; charset=UTF-8\r\n"sv);
  207. header_builder.appendff("Content-Length: {}\r\n", content_builder.length());
  208. header_builder.append("\r\n"sv);
  209. TRY(m_socket->write(header_builder.to_byte_buffer()));
  210. TRY(m_socket->write(content_builder.to_byte_buffer()));
  211. log_response(error.http_status, request);
  212. return {};
  213. }
  214. void Client::log_response(unsigned code, HTTP::HttpRequest const& request)
  215. {
  216. outln("{} :: {:03d} :: {} {}", Core::DateTime::now().to_string(), code, request.method_name(), request.resource());
  217. }
  218. // https://w3c.github.io/webdriver/#dfn-match-a-request
  219. ErrorOr<Client::RoutingResult, WebDriverError> Client::match_route(HTTP::HttpRequest::Method method, String const& resource)
  220. {
  221. // FIXME: Implement to spec.
  222. dbgln_if(WEBDRIVER_DEBUG, "match_route({}, {})", HTTP::to_string(method), resource);
  223. // https://w3c.github.io/webdriver/webdriver-spec.html#routing-requests
  224. if (!resource.starts_with(m_prefix))
  225. return WebDriverError::from_code(ErrorCode::UnknownCommand, "The resource doesn't start with the prefix.");
  226. Vector<StringView> resource_split = resource.substring_view(m_prefix.length()).split_view('/', SplitBehavior::KeepEmpty);
  227. Vector<StringView> parameters;
  228. bool matched_path = false;
  229. for (auto const& route : Client::s_routes) {
  230. dbgln_if(WEBDRIVER_DEBUG, "- Checking {} {}", HTTP::to_string(route.method), String::join("/"sv, route.path));
  231. if (resource_split.size() != route.path.size()) {
  232. dbgln_if(WEBDRIVER_DEBUG, "-> Discarding: Wrong length");
  233. continue;
  234. }
  235. bool match = true;
  236. for (size_t i = 0; i < route.path.size(); ++i) {
  237. if (route.path[i].starts_with(':')) {
  238. parameters.append(resource_split[i]);
  239. continue;
  240. }
  241. if (route.path[i] != resource_split[i]) {
  242. match = false;
  243. parameters.clear();
  244. dbgln_if(WEBDRIVER_DEBUG, "-> Discarding: Part `{}` does not match `{}`", route.path[i], resource_split[i]);
  245. break;
  246. }
  247. }
  248. if (match && route.method == method) {
  249. dbgln_if(WEBDRIVER_DEBUG, "-> Matched! :^)");
  250. return RoutingResult { route.handler, parameters };
  251. }
  252. matched_path = true;
  253. }
  254. // Matched a path, but didn't match a known method
  255. if (matched_path) {
  256. dbgln_if(WEBDRIVER_DEBUG, "- A path matched, but method didn't. :^(");
  257. return WebDriverError::from_code(ErrorCode::UnknownMethod, "The command matched a known URL but did not match a method for that URL.");
  258. }
  259. // Didn't have any match
  260. dbgln_if(WEBDRIVER_DEBUG, "- No matches. :^(");
  261. return WebDriverError::from_code(ErrorCode::UnknownCommand, "The command was not recognized.");
  262. }
  263. ErrorOr<Session*, WebDriverError> Client::find_session_with_id(StringView session_id)
  264. {
  265. auto session_id_or_error = session_id.to_uint<>();
  266. if (!session_id_or_error.has_value())
  267. return WebDriverError::from_code(ErrorCode::InvalidSessionId, "Invalid session id");
  268. for (auto& session : Client::s_sessions) {
  269. if (session.session_id() == session_id_or_error.value())
  270. return &session;
  271. }
  272. return WebDriverError::from_code(ErrorCode::InvalidSessionId, "Invalid session id");
  273. }
  274. void Client::close_session(unsigned session_id)
  275. {
  276. bool found = Client::s_sessions.remove_first_matching([&](auto const& it) {
  277. return it->session_id() == session_id;
  278. });
  279. if (found)
  280. dbgln_if(WEBDRIVER_DEBUG, "Shut down session {}", session_id);
  281. else
  282. dbgln_if(WEBDRIVER_DEBUG, "Unable to shut down session {}: Not found", session_id);
  283. }
  284. JsonValue Client::make_json_value(JsonValue const& value)
  285. {
  286. JsonObject result;
  287. result.set("value", value);
  288. return result;
  289. }
  290. // 8.1 New Session, https://w3c.github.io/webdriver/#dfn-new-sessions
  291. // POST /session
  292. ErrorOr<JsonValue, WebDriverError> Client::handle_new_session(Vector<StringView> const&, JsonValue const&)
  293. {
  294. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session");
  295. // FIXME: 1. If the maximum active sessions is equal to the length of the list of active sessions,
  296. // return error with error code session not created.
  297. // FIXME: 2. If the remote end is an intermediary node, take implementation-defined steps that either
  298. // result in returning an error with error code session not created, or in returning a
  299. // success with data that is isomorphic to that returned by remote ends according to the
  300. // rest of this algorithm. If an error is not returned, the intermediary node must retain a
  301. // reference to the session created on the upstream node as the associated session such
  302. // that commands may be forwarded to this associated session on subsequent commands.
  303. // FIXME: 3. If the maximum active sessions is equal to the length of the list of active sessions,
  304. // return error with error code session not created.
  305. // FIXME: 4. Let capabilities be the result of trying to process capabilities with parameters as an argument.
  306. auto capabilities = JsonObject {};
  307. // FIXME: 5. If capabilities’s is null, return error with error code session not created.
  308. // 6. Let session id be the result of generating a UUID.
  309. // FIXME: Actually create a UUID.
  310. auto session_id = Client::s_next_session_id++;
  311. // 7. Let session be a new session with the session ID of session id.
  312. NonnullOwnPtr<Session> session = make<Session>(session_id, *this);
  313. auto start_result = session->start();
  314. if (start_result.is_error()) {
  315. return WebDriverError::from_code(ErrorCode::SessionNotCreated, String::formatted("Failed to start session: {}", start_result.error().string_literal()));
  316. }
  317. // FIXME: 8. Set the current session to session.
  318. // FIXME: 9. Run any WebDriver new session algorithm defined in external specifications,
  319. // with arguments session and capabilities.
  320. // 10. Append session to active sessions.
  321. Client::s_sessions.append(move(session));
  322. // 11. Let body be a JSON Object initialized with:
  323. JsonObject body;
  324. // "sessionId"
  325. // session id
  326. body.set("sessionId", String::number(session_id));
  327. // "capabilities"
  328. // capabilities
  329. body.set("capabilities", move(capabilities));
  330. // FIXME: 12. Initialize the following from capabilities:
  331. // NOTE: See spec for steps
  332. // FIXME: 13. Set the webdriver-active flag to true.
  333. // FIXME: 14. Set the current top-level browsing context for session with the top-level browsing context
  334. // of the UA’s current browsing context.
  335. // FIXME: 15. Set the request queue to a new queue.
  336. // 16. Return success with data body.
  337. return make_json_value(body);
  338. }
  339. // 8.2 Delete Session, https://w3c.github.io/webdriver/#dfn-delete-session
  340. // DELETE /session/{session id}
  341. ErrorOr<JsonValue, WebDriverError> Client::handle_delete_session(Vector<StringView> const& parameters, JsonValue const&)
  342. {
  343. dbgln_if(WEBDRIVER_DEBUG, "Handling DELETE /session/<session_id>");
  344. // 1. If the current session is an active session, try to close the session.
  345. auto* session = TRY(find_session_with_id(parameters[0]));
  346. auto stop_result = session->stop();
  347. if (stop_result.is_error())
  348. return WebDriverError::from_code(ErrorCode::UnsupportedOperation, stop_result.error().string_literal());
  349. // 2. Return success with data null.
  350. return make_json_value(JsonValue());
  351. }
  352. // 8.3 Status, https://w3c.github.io/webdriver/#dfn-status
  353. // GET /status
  354. ErrorOr<JsonValue, WebDriverError> Client::handle_get_status(Vector<StringView> const&, JsonValue const&)
  355. {
  356. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /status");
  357. // 1. Let body be a new JSON Object with the following properties:
  358. // "ready"
  359. // The remote end’s readiness state.
  360. // "message"
  361. // An implementation-defined string explaining the remote end’s readiness state.
  362. // FIXME: Report if we are somehow not ready.
  363. JsonObject body;
  364. body.set("ready", true);
  365. body.set("message", "Ready to start some sessions!");
  366. // 2. Return success with data body.
  367. return body;
  368. }
  369. // 9.1 Get Timeouts, https://w3c.github.io/webdriver/#dfn-get-timeouts
  370. // GET /session/{session id}/timeouts
  371. ErrorOr<JsonValue, WebDriverError> Client::handle_get_timeouts(Vector<StringView> const& parameters, JsonValue const&)
  372. {
  373. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session id>/timeouts");
  374. auto* session = TRY(find_session_with_id(parameters[0]));
  375. auto result = session->get_timeouts();
  376. return make_json_value(result);
  377. }
  378. // 9.2 Set Timeouts, https://w3c.github.io/webdriver/#dfn-set-timeouts
  379. // POST /session/{session id}/timeouts
  380. ErrorOr<JsonValue, WebDriverError> Client::handle_set_timeouts(Vector<StringView> const& parameters, JsonValue const& payload)
  381. {
  382. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session id>/timeouts");
  383. auto* session = TRY(find_session_with_id(parameters[0]));
  384. auto result = TRY(session->set_timeouts(payload));
  385. return make_json_value(result);
  386. }
  387. // 10.1 Navigate To, https://w3c.github.io/webdriver/#dfn-navigate-to
  388. // POST /session/{session id}/url
  389. ErrorOr<JsonValue, WebDriverError> Client::handle_navigate_to(Vector<StringView> const& parameters, JsonValue const& payload)
  390. {
  391. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/url");
  392. auto* session = TRY(find_session_with_id(parameters[0]));
  393. auto result = TRY(session->navigate_to(payload));
  394. return make_json_value(result);
  395. }
  396. // 10.2 Get Current URL, https://w3c.github.io/webdriver/#dfn-get-current-url
  397. // GET /session/{session id}/url
  398. ErrorOr<JsonValue, WebDriverError> Client::handle_get_current_url(Vector<StringView> const& parameters, JsonValue const&)
  399. {
  400. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/url");
  401. auto* session = TRY(find_session_with_id(parameters[0]));
  402. auto result = TRY(session->get_current_url());
  403. return make_json_value(result);
  404. }
  405. // 10.3 Back, https://w3c.github.io/webdriver/#dfn-back
  406. // POST /session/{session id}/back
  407. ErrorOr<JsonValue, WebDriverError> Client::handle_back(Vector<StringView> const& parameters, JsonValue const&)
  408. {
  409. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/back");
  410. auto* session = TRY(find_session_with_id(parameters[0]));
  411. auto result = TRY(session->back());
  412. return make_json_value(result);
  413. }
  414. // 10.4 Forward, https://w3c.github.io/webdriver/#dfn-forward
  415. // POST /session/{session id}/forward
  416. ErrorOr<JsonValue, WebDriverError> Client::handle_forward(Vector<StringView> const& parameters, JsonValue const&)
  417. {
  418. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/forward");
  419. auto* session = TRY(find_session_with_id(parameters[0]));
  420. auto result = TRY(session->forward());
  421. return make_json_value(result);
  422. }
  423. // 10.5 Refresh, https://w3c.github.io/webdriver/#dfn-refresh
  424. // POST /session/{session id}/refresh
  425. ErrorOr<JsonValue, WebDriverError> Client::handle_refresh(Vector<StringView> const& parameters, JsonValue const&)
  426. {
  427. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/refresh");
  428. auto* session = TRY(find_session_with_id(parameters[0]));
  429. auto result = TRY(session->refresh());
  430. return make_json_value(result);
  431. }
  432. // 10.6 Get Title, https://w3c.github.io/webdriver/#dfn-get-title
  433. // GET /session/{session id}/title
  434. ErrorOr<JsonValue, WebDriverError> Client::handle_get_title(Vector<StringView> const& parameters, JsonValue const&)
  435. {
  436. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/title");
  437. auto* session = TRY(find_session_with_id(parameters[0]));
  438. auto result = TRY(session->get_title());
  439. return make_json_value(result);
  440. }
  441. // 11.1 Get Window Handle, https://w3c.github.io/webdriver/#get-window-handle
  442. // GET /session/{session id}/window
  443. ErrorOr<JsonValue, WebDriverError> Client::handle_get_window_handle(Vector<StringView> const& parameters, JsonValue const&)
  444. {
  445. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/window");
  446. auto* session = TRY(find_session_with_id(parameters[0]));
  447. auto result = TRY(session->get_window_handle());
  448. return make_json_value(result);
  449. }
  450. // 11.2 Close Window, https://w3c.github.io/webdriver/#dfn-close-window
  451. // DELETE /session/{session id}/window
  452. ErrorOr<JsonValue, WebDriverError> Client::handle_close_window(Vector<StringView> const& parameters, JsonValue const&)
  453. {
  454. dbgln_if(WEBDRIVER_DEBUG, "Handling DELETE /session/<session_id>/window");
  455. auto* session = TRY(find_session_with_id(parameters[0]));
  456. TRY(unwrap_result(session->close_window()));
  457. return make_json_value(JsonValue());
  458. }
  459. // 11.4 Get Window Handles, https://w3c.github.io/webdriver/#dfn-get-window-handles
  460. // GET /session/{session id}/window/handles
  461. ErrorOr<JsonValue, WebDriverError> Client::handle_get_window_handles(Vector<StringView> const& parameters, JsonValue const&)
  462. {
  463. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/window/handles");
  464. auto* session = TRY(find_session_with_id(parameters[0]));
  465. auto result = TRY(session->get_window_handles());
  466. return make_json_value(result);
  467. }
  468. // 11.8.1 Get Window Rect, https://w3c.github.io/webdriver/#dfn-get-window-rect
  469. // GET /session/{session id}/window/rect
  470. ErrorOr<JsonValue, WebDriverError> Client::handle_get_window_rect(Vector<StringView> const& parameters, JsonValue const&)
  471. {
  472. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/window/rect");
  473. auto* session = TRY(find_session_with_id(parameters[0]));
  474. auto result = TRY(session->get_window_rect());
  475. return make_json_value(result);
  476. }
  477. // 11.8.2 Set Window Rect, https://w3c.github.io/webdriver/#dfn-set-window-rect
  478. // POST /session/{session id}/window/rect
  479. ErrorOr<JsonValue, WebDriverError> Client::handle_set_window_rect(Vector<StringView> const& parameters, JsonValue const& payload)
  480. {
  481. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/window/rect");
  482. auto* session = TRY(find_session_with_id(parameters[0]));
  483. auto result = TRY(session->set_window_rect(payload));
  484. return make_json_value(result);
  485. }
  486. // 11.8.3 Maximize Window, https://w3c.github.io/webdriver/#dfn-maximize-window
  487. // POST /session/{session id}/window/maximize
  488. ErrorOr<JsonValue, WebDriverError> Client::handle_maximize_window(Vector<StringView> const& parameters, JsonValue const&)
  489. {
  490. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/window/maximize");
  491. auto* session = TRY(find_session_with_id(parameters[0]));
  492. auto result = TRY(session->maximize_window());
  493. return make_json_value(result);
  494. }
  495. // 11.8.4 Minimize Window, https://w3c.github.io/webdriver/#minimize-window
  496. // POST /session/{session id}/window/minimize
  497. ErrorOr<JsonValue, WebDriverError> Client::handle_minimize_window(Vector<StringView> const& parameters, JsonValue const&)
  498. {
  499. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/window/minimize");
  500. auto* session = TRY(find_session_with_id(parameters[0]));
  501. auto result = TRY(session->minimize_window());
  502. return make_json_value(result);
  503. }
  504. // 12.3.2 Find Element, https://w3c.github.io/webdriver/#dfn-find-element
  505. // POST /session/{session id}/element
  506. ErrorOr<JsonValue, WebDriverError> Client::handle_find_element(Vector<StringView> const& parameters, JsonValue const& payload)
  507. {
  508. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/element");
  509. auto* session = TRY(find_session_with_id(parameters[0]));
  510. auto result = TRY(session->find_element(payload));
  511. return make_json_value(result);
  512. }
  513. // 12.3.3 Find Elements, https://w3c.github.io/webdriver/#dfn-find-elements
  514. // POST /session/{session id}/elements
  515. ErrorOr<JsonValue, WebDriverError> Client::handle_find_elements(Vector<StringView> const& parameters, JsonValue const& payload)
  516. {
  517. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/elements");
  518. auto* session = TRY(find_session_with_id(parameters[0]));
  519. auto result = TRY(session->find_elements(payload));
  520. return make_json_value(result);
  521. }
  522. // 12.3.4 Find Element From Element, https://w3c.github.io/webdriver/#dfn-find-element-from-element
  523. // POST /session/{session id}/element/{element id}/element
  524. ErrorOr<JsonValue, WebDriverError> Client::handle_find_element_from_element(Vector<StringView> const& parameters, JsonValue const& payload)
  525. {
  526. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/element/<element_id>/element");
  527. auto* session = TRY(find_session_with_id(parameters[0]));
  528. auto result = TRY(session->find_element_from_element(payload, parameters[1]));
  529. return make_json_value(result);
  530. }
  531. // 12.3.5 Find Elements From Element, https://w3c.github.io/webdriver/#dfn-find-elements-from-element
  532. // POST /session/{session id}/element/{element id}/elements
  533. ErrorOr<JsonValue, WebDriverError> Client::handle_find_elements_from_element(Vector<StringView> const& parameters, JsonValue const& payload)
  534. {
  535. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/element/<element_id>/elements");
  536. auto* session = TRY(find_session_with_id(parameters[0]));
  537. auto result = TRY(session->find_elements_from_element(payload, parameters[1]));
  538. return make_json_value(result);
  539. }
  540. // 12.4.2 Get Element Attribute, https://w3c.github.io/webdriver/#dfn-get-element-attribute
  541. // GET /session/{session id}/element/{element id}/attribute/{name}
  542. ErrorOr<JsonValue, WebDriverError> Client::handle_get_element_attribute(Vector<StringView> const& parameters, JsonValue const& payload)
  543. {
  544. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/element/<element_id>/attribute/<name>");
  545. auto* session = TRY(find_session_with_id(parameters[0]));
  546. auto result = TRY(session->get_element_attribute(payload, parameters[1], parameters[2]));
  547. return make_json_value(result);
  548. }
  549. // 12.4.3 Get Element Property, https://w3c.github.io/webdriver/#dfn-get-element-property
  550. // GET /session/{session id}/element/{element id}/property/{name}
  551. ErrorOr<JsonValue, WebDriverError> Client::handle_get_element_property(Vector<StringView> const& parameters, JsonValue const& payload)
  552. {
  553. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/element/<element_id>/property/<name>");
  554. auto* session = TRY(find_session_with_id(parameters[0]));
  555. auto result = TRY(session->get_element_property(payload, parameters[1], parameters[2]));
  556. return make_json_value(result);
  557. }
  558. // 12.4.4 Get Element CSS Value, https://w3c.github.io/webdriver/#dfn-get-element-css-value
  559. // GET /session/{session id}/element/{element id}/css/{property name}
  560. ErrorOr<JsonValue, WebDriverError> Client::handle_get_element_css_value(Vector<StringView> const& parameters, JsonValue const& payload)
  561. {
  562. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/element/<element_id>/css/<property_name>");
  563. auto* session = TRY(find_session_with_id(parameters[0]));
  564. auto result = TRY(session->get_element_css_value(payload, parameters[1], parameters[2]));
  565. return make_json_value(result);
  566. }
  567. // 12.4.5 Get Element Text, https://w3c.github.io/webdriver/#dfn-get-element-text
  568. // GET /session/{session id}/element/{element id}/text
  569. ErrorOr<JsonValue, WebDriverError> Client::handle_get_element_text(Vector<StringView> const& parameters, JsonValue const& payload)
  570. {
  571. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/element/<element_id>/text");
  572. auto* session = TRY(find_session_with_id(parameters[0]));
  573. auto result = TRY(session->get_element_text(payload, parameters[1]));
  574. return make_json_value(result);
  575. }
  576. // 12.4.6 Get Element Tag Name, https://w3c.github.io/webdriver/#dfn-get-element-tag-name
  577. // GET /session/{session id}/element/{element id}/name
  578. ErrorOr<JsonValue, WebDriverError> Client::handle_get_element_tag_name(Vector<StringView> const& parameters, JsonValue const& payload)
  579. {
  580. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/element/<element_id>/name");
  581. auto* session = TRY(find_session_with_id(parameters[0]));
  582. auto result = TRY(session->get_element_tag_name(payload, parameters[1]));
  583. return make_json_value(result);
  584. }
  585. // 13.2.1 Execute Script, https://w3c.github.io/webdriver/#dfn-execute-script
  586. // POST /session/{session id}/execute/sync
  587. ErrorOr<JsonValue, WebDriverError> Client::handle_execute_script(Vector<StringView> const& parameters, JsonValue const& payload)
  588. {
  589. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/execute/sync");
  590. auto* session = TRY(find_session_with_id(parameters[0]));
  591. auto result = TRY(session->execute_script(payload));
  592. return make_json_value(result);
  593. }
  594. // 14.1 Get All Cookies, https://w3c.github.io/webdriver/#dfn-get-all-cookies
  595. // GET /session/{session id}/cookie
  596. ErrorOr<JsonValue, WebDriverError> Client::handle_get_all_cookies(Vector<StringView> const& parameters, JsonValue const&)
  597. {
  598. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/cookie");
  599. auto* session = TRY(find_session_with_id(parameters[0]));
  600. auto cookies = TRY(session->get_all_cookies());
  601. return make_json_value(cookies);
  602. }
  603. // 14.2 Get Named Cookie, https://w3c.github.io/webdriver/#dfn-get-named-cookie
  604. // GET /session/{session id}/cookie/{name}
  605. ErrorOr<JsonValue, WebDriverError> Client::handle_get_named_cookie(Vector<StringView> const& parameters, JsonValue const&)
  606. {
  607. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/cookie/<name>");
  608. auto* session = TRY(find_session_with_id(parameters[0]));
  609. auto cookies = TRY(session->get_named_cookie(parameters[1]));
  610. return make_json_value(cookies);
  611. }
  612. // 14.3 Add Cookie, https://w3c.github.io/webdriver/#dfn-adding-a-cookie
  613. // POST /session/{session id}/cookie
  614. ErrorOr<JsonValue, WebDriverError> Client::handle_add_cookie(Vector<StringView> const& parameters, JsonValue const& payload)
  615. {
  616. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/cookie");
  617. auto* session = TRY(find_session_with_id(parameters[0]));
  618. auto result = TRY(session->add_cookie(payload));
  619. return make_json_value(result);
  620. }
  621. // 14.4 Delete Cookie, https://w3c.github.io/webdriver/#dfn-delete-cookie
  622. // DELETE /session/{session id}/cookie/{name}
  623. ErrorOr<JsonValue, WebDriverError> Client::handle_delete_cookie(Vector<StringView> const& parameters, JsonValue const&)
  624. {
  625. dbgln_if(WEBDRIVER_DEBUG, "Handling DELETE /session/<session_id>/cookie/<name>");
  626. auto* session = TRY(find_session_with_id(parameters[0]));
  627. auto result = TRY(session->delete_cookie(parameters[1]));
  628. return make_json_value(result);
  629. }
  630. // 14.5 Delete All Cookies, https://w3c.github.io/webdriver/#dfn-delete-all-cookies
  631. // DELETE /session/{session id}/cookie
  632. ErrorOr<JsonValue, WebDriverError> Client::handle_delete_all_cookies(Vector<StringView> const& parameters, JsonValue const&)
  633. {
  634. dbgln_if(WEBDRIVER_DEBUG, "Handling DELETE /session/<session_id>/cookie");
  635. auto* session = TRY(find_session_with_id(parameters[0]));
  636. auto result = TRY(session->delete_all_cookies());
  637. return make_json_value(result);
  638. }
  639. // 17.1 Take Screenshot, https://w3c.github.io/webdriver/#take-screenshot
  640. // GET /session/{session id}/screenshot
  641. ErrorOr<JsonValue, WebDriverError> Client::handle_take_screenshot(Vector<StringView> const& parameters, JsonValue const&)
  642. {
  643. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/screenshot");
  644. auto* session = TRY(find_session_with_id(parameters[0]));
  645. auto result = TRY(session->take_screenshot());
  646. return make_json_value(result);
  647. }
  648. }