Add an action to link sessions to customer ids.

[georgestephanis]

I'm unsure if the @since should be populated now, or if that happens when something merges -- I left it as x.x.x for now.

Unsure if this should move above the ::save_data() invocation so it can fire before the migration happens -- but to have less potential for impacts, I'm adding it after the work is done so folks could have a record of what the id changed from and to.

Submission Review Guidelines:

• I have followed the WooCommerce Contributing Guidelines and the WordPress Coding Standards.
• I have checked to ensure there aren't other open Pull Requests for the same update/change.
• I have reviewed my code for security best practices.
• Following the above guidelines will result in quick merges and clear and detailed feedback when appropriate.

Changes proposed in this Pull Request:

Fires an action after a customer has logged in, and their guest session id has been deleted with its data migrated to a customer id.

This hook gives extensions the chance to connect the old session id to the customer id, if the key is being used externally.

Closes #44852

Testing

See #45146 (comment).

[github-actions]

Test Results Summary

Commit SHA: a041f5c

Test 🧪	Passed ✅	Failed 🚨	Broken 🚧	Skipped ⏭️	Unknown ❔	Total 📊	Duration ⏱️
API Tests	259	0	0	2	0	261	0m 37s
E2E Tests	71	0	0	282	0	353	5m 57s

---

To view the full API test report, click here.
To view the full E2E test report, click here.
To view all test reports, visit the WooCommerce Test Reports Dashboard.

[coreymckrill]

@georgestephanis could you add some testing instructions, including perhaps a code snippet that shows how the hook would be used?

[georgestephanis]

Sure.

Testing instructions:

Drop this code into a mu-plugins file:

<?php

add_action( 'woocommerce_guest_session_to_user_id', function( $guest_session_id, $customer_id ) {
	wc_get_logger()->log(
		'info',
		sprintf( 'Guest with Session ID %s has logged in to Customer ID %s.', $guest_session_id, $customer_id ),
		array(
			'source' => 'test-pr-45146'
		)
	);

	// Potentially trigger other db writes or external api calls to any data stores that had been keying off the old session id.
}, 10, 2 );

Open a new incognito window and browse to your shop. Add an item to the cart, and then go to log in.

After you log in, you should be able to view a record of that conversion from Session ID to Customer ID here: /wp-admin/admin.php?page=wc-status&tab=logs

[github-actions]

Hi @coreymckrill,

Apart from reviewing the code changes, please make sure to review the testing instructions as well.

You can follow this guide to find out what good testing instructions should look like:
https://github.com/woocommerce/woocommerce/wiki/Writing-high-quality-testing-instructions

[coreymckrill]

Looks good, thank you for the testing instructions and code snippet!

Unsure if this should move above the ::save_data() invocation so it can fire before the migration happens -- but to have less potential for impacts, I'm adding it after the work is done so folks could have a record of what the id changed from and to.

I think this is a good call. This way it's just a notification of something that happened instead of a place where the normal flow could get interrupted somehow.