White-labeled plugin: Add wpcom-migration key endpoint

[sixhours]

Proposed changes:

• Add a new endpoint to fetch a site's wpcom migration key from the wpcom-migration plugin. This is modeled after the migrate guru plugin endpoint but uses different classes and a more accurate endpoint name.

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)?

Jetpack product discussion

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

Testing instructions:

• Apply this branch to your AT using Jetpack Beta plugin following instructions in White-labeled plugin: Add wpcom-migration key endpoint #39377 (comment)
• Apply D161332-code to your sandbox and sandbox public-api.wordpress.com.
• Apply this branch also on your sandbox by running bin/jetpack-downloader test jetpack-mu-wpcom-plugin add/wpcom-key-endpoint (make sure this PR and D161332-code are running on your sandbox at the same time)
• Visit the developer console and fetch from /wpcom/v2/sites/%your-AT-site%/atomic-migration-status/wpcom-migration-key
• You should see a 403 error
• On the AT site, install and activate the Migrate to WordPress.com plugin (link found in Slack).
• Fetch the endpoint from the developer console; the migration key field should be populated with the same migration key you'll find at /wp-admin/admin.php?page=wpcom-migration
• Try to fetch it again and verify that a 403 error is returned

[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 add/wpcom-key-endpoint 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-mu-wpcom-plugin add/wpcom-key-endpoint
  

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.

---

Follow this PR Review Process:

1. Ensure all required checks appearing at the bottom of this PR are passing.
2. Choose a review path based on your changes:
   • A. Team Review: add the "[Status] Needs Team Review" label
     • For most changes, including minor cross-team impacts.
     • Example: Updating a team-specific component or a small change to a shared library.
   • B. Crew Review: add the "[Status] Needs Review" label
     • For significant changes to core functionality.
     • Example: Major updates to a shared library or complex features.
   • C. Both: Start with Team, then request Crew
     • For complex changes or when you need extra confidence.
     • Example: Refactor affecting multiple systems.
3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

[m1r0]

Fetch the endpoint from the developer console; the migration key field should be populated

Unfortunately, I wasn't able to fetch the migration key. I'm stuck on getting 403. Here's what I did, hopefully someone can spot my mistake:

• Applied the patch and sandboxed public-api.wordpress.com.
• Applied the branch on the sandbox.
• Created a WoA site (using the WoA Developer Blog Manager tool).
• Installed the Jetpack Beta plugin and activated this branch for the jetpack-mu-wpcom-plugin.
• Added the following to the wp-config.php:

define( 'JETPACK_MU_WPCOM_LOAD_VIA_BETA_PLUGIN', true );
define( 'JETPACK__SANDBOX_DOMAIN', '[my-sandbox-domain]' );

• Tested on https://developer.wordpress.com/docs/api/console/

[m1r0]

I've also checked if the wpcom_site_migration_wpcom_migration_key_read option was created in the database, but it wasn't.

[sixhours]

@m1r0 That would be user error on my part. I was using the wrong class name for the new plugin so it failed the permissions check. 🙃 That should be resolved with the above updates. Please give it another spin when you get a chance. Thank you!

[m1r0]

It works now! 🚀