Merge pull request #162 from plippe/move-querystring-tests-from-tide

Move querystring tests from tide

Author: yoshuawuyts

src/request.rs

@@ -14,7 +14,7 @@ use crate::headers::{
 };
 use crate::mime::Mime;
 use crate::trailers::{self, Trailers};
-use crate::{Body, Extensions, Method, Url, Version};
+use crate::{Body, Extensions, Method, StatusCode, Url, Version};
 
 pin_project_lite::pin_project! {
     /// An HTTP request.
@@ -627,12 +627,15 @@ impl Request {
     /// # Ok(()) }
     /// ```
     pub fn query<T: serde::de::DeserializeOwned>(&self) -> crate::Result<T> {
-        use std::io::{Error, ErrorKind};
-        let query = self
-            .url
-            .query()
-            .ok_or_else(|| Error::from(ErrorKind::InvalidData))?;
-        Ok(serde_urlencoded::from_str(query)?)
+        // Default to an empty query string if no query parameter has been specified.
+        // This allows successful deserialisation of structs where all fields are optional
+        // when none of those fields has actually been passed by the caller.
+        let query = self.url().query().unwrap_or("");
+        serde_urlencoded::from_str(query).map_err(|e| {
+            // Return the displayable version of the deserialisation error to the caller
+            // for easier debugging.
+            crate::Error::from_str(StatusCode::BadRequest, format!("{}", e))
+        })
     }
 
     /// Set the URL querystring.

tests/querystring.rs

@@ -0,0 +1,54 @@
+use http_types::{url::Url, Method};
+use serde::Deserialize;
+
+#[derive(Deserialize)]
+struct Params {
+    msg: String,
+}
+
+#[derive(Deserialize)]
+struct OptionalParams {
+    _msg: Option<String>,
+    _time: Option<u64>,
+}
+
+#[test]
+fn successfully_deserialize_query() {
+    let req = http_types::Request::new(
+        Method::Get,
+        Url::parse("http://example.com/?msg=Hello").unwrap(),
+    );
+
+    let params = req.query::<Params>();
+    assert!(params.is_ok());
+    assert_eq!(params.unwrap().msg, "Hello");
+}
+
+#[test]
+fn unsuccessfully_deserialize_query() {
+    let req = http_types::Request::new(Method::Get, Url::parse("http://example.com/").unwrap());
+
+    let params = req.query::<Params>();
+    assert!(params.is_err());
+    assert_eq!(params.err().unwrap().to_string(), "missing field `msg`");
+}
+
+#[test]
+fn malformatted_query() {
+    let req = http_types::Request::new(
+        Method::Get,
+        Url::parse("http://example.com/?error=should_fail").unwrap(),
+    );
+
+    let params = req.query::<Params>();
+    assert!(params.is_err());
+    assert_eq!(params.err().unwrap().to_string(), "missing field `msg`");
+}
+
+#[test]
+fn empty_query_string_for_struct_with_no_required_fields() {
+    let req = http_types::Request::new(Method::Get, Url::parse("http://example.com").unwrap());
+
+    let params = req.query::<OptionalParams>();
+    assert!(params.is_ok());
+}