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
use crate::{
http::{header::HeaderName, HeaderValue},
Endpoint, IntoResponse, Middleware, Request, Response, Result,
};
#[derive(Debug, Clone)]
enum Action {
Override(HeaderName, HeaderValue),
Append(HeaderName, HeaderValue),
}
/// Middleware for override/append headers to response.
///
/// # Example
///
/// ```
/// use poem::{
/// get, handler,
/// http::{HeaderValue, StatusCode},
/// middleware::SetHeader,
/// test::TestClient,
/// Endpoint, EndpointExt, Request, Route,
/// };
///
/// #[handler]
/// fn index() -> &'static str {
/// "hello"
/// }
///
/// let app = Route::new().at("/", get(index)).with(
/// SetHeader::new()
/// .appending("MyHeader1", "a")
/// .appending("MyHeader1", "b")
/// .overriding("MyHeader2", "a")
/// .overriding("MyHeader2", "b"),
/// );
///
/// # tokio::runtime::Runtime::new().unwrap().block_on(async {
/// let resp = TestClient::new(app).get("/").send().await;
/// resp.assert_status_is_ok();
/// resp.assert_header_all("MyHeader1", ["a", "b"]);
/// resp.assert_header_all("MyHeader2", ["b"]);
/// # });
/// ```
#[derive(Default)]
pub struct SetHeader {
actions: Vec<Action>,
}
impl SetHeader {
/// Create new `SetHeader` middleware.
#[must_use]
pub fn new() -> Self {
Default::default()
}
/// Inserts a header to response.
///
/// If a previous value exists for the same header, it is
/// removed and replaced with the new header value.
#[must_use]
pub fn overriding<K, V>(mut self, key: K, value: V) -> Self
where
K: TryInto<HeaderName>,
V: TryInto<HeaderValue>,
{
let key = key.try_into();
let value = value.try_into();
if let (Ok(key), Ok(value)) = (key, value) {
self.actions.push(Action::Override(key, value));
}
self
}
/// Appends a header to response.
///
/// If previous values exist, the header will have multiple values.
#[must_use]
pub fn appending<K, V>(mut self, key: K, value: V) -> Self
where
K: TryInto<HeaderName>,
V: TryInto<HeaderValue>,
{
let key = key.try_into();
let value = value.try_into();
if let (Ok(key), Ok(value)) = (key, value) {
self.actions.push(Action::Append(key, value));
}
self
}
}
impl<E: Endpoint> Middleware<E> for SetHeader {
type Output = SetHeaderEndpoint<E>;
fn transform(&self, ep: E) -> Self::Output {
SetHeaderEndpoint {
inner: ep,
actions: self.actions.clone(),
}
}
}
/// Endpoint for SetHeader middleware.
pub struct SetHeaderEndpoint<E> {
inner: E,
actions: Vec<Action>,
}
impl<E: Endpoint> Endpoint for SetHeaderEndpoint<E> {
type Output = Response;
async fn call(&self, req: Request) -> Result<Self::Output> {
let mut resp = self.inner.call(req).await?.into_response();
let headers = resp.headers_mut();
for action in &self.actions {
match action {
Action::Override(name, value) => {
headers.insert(name, value.clone());
}
Action::Append(name, value) => {
headers.append(name, value.clone());
}
}
}
Ok(resp)
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::{handler, test::TestClient, EndpointExt};
#[tokio::test]
async fn test_set_header() {
#[handler(internal)]
fn index() {}
let cli = TestClient::new(
index.with(
SetHeader::new()
.overriding("custom-a", "a")
.overriding("custom-a", "b")
.appending("custom-b", "a")
.appending("custom-b", "b"),
),
);
let resp = cli.get("/").send().await;
resp.assert_status_is_ok();
resp.assert_header_all("custom-a", ["b"]);
resp.assert_header_all("custom-b", ["a", "b"]);
}
}