worker_route/http/headers.rs
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
use super::response::ResponseBuilder;
use crate::Error;
use http::header::{
ACCESS_CONTROL_ALLOW_CREDENTIALS, ACCESS_CONTROL_ALLOW_HEADERS, ACCESS_CONTROL_ALLOW_METHODS,
ACCESS_CONTROL_ALLOW_ORIGIN, ACCESS_CONTROL_EXPOSE_HEADERS, ACCESS_CONTROL_MAX_AGE,
};
use http::{HeaderName, HeaderValue};
use std::iter::Map;
use std::ops::{Deref, DerefMut};
use worker::js_sys::{Array, IntoIter};
use worker::wasm_bindgen::JsValue;
use worker::{Cors, Headers};
type HeaderPair = (HeaderName, HeaderValue);
pub enum HeadersOp {
Insert,
Append,
}
impl HeadersOp {
pub fn set(&self, header: &HeaderPair, builder: &mut ResponseBuilder) {
let res = match self {
HeadersOp::Insert => builder.headers.set(&header.0, &header.1),
HeadersOp::Append => builder.headers.append(&header.0, &header.1),
};
if let Err(err) = res {
builder.error(err);
}
}
}
/// A wrapper for [`worker::Headers`](https://docs.rs/worker/latest/worker/struct.Headers.html) with additional methods.
///
/// This comes with two additional method which are [`self.len()`](Self::len) and [`self.is_empty()`](Self::is_empty).
#[derive(Clone, Debug, Default)]
pub struct HttpHeaders {
pub(super) headers: Headers,
// Length of elements in the headers.
pub(super) len: usize,
}
impl HttpHeaders {
pub fn new() -> Self {
Self::default()
}
pub(super) fn apply_cors(&mut self, cors: &Cors) -> Result<(), worker::Error> {
cors.apply_headers(&mut self.headers)?;
if self.get(&ACCESS_CONTROL_ALLOW_CREDENTIALS).is_some() {
self.len += 1;
}
if self.get(&ACCESS_CONTROL_MAX_AGE).is_some() {
self.len += 1;
}
if self.get(&ACCESS_CONTROL_ALLOW_ORIGIN).is_some() {
self.len += 1;
}
if self.get(&ACCESS_CONTROL_ALLOW_METHODS).is_some() {
self.len += 1;
}
if self.get(&ACCESS_CONTROL_ALLOW_HEADERS).is_some() {
self.len += 1;
}
if self.get(&ACCESS_CONTROL_EXPOSE_HEADERS).is_some() {
self.len += 1;
}
Ok(())
}
/// Returns all the values of a header within a `Headers` object with a given name.
///
/// # Panics
///
/// Panics if [`HeaderName`] is constructed from using the method [`from_static`](HeaderName::from_static)
/// and the static string is an invalid header or contains spaces.
///
/// Eg: Header contains invalid header's name or spaces.
///
pub fn get(&self, name: &HeaderName) -> Option<String> {
self.0.get(name.as_str()).unwrap_or(None)
}
/// Returns a boolean stating whether a `Headers` object contains a certain header.
///
/// # Panics
///
/// Panics if [`HeaderName`] is constructed from using the method [`from_static`](HeaderName::from_static)
/// and the static string is an invalid header or contains spaces.
///
/// Eg: Header contains invalid header's name or spaces.
pub fn has(&self, name: &HeaderName) -> bool {
self.0.has(name.as_str()).unwrap_or(false)
}
/// Returns the number of elements in the headers.
pub fn len(&self) -> usize {
self.len
}
/// Returns `true` if the headers contain no elements.
pub fn is_empty(&self) -> bool {
self.len() == 0
}
/// Append a header, keeping any that were set with an equivalent field name.
///
/// # Errors
///
/// Errors are returned if the header name or value is invalid (e.g. contains spaces)
///
/// # Panics
///
/// Panics if [`HeaderName`] or [`HeaderValue`] is constructed from using the method [`from_static`](HeaderName::from_static)
/// and the static string is an invalid header or contains spaces.
///
/// Eg: Header contains invalid header's name or spaces.
pub fn append(&mut self, name: &HeaderName, value: &HeaderValue) -> Result<(), Error> {
self.headers.append(name.as_str(), value.to_str()?)?;
self.len += 1;
Ok(())
}
/// Sets a new value for an existing header inside a `Headers` object, or adds the header if it does not already exist.
///
/// # Errors
///
/// Errors are returned if the header name or value is invalid (e.g. contains spaces)
///
/// # Panics
///
/// Panics if [`HeaderName`] or [`HeaderValue`] is constructed from using the method [`from_static`](HeaderName::from_static)
/// and the static string is an invalid header or contains spaces.
///
/// Eg: Header contains invalid header's name or spaces.
pub fn set(&mut self, name: &HeaderName, value: &HeaderValue) -> Result<(), Error> {
self.headers.set(name.as_str(), value.to_str()?)?;
self.len += 1;
Ok(())
}
/// Deletes a header from a `Headers` object.
///
/// # Errors
/// Errors are returned if the header name or value is invalid (e.g. contains spaces)
/// or if the JS Headers object's guard is immutable (e.g. for an incoming request)
///
/// # Panics
///
/// Panics if [`HeaderName`] is constructed from using the method [`from_static`](HeaderName::from_static)
/// and the static string is an invalid header or contains spaces.
///
/// Eg: Header contains invalid header's name or spaces.
pub fn delete(&mut self, name: &HeaderName) -> Result<(), Error> {
self.headers.delete(name.as_str())?;
Ok(())
}
/// Returns an iterator allowing to go through all key/value pairs contained in this object.
pub fn entries(&self) -> HeaderIterator {
self.headers.entries()
}
/// Returns an iterator allowing you to go through all keys of the key/value pairs contained in
/// this object.
pub fn keys(&self) -> impl Iterator<Item = String> {
self.headers.keys()
}
/// Returns an iterator allowing you to go through all values of the key/value pairs contained
/// in this object.
pub fn values(&self) -> impl Iterator<Item = String> {
self.headers.values()
}
}
type F1 = fn(Result<JsValue, JsValue>) -> Array;
type HeaderIterator = Map<Map<IntoIter, F1>, fn(Array) -> (String, String)>;
impl IntoIterator for &HttpHeaders {
type Item = (String, String);
type IntoIter = HeaderIterator;
fn into_iter(self) -> Self::IntoIter {
self.headers.entries()
}
}
impl<'a> From<&'a mut HttpHeaders> for &'a mut Headers {
fn from(headers: &'a mut HttpHeaders) -> Self {
&mut headers.headers
}
}
macro_rules! impl_headers {
($from:ty, $to:ty) => {
impl From<$from> for $to {
fn from(headers: $from) -> Self {
Self(headers)
}
}
};
($from:ty, $to:ty, $headers:tt, $expr:tt) => {
impl From<$from> for $to {
fn from(headers: $from) -> Self {
$headers(headers.$expr())
}
}
};
($from:ty, $to:ty, $headers:ident, $expr:expr) => {
impl From<$from> for $to {
fn from($headers: $from) -> Self {
$expr
}
}
};
}
// impl_headers!(Headers, HttpHeaders);
// impl_headers!(&Headers, HttpHeaders, Self, clone);
impl_headers!(&HttpHeaders, Headers, headers, headers.headers.clone());
impl_headers!(HttpHeaders, Headers, headers, headers.headers);
impl From<&Headers> for HttpHeaders {
fn from(headers: &Headers) -> Self {
let len = headers.keys().count();
Self {
headers: headers.clone(),
len,
}
}
}
impl Deref for HttpHeaders {
type Target = Headers;
fn deref(&self) -> &Self::Target {
&self.headers
}
}
impl DerefMut for HttpHeaders {
fn deref_mut(&mut self) -> &mut Headers {
&mut self.headers
}
}