Add support for Rule Based Promotions for Choice of Bonus Products - #3418
Merged
sf-shikhar-prasoon merged 31 commits intoOct 25, 2025
Conversation
update feature branch `bonus-products-rule-based-v3` with develop branch
update feature branch `bonus-products-rule-based-v3` with develop branch
update feature branch `bonus-products-rule-based-v3` with develop branch
* 1. use search endpoint * 2 add rule based detection * 3. update discovery logic * add tests, update bundle size limit, update changelog
…gic (#3408) * 1. use search endpoint * 2 add rule based detection * 3. update discovery logic * cleanup. remove unused code * add tests, update bundle size limit, update changelog
Collaborator
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
Update feature branch with latest from develop branch
sf-shikhar-prasoon
marked this pull request as ready for review
October 23, 2025 14:20
12 tasks
feature/bonus-products-rule-based-v3 into develop…3421) * fix header counts * fix flasing, re-rendering * pr comments + lint
| enabled: ruleBasedPromotions.length > 0, | ||
| limit: 50 | ||
| } | ||
| ) |
Contributor
There was a problem hiding this comment.
Why are we not creating a list of rule based promotionIds ?
And call search API for all promotionIds instead of one at a time ?
Contributor
There was a problem hiding this comment.
According to @sf-shikhar-prasoon This PR only supports 1 rule based promotion per product. Mentioned the same in changeLog
adamraya
reviewed
Oct 23, 2025
adamraya
reviewed
Oct 23, 2025
adamraya
reviewed
Oct 23, 2025
Contributor
|
Is this a bug? This video shows how it's possible a product that does not have bonus products could still be associated with bonus products. Arc.2025-10-23.at.19.09.24.mp4
|
Contributor
|
Now that we have modal for choosing the bonus products, let's make sure that its UX is the same/similar to the other modal for editing the cart item. For bonus products, the content shifts around each time we select a different size, for example. Compare that with how the UX feels like for editing the cart item. Yes, selecting a different size triggers a fetch, but is there a way to keep the content feels more stable? Arc.2025-10-23.at.19.16.31.mp4 |
12 tasks
…1/ruleBasedBugs/main Resolved conflict in use-rule-based-bonus-products.js by keeping Commerce SDK implementation (useProductSearch) which includes pmpt=bonus parameter. Merged changes: - Hybrid proxy support for local development - Order details multiship and BOPIS support - Bonus product calculations improvements - Various CHANGELOG updates
…9980361/ruleBasedBugs/main PR comments for #3418 (PR for merging feature branch bonus-products-rule-based-v3 into develop)
This PR enhances the existing rule-based bonus product promotions feature by adding proper variant eligibility checking. Previously, rule-based promotions could not accurately determine which specific product variants qualified for a promotion. This enhancement introduces a qualifying products lookup system that uses the product search API to fetch and validate eligible variants, ensuring that only products that truly qualify can trigger bonus product selection UI and functionality.
Key Changes:
1. New Hook: useRuleBasedQualifyingProducts
- Added to app/hooks/use-rule-based-bonus-products.js
- Fetches qualifying products for rule-based promotions using productSearch API
- Uses refinement parameters: pmid=${promotionId} and pmpt=qualifying
- Returns a Set of qualifying product IDs for efficient lookup
- Supports variant eligibility checking by examining both variant and master product IDs
2. Enhanced Promotion Eligibility Logic
- Updated getPromotionIdsForProduct() in app/utils/bonus-product/common.js
- Distinguishes between list-based and rule-based promotions
- Added fallback logic to check master product IDs when variants don't directly qualify
- Filters promotion IDs to only return those the product actually qualifies for
3. Qualifying Products Map Integration
- Added ruleBasedQualifyingProductsMap parameter throughout the bonus product utility chain
- Updated useBasketProductsWithPromotions() hook to fetch and return qualifying products map
- Propagated the map through all relevant functions and components
4. Updated Function Signatures
- isAutomaticPromotion()
- shouldShowBonusProductSelection()
- getBonusProductsForSpecificCartItem()
- getBonusProductsInCartForProduct()
- getAvailableBonusItemsForProduct()
- getRemainingAvailableBonusProductsForProduct()
5. Component Updates
- Cart Page: Destructures and passes ruleBasedQualifyingProductsMap
- Add to Cart Modal: Uses qualifying products map for eligibility checks
- Cart Product List: Accepts and forwards ruleBasedQualifyingProductsMap prop
6. Comprehensive Test Updates
- Updated all test files to distinguish list-based vs rule-based promotions
- Added new test cases for rule-based promotion eligibility scenarios
- Enhanced test coverage across all bonus product utility test files
Backward Compatibility:
- All changes are backward compatible with existing list-based promotions
- Default parameter values ensure functions work without the new map
- Existing tests updated to explicitly mark promotions as list-based
…#3431) * fix: prevent promotion flash by keeping previous data during variant changes - Add keepPreviousData option parameter to useProductViewModal hook - Pass keepPreviousData: true in BonusProductViewModal to maintain UI stability - Prevents promotion message from clearing while fetching new variant data * chore: trigger CI * remove those stable references * revert last changes
…0037720 Rule-Based Bonus Product Promotions Enhancement
* Fixed duplicating bonus products in the UI * Fixed issue with list based not rendering properly * Update cart-product-list-with-grouped-bonus-products.jsx Signed-off-by: Daniel Diaz <38542490+ddiazccrz@users.noreply.github.com> * Fixed lint errors --------- Signed-off-by: Daniel Diaz <38542490+ddiazccrz@users.noreply.github.com>
ddiazccrz
approved these changes
Oct 25, 2025
ddiazccrz
left a comment
Contributor
There was a problem hiding this comment.
I am approving this with the understanding that there are a few minor existing bugs (there with bonus products before this rule based bonus products) that will be fixed after. @sf-shikhar-prasoon lets make sure we make work items to address the lower priority issues.
sf-xingquan-jin
approved these changes
Oct 25, 2025
sf-deepali-bharmal
approved these changes
Oct 25, 2025
sf-deepali-bharmal
left a comment
Contributor
There was a problem hiding this comment.
I am approving the PR but please test this feature branch thoroughly, preferably maintain a doc with tested scenario's.
Mix of rule based, list based, multiple rules or list based promo's in cart etc end to end.
| enabled: ruleBasedPromotions.length > 0, | ||
| limit: 50 | ||
| } | ||
| ) |
Contributor
There was a problem hiding this comment.
According to @sf-shikhar-prasoon This PR only supports 1 rule based promotion per product. Mentioned the same in changeLog
|
|
||
| // Count selected items for this promotion (all bonus items with this promotion's bonusDiscountLineItemIds) | ||
| const promotionBonusLineItemIds = promotionBonusItems.map((item) => item.id).filter(Boolean) | ||
|
|
Contributor
There was a problem hiding this comment.
This file can be reverted.
shethj
pushed a commit
that referenced
this pull request
Oct 31, 2025
…3418) * @W-18957985- Product Search Integration & Rule-Based Detection (#3396) * 1. use search endpoint * 2 add rule based detection * 3. update discovery logic * add tests, update bundle size limit, update changelog * @W-19980361 Rule based bonus products- Work Item 2- update display logic (#3408) * 1. use search endpoint * 2 add rule based detection * 3. update discovery logic * cleanup. remove unused code * add tests, update bundle size limit, update changelog * fix header counts * fix flasing, re-rendering * pr comments + lint * @W-19980361 fix 2 bugs- selection count & flashing due to re-renders (#3421) * fix header counts * fix flasing, re-rendering * pr comments + lint * add param &refine=pmpt=bonus for promotion type * pr comments * use commerce sdk * add const- limit=50 | replace harded Search Param values * remove function breakdown change * update changelog * refactor. re-use * fix: prevent promotion message flashing when changing product variant… (#3428) * fix tests * Rule-Based Bonus Product Promotions Enhancement This PR enhances the existing rule-based bonus product promotions feature by adding proper variant eligibility checking. Previously, rule-based promotions could not accurately determine which specific product variants qualified for a promotion. This enhancement introduces a qualifying products lookup system that uses the product search API to fetch and validate eligible variants, ensuring that only products that truly qualify can trigger bonus product selection UI and functionality. Key Changes: 1. New Hook: useRuleBasedQualifyingProducts - Added to app/hooks/use-rule-based-bonus-products.js - Fetches qualifying products for rule-based promotions using productSearch API - Uses refinement parameters: pmid=${promotionId} and pmpt=qualifying - Returns a Set of qualifying product IDs for efficient lookup - Supports variant eligibility checking by examining both variant and master product IDs 2. Enhanced Promotion Eligibility Logic - Updated getPromotionIdsForProduct() in app/utils/bonus-product/common.js - Distinguishes between list-based and rule-based promotions - Added fallback logic to check master product IDs when variants don't directly qualify - Filters promotion IDs to only return those the product actually qualifies for 3. Qualifying Products Map Integration - Added ruleBasedQualifyingProductsMap parameter throughout the bonus product utility chain - Updated useBasketProductsWithPromotions() hook to fetch and return qualifying products map - Propagated the map through all relevant functions and components 4. Updated Function Signatures - isAutomaticPromotion() - shouldShowBonusProductSelection() - getBonusProductsForSpecificCartItem() - getBonusProductsInCartForProduct() - getAvailableBonusItemsForProduct() - getRemainingAvailableBonusProductsForProduct() 5. Component Updates - Cart Page: Destructures and passes ruleBasedQualifyingProductsMap - Add to Cart Modal: Uses qualifying products map for eligibility checks - Cart Product List: Accepts and forwards ruleBasedQualifyingProductsMap prop 6. Comprehensive Test Updates - Updated all test files to distinguish list-based vs rule-based promotions - Added new test cases for rule-based promotion eligibility scenarios - Enhanced test coverage across all bonus product utility test files Backward Compatibility: - All changes are backward compatible with existing list-based promotions - Default parameter values ensure functions work without the new map - Existing tests updated to explicitly mark promotions as list-based * fix: prevent promotion message flashing when changing product variant (#3431) * fix: prevent promotion flash by keeping previous data during variant changes - Add keepPreviousData option parameter to useProductViewModal hook - Pass keepPreviousData: true in BonusProductViewModal to maintain UI stability - Prevents promotion message from clearing while fetching new variant data * chore: trigger CI * remove those stable references * revert last changes * bundle size limit update * @W-20037720: Not allow duplicate items to appear in the cart (#3433) * Fixed duplicating bonus products in the UI * Fixed issue with list based not rendering properly * Update cart-product-list-with-grouped-bonus-products.jsx Signed-off-by: Daniel Diaz <38542490+ddiazccrz@users.noreply.github.com> * Fixed lint errors --------- Signed-off-by: Daniel Diaz <38542490+ddiazccrz@users.noreply.github.com> --------- Signed-off-by: Daniel Diaz <38542490+ddiazccrz@users.noreply.github.com> Co-authored-by: sf-xingquan-jin <xingquan.jin@salesforce.com> Co-authored-by: cboscenco <cboscenco@salesforce.com> Co-authored-by: Daniel Diaz <38542490+ddiazccrz@users.noreply.github.com>
12 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
10 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Add support for Rule Base Promotions to Choice of Bonus Products.
Last release we added support for Choice of Bonus Products where the shopper is presented a set of choices to select bonus products from.
Currently only list based promotions are supported. After merging this PR, rule based promotions will be supported.
Currently, merchants have to explicitly list the products that are offered as choices. After merging this PR, merchants can configure rules that will search for all products that satisfy the promotion rule and create the list to be presented to the shopper.
demo-.rule.based.mov
Types of Changes
Changes
Features:
Affected Components:
How to Test-Drive This PR
The promotion:
Checklists
General
Accessibility Compliance
You must check off all items in one of the follow two lists:
or...
Localization