1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
|
//
// Copyright (c) 2019-2025 Ruben Perez Hidalgo (rubenperez038 at gmail dot com)
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
//
#include <boost/asio/awaitable.hpp>
#include <boost/pfr/config.hpp>
#if defined(BOOST_ASIO_HAS_CO_AWAIT) && BOOST_PFR_CORE_NAME_ENABLED
//[example_http_server_cpp20_handle_request_cpp
//
// File: handle_request.cpp
//
// This file contains all the boilerplate code to dispatch HTTP
// requests to API endpoints. Functions here end up calling
// db_repository fuctions.
#include <boost/mysql/connection_pool.hpp>
#include <boost/mysql/diagnostics.hpp>
#include <boost/mysql/error_with_diagnostics.hpp>
#include <boost/asio/awaitable.hpp>
#include <boost/beast/http/message.hpp>
#include <boost/beast/http/status.hpp>
#include <boost/beast/http/string_body.hpp>
#include <boost/beast/http/verb.hpp>
#include <boost/json/parse.hpp>
#include <boost/json/serialize.hpp>
#include <boost/json/value_from.hpp>
#include <boost/json/value_to.hpp>
#include <boost/system/error_code.hpp>
#include <boost/system/result.hpp>
#include <boost/url/parse.hpp>
#include <boost/url/url_view.hpp>
#include <algorithm>
#include <charconv>
#include <cstdint>
#include <exception>
#include <iostream>
#include <optional>
#include <string>
#include <string_view>
#include <system_error>
#include <unordered_map>
#include <vector>
#include "error.hpp"
#include "handle_request.hpp"
#include "repository.hpp"
#include "types.hpp"
namespace asio = boost::asio;
namespace http = boost::beast::http;
namespace mysql = boost::mysql;
using boost::system::result;
namespace {
// Helper function that logs errors thrown by db_repository
// when an unexpected database error happens
void log_mysql_error(boost::system::error_code ec, const mysql::diagnostics& diag)
{
// Lock std::cerr, to avoid race conditions
auto guard = orders::lock_cerr();
// Inserting the error code only prints the number and category. Add the message, too.
std::cerr << "MySQL error: " << ec << " " << ec.message();
// client_message() contains client-side generated messages that don't
// contain user-input. This is usually embedded in exceptions.
// When working with error codes, we need to log it explicitly
if (!diag.client_message().empty())
{
std::cerr << ": " << diag.client_message();
}
// server_message() contains server-side messages, and thus may
// contain user-supplied input. Printing it is safe.
if (!diag.server_message().empty())
{
std::cerr << ": " << diag.server_message();
}
// Done
std::cerr << std::endl;
}
// Attempts to parse a numeric ID from a string
std::optional<std::int64_t> parse_id(std::string_view from)
{
std::int64_t id{};
auto res = std::from_chars(from.data(), from.data() + from.size(), id);
if (res.ec != std::errc{} || res.ptr != from.data() + from.size())
return std::nullopt;
return id;
}
// Helpers to create error responses with a single line of code
http::response<http::string_body> error_response(http::status code, std::string_view msg)
{
http::response<http::string_body> res;
res.result(code);
res.body() = msg;
return res;
}
// Like error_response, but always uses a 400 status code
http::response<http::string_body> bad_request(std::string_view body)
{
return error_response(http::status::bad_request, body);
}
// Like error_response, but always uses a 500 status code and
// never provides extra information that might help potential attackers.
http::response<http::string_body> internal_server_error()
{
return error_response(http::status::internal_server_error, "Internal server error");
}
// Creates a response with a serialized JSON body.
// T should be a type with Boost.Describe metadata containing the
// body data to be serialized
template <class T>
http::response<http::string_body> json_response(const T& body)
{
http::response<http::string_body> res;
// Set the content-type header
res.set("Content-Type", "application/json");
// Serialize the body data into a string and use it as the response body.
// We use Boost.JSON's automatic serialization feature, which uses Boost.Describe
// reflection data to generate a serialization function for us.
res.body() = boost::json::serialize(boost::json::value_from(body));
// Done
return res;
}
// Attempts to parse a string as a JSON into an object of type T.
// T should be a type with Boost.Describe metadata.
// We use boost::system::result, which may contain a result or an error.
template <class T>
result<T> parse_json(std::string_view json_string)
{
// Attempt to parse the request into a json::value.
// This will fail if the provided body isn't valid JSON.
boost::system::error_code ec;
auto val = boost::json::parse(json_string, ec);
if (ec)
return ec;
// Attempt to parse the json::value into a T. This will
// fail if the provided JSON doesn't match T's shape.
return boost::json::try_value_to<T>(val);
}
// Generates an HTTP error response based on an error code
// returned by db_repository.
http::response<http::string_body> response_from_db_error(boost::system::error_code ec)
{
if (ec.category() == orders::get_orders_category())
{
switch (static_cast<orders::errc>(ec.value()))
{
case orders::errc::not_found:
return error_response(http::status::not_found, "The referenced entity does not exist");
case orders::errc::product_not_found:
return error_response(
http::status::unprocessable_entity,
"The referenced product does not exist"
);
case orders::errc::order_invalid_status:
return error_response(
http::status::unprocessable_entity,
"The referenced order doesn't have the status required by the operation"
);
default: return internal_server_error();
}
}
else
{
return internal_server_error();
}
}
// Contains data associated to an HTTP request.
// To be passed to individual handler functions
struct request_data
{
// The incoming request
const http::request<http::string_body>& request;
// The URL the request is targeting
boost::urls::url_view target;
// Connection pool
mysql::connection_pool& pool;
orders::db_repository repo() const { return orders::db_repository(pool); }
};
//
// Endpoint handlers. They should be functions with signature
// asio::awaitable<http::response<http::string_body>>(const request_data&).
// Handlers are associated to a single URL path and HTTP method
//
// GET /products?search={s}: returns a list of products.
// The 'search' parameter is mandatory.
asio::awaitable<http::response<http::string_body>> handle_get_products(const request_data& input)
{
// Parse the query parameter
auto params_it = input.target.params().find("search");
if (params_it == input.target.params().end())
co_return bad_request("Missing mandatory query parameter: 'search'");
auto search = (*params_it).value;
// Invoke the database logic
std::vector<orders::product> products = co_await input.repo().get_products(search);
// Return the response
co_return json_response(products);
}
// GET /orders: returns all orders
// GET /orders?id={}: returns a single order
// Both endpoints share handler because they share path and method
asio::awaitable<http::response<http::string_body>> handle_get_orders(const request_data& input)
{
// Parse the query parameter
auto params_it = input.target.params().find("id");
// Which of the two endpoints are we serving?
if (params_it == input.target.params().end())
{
// GET /orders
// Invoke the database logic
std::vector<orders::order> orders = co_await input.repo().get_orders();
// Return the response
co_return json_response(orders);
}
else
{
// GET /orders?id={}
// Parse the query parameter
auto order_id = parse_id((*params_it).value);
if (!order_id.has_value())
co_return bad_request("URL parameter 'id' should be a valid integer");
// Invoke the database logic
result<orders::order_with_items> order = co_await input.repo().get_order_by_id(*order_id);
if (order.has_error())
co_return response_from_db_error(order.error());
// Return the response
co_return json_response(*order);
}
}
// POST /orders: creates a new order.
// Orders are created empty, so this request has no body.
asio::awaitable<http::response<http::string_body>> handle_create_order(const request_data& input)
{
// Invoke the database logic
orders::order_with_items order = co_await input.repo().create_order();
// Return the response
co_return json_response(order);
}
// POST /orders/items: adds a new order item to an existing order.
// The request has a JSON body, described by the add_order_item_request struct.
asio::awaitable<http::response<http::string_body>> handle_add_order_item(const request_data& input)
{
// Check that the request has the appropriate content type
auto it = input.request.find("Content-Type");
if (it == input.request.end() || it->value() != "application/json")
co_return bad_request("Invalid Content-Type: expected 'application/json'");
// Parse the request body
auto req = parse_json<orders::add_order_item_request>(input.request.body());
if (req.has_error())
co_return bad_request("Invalid JSON body");
// Invoke the database logic
result<orders::order_with_items> res = co_await input.repo()
.add_order_item(req->order_id, req->product_id, req->quantity);
if (res.has_error())
co_return response_from_db_error(res.error());
// Return the response
co_return json_response(*res);
}
// DELETE /orders/items?id={}: deletes an order item.
// The request has no body.
asio::awaitable<http::response<http::string_body>> handle_remove_order_item(const request_data& input)
{
// Parse the query parameter
auto params_it = input.target.params().find("id");
if (params_it == input.target.params().end())
co_return bad_request("Mandatory URL parameter 'id' not found");
auto id = parse_id((*params_it).value);
if (!id.has_value())
co_return bad_request("URL parameter 'id' should be a valid integer");
// Invoke the database logic
result<orders::order_with_items> res = co_await input.repo().remove_order_item(*id);
if (res.has_error())
co_return response_from_db_error(res.error());
// Return the response
co_return json_response(*res);
}
// POST /orders/checkout?id={}: checks out an order.
// The request has no body.
asio::awaitable<http::response<http::string_body>> handle_checkout_order(const request_data& input)
{
// Parse the query parameter
auto params_it = input.target.params().find("id");
if (params_it == input.target.params().end())
co_return bad_request("Mandatory URL parameter 'id' not found");
auto id = parse_id((*params_it).value);
if (!id.has_value())
co_return bad_request("URL parameter 'id' should be a valid integer");
// Invoke the database logic
result<orders::order_with_items> res = co_await input.repo().checkout_order(*id);
if (res.has_error())
co_return response_from_db_error(res.error());
// Return the response
co_return json_response(*res);
}
// POST /orders/complete?id={}: marks an order as completed.
// The request has no body.
asio::awaitable<http::response<http::string_body>> handle_complete_order(const request_data& input)
{
// Parse the query parameter
auto params_it = input.target.params().find("id");
if (params_it == input.target.params().end())
co_return bad_request("Mandatory URL parameter 'id' not found");
auto id = parse_id((*params_it).value);
if (!id.has_value())
co_return bad_request("URL parameter 'id' should be a valid integer");
// Invoke the database logic
result<orders::order_with_items> res = co_await input.repo().complete_order(*id);
if (res.has_error())
co_return response_from_db_error(res.error());
// Return the response
co_return json_response(*res);
}
// handle_request uses a table to dispatch to each endpoint.
// This is the table's element type.
struct http_endpoint
{
// The HTTP method associated to this endpoint.
http::verb method;
// The endpoint handler.
asio::awaitable<http::response<http::string_body>> (*handler)(const request_data&);
};
// Maps from a URL path to an endpoint handler.
// A URL path might be present more than once, for different methods.
const std::unordered_multimap<std::string_view, http_endpoint> endpoint_table{
{"/products", {http::verb::get, &handle_get_products} },
{"/orders", {http::verb::get, &handle_get_orders} },
{"/orders", {http::verb::post, &handle_create_order} },
{"/orders/items", {http::verb::post, &handle_add_order_item} },
{"/orders/items", {http::verb::delete_, &handle_remove_order_item}},
{"/orders/checkout", {http::verb::post, &handle_checkout_order} },
{"/orders/complete", {http::verb::post, &handle_complete_order} },
};
} // namespace
// External interface
asio::awaitable<http::response<http::string_body>> orders::handle_request(
const http::request<http::string_body>& request,
mysql::connection_pool& pool
)
{
// Parse the request target
auto target = boost::urls::parse_origin_form(request.target());
if (!target.has_value())
co_return bad_request("Invalid request target");
// Try to find an endpoint
auto [it1, it2] = endpoint_table.equal_range(target->path());
if (it1 == endpoint_table.end())
co_return error_response(http::status::not_found, "The requested endpoint does not exist");
// Match the verb. The table structure that we created
// allows us to distinguish between an "endpoint does not exist" error
// and an "unsupported method" error.
auto it3 = std::find_if(it1, it2, [&request](const std::pair<std::string_view, http_endpoint>& ep) {
return ep.second.method == request.method();
});
if (it3 == it2)
co_return error_response(http::status::method_not_allowed, "Unsupported HTTP method");
// Invoke the handler
try
{
// Attempt to handle the request
co_return co_await it3->second.handler(request_data{request, *target, pool});
}
catch (const mysql::error_with_diagnostics& err)
{
// A Boost.MySQL error. This will happen if you don't have connectivity
// to your database, your schema is incorrect or your credentials are invalid.
// Log the error, including diagnostics
log_mysql_error(err.code(), err.get_diagnostics());
// Never disclose error info to a potential attacker
co_return internal_server_error();
}
catch (const std::exception& err)
{
// Another kind of error. This indicates a programming error or a severe
// server condition (e.g. out of memory). Same procedure as above.
{
auto guard = orders::lock_cerr();
std::cerr << "Uncaught exception: " << err.what() << std::endl;
}
co_return internal_server_error();
}
}
//]
#endif
|