fix: Support wild card with acceptable_content_types

Author: rholshausen

src/content_negotiation.rs

@@ -6,7 +6,7 @@ use std::cmp::Ordering;
 use itertools::Itertools;
 
 use crate::Resource;
-use crate::context::WebmachineRequest;
+use crate::context::{WebmachineContext, WebmachineRequest};
 use crate::headers::HeaderValue;
 
 /// Enum to represent a match with media types
@@ -16,12 +16,22 @@ pub enum MediaTypeMatch {
     Full,
     /// Match where the sub-type was a wild card
     SubStar,
-    /// Full whild card match (type and sub-type)
+    /// Full wild card match (type and sub-type)
     Star,
     /// Does not match
     None
 }
 
+impl MediaTypeMatch {
+  /// If the match is a full or partial match
+  pub fn is_match(&self) -> bool {
+    match self {
+      MediaTypeMatch::None => false,
+      _ => true
+    }
+  }
+}
+
 /// Struct to represent a media type
 #[derive(Debug, Clone, PartialEq)]
 pub struct MediaType {
@@ -74,15 +84,19 @@ impl MediaType {
 
     /// If this media type matches the other media type
     pub fn matches(&self, other: &MediaType) -> MediaTypeMatch {
-        if other.main == "*" {
-            MediaTypeMatch::Star
-        } else if self.main == other.main && other.sub == "*" {
-            MediaTypeMatch::SubStar
-        } else if self.main == other.main && self.sub == other.sub {
-            MediaTypeMatch::Full
+      if other.main == "*" {
+        if other.sub == "*" || self.sub == other.sub {
+          MediaTypeMatch::Star
         } else {
-            MediaTypeMatch::None
+          MediaTypeMatch::None
         }
+      } else if self.main == other.main && other.sub == "*" {
+          MediaTypeMatch::SubStar
+      } else if self.main == other.main && self.sub == other.sub {
+          MediaTypeMatch::Full
+      } else {
+          MediaTypeMatch::None
+      }
     }
 
     /// Converts this media type into a string
@@ -137,6 +151,20 @@ pub fn matching_content_type(resource: &(dyn Resource + Send + Sync), request: &
   }
 }
 
+/// Determines if the media type accepted by the resource matches the media type
+/// provided by the client. Returns the match if there is one.
+pub fn acceptable_content_type(
+  resource: &(dyn Resource + Send + Sync),
+  context: &mut WebmachineContext
+) -> bool {
+  let ct = context.request.content_type().as_media_type();
+  resource.acceptable_content_types(context)
+    .iter()
+    .any(|acceptable_ct| {
+      ct.matches(&MediaType::parse_string(acceptable_ct)).is_match()
+    })
+}
+
 /// Struct to represent a media language
 #[derive(Debug, Clone, PartialEq)]
 pub struct MediaLanguage {

src/content_negotiation_tests.rs

@@ -145,6 +145,8 @@ fn media_type_matches_test() {
   expect!(media_type.matches(&MediaType { main: "application".to_string(), sub: "*".to_string(), weight: 1.0 })).to(be_equal_to(MediaTypeMatch::SubStar));
   expect!(media_type.matches(&MediaType { main: "*".to_string(), sub: "*".to_string(), weight: 1.0 })).to(be_equal_to(MediaTypeMatch::Star));
   expect!(media_type.matches(&MediaType { main: "application".to_string(), sub: "application".to_string(), weight: 1.0 })).to(be_equal_to(MediaTypeMatch::None));
+  expect!(media_type.matches(&MediaType { main: "*".to_string(), sub: "json".to_string(), weight: 1.0 })).to(be_equal_to(MediaTypeMatch::Star));
+  expect!(media_type.matches(&MediaType { main: "*".to_string(), sub: "xml".to_string(), weight: 1.0 })).to(be_equal_to(MediaTypeMatch::None));
 }
 
 #[test]

src/lib.rs

@@ -140,7 +140,7 @@ use tracing::{debug, error, trace};
 
 use context::{WebmachineContext, WebmachineRequest, WebmachineResponse};
 use headers::HeaderValue;
-
+use crate::content_negotiation::acceptable_content_type;
 use crate::paths::map_path;
 
 #[macro_use] pub mod headers;
@@ -234,6 +234,7 @@ pub trait Resource {
 
   /// The list of acceptable content types. Defaults to 'application/json'. If the content type
   /// of the request is not in this list, a '415 Unsupported Media Type' response is returned.
+  /// Wild cards can be used, like `*/*`, `type/*` or `*/sub-type`.
   fn acceptable_content_types(&self, _context: &mut WebmachineContext) -> Vec<&str> {
     vec!["application/json"]
   }
@@ -431,6 +432,7 @@ pub struct WebmachineResource {
   pub unsupported_content_headers: WebmachineCallback<bool>,
   /// The list of acceptable content types. Defaults to 'application/json'. If the content type
   /// of the request is not in this list, a '415 Unsupported Media Type' response is returned.
+  /// Wild cards can be used, like `*/*`, `type/*` or `*/sub-type`.
   pub acceptable_content_types: Vec<String>,
   /// If the entity length on PUT or POST is invalid, this should return false, which will result
   /// in a '413 Request Entity Too Large' response. Defaults to true.
@@ -1011,13 +1013,8 @@ async fn execute_decision(
       DecisionResult::wrap(resource.unsupported_content_headers(context), "unsupported content headers")
     },
     Decision::B5UnknownContentType => {
-      DecisionResult::wrap(context.request.is_put_or_post() && resource.acceptable_content_types(context)
-        .iter()
-        .find(|ct| {
-          let ct = HeaderValue::parse_string(ct);
-          context.request.content_type().value.to_lowercase() == ct.value.to_lowercase()
-        })
-        .is_none(), "acceptable content types")
+      DecisionResult::wrap(context.request.is_put_or_post() && !acceptable_content_type(resource, context),
+        "acceptable content types")
     },
     Decision::B4RequestEntityTooLarge => {
       DecisionResult::wrap(context.request.is_put_or_post() && !resource.valid_entity_length(context),

src/tests.rs

@@ -323,7 +323,6 @@ async fn execute_state_machine_handles_content_types_with_parameters() {
     ..WebmachineResource::default()
   };
   execute_state_machine(&mut context, &resource).await;
-  dbg!(&context);
   expect!(context.response.status).to_not(be_equal_to(415));
 }