Fix totalValue test measurement

[xav-ie]

Fix totalValue test measurement

WHY are these changes introduced?

In my limited experience, I notice many Shopify stores are sending an incorrect
totalValue(in analytics lib)/total_value(in network request) measurement in
their analytics. Most Shopify storefronts default to sending just the
product.value.

I am pretty sure this is incorrect:

hydrogen/packages/hydrogen-react/src/analytics-types.ts

Lines 116 to 117 in e7db0a5

	/** Total value of products. */
	totalValue?: number;

I went to verify this, but the tests do not rigourously test the totalValue. It
just sends placeholder value, not based on the products at all. Currently, it
is not clear what expected totalValue is for different product payloads.

WHAT is this pull request doing?

Enhances the tests to ensure the totalValue is more accurate. Establishes
that totalValue is indeed the total value of the products in the event.

1. adds helpers
2. tests the helpers
3. enhances the tests to have accurate totalValue measurement, making it
   clear totalValue is based on products total value.

HOW to test your changes?

npm run test

Checklist

• I've read the Contributing Guidelines
• I've considered possible cross-platform impacts (Mac, Linux, Windows)
• I've added a changeset if this PR contains user-facing or noteworthy changes
• I've added tests to cover my changes
• I've added or updated the documentation

[xav-ie]

total_value is actually expected to not exist when product quantity is 0 or undefined:

hydrogen/packages/hydrogen-react/src/analytics-schema-custom-storefront-customer-tracking.ts

Lines 206 to 211 in e7db0a5

	addDataIf(
	{
	event_name: PRODUCT_ADDED_TO_CART_EVENT_NAME,
	customerId: addToCartPayload.customerId,
	cart_token: cartToken?.id ? `${cartToken.id}` : null,
	total_value: addToCartPayload.totalValue,

^ removes total_value if totalValue is 0/undefined.

This is test case where totalValue is 0, since all products here are quantity undefined. products array is derived from BASE_PRODUCT_PAYLOAD, which does not define quantity.

I add a test below to test a payload where products has a product with quantity 1.

[Copilot]

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

Comments suppressed due to low confidence (1)

packages/hydrogen-react/src/analytics-utils.ts:125

• If product.quantity is undefined, the result defaults to 0. If a missing quantity should be interpreted as 1, consider adjusting the logic to use a default of 1.

export const getProductValue = (product: ShopifyAnalyticsProduct): number => parseFloat(product.price) * (product.quantity || 0);

[xav-ie]

If product.quantity is undefined, the result defaults to 0. If a missing quantity should be interpreted as 1, consider adjusting the logic to use a default of 1.

• copilot

If a product has no quantity, there is no quantity. The quantity is 0.
Default 1 is unexpected behavior.

[xav-ie]

Dear shopify devs, may I get another test run and review, please?

Your review approval will clarify what an expected event should have, which is very valuable for me. A disapproval will also be helpful in clarification.

[xav-ie]

Hello @juanpprieto , please let me know if I can change something to make this look good.

[juanpprieto]

Hey @xav-ie! Thanks for the PR and apologies for the delay.

I am still investigating internally what this value should be. In the liquid domain the reference Horizon theme's add to cart event appears to set total_value as the individual variant price and not the combined value with the quantity.

You can test here:
https://themes.shopify.com/themes/horizon/styles/horizon/preview

I will talk to the analytics team and try to confirm why we don't seem to be sending the combined value.

[xav-ie]

Thank you for investigating. I appreciate it a lot. This is the reason I made the PR.

I was also confused and thought this was wrong. Hopefully, it will become clear at conclusion of this PR :)

[github-actions]

This pull request has been marked as stale due to inactivity for 60 days. If no further activity occurs, it will be closed in 7 days.