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

use crate::headers::{HeaderName, HeaderValue, Headers, SOURCE_MAP};
use crate::{bail_status as bail, Status, Url};

use std::convert::TryInto;

/// Links to a file that maps transformed source to the original source.
///
/// [MDN Documentation](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/SourceMap)
///
/// # Specifications
///
/// - [Source Map Revision 3](https://sourcemaps.info/spec.html)
///
/// # Examples
///
/// ```
/// # fn main() -> http_types::Result<()> {
/// #
/// use http_types::{Response, Url};
/// use http_types::other::SourceMap;
///
/// let source_map = SourceMap::new(Url::parse("https://example.net/")?);
///
/// let mut res = Response::new(200);
/// source_map.apply(&mut res);
///
/// let base_url = Url::parse("https://example.net/")?;
/// let source_map = SourceMap::from_headers(base_url, res)?.unwrap();
/// assert_eq!(source_map.location(), &Url::parse("https://example.net/")?);
/// #
/// # Ok(()) }
/// ```
#[derive(Debug)]
pub struct SourceMap {
    location: Url,
}

impl SourceMap {
    /// Create a new instance of `SourceMap` header.
    pub fn new(location: Url) -> Self {
        Self { location }
    }

    /// Create a new instance from headers.
    pub fn from_headers<U>(base_url: U, headers: impl AsRef<Headers>) -> crate::Result<Option<Self>>
    where
        U: TryInto<Url>,
        U::Error: std::fmt::Debug,
    {
        let headers = match headers.as_ref().get(SOURCE_MAP) {
            Some(headers) => headers,
            None => return Ok(None),
        };

        // If we successfully parsed the header then there's always at least one
        // entry. We want the last entry.
        let header_value = headers.iter().last().unwrap();

        let url = match Url::parse(header_value.as_str()) {
            Ok(url) => url,
            Err(_) => match base_url.try_into() {
                Ok(base_url) => base_url.join(header_value.as_str().trim()).status(500)?,
                Err(_) => bail!(500, "Invalid base url provided"),
            },
        };

        Ok(Some(Self { location: url }))
    }

    /// Sets the header.
    pub fn apply(&self, mut headers: impl AsMut<Headers>) {
        headers.as_mut().insert(self.name(), self.value());
    }

    /// Get the `HeaderName`.
    pub fn name(&self) -> HeaderName {
        SOURCE_MAP
    }

    /// Get the `HeaderValue`.
    pub fn value(&self) -> HeaderValue {
        let output = self.location.to_string();

        // SAFETY: the internal string is validated to be ASCII.
        unsafe { HeaderValue::from_bytes_unchecked(output.into()) }
    }

    /// Get the url.
    pub fn location(&self) -> &Url {
        &self.location
    }

    /// Set the url.
    pub fn set_location<U>(&mut self, location: U) -> Result<(), U::Error>
    where
        U: TryInto<Url>,
        U::Error: std::fmt::Debug,
    {
        self.location = location.try_into()?;
        Ok(())
    }
}

#[cfg(test)]
mod test {
    use super::*;
    use crate::headers::Headers;

    #[test]
    fn smoke() -> crate::Result<()> {
        let source_map = SourceMap::new(Url::parse("https://example.net/test.json")?);

        let mut headers = Headers::new();
        source_map.apply(&mut headers);

        let base_url = Url::parse("https://example.net/")?;
        let source_map = SourceMap::from_headers(base_url, headers)?.unwrap();
        assert_eq!(
            source_map.location(),
            &Url::parse("https://example.net/test.json")?
        );
        Ok(())
    }

    #[test]
    fn bad_request_on_parse_error() {
        let mut headers = Headers::new();
        headers.insert(SOURCE_MAP, "htt://<nori ate the tag. yum.>");
        let err = SourceMap::from_headers(Url::parse("https://example.net").unwrap(), headers)
            .unwrap_err();
        assert_eq!(err.status(), 500);
    }

    #[test]
    fn fallback_works() -> crate::Result<()> {
        let mut headers = Headers::new();
        headers.insert(SOURCE_MAP, "/test.json");

        let base_url = Url::parse("https://fallback.net/")?;
        let source_map = SourceMap::from_headers(base_url, headers)?.unwrap();
        assert_eq!(
            source_map.location(),
            &Url::parse("https://fallback.net/test.json")?
        );

        let mut headers = Headers::new();
        headers.insert(SOURCE_MAP, "https://example.com/test.json");

        let base_url = Url::parse("https://fallback.net/")?;
        let source_map = SourceMap::from_headers(base_url, headers)?.unwrap();
        assert_eq!(
            source_map.location(),
            &Url::parse("https://example.com/test.json")?
        );
        Ok(())
    }
}