Skip to content

Honor WooCommerce currency decimals in conversion events. #13141

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
faisalahammad wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Honor WooCommerce currency decimals in conversion events. #13141

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 35 additions & 11 deletions assets/js/event-providers/woocommerce.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@

const {
currency: globalCurrency,
currency_minor_unit: globalCurrencyMinorUnit = 2,
products: globalProducts,
purchase,
add_to_cart: addToCart,
Expand All @@ -32,7 +33,15 @@
if ( addToCart && canTrackAddToCart ) {
const { price } = addToCart;

const eventData = formatEventData( price, globalCurrency, addToCart );
const eventData = formatEventData(
price,
globalCurrency,
addToCart,
null,
null,
null,
globalCurrencyMinorUnit
);

global._googlesitekit?.gtagEvent?.( 'add_to_cart', eventData );
}
Expand All @@ -46,7 +55,8 @@
items,
id,
totals.shipping_total,
totals.tax_total
totals.tax_total,
globalCurrencyMinorUnit
);

// User data is already normalized from WooCommerce.php.
Expand Down Expand Up @@ -82,7 +92,11 @@
const eventData = formatEventData(
price,
globalCurrency,
productData
productData,
null,
null,
null,
globalCurrencyMinorUnit
);
global._googlesitekit?.gtagEvent?.( 'add_to_cart', eventData );
} );
Expand Down Expand Up @@ -126,7 +140,11 @@
const eventData = formatEventData(
price,
globalCurrency,
productData
productData,
null,
null,
null,
globalCurrencyMinorUnit
);

global._googlesitekit?.gtagEvent?.( 'add_to_cart', eventData );
Expand All @@ -140,10 +158,11 @@
products,
transactionID = null,
shipping = null,
tax = null
tax = null,
currencyMinorUnit = 2
) {
const formattedData = {
value: formatPrice( value ),
value: formatPrice( value, currencyMinorUnit ),
currency,
items: [],
googlesitekit_event_provider: 'woocommerce',
Expand All @@ -167,22 +186,26 @@

if ( products && products.length ) {
for ( const product of products ) {
formattedData.items.push( formatProductData( product ) );
formattedData.items.push(
formatProductData( product, currencyMinorUnit )
);
}
} else if ( products && products.id ) {
formattedData.items = [ formatProductData( products ) ];
formattedData.items = [
formatProductData( products, currencyMinorUnit ),
];
}

return formattedData;
}

function formatProductData( product ) {
function formatProductData( product, currencyMinorUnit = 2 ) {
const { id, name, price, variation, quantity, categories } = product;

const mappedItem = {
item_id: id,
item_name: name,
price: formatPrice( price ),
price: formatPrice( price, currencyMinorUnit ),
};

if ( quantity ) {
Expand Down Expand Up @@ -213,9 +236,10 @@
* Returns the price of a product formatted with decimal places if necessary.
*
* @since 1.158.0
* @since n.e.x.t Added the `currencyMinorUnit` parameter.
*
* @param {string} price The price to parse.
* @param {number} [currencyMinorUnit=2] The number decimals to show in the currency.
* @param {number} [currencyMinorUnit=2] The number of decimals used by the store currency, as configured in WooCommerce settings.
* @return {number} The price of the product with decimals.
*/
function formatPrice( price, currencyMinorUnit = 2 ) {
Expand Down
252 changes: 252 additions & 0 deletions assets/js/event-providers/woocommerce.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,252 @@
/**
* WooCommerce event provider tests.
*
* Site Kit by Google, Copyright 2026 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

/**
* Internal dependencies
*/

// The IIFE in `./woocommerce` runs at require time and synchronously calls
// `gtagEvent` for the `add_to_cart` and `purchase` events it finds on
// `window._googlesitekit.wcdata`. Tests must set up that global and a
// jQuery stub before requiring the file.

const gtagEventCalls = [];

function setupGlobals( {
currency = 'USD',
currencyMinorUnit = 2,
addToCart = null,
purchase = null,
products = [],
eventsToTrack = [ 'add_to_cart', 'purchase' ],
} = {} ) {
gtagEventCalls.length = 0;

global._googlesitekit = {
...global._googlesitekit,
wcdata: {
currency,
currency_minor_unit: currencyMinorUnit,
products,
add_to_cart: addToCart,
purchase,
eventsToTrack,
},
gtagEvent: jest.fn( ( name, data ) => {
gtagEventCalls.push( { name, data } );
} ),
};

// Minimal jQuery stub — the WC provider only uses `body.on` and `.each`
// against the products DOM, neither of which needs to fire in unit tests.
global.jQuery = jest.fn( () => ( {
on: jest.fn(),
each: jest.fn(),
find: jest.fn( () => ( { attr: () => null } ) ),
} ) );
global.jQuery.fn = global.jQuery;
}

describe( 'WooCommerce event provider', () => {
beforeEach( () => {
jest.resetModules();
} );

afterEach( () => {
delete global._googlesitekit.wcdata;
delete global.jQuery;
} );

describe( 'add_to_cart value formatting', () => {
it( 'should divide by 100 when currency uses 2 decimal places', () => {
setupGlobals( {
currency: 'USD',
currencyMinorUnit: 2,
addToCart: {
id: 1,
name: 'Test Product',
price: 25075,
},
} );

require( './woocommerce' );

expect( gtagEventCalls ).toHaveLength( 1 );
expect( gtagEventCalls[ 0 ].name ).toBe( 'add_to_cart' );
expect( gtagEventCalls[ 0 ].data.value ).toBe( 250.75 );
expect( gtagEventCalls[ 0 ].data.items[ 0 ].price ).toBe( 250.75 );
} );

it( 'should divide by 10000 when currency uses 4 decimal places', () => {
setupGlobals( {
currency: 'BHD',
currencyMinorUnit: 4,
addToCart: {
id: 2,
name: 'High Precision Product',
price: 12345,
},
} );

require( './woocommerce' );

expect( gtagEventCalls ).toHaveLength( 1 );
expect( gtagEventCalls[ 0 ].name ).toBe( 'add_to_cart' );
expect( gtagEventCalls[ 0 ].data.value ).toBe( 1.2345 );
expect( gtagEventCalls[ 0 ].data.items[ 0 ].price ).toBe( 1.2345 );
} );

it( 'should pass the value through when currency uses 0 decimal places', () => {
setupGlobals( {
currency: 'JPY',
currencyMinorUnit: 0,
addToCart: {
id: 3,
name: 'Yen Product',
price: 12345,
},
} );

require( './woocommerce' );

expect( gtagEventCalls[ 0 ].data.value ).toBe( 12345 );
expect( gtagEventCalls[ 0 ].data.items[ 0 ].price ).toBe( 12345 );
} );

it( 'should divide by 1000 when currency uses 3 decimal places', () => {
setupGlobals( {
currency: 'KWD',
currencyMinorUnit: 3,
addToCart: {
id: 4,
name: 'KWD Product',
price: 250750,
},
} );

require( './woocommerce' );

expect( gtagEventCalls[ 0 ].data.value ).toBe( 250.75 );
} );
} );

describe( 'purchase value formatting', () => {
const purchaseFixture = {
id: 99,
totals: {
currency_code: 'USD',
total_price: 25075,
shipping_total: 500,
tax_total: 200,
},
items: [
{
id: 1,
name: 'Test Product',
price: 12345,
quantity: 2,
},
],
};

it( 'should divide purchase value by 100 with 2 decimal places', () => {
setupGlobals( {
currency: 'USD',
currencyMinorUnit: 2,
purchase: purchaseFixture,
} );

require( './woocommerce' );

expect( gtagEventCalls[ 0 ].name ).toBe( 'purchase' );
expect( gtagEventCalls[ 0 ].data.value ).toBe( 250.75 );
expect( gtagEventCalls[ 0 ].data.transaction_id ).toBe( 99 );
expect( gtagEventCalls[ 0 ].data.items[ 0 ].price ).toBe( 123.45 );
} );

it( 'should divide purchase value by 10000 with 4 decimal places', () => {
setupGlobals( {
currency: 'BHD',
currencyMinorUnit: 4,
purchase: {
...purchaseFixture,
totals: {
...purchaseFixture.totals,
total_price: 1234500,
},
items: [
{
id: 1,
name: 'Test Product',
price: 12345,
quantity: 2,
},
],
},
} );

require( './woocommerce' );

expect( gtagEventCalls[ 0 ].name ).toBe( 'purchase' );
expect( gtagEventCalls[ 0 ].data.value ).toBe( 123.45 );
expect( gtagEventCalls[ 0 ].data.items[ 0 ].price ).toBe( 1.2345 );
} );

it( 'should not fire purchase event when eventsToTrack excludes it', () => {
setupGlobals( {
currency: 'USD',
currencyMinorUnit: 2,
purchase: purchaseFixture,
eventsToTrack: [ 'add_to_cart' ],
} );

require( './woocommerce' );

expect( gtagEventCalls ).toHaveLength( 0 );
} );
} );

describe( 'fallback behavior', () => {
it( 'should default to 2 decimal places when currency_minor_unit is missing from wcdata', () => {
gtagEventCalls.length = 0;
global._googlesitekit = {
...global._googlesitekit,
wcdata: {
currency: 'USD',
products: [],
add_to_cart: { id: 1, name: 'X', price: 10000 },
purchase: null,
eventsToTrack: [ 'add_to_cart', 'purchase' ],
},
gtagEvent: jest.fn( ( name, data ) => {
gtagEventCalls.push( { name, data } );
} ),
};
global.jQuery = jest.fn( () => ( {
on: jest.fn(),
each: jest.fn(),
find: jest.fn( () => ( { attr: () => null } ) ),
} ) );
global.jQuery.fn = global.jQuery;

require( './woocommerce' );

expect( gtagEventCalls[ 0 ].data.value ).toBe( 100 );
} );
} );
} );
2 changes: 2 additions & 0 deletions includes/Core/Conversion_Tracking/Conversion_Event_Providers/WooCommerce.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,6 +278,7 @@ function () {
sprintf( 'window._googlesitekit.wcdata.products = %s;', wp_json_encode( $this->products ) ),
sprintf( 'window._googlesitekit.wcdata.add_to_cart = %s;', wp_json_encode( $this->add_to_cart ) ),
sprintf( 'window._googlesitekit.wcdata.currency = "%s";', esc_js( get_woocommerce_currency() ) ),
sprintf( 'window._googlesitekit.wcdata.currency_minor_unit = %d;', absint( wc_get_price_decimals() ) ),
sprintf( 'window._googlesitekit.wcdata.eventsToTrack = %s;', wp_json_encode( $events_to_track ) ),
)
);
Expand Down Expand Up @@ -647,6 +648,7 @@ protected function maybe_add_purchase_inline_script( $order_id, $skip_meta_value
"\n",
array(
'window._googlesitekit.wcdata = window._googlesitekit.wcdata || {};',
sprintf( 'window._googlesitekit.wcdata.currency_minor_unit = %d;', absint( wc_get_price_decimals() ) ),
sprintf( 'window._googlesitekit.wcdata.purchase = %s;', wp_json_encode( $this->get_formatted_order( $order ) ) ),
)
),
Expand Down
Loading