Merge pull request #597 from Shopify/jh/small-changes-fn

Propagating errors instead of panicking

Author: jonathanhamel4

discounts/rust/discounts/default/src/fetch.rs

@@ -1,4 +1,4 @@
-use serde_json::json;
+use serde::Serialize;
 use shopify_function::prelude::*;
 use shopify_function::Result;
 
@@ -18,24 +18,30 @@ type DeliveryFetchResponseData = delivery_fetch::input::ResponseData;
 type CartHttpRequestHeader = cart_fetch::output::HttpRequestHeader;
 type DeliveryHttpRequestHeader = delivery_fetch::output::HttpRequestHeader;
 
+#[derive(Serialize)]
+#[serde(rename_all = "camelCase")]
+struct RequestBody {
+    entered_discount_codes: Vec<String>,
+}
+
 #[shopify_function_target(
     target = "cart_fetch",
     query_path = "src/fetch.graphql",
     schema_path = "schema.graphql"
 )]
 fn cart_fetch(input: CartFetchResponseData) -> Result<FunctionCartFetchResult> {
-    let body = json!({
-        "enteredDiscountCodes": input.entered_discount_codes
-    });
+    let request_body = RequestBody {
+        entered_discount_codes: input.entered_discount_codes,
+    };
 
     Ok(FunctionCartFetchResult {
         request: Some(CartHttpRequest {
-            body: Some(body.to_string()),
+            body: Some(serde_json::to_string(&request_body)?),
             headers: vec![CartHttpRequestHeader {
                 name: "Accept".to_string(),
                 value: "application/json; charset=utf-8".to_string(),
             }],
-            json_body: Some(body.clone()),
+            json_body: Some(serde_json::to_value(&request_body)?),
             method: CartHttpRequestMethod::POST,
             policy: CartHttpRequestPolicy {
                 read_timeout_ms: 2000,
@@ -51,18 +57,18 @@ fn cart_fetch(input: CartFetchResponseData) -> Result<FunctionCartFetchResult> {
     schema_path = "schema.graphql"
 )]
 fn delivery_fetch(input: DeliveryFetchResponseData) -> Result<FunctionDeliveryFetchResult> {
-    let body = json!({
-        "enteredDiscountCodes": input.entered_discount_codes
-    });
+    let request_body = RequestBody {
+        entered_discount_codes: input.entered_discount_codes,
+    };
 
     Ok(FunctionDeliveryFetchResult {
         request: Some(DeliveryHttpRequest {
-            body: Some(body.to_string()),
+            body: Some(serde_json::to_string(&request_body)?),
             headers: vec![DeliveryHttpRequestHeader {
                 name: "Accept".to_string(),
                 value: "application/json; charset=utf-8".to_string(),
             }],
-            json_body: Some(body.clone()),
+            json_body: Some(serde_json::to_value(&request_body)?),
             method: DeliveryHttpRequestMethod::POST,
             policy: DeliveryHttpRequestPolicy {
                 read_timeout_ms: 2000,
@@ -75,6 +81,7 @@ fn delivery_fetch(input: DeliveryFetchResponseData) -> Result<FunctionDeliveryFe
 #[cfg(test)]
 mod tests {
     use super::*;
+    use serde_json::json;
     use shopify_function::{run_function_with_input, Result};
 
     fn get_fetch_input_json() -> serde_json::Value {

discounts/rust/discounts/default/src/run.rs

@@ -26,53 +26,46 @@ type CartResponseData = cart_run::input::ResponseData;
 type DeliveryResponseData = delivery_run::input::ResponseData;
 
 impl CartResponseData {
-    fn metafield(&self) -> Metafield {
-        self.discount_node
+    fn metafield(&self) -> Result<Metafield> {
+        let metafield = self
+            .discount_node
             .metafield
             .as_ref()
-            .map(|metafield| serde_json::from_str(&metafield.value))
-            .unwrap()
-            .expect("Missing required metafield configuration")
+            .ok_or("Missing metafield")?;
+        serde_json::from_str(&metafield.value)
+            .map_err(|_| "Metafield value cannot be parsed".into())
     }
-    fn valid_discount_codes(&self) -> Vec<String> {
-        self.fetch_result
-            .as_ref()
-            .unwrap()
-            .body
-            .as_ref()
-            .map(|available_codes| serde_json::from_str(available_codes))
-            .unwrap()
-            .expect("Missing required metafield configuration")
+    fn valid_discount_codes(&self) -> Result<Vec<String>> {
+        let fetch_result = self.fetch_result.as_ref().ok_or("Missing fetch result")?;
+        let body = fetch_result.body.as_ref().ok_or("Missing body")?;
+        serde_json::from_str(body).map_err(|_| "Fetch result body cannot be parsed".into())
     }
 }
 
 impl DeliveryResponseData {
-    fn metafield(&self) -> Metafield {
-        self.discount_node
+    fn metafield(&self) -> Result<Metafield> {
+        let metafield = self
+            .discount_node
             .metafield
             .as_ref()
-            .map(|metafield| serde_json::from_str(&metafield.value))
-            .unwrap()
-            .expect("Missing required metafield configuration")
+            .ok_or("Missing metafield")?;
+        serde_json::from_str(&metafield.value)
+            .map_err(|_| "Metafield value cannot be parsed".into())
     }
 
-    fn valid_discount_codes(&self) -> Vec<String> {
-        self.fetch_result
-            .as_ref()
-            .unwrap()
-            .body
-            .as_ref()
-            .map(|available_codes| serde_json::from_str(available_codes))
-            .unwrap()
-            .expect("Missing required metafield configuration")
+    fn valid_discount_codes(&self) -> Result<Vec<String>> {
+        let fetch_result = self.fetch_result.as_ref().ok_or("Missing fetch result")?;
+        let body = fetch_result.body.as_ref().ok_or("Missing body")?;
+        serde_json::from_str(body).map_err(|_| "Fetch result body cannot be parsed".into())
     }
 }
 
 #[derive(Deserialize)]
+#[serde(rename_all = "camelCase")]
 struct Metafield {
-    cart_percent: Option<Decimal>,
-    product_percent: Option<Decimal>,
-    delivery_percent: Option<Decimal>,
+    order_percentage: Option<Decimal>,
+    product_percentage: Option<Decimal>,
+    delivery_percentage: Option<Decimal>,
 }
 
 #[shopify_function_target(
@@ -81,15 +74,14 @@ struct Metafield {
     schema_path = "schema.graphql"
 )]
 fn cart_run(input: CartResponseData) -> Result<FunctionCartRunResult> {
-    let default = FunctionCartRunResult { operations: vec![] };
-    let codes = input.valid_discount_codes();
+    let codes = input.valid_discount_codes()?;
     let available_discount_code = codes.first();
 
     if available_discount_code.is_none() {
-        return Ok(default);
+        return Ok(FunctionCartRunResult { operations: vec![] });
     }
 
-    let metafield = input.metafield();
+    let metafield = input.metafield()?;
     let mut operations: Vec<CartOperation> = vec![];
     let available_discount_code = available_discount_code.unwrap();
 
@@ -101,11 +93,11 @@ fn cart_run(input: CartResponseData) -> Result<FunctionCartRunResult> {
         },
     ));
 
-    if metafield.cart_percent.is_some() {
+    if metafield.order_percentage.is_some() {
         operations.push(create_order_discount(&metafield, available_discount_code));
     }
 
-    if metafield.product_percent.is_some() {
+    if metafield.product_percentage.is_some() {
         let highest_priced_line = input
             .cart
             .lines
@@ -132,13 +124,12 @@ fn cart_run(input: CartResponseData) -> Result<FunctionCartRunResult> {
     schema_path = "schema.graphql"
 )]
 fn delivery_run(input: DeliveryResponseData) -> Result<FunctionDeliveryRunResult> {
-    let default = FunctionDeliveryRunResult { operations: vec![] };
-    let codes = input.valid_discount_codes();
+    let codes = input.valid_discount_codes()?;
     let available_discount_code = codes.first();
-    let metafield = input.metafield();
+    let metafield = input.metafield()?;
 
-    if available_discount_code.is_none() || metafield.delivery_percent.is_none() {
-        return Ok(default);
+    if available_discount_code.is_none() || metafield.delivery_percentage.is_none() {
+        return Ok(FunctionDeliveryRunResult { operations: vec![] });
     }
 
     let mut operations: Vec<DeliveryOperation> = vec![];
@@ -183,7 +174,7 @@ fn create_order_discount(metafield: &Metafield, available_discount_code: &str) -
             }),
             message: None,
             value: OrderDiscountCandidateValue::Percentage(CartPercentage {
-                value: metafield.cart_percent.unwrap(),
+                value: metafield.order_percentage.unwrap(),
             }),
             conditions: None,
         }],
@@ -207,7 +198,7 @@ fn create_product_discount(
             }),
             message: None,
             value: ProductDiscountCandidateValue::Percentage(CartPercentage {
-                value: metafield.product_percent.unwrap(),
+                value: metafield.product_percentage.unwrap(),
             }),
         }],
     })
@@ -225,7 +216,7 @@ fn create_delivery_discount_candidate(
             },
         )],
         value: DeliveryDiscountCandidateValue::Percentage(DeliveryPercentage {
-            value: metafield.delivery_percent.unwrap(),
+            value: metafield.delivery_percentage.unwrap(),
         }),
         message: None,
         associated_discount_code: Some(DeliveryAssociatedDiscountCode {
@@ -271,9 +262,9 @@ mod tests {
             "discountNode": {
                 "metafield": {
                     "value": json!({
-                        "cart_percent": "10",
-                        "product_percent": "20",
-                        "delivery_percent": "30",
+                        "orderPercentage": "10",
+                        "productPercentage": "20",
+                        "deliveryPercentage": "30",
                     }).to_string(),
                 }
             },