Client.cpp 35 KB

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