Properly create/remove/prune shipping records everywhere

imports/plugins/core/shipping/client/templates/checkout/shipping.js

@@ -1,10 +1,33 @@
 import _ from "lodash";
 import { Meteor } from "meteor/meteor";
+import { EJSON } from "meteor/ejson";
 import { Template } from "meteor/templating";
 import { ReactiveDict } from "meteor/reactive-dict";
 import { Reaction } from "/client/api";
 import { Cart } from "/lib/collections";
 
+
+// Because we are duplicating shipment quotes across shipping records
+// we will get duplicate shipping quotes but we only want to diplay one
+// So this function eliminates duplicates
+/**
+ * Return a unique list of objects
+ * @param {Array} objs - An array of objects
+ * @returns {Array} An array of object only containing unique members
+ * @private
+ */
+function uniqObjects(objs) {
+  const jsonBlobs = objs.map((obj) => {
+    return JSON.stringify(obj);
+  });
+  const uniqueBlobs = _.uniq(jsonBlobs);
+  return uniqueBlobs.map((blob) => {
+    return EJSON.parse(blob);
+  });
+}
+
+// cartShippingQuotes
+// returns multiple methods
 /**
  * cartShippingQuotes - returns a list of all the shipping costs/quotations
  * of each available shipping carrier like UPS, Fedex etc.
@@ -16,24 +39,18 @@ import { Cart } from "/lib/collections";
 function cartShippingQuotes(currentCart) {
   const cart = currentCart || Cart.findOne();
   const shipmentQuotes = [];
-  const primaryShopId = Reaction.getPrimaryShopId();
   if (cart) {
     if (cart.shipping) {
       for (const shipping of cart.shipping) {
         if (shipping.shipmentQuotes) {
           for (const quote of shipping.shipmentQuotes) {
-            if (shipping.shopId === primaryShopId) {
-              if (quote.carrier === "Flat Rate" || quote.requestStatus !== "error") {
-                shipmentQuotes.push(quote);
-              }
-            }
+            shipmentQuotes.push(quote);
           }
         }
       }
     }
   }
-
-  return shipmentQuotes;
+  return uniqObjects(shipmentQuotes);
 }
 
 function shippingMethodsQueryStatus(currentCart) {
@@ -66,13 +83,10 @@ function shippingMethodsQueryStatus(currentCart) {
 function cartShipmentMethods() {
   const cart = Cart.findOne();
   const shipmentMethods = [];
-  const primaryShopId = Reaction.getPrimaryShopId();
   if (cart) {
     if (cart.shipping) {
       for (const shipping of cart.shipping) {
-        if (shipping.shipmentMethod && shipping.shopId === primaryShopId) {
-          shipmentMethods.push(shipping.shipmentMethod);
-        }
+        shipmentMethods.push(shipping.shipmentMethod);
       }
     }
   }

imports/plugins/included/shipping-rates/server/hooks/hooks.js

@@ -1,4 +1,5 @@
 import { check } from "meteor/check";
+import { Meteor } from "meteor/meteor";
 import { Shipping, Packages } from "/lib/collections";
 import { Logger, Reaction, Hooks } from "/server/api";
 import { Cart as CartSchema } from "/lib/collections/schemas";
@@ -34,20 +35,35 @@ function getShippingRates(previousQueryResults, cart) {
       return previousQueryResults;
     }
   }
-  if (!(cart.shipping && cart.shipping[0] && cart.shipping[0].address)) {
+
+  // Verify that we have shipping records
+  if (!cart.shipping || !cart.shipping.length) {
     const errorDetails = {
       requestStatus: "error",
-      shippingProvider: "shippo",
-      message: "The 'shipping' property of this cart is either missing or incomplete."
+      shippingProvider: "flat-rate-shipping",
+      message: "this cart is missing shipping records"
     };
-    rates.push(errorDetails);
-    return [rates, retrialTargets];
+    return [[errorDetails], []];
   }
-  if (!(cart.items && cart.items[0] && cart.items[0].parcel)) {
+
+  // Verify that we have a valid address to work with
+  let shippingErrorDetails;
+  if (cart.shipping.find((shippingRecord) => !shippingRecord.address)) {
+    shippingErrorDetails = {
+      requestStatus: "error",
+      shippingProvider: "flat-rate-shipping",
+      message: "The address property on one or more shipping records are incomplete"
+    };
+    return [[shippingErrorDetails], []];
+  }
+
+  // Validate that we have valid items to work with. We should never get here since we filter for this
+  // at the cart level
+  if (!cart.items || !cart.items.length) {
     const errorDetails = {
       requestStatus: "error",
-      shippingProvider: "shippo",
-      message: "This cart has no items, or the first item has no 'parcel' property."
+      shippingProvider: "flat-rate-shipping",
+      message: "this cart has no items"
     };
     return [[errorDetails], []];
   }
@@ -58,21 +74,20 @@ function getShippingRates(previousQueryResults, cart) {
     merchantShippingRates = marketplaceSettings.public.merchantShippingRates;
   }
 
-  // TODO: Check to see if the merchantShippingRates flag is set in
-  // marketplace and get rates from the correct shop.
-  const pkgData = Packages.findOne({
-    name: "reaction-shipping-rates",
-    shopId: Reaction.getPrimaryShopId()
-  });
+  let pkgData;
+  if (merchantShippingRates) {
+    // TODO this needs to be rewritten to handle getting rates from each shops that's represented on the order
+    Logger.fatal("Multiple shipping providers is currently not supported");
+    throw new Meteor.Error("not-implemented", "Multiple shipping providers is currently not supported");
+  } else {
+    pkgData = Packages.findOne({
+      name: "reaction-shipping-rates",
+      shopId: Reaction.getPrimaryShopId()
+    });
+  }
+
 
   if (!pkgData || !cart.items || pkgData.settings.flatRates.enabled !== true) {
-    const errorDetails = {
-      requestStatus: "error",
-      shippingProvider: "flat-rate-shipping",
-      message: "Error. Flat rate shipping might be uninstalled or disabled, or your cart is empty."
-    };
-    // There's no need for a retry in this case.
-    rates.push(errorDetails);
     return [rates, retrialTargets];
   }
 
@@ -82,6 +97,8 @@ function getShippingRates(previousQueryResults, cart) {
     "provider.enabled": true
   };
 
+  // Get rates from shops if merchantShippingRates is enabled
+  // Otherwise just get them from the primaryShop
   if (merchantShippingRates) {
     // create an array of shops, allowing
     // the cart to have products from multiple shops
@@ -90,7 +107,6 @@ function getShippingRates(previousQueryResults, cart) {
         shops.push(product.shopId);
       }
     }
-
     // if we have multiple shops in cart
     if ((shops !== null ? shops.length : void 0) > 0) {
       selector = {

imports/plugins/included/shippo/server/hooks/rates.js → imports/plugins/included/shipping-shippo/server/hooks/rates.js

@@ -4,24 +4,30 @@ import { Logger, Reaction, Hooks } from "/server/api";
 
 // callback ran on getShippingRates hook
 function getShippingRates(previousQueryResults, cart) {
+  const marketplaceSettings = Reaction.getMarketplaceSettings();
+  let merchantShippingRates = false;
+  if (marketplaceSettings && marketplaceSettings.public && marketplaceSettings.public.merchantShippingRates) {
+    merchantShippingRates = marketplaceSettings.public.merchantShippingRates;
+  }
+
   const [rates, retrialTargets] = previousQueryResults;
   const shops = [];
   const products = cart.items;
 
-  const pkgData = Packages.findOne({
-    name: "reaction-shippo",
-    shopId: Reaction.getShopId()
-  });
+  let pkgData;
+  if (merchantShippingRates) {
+    Logger.fatal("Multiple shipping providers is currently not implemented");
+    throw new Meteor.Error("not-implemented", "Multiple shipping providers is currently not implemented");
+  } else {
+    pkgData = Packages.findOne({
+      name: "reaction-shippo",
+      shopId: Reaction.getPrimaryShopId()
+    });
+  }
+
 
   // must have cart items and package enabled to calculate shipping
   if (!pkgData || !cart.items || pkgData.settings.shippo.enabled !== true) {
-    const errorDetails = {
-      requestStatus: "error",
-      shippingProvider: "shippo",
-      message: "Error. The Shippo package may be uninstalled or disabled, or your cart is empty."
-    };
-    // There's no need for a retry in this case.
-    rates.push(errorDetails);
     return [rates, retrialTargets];
   }
 
@@ -31,22 +37,24 @@ function getShippingRates(previousQueryResults, cart) {
     "provider.enabled": true
   };
 
-  // create an array of shops, allowing
-  // the cart to have products from multiple shops
-  for (const product of products) {
-    if (product.shopId) {
-      shops.push(product.shopId);
+  // if we don't have merchant shipping rates enabled, only grab rates from primary shop
+  if (!merchantShippingRates) {
+    shops.push(Reaction.getPrimaryShopId());
+  } else {
+    // create an array of shops, allowing
+    // the cart to have products from multiple shops
+    for (const product of products) {
+      if (product.shopId) {
+        shops.push(product.shopId);
+      }
     }
   }
-  // if we have multiple shops in cart
-  if ((shops !== null ? shops.length : void 0) > 0) {
-    selector = {
-      "shopId": {
-        $in: shops
-      },
-      "provider.enabled": true
-    };
-  }
+  selector = {
+    "shopId": {
+      $in: shops
+    },
+    "provider.enabled": true
+  };
 
   const shippingCollection = Shipping.find(selector);
   const shippoDocs = {};

imports/plugins/included/shippo/server/methods/shippo.js → imports/plugins/included/shipping-shippo/server/methods/shippo.js

@@ -32,19 +32,27 @@ function createShippoAddress(reactionAddress, email, purpose) {
 
 // Creates a parcel object suitable for Shippo Api Calls given
 // a reaction product's parcel and units of measure for mass and distance
-function createShippoParcel(reactionParcel, reactionMassUnit, reactionDistanceUnit) {
+function createShippoParcel(reactionParcel, cartWeight, reactionMassUnit, reactionDistanceUnit) {
   const shippoParcel = {
     width: reactionParcel.width || "",
     length: reactionParcel.length || "",
     height: reactionParcel.height || "",
-    weight: reactionParcel.weight || "",
+    weight: cartWeight,
     distance_unit: reactionDistanceUnit,
     mass_unit: reactionMassUnit
   };
 
   return shippoParcel;
 }
 
+function getTotalCartweight(cart) {
+  const totalWeight = cart.items.reduce((sum, cartItem) => {
+    const itemWeight = cartItem.quantity * cartItem.parcel.weight;
+    return sum + itemWeight;
+  }, 0);
+  return totalWeight;
+}
+
 // converts the Rates List fetched from the Shippo Api to Reaction Shipping Rates form
 function ratesParser(shippoRates, shippoDocs) {
   return shippoRates.map(rate => {
@@ -411,7 +419,8 @@ export const methods = {
       if (cart.items && cart.items[0] && cart.items[0].parcel) {
         const unitOfMeasure = shop && shop.baseUOM || "kg";
         const unitOfLength = shop && shop.baseUOL || "cm";
-        shippoParcel = createShippoParcel(cart.items[0].parcel, unitOfMeasure, unitOfLength);
+        const cartWeight = getTotalCartweight(cart);
+        shippoParcel = createShippoParcel(cart.items[0].parcel, cartWeight, unitOfMeasure, unitOfLength);
       } else {
         errorDetails.message = "This cart has no items, or the first item has no 'parcel' property.";
         return [[errorDetails], []];