[API Pull] Add Track Events to the Auth API responses

[jorgemd24]

Changes proposed in this Pull Request:

Part of #2146 .

Currently, we have two tracking events, gla_disable_product_sync_click and gla_enable_product_sync_click. However, it would also be useful to track the status of the Auth flow and when merchants revoke access.

This PR adds the following server-side event tracking:

• revoke_wpcom_api_authorization -> When the token is revoked, this event will include the status, blog id, and any error if it exists.
• update_wpcom_api_authorization -> When the Auth flow is completed, this event will include the status, blog id, and any error if it exists.

Screenshots:

Detailed test instructions:

1. Confirm tracking is allowed in WooCommerce > Settings > Advanced > Woo.com
2. To view the tracking, go to Tracks -> History (live tracking doesn't show the properties). Filter by your username and the following events: wcadmin_gla_update_wpcom_api_authorization and wcadmin_gla_revoke_wpcom_api_auth. It may take some time for the data to appear.
3. Alternatively you can use the following filter to see the events in the error log:

add_filter(
	'pre_http_request',
	function ( $pre, $args, $url ) {
		if ( str_starts_with( $url, 'https://pixel.wp.com' ) ) {
			wp_parse_str( wp_parse_url( $url, PHP_URL_QUERY ), $query_vars );
			error_log( json_encode( $query_vars, JSON_PRETTY_PRINT ) );
		}
		return $pre;
	},
	10,
	3
);

Ref: #2207

4. Enable the notification service: add_filter( 'woocommerce_gla_notifications_enabled','__return_true' );
5. Go to GLA -> Settings -> Get Early Access -> follow the steps.
6. Revoke the access by clicking in : Disable product data fetch:

Additional details:

• I included the blog_id because I thought it might help with debugging issues, but I can't see it in Tracks. I'm not sure why that is.

Changelog entry

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 64.8%. Comparing base (7ff8a9e) to head (2171ce6).
Report is 36 commits behind head on feature/google-api-project.

Additional details and impacted files

@@                      Coverage Diff                       @@
##             feature/google-api-project   #2452     +/-   ##
==============================================================
+ Coverage                          64.6%   64.8%   +0.1%     
  Complexity                         4552    4552             
==============================================================
  Files                               473     473             
  Lines                             17757   17783     +26     
==============================================================
+ Hits                              11478   11516     +38     
+ Misses                             6279    6267     -12     

Flag	Coverage Δ
php-unit-tests	64.8% <100.0%> (+0.1%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
src/API/WP/OAuthService.php	100.0% <100.0%> (+3.9%)	⬆️
src/MerchantCenter/AccountService.php	98.4% <100.0%> (+0.1%)	⬆️

... and 2 files with indirect coverage changes

[puntope]

I included the blog_id because I thought it might help with debugging issues, but I can't see it in Tracks. I'm not sure why that is.

@jorgemd24 I yes get the blog ID (in the logs using the snippets. In tracks I didn0't check)

[puntope]

Can we add here the property directives? Also, I miss the event description.

[jorgemd24]

Thanks I add them here: fb8b49c

[puntope]

Same as https://github.com/woocommerce/google-listings-and-ads/pull/2452/files#r1666846943

[jorgemd24]

Thanks @puntope for the review!

I yes get the blog ID (in the logs using the snippets. In tracks I didn0't check)

Yes, the blog_id is being sent to Tracks, and it shows in the logs, but I can't see it in Tracks. I'll need to investigate further to see if there are any restrictions on sending this parameter to Tracks.

Can you take another look to this PR?

[puntope]

Instead of mixed WDYT about number|null ?

[puntope]

Also, maybe we can consider sending 400 or 500 for example or get the error code to have consistency between both woocommerce_gla_track_event tracks (in some is a number, the request status, and in this one the string "error" )

[puntope]

error seems to be optional

[puntope]

Status is number in this case right?

[puntope]

Thanks @jorgemd24 for adding the docs. I left some additional comments

[jorgemd24]

Hi @puntope,

I addressed your suggestions. Can u have another look? Thanks

[puntope]

Missing to refactor the status, is also int here.

[puntope]

Thx @jorgemd24 approved in advance. However, I miss some doc tweak in one of the revoke_wpcom_api_authorization