@ordergroove/offers 2.27.22 → 2.27.23-alpha-PR-672-4.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ordergroove/offers",
-  "version": "2.27.22",
+  "version": "2.27.23-alpha-PR-672-4.2+09921357",
   "description": "offer state component",
   "author": "Eugenio Lattanzio <eugenio63@gmail.com>",
   "homepage": "https://github.com/ordergroove/plush-toys#readme",
@@ -45,5 +45,5 @@
   "devDependencies": {
     "@ordergroove/offers-templates": "^0.4.15"
   },
-  "gitHead": "e1fa1dd0940ca4f2a44c773e6df4c3f6468d2c4f"
+  "gitHead": "09921357b675720d65a998f45f8badeb642554bb"
 }

package/src/shopify/__tests__/shopifyReducer.spec.js

@@ -52,14 +52,16 @@ describe('autoshipEligible', () => {
       {
         type: constants.SETUP_PRODUCT,
         payload: {
-          id: 'yum product id',
-          selling_plan_allocations: [{ 'yum key': 'yum value' }],
-          variants: [
-            {
-              id: 'yum variant id',
-              selling_plan_allocations: [{ 'yum key': 'yum value' }]
-            }
-          ]
+          product: {
+            id: 'yum product id',
+            selling_plan_allocations: [{ 'yum key': 'yum value' }],
+            variants: [
+              {
+                id: 'yum variant id',
+                selling_plan_allocations: [{ 'yum key': 'yum value' }]
+              }
+            ]
+          }
         }
       }
     );
@@ -73,14 +75,16 @@ describe('autoshipEligible', () => {
       {
         type: constants.SETUP_PRODUCT,
         payload: {
-          id: 'yum product id',
-          selling_plan_allocations: [],
-          variants: [
-            {
-              id: 'yum variant id',
-              selling_plan_allocations: []
-            }
-          ]
+          product: {
+            id: 'yum product id',
+            selling_plan_allocations: [],
+            variants: [
+              {
+                id: 'yum variant id',
+                selling_plan_allocations: []
+              }
+            ]
+          }
         }
       }
     );
@@ -120,55 +124,27 @@ describe('config', () => {
     );
   });
 
-  it('should return first selling plan id as default frequency given action SETUP_PRODUCT', () => {
-    const actual = config(
-      {},
-      {
-        type: constants.SETUP_PRODUCT,
-        payload: {
-          selling_plan_groups: [
-            {
-              name: 'Subscribe and Save',
-              selling_plans: [
-                {
-                  id: 'yum selling plan id 1'
-                },
-                {
-                  id: 'yum selling plan id 2'
-                }
-              ]
-            }
-          ]
-        }
-      }
-    );
-
-    expect(actual).toEqual(
-      jasmine.objectContaining({
-        defaultFrequency: 'yum selling plan id 1'
-      })
-    );
-  });
-
   it('should return selling plan ids as frequencies given action SETUP_PRODUCT', () => {
     const actual = config(
       {},
       {
         type: constants.SETUP_PRODUCT,
         payload: {
-          selling_plan_groups: [
-            {
-              name: 'Subscribe and Save',
-              selling_plans: [
-                {
-                  id: 'yum selling plan id 1'
-                },
-                {
-                  id: 'yum selling plan id 2'
-                }
-              ]
-            }
-          ]
+          product: {
+            selling_plan_groups: [
+              {
+                name: 'Subscribe and Save',
+                selling_plans: [
+                  {
+                    id: 'yum selling plan id 1'
+                  },
+                  {
+                    id: 'yum selling plan id 2'
+                  }
+                ]
+              }
+            ]
+          }
         }
       }
     );
@@ -186,26 +162,28 @@ describe('config', () => {
       {
         type: constants.SETUP_PRODUCT,
         payload: {
-          selling_plan_groups: [
-            {
-              name: 'Old Selling Plan Group',
-              options: [{ values: 'old yum values' }],
-              selling_plans: [
-                {
-                  id: 'old yum selling plan id'
-                }
-              ]
-            },
-            {
-              name: 'Subscribe and Save',
-              options: [{ values: 'yum values' }],
-              selling_plans: [
-                {
-                  id: 'yum selling plan id'
-                }
-              ]
-            }
-          ]
+          product: {
+            selling_plan_groups: [
+              {
+                name: 'Old Selling Plan Group',
+                options: [{ values: 'old yum values' }],
+                selling_plans: [
+                  {
+                    id: 'old yum selling plan id'
+                  }
+                ]
+              },
+              {
+                name: 'Subscribe and Save',
+                options: [{ values: 'yum values' }],
+                selling_plans: [
+                  {
+                    id: 'yum selling plan id'
+                  }
+                ]
+              }
+            ]
+          }
         }
       }
     );
@@ -264,14 +242,16 @@ describe('inStock', () => {
       {
         type: constants.SETUP_PRODUCT,
         payload: {
-          id: 'yum product id',
-          available: true,
-          variants: [
-            {
-              id: 'yum variant id',
-              available: true
-            }
-          ]
+          product: {
+            id: 'yum product id',
+            available: true,
+            variants: [
+              {
+                id: 'yum variant id',
+                available: true
+              }
+            ]
+          }
         }
       }
     );
@@ -288,14 +268,16 @@ describe('inStock', () => {
       {
         type: constants.SETUP_PRODUCT,
         payload: {
-          id: 'yum product id',
-          available: false,
-          variants: [
-            {
-              id: 'yum variant id',
-              available: false
-            }
-          ]
+          product: {
+            id: 'yum product id',
+            available: false,
+            variants: [
+              {
+                id: 'yum variant id',
+                available: false
+              }
+            ]
+          }
         }
       }
     );
@@ -365,6 +347,156 @@ describe('optedin', () => {
     ]);
   });
 
+  it('should return existing optin given action RECEIVE_OFFER and optin already exists in state, and new optin is ineligible for autoship by default', () => {
+    const actual = optedin(
+      [
+        {
+          id: 'yum product id 1',
+          frequency: 'yum existing frequency'
+        }
+      ],
+      {
+        type: constants.RECEIVE_OFFER,
+        payload: {
+          autoship: {
+            'yum product id 1': false
+          },
+          autoship_by_default: {
+            'yum product id 1': false
+          },
+          in_stock: {
+            'yum product id 1': false
+          },
+          offer: {
+            defaultFrequency: 'yum offer default frequency'
+          }
+        }
+      }
+    );
+
+    expect(actual).toEqual([
+      {
+        id: 'yum product id 1',
+        frequency: 'yum existing frequency'
+      }
+    ]);
+  });
+
+  it('should return existing optin given action RECEIVE_OFFER, optin already exists in state, and new optin is eligible for autoship by default', () => {
+    const actual = optedin(
+      [
+        {
+          id: 'yum product id 1',
+          frequency: 'yum existing frequency'
+        }
+      ],
+      {
+        type: constants.RECEIVE_OFFER,
+        payload: {
+          autoship: {
+            'yum product id 1': true
+          },
+          autoship_by_default: {
+            'yum product id 1': true
+          },
+          in_stock: {
+            'yum product id 1': true
+          },
+          offer: {
+            defaultFrequency: 'yum offer default frequency'
+          }
+        }
+      }
+    );
+
+    expect(actual).toEqual([
+      {
+        id: 'yum product id 1',
+        frequency: 'yum existing frequency'
+      }
+    ]);
+  });
+
+  it('should return existing optin given action RECEIVE_OFFER, optin already exists in state, and new optin is eligible for autoship by default', () => {
+    const actual = optedin(
+      [
+        {
+          id: 'yum product id 1',
+          frequency: 'yum existing frequency'
+        }
+      ],
+      {
+        type: constants.RECEIVE_OFFER,
+        payload: {
+          autoship: {
+            'yum product id 1': true
+          },
+          autoship_by_default: {
+            'yum product id 1': true
+          },
+          in_stock: {
+            'yum product id 1': true
+          },
+          offer: {
+            defaultFrequency: 'yum offer default frequency'
+          }
+        }
+      }
+    );
+
+    expect(actual).toEqual([
+      {
+        id: 'yum product id 1',
+        frequency: 'yum existing frequency'
+      }
+    ]);
+  });
+
+  it('should return no optin given action RECEIVE_OFFER, optin does not exist in state, and product is not eligible for default to subscription', () => {
+    const actual = optedin([], {
+      type: constants.RECEIVE_OFFER,
+      payload: {
+        product: {},
+        offer: {
+          autoship: false,
+          autoship_by_default: false,
+          in_stock: false
+        }
+      }
+    });
+
+    expect(actual).toEqual([]);
+  });
+
+  it('should return optin given action RECEIVE_OFFER, optin does not exist in state, and product is eligible for default to subscription', () => {
+    const actual = optedin(
+      [
+        {
+          id: 'yum item id 1',
+          frequency: 'yum selling plan id 1'
+        }
+      ],
+      {
+        type: constants.RECEIVE_OFFER,
+        payload: {
+          product: {},
+          offer: {
+            autoship: true,
+            autoship_by_default: true,
+            in_stock: true
+          }
+        }
+      }
+    );
+
+    expect(actual).toEqual([
+      {
+        id: 'yum item id 1',
+        frequency: 'yum selling plan id 1'
+      }
+    ]);
+  });
+
   it('should return unmodified state given unsupported action', () => {
     const actual = optedin(
       { 'yum existing key': 'yum existing value' },
@@ -393,48 +525,50 @@ describe('productPlans', () => {
       {
         type: constants.SETUP_PRODUCT,
         payload: {
-          id: 'yum product id',
-          selling_plan_allocations: [
-            {
-              selling_plan_id: 'yum selling plan id 1',
-              compare_at_price: 100,
-              price: 50,
-              price_adjustments: [
-                {
-                  value: 50,
-                  value_type: 'percentage'
-                }
-              ]
-            }
-          ],
-          variants: [
-            {
-              id: 'yum variant id 1',
-              selling_plan_allocations: [
-                {
-                  selling_plan_id: 'yum selling plan id 2',
-                  compare_at_price: 50,
-                  price: 25,
-                  price_adjustments: [
-                    {
-                      value: 25
-                    }
-                  ]
-                }
-              ]
-            },
-            {
-              id: 'yum variant id 2',
-              selling_plan_allocations: [
-                {
-                  selling_plan_id: 'yum selling plan id 3',
-                  compare_at_price: 10,
-                  price: 8,
-                  price_adjustments: []
-                }
-              ]
-            }
-          ]
+          product: {
+            id: 'yum product id',
+            selling_plan_allocations: [
+              {
+                selling_plan_id: 'yum selling plan id 1',
+                compare_at_price: 100,
+                price: 50,
+                price_adjustments: [
+                  {
+                    value: 50,
+                    value_type: 'percentage'
+                  }
+                ]
+              }
+            ],
+            variants: [
+              {
+                id: 'yum variant id 1',
+                selling_plan_allocations: [
+                  {
+                    selling_plan_id: 'yum selling plan id 2',
+                    compare_at_price: 50,
+                    price: 25,
+                    price_adjustments: [
+                      {
+                        value: 25
+                      }
+                    ]
+                  }
+                ]
+              },
+              {
+                id: 'yum variant id 2',
+                selling_plan_allocations: [
+                  {
+                    selling_plan_id: 'yum selling plan id 3',
+                    compare_at_price: 10,
+                    price: 8,
+                    price_adjustments: []
+                  }
+                ]
+              }
+            ]
+          }
         }
       }
     );

package/src/shopify/shopifyMiddleware.ts

@@ -38,7 +38,8 @@ async function setupPdp(store, offer) {
   const handle = guessProductHandle();
   if (handle) {
     try {
-      store.dispatch({ type: SETUP_PRODUCT, payload: await getProduct(handle) });
+      const product = await getProduct(handle);
+      store.dispatch({ type: SETUP_PRODUCT, payload: { product, offer } });
     } catch (err) {
       console.warn('OG: Unable to fetch product details for PDP', err);
     }
@@ -126,7 +127,7 @@ async function setupCart(store, offer) {
   }
 
   const products = await Promise.all(Array.from(new Set(items.map(({ handle }) => handle))).map(getProduct));
-  products.forEach(product => store.dispatch({ type: SETUP_PRODUCT, payload: product }));
+  products.forEach(product => store.dispatch({ type: SETUP_PRODUCT, payload: { product, offer } }));
 }
 
 /**
@@ -358,30 +359,21 @@ export default function shopifyMiddleware(store) {
      * This redux middleware will perform Shopify specific side-effects such as change
      * the product selling plan when offer is cart
      */
+    
+    next(action);
+
     switch (action.type) {
-      case OPTIN_PRODUCT:
-      case OPTOUT_PRODUCT:
-      case PRODUCT_CHANGE_FREQUENCY:
-        break;
-      case REQUEST_OFFER:
+      case RECEIVE_OFFER:
         if (action.payload.offer?.isCart) {
           setupCart(store, action.payload.offer);
         } else {
           setupPdp(store, action.payload.offer);
         }
         break;
-      default:
-    }
-
-    next(action);
-
-    switch (action.type) {
       case OPTIN_PRODUCT:
       case OPTOUT_PRODUCT:
       case PRODUCT_CHANGE_FREQUENCY:
         synchronizeCartOptin(action, store);
-      case REQUEST_OFFER:
-      case RECEIVE_OFFER:
       case SETUP_PRODUCT:
         synchronizeSellingPlan(store, action.payload.offer);
         break;