Sync: Add links when expanding posts at a later stage

[darssen]

Fixes https://github.com/Automattic/vulcan/issues/297

Proposed changes:

When syncing posts, we used to expand them via the filter_post_content_and_add_links. This was originally done before sending, but after dedicated sync was created, we decided to move it to before enqueuing the actions.

Since sometimes the links like permalink are not available. The approach here is to separate the filtering part from the adding links.

The expectation is that adding the links before we send the action, as we used to do will allow us to fetch the proper links.

The possible problem here is that with Dedicated Sync enabled, we would be fetching those fields on init because this is when we spawn the next dedicated sync request.

Other information:

• Have you written new tests for your changes, if applicable?
• Have you checked the E2E test CI results, and verified that your changes do not break them?
• Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Does this pull request change what data or activity we track or use?

No

Testing instructions:

The initial idea here is to test that we are still properly populating the links.

In a connected Jetpack site with this patch.

• Create a post and publish it.
• Check that the sync action jetpack_sync_save_post The second one, when the post is published, has the proper permalink.
• Update the post.
• Check that the permalink is still showing in the action.

Now test with a plugin that will change the permalink like Yoast SEO.

• Create a post and publish it.
• Check that the sync action jetpack_sync_save_post
• Update the post, but this time by updating Yoast SEO slug parameter which will change the permalink.
• Check that the permalink in the jetpack_sync_save_post has changed.

Bonus points if tested with WPML plugin as described in the links inside the issue

[github-actions]

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

• To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin, and enable the update/sync-add-links-when-expanding-posts-in-before-send branch.

  • For jetpack-mu-wpcom changes, also add define( 'JETPACK_MU_WPCOM_LOAD_VIA_BETA_PLUGIN', true ); to your wp-config.php file.

• To test on Simple, run the following command on your sandbox:

  bin/jetpack-downloader test jetpack update/sync-add-links-when-expanding-posts-in-before-send
  

  bin/jetpack-downloader test jetpack-mu-wpcom-plugin update/sync-add-links-when-expanding-posts-in-before-send
  

Interested in more tips and information?

• In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
• Read more about our development workflow here: PCYsg-eg0-p2
• Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

[github-actions]

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

• ✅ Include a description of your PR changes.
  
• 🔴 Add a "[Status]" label (In Progress, Needs Team Review, ...).
  
• ✅ Add testing instructions.
  
• ✅ Specify whether this PR includes any changes to data or privacy.
  
• ✅ Add changelog entries to affected projects
  

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

---

The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.

---

Once your PR is ready for review, check one last time that all required checks appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team Review" label and ask someone from your team review the code. Once reviewed, it can then be merged.
If you need an extra review from someone familiar with the codebase, you can update the labels from "[Status] Needs Team Review" to "[Status] Needs Review", and in that case Jetpack Approvers will do a final review of your PR.

---

Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

• WordPress.com Simple releases happen daily.
• WoA releases happen weekly.
• Releases to self-hosted sites happen monthly. The next release is scheduled for August 6, 2024 (scheduled code freeze on August 5, 2024).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

[fgiannar]

I know this is still in progress however I left some related thoughts in D152661-code.

Mostly concerns around removing a public method instead of deprecating and the performance cost of running array_map twice in expand_posts

[fgiannar]

Testing with WPML and consistently getting wrong permalinks unfortunately. Not sure if this is worth pursuing if we are not able to get the right permalinks with the WPML plugin since it's one of the main reasons we are making this change..

[darssen]

Testing with WPML and consistently getting wrong permalinks unfortunately. Not sure if this is worth pursuing if we are not able to get the right permalinks with the WPML plugin since it's one of the main reasons we are making this change..

Does the fix in https://github.com/Automattic/jpop-issues/issues/8721 get the proper permalinks?

[fgiannar]

Does the fix in Automattic/jpop-issues#8721 get the proper permalinks?

It doesn't for me, I tested that too.. I was testing with the latest WPML version on trunk and adding the suggested filters via Code Snippets

[darssen]

Closing this since it doesn't make sense to go with this approach if the JPOP issue https://github.com/Automattic/jpop-issues/issues/8721 does not get solved