Apply discounts to the ecommerce event if available

[ianlin]

Changes proposed in this Pull Request:

Closes #417. This PR fixes a bug that the price in purchase events does not take coupon discounts into account by getting the price after discount using the method get_total() in WC_Order_Item_Product class, and add the discount parameter to the ecommerce event.

Only the purchase event will include discounts if available, since only the method get_formatted_order() will include the "price after coupon discounts" for each order line item.

Checks:

• Does your code follow the WordPress coding standards?
• Have you written new tests for your changes, as applicable?
• Have you successfully run tests with your changes locally?
• Have you checked to ensure there aren't other open Pull Requests for the same update/change?

Screenshots:

Detailed test instructions:

1. Checkout the branch of this PR and run npm ci and npm run build
2. Open Network tab from browser dev console, add google-analytics as the filter
3. Add some products into the cart, for example, two products.
4. Go to checkout page
5. Apply a coupon
6. Complete the purchase, see the order received page
7. From the Network tab, find the request with dt: Order Confirmation and en: purchase, which is the purchase event
8. From this event you should see there are two product parameters starts with pr1 and pr2, e.g.
   • pr1: id28~nmSingle~caMusic~qt1~pr12~ds12
   • pr2: id36~nmBeanie with Logo~caAccessories~qt1~pr10~ds8
9. The pr in the value is the price after coupon discounts, and ds is the amount of coupon discounts.
10. Add another two products into the carts, complete the order WITHOUT applying any coupons.
11. You should see there is no ds in the event parameters, and the price is just the regular price.

Additional details:

Changelog entry

Fix - Apply discounts to the ecommerce event if available

[puntope]

Why do we need these two? product.price_after_coupon_discount seems to be always a number

[ianlin]

Since there were not only purchase event would call the method getProductFieldObject(), for example begin_checkout event would call this method as well. Initially I wanted to test if product.price_after_coupon_discount is defined but since the price after discount could be 0 and 0 is treated as false, that's why I added these two conditions here.

[puntope]

Ah, I see. Thanks for clarifying. That might explain why we used

if ( typeof product.price_after_coupon_discount === 'number' )

But what about the NaN line check?

Also WDYT of doing something like:

if ( product?.price_after_coupon_discount < product.prices.price )

So we can save both checks number and nan

You can test it but in case product.price_after_coupon_discount is undefined this would be false still.

[ianlin]

@puntope

But what about the NaN line check?

I added it because I see typeof NaN is also a number, so added it for some prevention.

Also WDYT of doing something like:
if ( product?.price_after_coupon_discount < product.prices.price )
So we can save both checks number and nan
You can test it but in case product.price_after_coupon_discount is undefined this would be false still.

Ah good point, thanks for the info.

[puntope]

WDYT about changing this to product.price_after_coupon_discount < product.prices.price I don't think we can have negative discounts.

[puntope]

We need to wrap this with formatPrice() as well. Otherwise, the discount is sent without decimals.

[ianlin]

Thanks for the nice catch!

[puntope]

Thanks for working on this @ianlin

The price is shown correctly but not the discount.

See my comments in the PR. Thanks

[ianlin]

Hey @puntope, thanks for the review and nice suggestions. I've pushed more commits and it's ready for another round.

[puntope]

Thanks for the changes @ianlin

I left one more comment regarding the need for the number and nan check. But approved in advance