Lines
77.94 %
Functions
46.67 %
Branches
100 %
//! Module for helping with dirserver's HTTP interface.
//!
//! This module is unfortunately necessary as a middleware due to some obscure
//! things in Tor, most notably the ".z" extensions.
use cache::StoreCache;
use r2d2::Pool;
use r2d2_sqlite::SqliteConnectionManager;
#[cfg(feature = "dir-plugin-backend")]
use tor_dircommon::dir_plugin_backend::DirBackendPlugin;
use tor_error::{internal, warn_report};
use std::{
collections::VecDeque,
convert::Infallible,
panic::{AssertUnwindSafe, catch_unwind},
str::FromStr,
sync::Arc,
task::{Context, Poll},
time::Duration,
};
use bytes::Bytes;
use futures::{Stream, StreamExt};
use http::{Method, Request, Response, StatusCode, header};
use http_body::{Body, Frame};
use hyper::{
body::Incoming,
server::conn::http1::{self},
service::service_fn,
use hyper_util::rt::TokioIo;
use rusqlite::{Transaction, params};
use tokio::{
io::{AsyncRead, AsyncWrite},
task::JoinSet,
time,
use tracing::warn;
use http_body_util::Full;
use std::io::Cursor;
use crate::database::{self, ContentEncoding, DocumentId, sql};
mod cache;
/// A type alias for the functions implementing endpoint logic.
///
/// An endpoint function is a function of the following form:
/// ```rust,ignore
/// fn get_consensus(
/// tx: &Transaction<'_>,
/// requ: &Request<Incoming>
/// ) -> Result<Response<Vec<DocumentId>>, Box<dyn std::error::Error + Send>>;
/// ```
/// The arguments give the endpoint function access to fixed state of the
/// database ([`Transaction`]) and the incoming [`Request`]. The return type is
/// a [`Result`] with an arbitrary error that implements [`Send`] and gets logged
/// but not returned to the client, which will just receive an `Internal Server Error`.
/// The [`Ok`] type of the [`Result`] is a [`Vec`] consisting of [`DocumentId`]
/// hashsums identifying (uncompressed) objects in the `store` table.
/// Changes to the database within the [`Transaction`] will (for now) get rolled
/// back, thereby giving the endpoint functions just read-only access to the
/// database.
/// TODO DIRMIRROR: Document the responsibilities here.
/// TODO DIRMIRROR: The error handling of endpoint functions may need further
/// discussions. Maybe take a look at what other frameworks do?
type EndpointFn = fn(
&Transaction,
&Request<Incoming>,
) -> Result<Response<Vec<DocumentId>>, Box<dyn std::error::Error + Send>>;
/// A type that implements [`Body`] for a list of [`Arc<[u8]>`] data.
/// This is required because we use the reference counts as first-level return
/// types in order to avoid duplicate entries of the same data in memory.
/// See the documentation of [`StoreCache`] for more information on that.
struct DocumentBody(VecDeque<Arc<[u8]>>);
/// Representation of an endpoint, uniquely identified by a [`Method`] and path
/// pair followed by an appropriate [`EndpointFn`].
/// The path itself is a special string that refers to the endpoint at which this
/// resource should be available. It supports a pattern-matching like syntax
/// through the use of the asterisk `*` character.
/// For example:
/// `/tor/status-vote/current/consensus` will match the URL exactly, whereas
/// `/tor/status-vote/current/*` will match every string that is in the
/// fourth component; such as `/tor/status-vote/current/consensus` or
/// `/tor/status-vote/current/consensus-microdesc`; it will however not
/// match in a prefix-like syntax, such as
/// `/tor/status-vote/current/consensus-microdesc/diff`.
/// In the case of non-unique matches, the first match wins. Also, because
/// of wildcards, matching takes place in a `O(n)` fashion, so be sure to
/// to keep the `n` at a reasonable size. This should not be much of a
/// problem for Tor applications though, because the list of endpoints is
/// reasonable (less than 30).
/// TODO: The entire asterisk matching is not so super nice, primarily because
/// it removes compile-time semantic checks; however, I cannot really think
/// of a much cleaner way that would not involve lots of boilerplate.
/// The most minimal "clean" way could be to do `path: &Option<&'static str>`
/// but I am not sure if this overhead is worth it, i.e.:
/// * `/tor/status-vote/current/*/diff/*/*`
/// * `[Some(""), Some("tor"), Some("status-vote"), Some("current"), None, ...]`
/// Maybe a macro could help here though ...
type Endpoint = (Method, &'static str, EndpointFn);
/// Representation of the core HTTP server.
#[derive(Debug)]
pub(crate) struct HttpServer {
/// List of [`Endpoint`] entries.
endpoints: Vec<Endpoint>,
/// Access to the database pool.
pool: Pool<SqliteConnectionManager>,
}
impl Body for DocumentBody {
type Data = Bytes;
type Error = Infallible;
fn poll_frame(
mut self: std::pin::Pin<&mut Self>,
_cx: &mut Context<'_>,
) -> Poll<Option<Result<Frame<Self::Data>, Self::Error>>> {
Poll::Ready(
self.0
.pop_front()
.map(|bytes| Ok(Frame::data(Bytes::from_owner(bytes)))),
)
impl HttpServer {
/// Creates a new [`HttpServer`] with a given [`Vec`] of [`Endpoint`] entries
/// alongside access to the database [`Pool`].
pub(crate) fn new(endpoints: Vec<Endpoint>, pool: Pool<SqliteConnectionManager>) -> Self {
Self { endpoints, pool }
/// Bluntly launches an HTTP server only serving from the given backend.
/// Absolutely not suited for anything in production as it comes with
/// various limitations. Primarily intended as an intermediate abstraction
/// for relay development.
pub(crate) async fn serve_backend<I, S, E, B>(
mut listener: I,
backend: B,
) -> Result<(), tor_error::Bug>
where
I: Stream<Item = Result<S, E>> + Unpin,
S: AsyncRead + AsyncWrite + Unpin + Send + 'static,
E: std::error::Error + 'static,
B: DirBackendPlugin,
{
// Creates a failing HTTP resposne while satisfying the hyper requirements.
let failure = |code| -> _ {
Response::builder()
.status(code)
.body(Default::default())
.expect("response builder should not fail")
// We need to wrap the backend as an Arc, as the value would otherwise
// not live long enough.
let backend = Arc::new(backend);
let mut tasks: JoinSet<Result<(), hyper::Error>> = JoinSet::new();
loop {
tokio::select! {
res = listener.next() => match res {
// Connection successfully accepted.
Some(Ok(s)) => {
let stream = TokioIo::new(s);
// Two Arc clones required. First is to be able to run
// this in an endless loop and second one is required
// because hyper requires the function to be Fn, i.e.
// meaning it may not capture from it's surrounding
// state.
let backend = backend.clone();
let service = service_fn(move |requ: Request<Incoming>| {
async move {
if requ.method() != Method::GET {
warn!("Unsupported method: {}", requ.method());
// dir-spec does not allow StatusCode::METHOD_NOT_ALLOWED.
return Ok(failure(StatusCode::BAD_REQUEST));
if !requ.body().is_end_stream() {
warn!("HTTP GET with non-empty body?");
// Convert Request::<Incoming> to Request::<()>.
let requ = requ.map(|_| ());
// Convert the Box<[u8]> to something hyper accepts.
backend
.get(&requ)
.map(|resp| resp.map(|body| Full::new(Cursor::new(body))))
});
tasks.spawn(http1::Builder::new().serve_connection(stream, service));
},
// There has been an error in accepting the connection.
Some(Err(e)) => {
warn_report!(e, "listener accept failure");
continue;
// This should not happen due to ownership.
None => return Err(internal!("listener was closed externally?")),
// A hyper task we monitored in our tasks has exiteed.
Some(res) = tasks.join_next() => match res {
Ok(Ok(())) => {},
Ok(Err(e)) => warn_report!(e, "client task encountered an error"),
Err(e) => warn_report!(e, "client task exited ungracefully"),
/// Runs the server endlessly in the current task.
/// This function does not fail, because all errors that could potentially
/// occur, occur in further sub-tasks spawned by it and handled appropriately,
/// that is usually logging the error and continuing the execution.
pub(crate) async fn serve<I, S, E>(self, mut listener: I) -> Result<(), tor_error::Bug>
E: std::error::Error,
let cache = Arc::new(StoreCache::new());
let endpoints: Arc<[Endpoint]> = self.endpoints.into();
let pool = self.pool;
// We operate exclusively in JoinSets so that everything gets aborted
// nicely in order without causing any sort of leaks.
let mut hyper_tasks: JoinSet<Result<(), hyper::Error>> = JoinSet::new();
let mut misc_tasks: JoinSet<()> = JoinSet::new();
// Spawn a simple garbage collection task that periodically removes
// dead references, just in case, from the StoreCache.
misc_tasks.spawn({
let cache = cache.clone();
cache.gc();
time::sleep(Duration::from_secs(60)).await;
Some(Ok(s)) => Self::dispatch_stream(&cache, &endpoints, &pool, &mut hyper_tasks, s),
warn!("listener accept failure: {e}");
//
// We distinguish between graceful and ungraceful errors, with
// the latter one being errors related to a failure in tokio's
// joining itself, such as if the underlying task panic'ed;
// whereas graceful errors are logical application level errors.
Some(res) = hyper_tasks.join_next() => match res {
Ok(Err(e)) => warn!("client task encountered an error: {e}"),
Err(e) => warn!("client task exited ungracefully: {e}"),
/// Dispatches a new [`Stream`] into an existing [`JoinSet`].
fn dispatch_stream<S: AsyncRead + AsyncWrite + Unpin + Send + 'static>(
cache: &Arc<StoreCache>,
endpoints: &Arc<[Endpoint]>,
pool: &Pool<SqliteConnectionManager>,
tasks: &mut JoinSet<Result<(), hyper::Error>>,
stream: S,
) {
let stream = TokioIo::new(stream);
// Create the `service_fn` to pass to `hyper`.
// Unfortunately, we have to clone the reference counter of all shared
// objects two times here. The first clone is required to not move
// it into the `service_fn`, the second one is required to
// circumvent a hyper limitation, namely that a service function
// requires a `Fn`, not an `FnMut`, which would allow capturing values
// from the environment natively.
let endpoints = endpoints.clone();
let pool = pool.clone();
let service = service_fn(move |requ| {
async move { Self::handler(cache, endpoints, pool, requ).await }
/// A small wrapper function that creates a read-only or read-write
/// [`Transaction`] based upon the [`Method`] and continues execution in
/// [`Self::handler_tx`].
#[allow(clippy::unused_async)] // TODO
async fn handler(
cache: Arc<StoreCache>,
endpoints: Arc<[Endpoint]>,
requ: Request<Incoming>,
) -> Result<Response<DocumentBody>, Infallible> {
// TODO: This would be the place to either use read_tx or rw_tx depending
// on the method, but given that this is all GET at the moment, just go
// with read_tx.
Ok(
database::read_tx(&pool, |tx| Self::handler_tx(&cache, &endpoints, tx, &requ))
.unwrap_or_else(|e| {
warn!("database error: {e}");
Self::empty_response(StatusCode::INTERNAL_SERVER_ERROR)
}),
/// A big monolithic function that handles incoming request with a consist
/// view upon the database.
/// The function works in eight steps which are documented with more detail
/// within the code:
/// 1. Determine the compression algorithm
/// 2. Select an [`EndpointFn`] by matching the path component
/// 3. Call the [`EndpointFn`] to obtain various [`DocumentId`]s
/// 4. Map the [`DocumentId`]s to their compressed counterpart
/// 5. Query the [`StoreCache`] with the [`DocumentId`] and [`Transaction`]
/// handle to store the document ref
/// 6. Compose the [`Response`]
/// TODO DIRMIRROR: Implement [`Method::HEAD`].
fn handler_tx(
endpoints: &[Endpoint],
tx: &Transaction,
requ: &Request<Incoming>,
) -> Response<DocumentBody> {
// (1) Determine the compression algorithm
// This step determines the compression algorithm, according to:
// https://spec.torproject.org/dir-spec/standards-compliance.html#http-headers.
let (encoding, advertise_encoding) = Self::determine_encoding(requ);
// (2) Select an `EndpointFn` by matching the path component
let endpoint_fn = match Self::match_endpoint(endpoints, requ) {
Some((_, _, endpoint_fn)) => endpoint_fn,
None => return Self::empty_response(StatusCode::NOT_FOUND),
// (3) Call the `EndpointFn` to obtain various `DocumentId`s
let endpoint_fn_resp = match catch_unwind(AssertUnwindSafe(|| endpoint_fn(tx, requ))) {
// Everything went successful.
Ok(Ok(r)) => r,
// The endpoint function gracefully failed with an error.
Ok(Err(e)) => {
warn!(
"{} {}: endpoint function failed: {e}",
requ.method(),
requ.uri()
);
return Self::empty_response(StatusCode::INTERNAL_SERVER_ERROR);
// The endpoint function unexpectedly crashed.
Err(_) => {
"{} {}: endpoint function crashed",
let (endpoint_fn_parts, docids) = endpoint_fn_resp.into_parts();
// (4) Map the docids to their compressed counterpart
let docids = docids
.into_iter()
.map(|docid| Self::map_encoding(tx, docid, encoding))
.collect::<Result<Vec<_>, _>>();
let docids = match docids {
Ok(s) => s,
Err(e) => {
"{} {}: unable to find compressed document: {e}",
// (5) Query the [`StoreCache`] with the [`DocumentId`] and
// [`Transaction`] handle to store the document ref.
let mut documents = VecDeque::new();
for docid in docids {
let document = match cache.get(tx, docid) {
Ok(document) => document,
"{} {}: unable to access the cache: {e}",
documents.push_back(document);
// (6) Compose the `Response`.
// The composing primarily consists of building a response from the parts
// of the intermediate response plus optionally adding a Content-Encoding
// header.
let mut resp = Response::from_parts(endpoint_fn_parts, DocumentBody(documents));
if advertise_encoding {
// Add the Content-Encoding header, if necessary.
resp.headers_mut().insert(
header::CONTENT_ENCODING,
encoding
.to_string()
.try_into()
.expect("strum serialized a non-valid header?!?"),
resp
/// Determines the [`ContentEncoding`] based on the path and the value of [`header::ACCEPT_ENCODING`].
/// This function returns a tuple containing the determined [`ContentEncoding`]
/// alongside a boolean that indicates whether [`header::CONTENT_ENCODING`]
/// should be set or not with the value of the just determined
/// [`ContentEncoding`].
fn determine_encoding<B: Body>(requ: &Request<B>) -> (ContentEncoding, bool) {
let z_suffix = requ.uri().path().ends_with(".z");
// TODO: Refactor this in a flat fashion once we get stable If-Let-Chains
// by upgrading MSVC to 1.88.
// This works by branching the parameters into the following four branches:
// 1. Accept-Encoding && ".z" URL
// 2. Accept-Encoding && No ".z" URL
// 3. No Accept-Encoding && ".z" URL
// 4. No Accept-Encoding && No "z" URL
// Technically we could use an else-if here, but given the branching
// I explained above, I would like to keep it in the nested fashion
// once we got stable If-Let.
#[allow(clippy::collapsible_else_if)]
if let Some(accept_encoding) = requ.headers().get(header::ACCEPT_ENCODING) {
// Parse the accept_encoding value by splitting it at "," and then
// parse each trimmed component as a ContentEncoding. Unsupported
// ContentEncodings are ignored.
let encodings = accept_encoding
.to_str()
.unwrap_or("")
.split(",")
.filter_map(|encoding| ContentEncoding::from_str(encoding.trim()).ok())
.collect::<Vec<_>>();
if z_suffix {
// (1) Accept-Encoding && ".z" URL
// From the specification:
// > If the client does send an Accept-Encoding header along with
// > a .z URL, the server SHOULD treat the request the same way
// > as for the URL without the .z. If deflate is included in the
// > Accept-Encoding, the response MUST be encoded, once, with
// > an encoding advertised by the client, and be accompanied by
// > an appropriate Content-Encoding.
// We do not check whether Accept-Encoding contains deflate,
// because the specification gives us the assurance.
// TODO: Maybe we should?
(ContentEncoding::Deflate, true)
} else {
// (2) Accept-Encoding && No ".z" URL
if let Some(encoding) = encodings.first() {
// Pick the first found encoding and include it in the header,
// if it is not the identity encoding.
let include_in_header = *encoding != ContentEncoding::Identity;
(*encoding, include_in_header)
// No supported encodings were found, fallback to identity
// and do not provide a Content-Encoding header.
// This is effectively equivalent to (4).
(ContentEncoding::Identity, false)
// (3) No Accept-Encoding && ".z" URL
// > If the client does not send an Accept-Encoding header along
// > with a .z URL, the server MUST send the response compressed
// > with deflate and SHOULD NOT send a Content-Encoding header.
(ContentEncoding::Deflate, false)
// (4) No Accept-Encoding && No ".z" URL
/// Matches an incoming request to an existing endpoint.
/// The matching works in a first-match wins fashion.
/// An endpoint is said to be matched when the following two properties for
/// the incoming request hold true:
/// * Both [`Method`] values are the same.
/// * Each component of the URL path is equal at the respective position or,
/// in the case of the endpoint path, is a wildcard.
fn match_endpoint<'a, B: Body>(
endpoints: &'a [Endpoint],
requ: &Request<B>,
) -> Option<&'a Endpoint> {
let requ_path = requ.uri().path();
let requ_path = requ_path.strip_suffix(".z").unwrap_or(requ_path);
let requ_path = requ_path.split('/').collect::<Vec<_>>();
let mut res = None;
for tuple in endpoints.iter() {
let (method, path, _endpoint_fn) = tuple;
let path = path.split('/').collect::<Vec<_>>();
// Filter the method out first.
if requ.method() != method {
// Now that the method is filtered out, perform the path matching
// algorithm.
// The path algorithm works as follows:
// 1. Check whether `path.len() == requ_path.len()`, for a match,
// two paths must have the same number of path components.
// 2. Initialize `is_match = true`.
// 3. Walk over the path components in pairs (i.e. compare first
// component of `path` with the first component of `requ_path`, ...)
// and check for each component tuple, whether they are equal or
// whether the component at the current position in path is a
// wildcard component, that is, a component that equals `*`.
// Stop immediately the moment
// `path[i] == requ_path[i] || path[i] == "*"` yields `false`;
// set `is_match = false`.
// 4. Check the result of `is_match`.
// Paths must have the same number of components in order to match.
// An inequality here means instant disqualification.
if path.len() != requ_path.len() {
// Iterate over the path component for component until we disqualify
// for a match.
let mut is_match = true;
for (this, incoming) in path.iter().zip(&requ_path) {
if this == incoming || *this == "*" {
is_match = false;
break;
// Stop on the first match, propagate the match to the outside.
if is_match {
res = Some(tuple);
res
/// Looks up the corresponding [`DocumentId`] for a given [`DocumentId`] and
/// a [`ContentEncoding`].
fn map_encoding(
docid: DocumentId,
encoding: ContentEncoding,
) -> Result<DocumentId, rusqlite::Error> {
// If the encoding is the identity, do not bother about it any further.
if encoding == ContentEncoding::Identity {
return Ok(docid);
let mut stmt = tx.prepare_cached(sql!(
"
SELECT compressed_docid
FROM compressed_document
WHERE identity_docid = ?1
AND algorithm = ?2
))?;
let compressed_docid =
stmt.query_one(params![docid, encoding.to_string()], |row| row.get(0))?;
Ok(compressed_docid)
/// Generates an empty response with a given [`StatusCode`].
fn empty_response(status: StatusCode) -> Response<DocumentBody> {
// TODO DIRMIRROR: Statically assert that.
.status(status)
.body(DocumentBody(VecDeque::new()))
.expect("response builder for empty response failed?!?")
#[cfg(test)]
pub(in crate::http) mod test {
// @@ begin test lint list maintained by maint/add_warning @@
#![allow(clippy::bool_assert_comparison)]
#![allow(clippy::clone_on_copy)]
#![allow(clippy::dbg_macro)]
#![allow(clippy::mixed_attributes_style)]
#![allow(clippy::print_stderr)]
#![allow(clippy::print_stdout)]
#![allow(clippy::single_char_pattern)]
#![allow(clippy::unwrap_used)]
#![allow(clippy::unchecked_time_subtraction)]
#![allow(clippy::useless_vec)]
#![allow(clippy::needless_pass_by_value)]
#![allow(clippy::string_slice)] // See arti#2571
//! <!-- @@ end test lint list maintained by maint/add_warning @@ -->
use crate::database;
use super::*;
io::{Cursor, Write},
use flate2::{
Compression,
write::{DeflateDecoder, DeflateEncoder, GzEncoder},
use http::Version;
use http_body_util::{BodyExt, Empty};
use lazy_static::lazy_static;
net::{TcpListener, TcpStream},
task,
use tokio_stream::wrappers::TcpListenerStream;
pub(in crate::http) const IDENTITY: &str = "Lorem ipsum dolor sit amet.";
lazy_static! {
pub(in crate::http) static ref IDENTITY_DOCID: DocumentId =
hex_to_docid("DD14CBBF0E74909AAC7F248A85D190AFD8DA98265CEF95FC90DFDDABEA7C2E66");
pub(in crate::http) static ref DEFLATE_DOCID: DocumentId =
hex_to_docid("07564DD13A7F4A6AD98B997F2938B1CEE11F8C7F358C444374521BA54D50D05E");
pub(in crate::http) static ref GZIP_DOCID: DocumentId =
hex_to_docid("1518107D3EF1EC6EAC3F3249DF26B2F845BC8226C326309F4822CAEF2E664104");
pub(in crate::http) static ref XZ_STD_DOCID: DocumentId =
hex_to_docid("17416948501F8E627CC9A8F7EFE7A2F32788D53CB84A5F67AC8FD4C1B59184CF");
pub(in crate::http) static ref X_TOR_LZMA_DOCID: DocumentId =
hex_to_docid("B5549F79A69113BDAF3EF0AD1D7D339D0083BC31400ECEE1B673F331CF26E239");
pub(in crate::http) fn create_test_db_pool() -> Pool<SqliteConnectionManager> {
let pool = database::open("").unwrap();
database::rw_tx(&pool, init_test_db).unwrap();
pool
fn hex_to_docid(s: &str) -> DocumentId {
let data: [u8; 32] = hex::decode(s).unwrap().try_into().unwrap();
data.into()
fn init_test_db(tx: &Transaction) {
assert_eq!(DocumentId::digest(IDENTITY.as_bytes()), *IDENTITY_DOCID);
let deflate = {
let mut encoder = DeflateEncoder::new(Vec::new(), Compression::default());
encoder.write_all(IDENTITY.as_bytes()).unwrap();
encoder.finish().unwrap()
assert_eq!(DocumentId::digest(&deflate), *DEFLATE_DOCID);
let gzip = {
let mut encoder = GzEncoder::new(Vec::new(), Compression::default());
assert_eq!(DocumentId::digest(&gzip), *GZIP_DOCID);
let xz_std = zstd::encode_all(IDENTITY.as_bytes(), 3).unwrap();
assert_eq!(DocumentId::digest(&xz_std), *XZ_STD_DOCID);
let mut x_tor_lzma = Vec::new();
lzma_rs::lzma_compress(&mut Cursor::new(IDENTITY), &mut x_tor_lzma).unwrap();
assert_eq!(DocumentId::digest(&x_tor_lzma), *X_TOR_LZMA_DOCID);
tx.execute(
sql!(
INSERT INTO store(docid, content) VALUES
(?1, ?2), -- identity
(?3, ?4), -- deflate
(?5, ?6), -- gzip
(?7, ?8), -- xzstd
(?9, ?10) -- lzma
),
params![
*IDENTITY_DOCID,
IDENTITY.as_bytes().to_vec(),
*DEFLATE_DOCID,
deflate,
*GZIP_DOCID,
gzip,
*XZ_STD_DOCID,
xz_std,
*X_TOR_LZMA_DOCID,
x_tor_lzma
],
.unwrap();
INSERT INTO compressed_document(algorithm, identity_docid, compressed_docid) VALUES
('deflate', ?1, ?2),
('gzip', ?1, ?3),
('x-zstd', ?1, ?4),
('x-tor-lzma', ?1, ?5)
*X_TOR_LZMA_DOCID
#[test]
fn content_encoding() {
assert_eq!(ContentEncoding::Identity.to_string(), "identity");
assert_eq!(
ContentEncoding::from_str("identity").unwrap(),
ContentEncoding::Identity
assert_eq!(ContentEncoding::Deflate.to_string(), "deflate");
ContentEncoding::from_str("DeFlaTe").unwrap(),
ContentEncoding::Deflate
assert_eq!(ContentEncoding::Gzip.to_string(), "gzip");
ContentEncoding::from_str("GzIP").unwrap(),
ContentEncoding::Gzip
assert_eq!(ContentEncoding::XZstd.to_string(), "x-zstd");
ContentEncoding::from_str("x-zStD").unwrap(),
ContentEncoding::XZstd
assert_eq!(ContentEncoding::XTorLzma.to_string(), "x-tor-lzma");
ContentEncoding::from_str("x-tOr-lzMa").unwrap(),
ContentEncoding::XTorLzma
fn determine_encoding() {
// 1. Accept-Encoding && ".z" URL.
let requ = Request::builder()
.header("Accept-Encoding", "deflate,identity , gzip")
.uri("/foo.z")
.body(String::new())
HttpServer::determine_encoding(&requ),
// 2a. Valid Accept-Encoding && No ".z" URL.
.header("Accept-Encoding", " gzip ")
.uri("/foo")
(ContentEncoding::Gzip, true)
// 2b. Identity Accept-Encoding && No ".z" URL.
.header("Accept-Encoding", "identity")
// 2c. Invalid Accept-Encoding && No ".z" URL.
.header("Accept-Encoding", " unSuppOrtEd_EncODing_SCHEMA , yeah ")
// 4. No Accept-Encoding && No ".z" URL
let requ = Request::builder().uri("/foo").body(String::new()).unwrap();
fn match_endpoint() {
/// Dummy call back that does nothing and is not even called.
fn dummy(
_: &Transaction,
_: &Request<Incoming>,
) -> Result<Response<Vec<DocumentId>>, Box<dyn std::error::Error + Send>> {
todo!()
let endpoints: Vec<Endpoint> = vec![
(Method::GET, "/foo/bar/baz", dummy),
(Method::GET, "/foo/*/baz", dummy),
(Method::GET, "/bar/*", dummy),
(Method::GET, "/", dummy),
];
/// Basically a domain specific [`assert_eq`] that works by comparing
/// pointers instead of a deep comparison.
macro_rules! check_match {
($uri:literal, $endpoint:literal) => {
let requ = Request::builder().uri($uri).body(String::new()).unwrap();
let left: *const Endpoint = HttpServer::match_endpoint(&endpoints, &requ).unwrap();
let right: *const Endpoint = &endpoints[$endpoint];
assert_eq!(left, right);
macro_rules! check_no_match {
($uri:literal) => {
assert!(HttpServer::match_endpoint(&endpoints, &requ).is_none());
check_match!("/foo/bar/baz", 0);
check_match!("/foo/bar/baz.z", 0);
check_no_match!("/foo/bar/baz1");
check_no_match!("/foo/bar/baz/");
check_match!("/foo/I_DONT_CARE/baz", 1);
check_match!("/foo/I_DONT_CARE/baz.z", 1);
check_match!("/foo//baz", 1);
check_no_match!("/foo/");
check_no_match!("/foo/foo");
check_no_match!("/foo/foo/foo");
check_match!("/bar/", 2);
check_match!("/bar/.z", 2);
check_match!("/bar/foo", 2);
check_match!("/bar/foo.z", 2);
check_no_match!("/bar/foo/");
check_no_match!("/bar/foo/foo");
check_match!("/", 3);
check_match!("/.z", 3);
fn map_encoding() {
let pool = create_test_db_pool();
let data = [
(ContentEncoding::Identity, *IDENTITY_DOCID),
(ContentEncoding::Deflate, *DEFLATE_DOCID),
(ContentEncoding::Gzip, *GZIP_DOCID),
(ContentEncoding::XZstd, *XZ_STD_DOCID),
(ContentEncoding::XTorLzma, *X_TOR_LZMA_DOCID),
database::read_tx(&pool, |tx| {
for (encoding, compressed_docid) in data {
println!("{encoding}");
HttpServer::map_encoding(tx, *IDENTITY_DOCID, encoding).unwrap(),
compressed_docid
})
#[tokio::test]
async fn basic_http_server() {
// This is a stupid clippy false positive.
#[allow(clippy::unnecessary_wraps)]
fn identity(
_tx: &Transaction<'_>,
_requ: &Request<Incoming>,
Ok(Response::new(vec![*IDENTITY_DOCID]))
let server = HttpServer::new(
vec![(Method::GET, "/tor/status-vote/current/consensus", identity)],
pool,
let listener = TcpListener::bind("[::1]:0").await.unwrap();
let local_addr = listener.local_addr().unwrap();
let listener = TcpListenerStream::new(listener);
task::spawn(async move {
server.serve(listener).await.unwrap();
let stream = TcpStream::connect(local_addr).await.unwrap();
let (mut sender, conn) = hyper::client::conn::http1::handshake(TokioIo::new(stream))
.await
if let Err(e) = conn.await {
println!("Connection failed: {e:?}");
// Perform a simple request.
// TODO: Put this into one function for making requests or use reqwest.
.version(Version::HTTP_11)
.uri("/tor/status-vote/current/consensus")
.body(Empty::<Bytes>::new())
let mut resp = sender.send_request(requ).await.unwrap();
let mut resp_body: Vec<u8> = Vec::new();
while let Some(next) = resp.frame().await {
resp_body.append(&mut next.unwrap().data_ref().unwrap().as_ref().to_vec());
assert_eq!(IDENTITY, String::from_utf8_lossy(&resp_body));
// Perform a ".z" request.
.uri("/tor/status-vote/current/consensus.z")
let mut decoder = DeflateDecoder::new(Vec::new());
decoder.write_all(&resp_body).unwrap();
let decoded_resp = decoder.finish().unwrap();
assert_eq!(IDENTITY, String::from_utf8_lossy(&decoded_resp));