@ordergroove/offers 2.45.6 → 2.46.1-alpha-PR-1285-2.53

package/src/core/__tests__/reducer.spec.js

@@ -11,7 +11,8 @@ import {
   eligibilityGroups,
   defaultFrequencies,
   productPlans,
-  prepaidShipmentsSelected
+  prepaidShipmentsSelected,
+  incentives
 } from '../reducer';
 import * as constants from '../constants';
 import { getObjectStructuredProductPlans } from '../adapters';
@@ -1003,4 +1004,154 @@ describe('reducers', () => {
       });
     });
   });
+
+  describe('incentives', () => {
+    const offerResponse = {
+      result: 'success',
+      module_view: { regular: 'f5aa0b83653c4fae956bc0440415dfcb' },
+      incentives: {
+        44198332104980: {
+          ongoing: ['8285f16f826e4cf29b49f073e45e32ab', '10205e185a5c4ccf83de75459241623a'],
+          initial: ['0f98a321d29e47d2a17fe3a8a7522d26']
+        }
+      },
+      incentives_display: {
+        '8285f16f826e4cf29b49f073e45e32ab': {
+          object: 'order',
+          field: 'sub_total',
+          type: 'Discount Percent',
+          value: 10.0
+        },
+        '10205e185a5c4ccf83de75459241623a': {
+          object: 'item',
+          field: 'total_price',
+          type: 'Discount Amount',
+          value: 5.0
+        },
+        '0f98a321d29e47d2a17fe3a8a7522d26': {
+          object: 'item',
+          field: 'total_price',
+          type: 'Discount Percent',
+          value: 11.0
+        }
+      }
+    };
+
+    it('should map incentives correctly', () => {
+      expect(incentives({}, { type: constants.RECEIVE_OFFER, payload: offerResponse })).toEqual({
+        44198332104980: {
+          ongoing: [
+            {
+              object: 'order',
+              field: 'sub_total',
+              type: 'Discount Percent',
+              value: 10.0,
+              id: '8285f16f826e4cf29b49f073e45e32ab'
+            },
+            {
+              object: 'item',
+              field: 'total_price',
+              type: 'Discount Amount',
+              value: 5.0,
+              id: '10205e185a5c4ccf83de75459241623a'
+            }
+          ],
+          initial: [
+            {
+              object: 'item',
+              field: 'total_price',
+              type: 'Discount Percent',
+              value: 11.0,
+              id: '0f98a321d29e47d2a17fe3a8a7522d26'
+            }
+          ]
+        }
+      });
+    });
+
+    it('should consider incentives_display_enhanced if present', () => {
+      const enhancedOfferResponse = {
+        ...offerResponse,
+        incentives_display_enhanced: {
+          '8285f16f826e4cf29b49f073e45e32ab': {
+            incentive_target: 'order',
+            incentive_type: 'discount_percent',
+            incentive_value: '10.00',
+            // no criteria, since this is program-wide
+            threshold_field: null,
+            threshold_value: null
+          },
+          '10205e185a5c4ccf83de75459241623a': {
+            incentive_target: 'item',
+            incentive_type: 'discount_percent',
+            incentive_value: '5.00',
+            threshold_field: null,
+            threshold_value: null,
+            criteria: {
+              node_type: 'PREMISE',
+              standard: 'PREPAID_ORDERS_PER_BILLING',
+              premise_value: 3
+            }
+          },
+          '0f98a321d29e47d2a17fe3a8a7522d26': {
+            incentive_target: 'item',
+            incentive_type: 'discount_percent',
+            incentive_value: '11.00',
+            threshold_field: null,
+            threshold_value: null,
+            criteria: {
+              node_type: 'PREMISE',
+              standard: 'PSI',
+              premise_value: ['Product Group A']
+            }
+          }
+        }
+      };
+
+      expect(incentives({}, { type: constants.RECEIVE_OFFER, payload: enhancedOfferResponse })).toEqual({
+        44198332104980: {
+          ongoing: [
+            {
+              object: 'order',
+              field: 'sub_total',
+              type: 'Discount Percent',
+              value: 10.0,
+              id: '8285f16f826e4cf29b49f073e45e32ab',
+              criteria: {
+                node_type: 'PREMISE',
+                standard: 'PROGRAM_WIDE',
+                premise_value: null
+              }
+            },
+            {
+              object: 'item',
+              field: 'total_price',
+              type: 'Discount Amount',
+              value: 5.0,
+              id: '10205e185a5c4ccf83de75459241623a',
+              criteria: {
+                node_type: 'PREMISE',
+                standard: 'PREPAID_ORDERS_PER_BILLING',
+                premise_value: 3
+              }
+            }
+          ],
+          initial: [
+            {
+              object: 'item',
+              field: 'total_price',
+              type: 'Discount Percent',
+              value: 11.0,
+              id: '0f98a321d29e47d2a17fe3a8a7522d26',
+              criteria: {
+                node_type: 'PREMISE',
+                standard: 'PSI',
+                premise_value: ['Product Group A']
+              }
+            }
+          ]
+        }
+      });
+    });
+  });
 });

package/src/core/__tests__/selectors.spec.js

@@ -5,7 +5,9 @@ import {
   templatesSelector,
   makeProductSpecificDefaultFrequencySelector,
   makeProductPrepaidShipmentOptionsSelector,
-  makeProductFrequenciesSelector
+  makeProductFrequenciesSelector,
+  makeDiscountedProductPriceSelector,
+  isShopifyDiscountFunctionInUseSelector
 } from '../selectors';
 import { stringifyFrequency } from '../api';
 
@@ -231,3 +233,405 @@ describe('makeProductFrequenciesSelector', () => {
     });
   });
 });
+
+describe('makeDiscountedProductPriceSelector', () => {
+  /** @returns {import('../types/reducer').State} */
+  function makeTestState({
+    incentives = [
+      {
+        object: 'item',
+        field: 'total_price',
+        type: 'Discount Percent',
+        value: 11,
+        criteria: {
+          node_type: 'PREMISE',
+          standard: 'PROGRAM_WIDE'
+        }
+      }
+    ],
+    price = 1000,
+    currency = 'USD',
+    productId = 123
+  } = {}) {
+    return {
+      config: {
+        storeCurrency: currency
+      },
+      price: {
+        [productId]: { value: price }
+      },
+      incentives: {
+        [productId]: {
+          initial: incentives,
+          ongoing: []
+        }
+      }
+    };
+  }
+
+  it('applies Discount Percent incentive (USD)', () => {
+    const selector = makeDiscountedProductPriceSelector(123);
+    const result = selector(makeTestState());
+    expect(result).toEqual({
+      regularPrice: '$10.00',
+      discountRate: '11%',
+      subscriptionPrice: '$8.90'
+    });
+  });
+
+  it('applies Discount Amount incentive (USD)', () => {
+    const selector = makeDiscountedProductPriceSelector(123);
+    const result = selector(
+      makeTestState({
+        incentives: [
+          {
+            object: 'item',
+            field: 'total_price',
+            type: 'Discount Amount',
+            value: 2.5, // $2.50 off
+            criteria: {
+              node_type: 'PREMISE',
+              standard: 'PROGRAM_WIDE'
+            }
+          }
+        ]
+      })
+    );
+    expect(result).toEqual({
+      regularPrice: '$10.00',
+      discountRate: '$2.50',
+      subscriptionPrice: '$7.50'
+    });
+  });
+
+  it('handles Discount Amount larger than price', () => {
+    const selector = makeDiscountedProductPriceSelector(123);
+    const result = selector(
+      makeTestState({
+        incentives: [
+          {
+            object: 'item',
+            field: 'total_price',
+            type: 'Discount Amount',
+            value: 15, // $15.00 off
+            criteria: {
+              node_type: 'PREMISE',
+              standard: 'PROGRAM_WIDE'
+            }
+          }
+        ]
+      })
+    );
+    expect(result).toEqual({
+      regularPrice: '$10.00',
+      discountRate: '$10.00',
+      subscriptionPrice: '$0.00'
+    });
+  });
+
+  it('does not apply Discount Amount for non-USD currency', () => {
+    const selector = makeDiscountedProductPriceSelector(123);
+    const result = selector(
+      makeTestState({
+        incentives: [
+          {
+            object: 'item',
+            field: 'total_price',
+            type: 'Discount Amount',
+            value: 2.5,
+            criteria: {
+              node_type: 'PREMISE',
+              standard: 'PROGRAM_WIDE'
+            }
+          }
+        ],
+        currency: 'EUR'
+      })
+    );
+    expect(result).toEqual({
+      regularPrice: '€10.00',
+      discountRate: '€0.00', // no discount applied
+      subscriptionPrice: '€10.00'
+    });
+  });
+
+  it('applies Discount Percent for non-USD currency', () => {
+    const selector = makeDiscountedProductPriceSelector(123);
+    const result = selector(
+      makeTestState({
+        incentives: [
+          {
+            object: 'item',
+            field: 'total_price',
+            type: 'Discount Percent',
+            value: 20,
+            criteria: {
+              node_type: 'PREMISE',
+              standard: 'PROGRAM_WIDE'
+            }
+          }
+        ],
+        currency: 'GBP'
+      })
+    );
+    expect(result).toEqual({
+      regularPrice: '£10.00',
+      discountRate: '20%',
+      subscriptionPrice: '£8.00'
+    });
+  });
+
+  it('handles missing price for product', () => {
+    const selector = makeDiscountedProductPriceSelector(123);
+    const state = makeTestState({ productId: 123 });
+    delete state.price[123];
+
+    const result = selector(state);
+    expect(result).toEqual({});
+  });
+
+  it('handles empty incentives array', () => {
+    const selector = makeDiscountedProductPriceSelector(123);
+    const result = selector(makeTestState({ incentives: [] }));
+    expect(result).toEqual({
+      regularPrice: '$10.00',
+      discountRate: '$0.00',
+      subscriptionPrice: '$10.00'
+    });
+  });
+
+  it('applies 100% discount', () => {
+    const selector = makeDiscountedProductPriceSelector(123);
+    const result = selector(
+      makeTestState({
+        incentives: [
+          {
+            object: 'item',
+            field: 'total_price',
+            type: 'Discount Percent',
+            value: 100,
+            criteria: {
+              node_type: 'PREMISE',
+              standard: 'PROGRAM_WIDE'
+            }
+          }
+        ]
+      })
+    );
+    expect(result).toEqual({
+      regularPrice: '$10.00',
+      discountRate: '100%',
+      subscriptionPrice: '$0.00'
+    });
+  });
+
+  it('handles zero price', () => {
+    const selector = makeDiscountedProductPriceSelector(123);
+    const result = selector(
+      makeTestState({
+        price: 0
+      })
+    );
+    expect(result).toEqual({
+      regularPrice: '$0.00',
+      discountRate: '11%',
+      subscriptionPrice: '$0.00'
+    });
+  });
+
+  it('ignores unknown incentive types', () => {
+    const selector = makeDiscountedProductPriceSelector(123);
+    const result = selector(
+      makeTestState({
+        incentives: [
+          {
+            object: 'item',
+            field: 'total_price',
+            type: 'Unknown Type',
+            value: 50,
+            criteria: {
+              node_type: 'PREMISE',
+              standard: 'PROGRAM_WIDE'
+            }
+          }
+        ],
+        price: 1000
+      })
+    );
+    expect(result).toEqual({
+      regularPrice: '$10.00',
+      discountRate: '$0.00',
+      subscriptionPrice: '$10.00'
+    });
+  });
+
+  it('filters out irrelevant incentives', () => {
+    const selector = makeDiscountedProductPriceSelector(123);
+    const result = selector(
+      makeTestState({
+        incentives: [
+          {
+            object: 'order',
+            field: 'total_price',
+            type: 'Discount Percent',
+            value: 50,
+            criteria: {
+              node_type: 'PREMISE',
+              standard: 'PROGRAM_WIDE'
+            }
+          },
+          {
+            object: 'order',
+            field: 'shipping_total',
+            type: 'Discount Percent',
+            value: 25,
+            criteria: {
+              node_type: 'PREMISE',
+              standard: 'PROGRAM_WIDE'
+            }
+          },
+
+          {
+            object: 'item',
+            field: 'total_price',
+            type: 'Discount Percent',
+            value: 33,
+            criteria: {
+              node_type: 'PREMISE',
+              standard: 'PREPAID_ORDERS_PER_BILLING'
+            }
+          },
+          {
+            object: 'item',
+            field: 'total_price',
+            type: 'Discount Percent',
+            value: 37,
+            criteria: {
+              node_type: 'AND',
+              children: [
+                {
+                  node_type: 'PREMISE',
+                  standard: 'NTH_ORDER_FOR_SUBSCRIBER',
+                  premise_value: 3,
+                  premise_operand: 'GREATER_THAN'
+                },
+                {
+                  node_type: 'PREMISE',
+                  standard: 'ITEM_HAS_SUBSCRIPTION',
+                  premise_value: true
+                }
+              ]
+            }
+          },
+          {
+            object: 'item',
+            field: 'total_price',
+            type: 'Discount Percent',
+            value: 10,
+            criteria: {
+              node_type: 'PREMISE',
+              standard: 'PROGRAM_WIDE'
+            }
+          }
+        ]
+      })
+    );
+    expect(result).toEqual({
+      regularPrice: '$10.00',
+      discountRate: '10%',
+      subscriptionPrice: '$9.00'
+    });
+  });
+
+  it('displays PSI incentive when available', () => {
+    const selector = makeDiscountedProductPriceSelector(123);
+    const result = selector(
+      makeTestState({
+        incentives: [
+          {
+            object: 'item',
+            field: 'total_price',
+            type: 'Discount Percent',
+            value: 15,
+            criteria: {
+              node_type: 'PREMISE',
+              standard: 'PSI'
+            }
+          }
+        ]
+      })
+    );
+    expect(result).toEqual({
+      regularPrice: '$10.00',
+      discountRate: '15%',
+      subscriptionPrice: '$8.50'
+    });
+  });
+
+  it('does not calculate a discount if no standardized incentives', () => {
+    const selector = makeDiscountedProductPriceSelector(123);
+    const result = selector(
+      makeTestState({
+        incentives: [
+          {
+            object: 'item',
+            field: 'total_price',
+            type: 'Discount Percent',
+            value: 50
+          }
+        ]
+      })
+    );
+    expect(result).toEqual({
+      regularPrice: '$10.00',
+      discountRate: '$0.00',
+      subscriptionPrice: '$10.00'
+    });
+  });
+});
+
+describe('isShopifyDiscountFunctionInUseSelector', () => {
+  it('should return false when productPlans is an empty object', () => {
+    const state = { productPlans: {} };
+    expect(isShopifyDiscountFunctionInUseSelector(state)).toBe(false);
+  });
+
+  it('should return false when productPlans has product with empty array', () => {
+    const state = { productPlans: { 123: [] } };
+    expect(isShopifyDiscountFunctionInUseSelector(state)).toBe(false);
+  });
+
+  it('should return false when some product plan does not have hasPriceAdjustments property', () => {
+    const state = {
+      productPlans: {
+        123: [{ id: 'plan-1' }],
+        456: [{ id: 'plan-2', hasPriceAdjustments: false }]
+      }
+    };
+    expect(isShopifyDiscountFunctionInUseSelector(state)).toBe(false);
+  });
+
+  it('should return false when some product plan has hasPriceAdjustments = true', () => {
+    const state = {
+      productPlans: {
+        123: [{ id: 'plan-1', hasPriceAdjustments: false }],
+        456: [{ id: 'plan-2', hasPriceAdjustments: true }]
+      }
+    };
+    expect(isShopifyDiscountFunctionInUseSelector(state)).toBe(false);
+  });
+
+  it('should return true when all product plans have hasPriceAdjustments = false or are prepaid', () => {
+    const state = {
+      productPlans: {
+        123: [{ id: 'plan-1', hasPriceAdjustments: false }],
+        456: [
+          { id: 'plan-2', hasPriceAdjustments: false },
+          { id: 'plan-3', hasPriceAdjustments: false },
+          { id: 'plan-3', hasPriceAdjustments: true, prepaidShipments: 3 }
+        ]
+      }
+    };
+    expect(isShopifyDiscountFunctionInUseSelector(state)).toBe(true);
+  });
+});

package/src/core/adapters.js

@@ -45,6 +45,8 @@ export const getProductsForPurchasePost = (state = {}, productIds = []) =>
  *     discountRate: '10%'
  *   },
  * ]
+ *
+ * @returns {import('./types/reducer').ProductPlansState}
  */
 export const getObjectStructuredProductPlans = (productPlans = {}) => {
   const adaptedProductPlans = {};

package/src/core/constants.js

@@ -54,6 +54,13 @@ export const ENV_PROD = 'prod';
 export const STATIC_HOST = 'static.ordergroove.com';
 export const STAGING_STATIC_HOST = 'staging.static.ordergroove.com';
 
+export const INCENTIVE_STANDARD_TYPES = {
+  PSI: 'PSI',
+  // note: this is a "pseudo-standard" that we set in our own code
+  // the API actually returns no criteria for program wide incentives
+  PROGRAM_WIDE: 'PROGRAM_WIDE'
+};
+
 /**
  * @event
  * Events that fires once optin/optout occurs on a cart offer

package/src/core/experiments.js

@@ -71,8 +71,9 @@ export function experimentsReducer(state = {}, action) {
  * object.
  */
 function resolveShopifySetupProductWhenExperiment(variant, product, experimentSettings) {
-  // So, on the sellingPlanGroup appId we are doing "ordergroove-subscribe-and-save-{experiment_variant_id}"
-  // this logic will only be enabled if we are in an experiment, there are at least 2 groups in the OG selling plan group
+  // When an experiment is running, you may have multiple selling plan groups with the app_id "ordergroove-subscribe-and-save-{experiment_variant_id}"
+  // We want offers to use only the selling plan group that matches the assigned experiment variant
+  // Note: whether or not you have variant-specific selling plan groups depends on if the Shopify Discount Function is being used. If it is, then the selling plan groups do not contain price adjustments and there is only a single selling plan group (all variants use the same group).
   if (!variant) return;
 
   if (experimentSettings.variants.length === 0) return;