Add new actions for tracking

[puntope]

Changes proposed in this Pull Request:

Closes part of #227

This PR implements a set of new actions and their respective tracking functions for handling GA events with addAction hook.

Replace this with a good description of your changes & reasoning.

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?

Detailed test instructions:

1. For testing the actions I added this list of doActions (see after), you can see how GTag events run in Google Analytics Debugger.
2. See that are no duplicates with WC Blocks (WC Blocks shows a log in console too console.log( Tracking event ${ eventName } );)
3. Compare the actions with the ones in WC Blocks
4. You can also test to add other actions with same name in different namespace so you can check they are not deleted.

List of doActions.

const product = {
	id: '1234',
	name: 'Test',
	list_name: 'List test',
	categories: [ { name: 'cat 1' }, { name: 'cat 2' } ],
	prices: {
		price: 2222,
		currency_minor_unit: 2,
	},
};

const product2 = {
	id: '12345',
	name: 'Test 2',
	list_name: 'List test',
	categories: [ { name: 'cat 1' }, { name: 'cat 2' } ],
	prices: {
		price: 2222,
		currency_minor_unit: 2,
	},
};

const storeCart = {
	cartItems: [ product, product2 ],
	cartCoupons: [
		{
			code: '123',
		},
	],
	cartTotals: {
		currency_code: 'EUR',
		total_price: 2222,
		currency_minor_unit: 2,
	},
};

doAction( `${ ACTION_PREFIX }-store-notice-create`, {
	status: 'error',
	content: 'test',
} );

doAction( `${ ACTION_PREFIX }-store-notice-create`, {
	status: 'other',
	content: 'test',
} );

doAction( `${ ACTION_PREFIX }-product-render`, { product, listName: 'test' } );
doAction( `${ ACTION_PREFIX }-product-search`, { searchTerm: 'joe' } );
doAction( `${ ACTION_PREFIX }-product-view-link`, {
	product,
	listName: 'test',
} );

doAction( `${ ACTION_PREFIX }-cart-add-item`, { product, quantity: 2 } );
doAction( `${ ACTION_PREFIX }-cart-remove-item`, { product, quantity: 1 } );
doAction( `${ ACTION_PREFIX }-cart-set-item-quantity`, {
	product,
	quantity: 3,
} );

doAction( `${ ACTION_PREFIX }-product-list-render`, {
	products: [ product, product2 ],
} );

doAction( `${ ACTION_PREFIX }-checkout-render-checkout-form`, { storeCart } );
doAction( `${ ACTION_PREFIX }-checkout-set-email-address`, { storeCart } );
doAction( `${ ACTION_PREFIX }-checkout-set-shipping-address`, { storeCart } );
doAction( `${ ACTION_PREFIX }-checkout-set-billing-address`, { storeCart } );
doAction( `${ ACTION_PREFIX }-checkout-set-phone-number`, {
	step: 'shipping',
	storeCart,
} );

doAction( `${ ACTION_PREFIX }-checkout-set-selected-shipping-rate`, {
	shippingRateId: 'hello',
} );

doAction( `${ ACTION_PREFIX }-checkout-set-active-payment-method`, {
	paymentMethodSlug: 'hello',
} );

Additional details:

⚠️ JS Unit Tests support are not included in this PR

Changelog entry

Add - Implement tracking with Actions Hooks

[martynmjones]

Hey @puntope, thanks for your work on modernising the tracking!

This PR is working as expected and does a really nice job of replacing the core tracking but all the events are following the structure for Universal Analytics instead of GA4.

As UA will be retired on the 1st of July 2023 it seems like these changes should be made to support GA4.

I've left a couple of comments but haven't gone through each event as it looks like they will all need to be adjusted.

[martynmjones]

GA4 drops checkout_progress completely and doesn't include checkout_step option

[martynmjones]

GA4 drops the event_category and event_label structure in favor of individual parameters for each event. Ref: https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client_type=gtag#view_item_list

[martynmjones]

Again a UA/GA4 issue and I know it wasn't introduced in this PR but getProductImpressionObject parameter names have things like id and name instead of item_id and item_name.

For the map here, list_position would become index.

[puntope]

Hello @martynmjones Thanks for the GA changes catch. Since this PR is not going to be merged into develop branch (yet) I will discuss it with the WC Blocks team and perform the updates in other PR if that's ok.

In regards to your comment about the missed key, it's already clarified

[martynmjones]

Hey @puntope,

Thanks for the clarification 👍