Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Calypsoify: Removing Calypsoify files and references from the Jetpack plugin #38259

Merged
merged 2 commits into from
Jul 10, 2024

Conversation

coder-karen
Copy link
Contributor

@coder-karen coder-karen commented Jul 9, 2024

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

Proposed changes:

  • This PR completes the project to remove Calypsoify from Jetpack (and move it to the Jetpack Mu WPcom plugin for WoA sites), by removing the Jetpack plugin module files, as well as any references to those files from within the Jetpack plugin. It also ensures we are not requiring the Calypsoify package in Jetpack as well.
  • The deprecations were included in 13.6, so the intention is that this will be removed from Jetpack in 13.7.

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/324

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

No.

Testing instructions:

For WoA sites in particular we want to confirm that Calypsoify continues to work as before.

WoA:

  • To test using the Beta Tester plugin on a WoA site, apply this PR to the Jetpack plugin.
  • Visit the wp-admin post editor for a post (not using the Classic Editor), and add the calypsoify=1 param to the URL. Example: https://example.com/wp-admin/post.php?post=827&action=edit&calypsoify=1.
  • Confirm the Calypso stylesheet / scripts are loaded when the query param is added by checking the page source (see calypsoify_wpadminmods_js-css and calypsoify_wpadminmods_js-js-extra).
  • Click on the 'options' menu, confirm that you see no option to toggle Fullscreen mode off.
  • Go back to the post and remove the &calypsoify=1 from the URL, and refresh. Click on the 'options' menu, and you should see the option to toggle off Fullscreen mode. Click this, and refresh the page to confirm the change sticks.
  • Then, Calypsoify the URL and refresh the page again - the editor should now be full-screen, and the option to toggle off full-screen gone from the options menu.
  • Open up a revision for the post, and Calypsoify the URL ( for example /wp-admin/revision.php?revision=122&calypsoify=1). The revision page should now be full-screen (vs. not without Calypsoification).

Simple:

  • The changes here should not affect Simple sites as these sites load Calypsoify from admin-plugins/calypsoify.php.

Self-hosted:

  • We want to confirm that Calypsoify is no longer loaded for self-hosted sites, so none of the testing steps above should work on self-hosted (with no errors showing either). If testing locally, make sure to build jetpack with jetpack build plugins/jetpack, choosing the option to build all dependencies. If using the Beta Tester plugin, the branch only needs to be applied for the Jetpack plugin.
Copy link
Contributor

github-actions bot commented Jul 9, 2024

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 remove/calypoify-module-code branch.

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

    bin/jetpack-downloader test jetpack remove/calypoify-module-code
    

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 github-actions bot added [Feature] Calypsoify [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ Docs labels Jul 9, 2024
Copy link
Contributor

github-actions bot commented Jul 9, 2024

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.

@coder-karen coder-karen marked this pull request as ready for review July 9, 2024 15:25
@coder-karen coder-karen added [Status] Needs Review To request a review from Crew. Label will be renamed soon. and removed [Status] In Progress labels Jul 9, 2024
@coder-karen coder-karen requested a review from a team July 9, 2024 15:41
Copy link
Contributor

@darssen darssen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for taking care of this @coder-karen.

This tests well for me in WoA and self-hosted.

Also a search for the calyspoify token inside the jetpack plugin now only returns changelogs, buildfiles and some occurrences on the deprecated wpcom-block-editor which will be removed soon too.

@coder-karen coder-karen merged commit ac04f2e into trunk Jul 10, 2024
63 of 66 checks passed
@coder-karen coder-karen deleted the remove/calypoify-module-code branch July 10, 2024 10:41
@coder-karen coder-karen removed the [Status] Needs Review To request a review from Crew. Label will be renamed soon. label Jul 10, 2024
@github-actions github-actions bot added this to the jetpack/13.7 milestone Jul 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs [Feature] Calypsoify [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/
2 participants