Calypsoify: Add deprecations within Calypsoify file

[coder-karen]

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

Proposed changes:

• This PR adds deprecations to function and the Jetpack_Calypsoify class, in the Calypsoify module.

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

https://github.com/Automattic/vulcan/issues/322

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

No.

Testing instructions:

• Proof-read. Make sure deprecations are not happening unnecessarily or by default - when checking this branch out and Calypsoifying a post which you can do by visiting the wp-admin post editor for a post and adding &calypsoify=1 to the end, for example: https://example.com/wp-admin/post.php?post=827&action=edit&calypsoify=1.
• You can also test the deprecations by changing Calypsoify::get_instance(); to Jetpack_Calypsoify::get_instance(); in class-jetpack-calypsoify.php.

[github-actions[bot]]

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/deprecate-calypsoify-functions 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/deprecate-calypsoify-functions
  

  bin/jetpack-downloader test jetpack-mu-wpcom-plugin update/deprecate-calypsoify-functions
  

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[bot]]

Thank you for your PR!

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

• :white_check_mark: Include a description of your PR changes.
  
• :white_check_mark: Add a "[Status]" label (In Progress, Needs Team Review, ...).
  
• :white_check_mark: Add testing instructions.
  
• :white_check_mark: Specify whether this PR includes any changes to data or privacy.
  
• :white_check_mark: 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 :robot:

---

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 July 2, 2024 (scheduled code freeze on June 24, 2024).

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

[coder-karen]

would it make sense to have any public and protected methods call through to Automattic\Jetpack\Calypsoify\Jetpack_Calypsoify?

It would, thank you! I've edited each relevant function. Edit to add - looks like more work needed here now as phan tests are failing.

(private methods can be safely deleted since they're private)

Got it, I've deleted these now.

You could handle the public is_calypsoify_enabled property via __get and __set magic methods if you want too.

Would this be in reference to the setup function? If I call through to the package version of this function it doesn't seem I'd need to use the magic methods in place of $this->is_calypsoify_enabled, but just want to make sure I understand what you're suggesting.

[coder-karen]

Thanks @anomiex !

I've also updated the testing instructions so that should include both testing the class instance, and testing individual functions where possible.