fix(nrh): fixes for ESP contact syncing w/ NRH, newsletter signups

[dkoo]

All Submissions:

• Have you followed the Newspack Contributing guideline?
• Does your code follow the WordPress' coding standards and VIP Go coding standards?
• Have you checked to ensure there aren't other open Pull Requests for the same update/change?

Changes proposed in this Pull Request:

It's possible to enable Reader Activation contact syncing while also using NRH instead of WooCommerce as a reader revenue platform, but this is currently broken.

Handles ESP contact syncing when using NRH as a reader revenue platform, and/or WooCommerce Subscriptions is not available. WooCommerce itself is still a soft requirement for ESP syncing when using NRH, as we rely on its WC_Customer class for fetching basic user meta fields.

Also fixes two scenarios where some contact metadata is lost before getting synced:

• Upon registering/subscribing to newsletters via the Registration and Newsletter Subscription newspack_newsletters_contact_subscribed action triggers a newsletter_subscribed data event that contains the full contact metadata in the payload, but while the handler for this data event triggers a contact sync, it doesn't include the full metadata in the sync. This PR fixes the issue by including all metadata in the sync.
• When queued data events include certain metadata that's not included in subsequent events in the queue, that metadata is lost. This PR fixes the issue by merging contact metadata from all queued data events before syncing them.

Closes 1200550061930446/1209469667970736.

How to test the changes in this Pull Request:

Testing synced metadata when registering via signup blocks

1. With Reader Activation syncing active with all contact fields enabled and connected to an ESP, enable the Newspack reader revenue platform.
2. In new reader sessions, sign up for newsletters via the Registration and Newsletter Subscription Form blocks.
3. On release, observe that some contact metadata fields are not synced to the ESP (NP_Registration Page, any Signup UTM fields).
4. Check out this branch and repeat, and confirm that all registration-related fields are synced.

Testing contact syncing with NRH

1. On a site with Reader Activation syncing active and connected to an ESP, set your reader revenue platform to NRH and deactivate the WooCommerce Subscriptions plugin.
2. On release, as a reader, sign up for newsletters via the Newsletter Subscription Form and Reader Registration blocks on a page that contains UTM parameters in the URL (e.g. ?utm_medium=test&utm_campaign=NRH&utm_content=NRH%20content. Observe that the contact sync to the connected ESP is logged, but without most of the RAS contact metadata fields. Also observe a fatal error in PHP: Fatal error: Uncaught Error: Call to undefined function wcs_get_users_subscriptions()
3. Check out this branch and fix(subscribe): optionally include metadata on subscribe newspack-newsletters#1763. As an admin, navigate to Newspack > Reader Activation > Advanced Settings > Metadata field settings. Confirm that only basic metadata fields are available (as payment fields assume that the reader revenue platform is WooCommerce):

7. Repeat signing up for newsletters with UTM params as in step 2, but this time confirm that all metadata fields are synced to the ESP without the fatal error.
8. Follow testing instructions for fix: dont send metadata on subscribe newspack-newsletters#1648 and ensure that GA4 data is unaffected.

Other information:

• Have you added an explanation of what your changes do and why you'd like us to include them?
• Have you written new tests for your changes, as applicable?
• Have you successfully ran tests with your changes locally?

---

• To see the specific tasks where the Asana app for GitHub is being used, see below:
  • https://app.asana.com/0/0/1209571170057170

[adekbadek]

Works accordingly to the testing instructions, but there's an ongoing discussion on the other PR (Automattic/newspack-newsletters#1763 (review)), which should be resolved before this is merged.

[dkoo]

@adekbadek @miguelpeixe @leogermani following up from a comment in the other PR, which is no longer needed after 6b571e9. I updated the PR description here to explain what was happening and how this PR fixes it.

[leogermani]

Not sure if there's something wrong on my end, but I was not able to confirm most of the things in the testing instructions.

= Testing synced metadata when registering via signup blocks =

Both on release and on this branch, I never see "Registration Page" going through. "Registration Method" is always there, on both branches

= Testing contact syncing with NRH =

I see the Fatal error going away and the actual sync happening. Also see the shortened list of fields on the admin. But I don't see neither "Registration Page" or the UTM params going through.... :/

Maybe we can debug it together

[dkoo]

@leogermani looks like there was an unrelated bug preventing Signup UTM fields from being set. Fixed in 826df46. Also, Registration Method was not affected by any of these bugs. Removed that from testing instructions

I never see "Registration Page" going through

That doesn't match what I see...on this branch, I do see "Registration Page", but not on release or trunk. Are you sure the field is enabled in sync settings?