Site Migration: New setting for tracking the migration flow

[markbiek]

Related to Automattic/wp-calypso#89401

Proposed changes:

As part of the new Site Migration onboarding flow, we need to know if a new site is in the middle of the Site Migration Stepper flow.

This adds in_site_migration_flow to the list of site settings that can be set and retrieved from the /rest/v1.2/sites/:siteId/settings endpoint. We'll be updating Calypso to set this setting to true when the migration flow starts and false when it's done.

Then we'll use the presence of this setting to redirect the user appropriately when they click on the verification email for their account.

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 PR on your sandbox and sandbox the public-api.
• Pick any newly created Simple site and get the site id.
• In the https://developer.wordpress.com/docs/api/console/, do a GET query to /rest/v1.4/site/:siteId/settings.
• Scroll through the settings property of the response until you find in_site_migration_flow (you may have to expand some of the collapsed sections.
• Verify that the value of in_site_migration_flow is false.
  
• At this point, you may want to comment out line 36 of class.wpcom-json-api-site-settings-endpoint.php (which is 'group' => '__do_not_document',) so you can see the endpoint in the API console.
• Refresh the API console and select a POST request.
• Find the /rest/v1.4/site/:siteId/settings endpoint and set in_site_migration_flow to 1 in the body.

* Make the `POST` request and verify there are no errors. * Then make another `GET` request and verify that `in_site_migration_flow` is now true.

[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 89401-update/in-site-migration-setting branch.

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

  bin/jetpack-downloader test jetpack 89401-update/in-site-migration-setting
  

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 May 7, 2024 (scheduled code freeze on May 6, 2024).

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

[andres-blanco]

This works as expected. Left a note, but is not a blocker.

[andres-blanco]

Thanks for applying the changes! This LGTM