feat(content-distribution): migrator

[miguelpeixe]

Implements a migration tool so sites using Distributor can move to our content distribution functionality for posts being distributed within the network.

The migration is done via CLI:

NAME

  wp newspack network distributor migrate

DESCRIPTION

  Migrate posts from Distributor to Newspack Network's content distribution

SYNOPSIS

  wp newspack network distributor migrate [<post-id>] [--batch-size=<batch-size>]
  [--all] [--strict] [--delete]

OPTIONS

  [<post-id>]
    The ID of the post to migrate.

  [--batch-size=<batch-size>]
    Number of posts to migrate in each batch.
    ---
    default: 50
    ---

  [--all]
    Migrate all posts.

  [--strict]
    Whether to only migrate if all distributed posts can be migrated.

  [--delete]
    Whether to deactivate and delete the Distributor plugin after migrating all
    posts. This will only take effect if all posts were able to migrate.

The tool migrates Distributor's subscriptions, using its metadata to create an outgoing post. A data event is dispatched to migrate the incoming posts so this is handled asynchronously. Because of that, it runs in batches of 50.

Testing

1. In your network setup, make sure you have Distributor configured to all sites in the network
2. Create a new site, outside the network, and add it to your Distributor connections in order to test an attempt to migrate content distributed to a site outside the network
3. Publish posts with the following Distributor distribution:
   1. to 1 site within the network
   2. to 1 site outside the network
   3. to 2 sites within the network
   4. to all sites (within and outside the network)
4. Run the CLI to migrate the first post:

wp newspack network distributor migrate {post_id}

5. Visit the post origin and confirm the 🌐 panel reflects the correct setup
6. Confirm the post no longer has "Distributor" settings
7. Make a change and save
8. Make sure the network events are synced in all nodes: wp newspack-network sync-all
9. Confirm the change is distributed via the network's content distribution
10. Run the CLI to migrate all posts in strict mode:

wp newspack network distributor migrate --all --strict

11. Confirm no posts were migrated
12. Run the CLI to migrate all posts:

wp newspack network distributor migrate --all

13. Confirm that the posts with distribution outside the network were not migrated
14. For the posts that were able to migrate, repeat steps 5-8 for each post
15. Delete the posts that are being distributed outside the network and publish a new post distributed, via Distributor, within the network
16. Run the CLI again, but now flagging the plugin deletion:

wp newspack network distributor migrate --all --delete

17. Confirm the plugin has been deleted after the migration

[naxoc]

Found a couple of smaller things in code – will do a test next, but m not sure I entirely get step 3.

Are these assumptions correct?

Let's say I have hub.test, node1.test, node2.test, node3.test.
hub, node1, and node2 are networked (content distribution enabled). node3 is not. All sites have distributor enabled and are networked.

• to 1 site within the network - so post on hub and distribute to node1?
• to 1 site outside the network - so post on hub and distribute to node3?
• to 2 sites within the network - so post on hub and distribute to node1 and node2?
• to all sites (within and outside the network) - so post on hub and distribute to node1, node2, and node3? (I guess this one is not so hard to understand).

Am I right about the above?

[miguelpeixe]

Thanks for the review, @naxoc!

Am I right about the above?

Yes, that's the setup for testing.

A few things were missing to handle the incoming posts migration, which have been implemented in 1d5f4d1 and improved logging was also added in 6f7af2c

[naxoc]

👍 🎉

I ran through the testing scenario and it works like a charm now.

[github-actions]

Hey @miguelpeixe, good job getting this PR merged! 🎉

Now, the needs-changelog label has been added to it.

Please check if this PR needs to be included in the "Upcoming Changes" and "Release Notes" doc. If it doesn't, simply remove the label.

If it does, please add an entry to our shared document, with screenshots and testing instructions if applicable, then remove the label.

Thank you! ❤️

[matticbot]

🎉 This PR is included in version 2.5.0-alpha.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀