This repository has been archived by the owner on Feb 23, 2024. It is now read-only.
Change couponName filter to coupons and update documentation
#4312
Conversation
This file contains 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
opr
added
type: bug
opr
changed the title
couponName filter to coupons and update documentation
|
Size Change: +3 kB (0%) Total Size: 997 kB
ℹ️ View Unchanged
|
Merged
ralucaStan
suggested changes
Jun 23, 2021
| if you dynamically generate a coupon code that is not user friendly. It may, therefore, be desirable to change the way | ||
| this code is displayed. To do this, the filter `couponName` exists. | ||
| if you dynamically generate a coupon code that is not user-friendly. It may, therefore, be desirable to change the way | ||
| this code is displayed. To do this, the filter `couponName` exists. |
There was a problem hiding this comment.
I think you missed one replace here: the filter coupons exists instead of couponName
|
|
||
| The additional argument supplied to this filter is: `{ context: 'summary', coupon: CartCoupon }`. A `CartCoupon` has the following shape: | ||
| The additional argument supplied to this filter is: `{ context: 'summary' }`. A `CartCoupon` has the following shape: |
There was a problem hiding this comment.
I am wondering if coupon was actually the only additional argument and maybe this line needs to go away?
About CartCoupon, as there is no longer any reference to it in this paragraph, I would remove the sentence from here and make it standalone.
There was a problem hiding this comment.
Unrelated to the changes, I've looked at the readme and there is no example of how one should actually use this filter. It would be great if you could add one, two examples with the coupons filter.
There was a problem hiding this comment.
This isn't the case, the context is passed as the only additional argument, the coupon is no longer passed. The current state of this file does correctly describe what is passed to the filter function.
| // functionality when it comes to removing the coupon. | ||
| const cartCoupons = cartData.coupons.map( ( coupon ) => ( { | ||
| ...coupon, | ||
| text: coupon.code, |
There was a problem hiding this comment.
Wondering if label would be more appropriate than text. For example, we have the Total label that the user can change, so to keep it in the same registry I'd say a coupon label makes it more clear that we are talking about what text is displayed. What do you think?
This is needed to allow extensions to change the text without affecting the code.
ralucaStan
reviewed
Jul 1, 2021
| @@ -92,7 +89,7 @@ const TotalsDiscount = ( { | |||
| 'Remove coupon "%s"', | |||
| 'woo-gutenberg-products-block' | |||
| ), | |||
| filteredCouponCode | |||
| cartCoupon.text | |||
There was a problem hiding this comment.
Shouldn't this be cartCoupon.label as well?
ralucaStan
reviewed
Jul 1, 2021
| } | ||
| return { | ||
| ...coupon, | ||
| text: sprintf( |
There was a problem hiding this comment.
You need to replace text with label here as well.
ralucaStan
reviewed
Jul 1, 2021
|
|
||
| | Before | After | | ||
| |---|---| | ||
| | <img src="https://user-images.githubusercontent.com/5656702/123768988-bc55eb80-d8c0-11eb-9262-5d629837706d.png" /> | * | |
There was a problem hiding this comment.
There is no after photo here from what I see.
ralucaStan
reviewed
Jul 1, 2021
| @@ -201,6 +206,39 @@ __experimentalRegisterCheckoutFilters( 'my-hypothetical-price-plugin', { | |||
| |---|---| | |||
| | <img src="https://user-images.githubusercontent.com/5656702/117035086-d5488300-acfb-11eb-9954-feb326916168.png" width=400 /> | <img src="https://user-images.githubusercontent.com/5656702/117035616-70415d00-acfc-11eb-98d3-6c8096817e5b.png" width=400 /> | | |||
|
|
|||
| ### Change the name of a coupon | |||
There was a problem hiding this comment.
Great job adding this example, I'm sure it's gonna be super useful
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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
There is a bug where the coupon filter doesn't work if more than one coupon is added to the cart. This PR will change the way the coupon filter works to ensure the filter is only invoked once per render. Unfortunately this is a breaking change.
Another way to solve this would be to implement our own memoization function, and use that in
__experimentalApplyCheckoutFilterrather thanReact.useMemo, or to simply remove memoization altogether (not desirable).Changes made in this PR
textproperty to eachcouponin the cart. This is required because when extensions change how the coupon is displayed, we need to keep a record of the code, so we can remove it from the cart if the shopper desires.couponNamesfilter, and replace it withcoupons. Move the filter outside of the loop so it is always called once per render.couponNamesin its filters object.Fixes #4311
How to test the changes in this Pull Request:
testcoupon.packages/checkout/registry/index.ts)couponName is deprecated. Please use coupons instead.testcouponis now shown asthis is custom coupon text!Changelog