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.

Sign up for GitHub

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

Jump to bottom

Jetpack: check for other plugins before uninstall cleanup. #33920

Merged
merged 8 commits into from
Nov 3, 2023
Merged

Jetpack: check for other plugins before uninstall cleanup. #33920

merged 8 commits into from
Nov 3, 2023

Conversation

sergeymitr
Copy link
Contributor

@sergeymitr sergeymitr commented Nov 1, 2023 •
edited
Loading

Proposed changes:

  • Introduce new Manager::is_ready_for_cleanup() method in Connection package to check if a plugin should perform the cleanup, or there are other plugins using connection.
  • Make use of that new method on Jetpack uninstall to keep connection intact for other plugins when needed.

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

p1698683954801629-slack-CBG1CP4EN

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

No.

Testing instructions:

Testing is tricky because we can't use Jetpack Beta for uninstall testing.
I suggest using JN.
You can use release versions of Jetpack and Jetpack Backup, but you'll need to run these commands to overwrite the changed files.

Jetpack (from the site's root directory):

curl https://raw.githubusercontent.com/Automattic/jetpack/update/jetpack-no-disconnect-on-uninstall/projects/packages/connection/src/class-manager.php > wp-content/plugins/jetpack/jetpack_vendor/automattic/jetpack-connection/src/class-manager.php
curl https://raw.githubusercontent.com/Automattic/jetpack/update/jetpack-no-disconnect-on-uninstall/projects/plugins/jetpack/uninstall.php > wp-content/plugins/jetpack/uninstall.php

Jetpack Backup:

curl https://raw.githubusercontent.com/Automattic/jetpack/update/jetpack-no-disconnect-on-uninstall/projects/packages/connection/src/class-manager.php > wp-content/plugins/jetpack-backup/jetpack_vendor/automattic/jetpack-connection/src/class-manager.php
  1. Install and connect Jetpack, overwrite the files (see above).
  2. Install a standalone plugin (e.g. Jetpack VaultPress Backup), purchase a plan. Overwrite the class-manager.php (see above).
  3. Go to "Plugins", deactivate and uninstall Jetpack.
  4. Confirm VaultPress Backup is still connected.
  5. Deactivate VaultPress Backup, reinstall and reconnect Jetpack. Overwrite the files (see above).
  6. Go to "Plugins" and deactivate and uninstall Jetpack.
  7. Confirm the options were cleaned up (you can use wp option get jetpack_options).

@sergeymitr sergeymitr added this to the jetpack/12.8 milestone Nov 1, 2023
@sergeymitr sergeymitr self-assigned this Nov 1, 2023
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 1, 2023 •
edited
Loading

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/jetpack-no-disconnect-on-uninstall branch.

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

    bin/jetpack-downloader test jetpack update/jetpack-no-disconnect-on-uninstall

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 [Package] Connection [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ labels Nov 1, 2023
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 1, 2023 •
edited
Loading

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 December 5, 2023 (scheduled code freeze on November 28, 2023).

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

Backup plugin:

  • Next scheduled release: December 5, 2023.
  • Scheduled code freeze: November 27, 2023.

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

Boost plugin:

  • Next scheduled release: December 5, 2023.
  • Scheduled code freeze: November 27, 2023.

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

Search plugin:

  • Next scheduled release: December 5, 2023.
  • Scheduled code freeze: November 27, 2023.

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

Social plugin:

  • Next scheduled release: December 5, 2023.
  • Scheduled code freeze: November 27, 2023.

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

Starter Plugin plugin:

  • Next scheduled release: December 5, 2023.
  • Scheduled code freeze: November 27, 2023.

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

Protect plugin:

  • Next scheduled release: December 5, 2023.
  • Scheduled code freeze: November 27, 2023.

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

Videopress plugin:

  • Next scheduled release: December 5, 2023.
  • Scheduled code freeze: November 27, 2023.

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

Migration plugin:

  • Next scheduled release: December 5, 2023.
  • Scheduled code freeze: November 27, 2023.

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

Inspect plugin:

  • Next scheduled release: December 5, 2023.
  • Scheduled code freeze: November 27, 2023.

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

@github-actions github-actions bot added [Plugin] Backup A plugin that allows users to save every change and get back online quickly with one-click restores. [Plugin] Boost A feature to speed up the site and improve performance. [Plugin] Inspect [Plugin] Migration [Plugin] Protect A plugin with features to protect a site: brute force protection, security scanning, and a WAF. [Plugin] Search A plugin to add an instant search modal to your site to help visitors find content faster. [Plugin] Social Issues about the Jetpack Social plugin [Plugin] Starter Plugin [Plugin] VideoPress A standalone plugin to add high-quality VideoPress videos to your site. labels Nov 1, 2023
@sergeymitr sergeymitr added [Status] Needs Review To request a review from Crew. Label will be renamed soon. and removed [Status] In Progress labels Nov 3, 2023
@sergeymitr sergeymitr modified the milestones: jetpack/12.8, jetpack/12.9 Nov 3, 2023
chrisbliss18
chrisbliss18 approved these changes Nov 3, 2023
View reviewed changes
Copy link
Contributor

@chrisbliss18 chrisbliss18 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 the comprehensive testing instructions. I ran through them a couple of times, and everything worked as described each time. I also ran the wp option get jetpack_options check before expected cleanup to confirm that the data was present, and the data was present before expected cleanup and gone after.

Looking at the code, the changes are well laid out and make sense. Good work! :)

@sergeymitr sergeymitr merged commit 670652d into trunk Nov 3, 2023
67 of 68 checks passed
@sergeymitr sergeymitr deleted the update/jetpack-no-disconnect-on-uninstall branch November 3, 2023 18:38
@github-actions github-actions bot removed the [Status] Needs Review To request a review from Crew. Label will be renamed soon. label Nov 3, 2023
@jeherve jeherve mentioned this pull request Nov 21, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@chrisbliss18 chrisbliss18 chrisbliss18 approved these changes

Assignees

@sergeymitr sergeymitr

Labels
[Package] Connection [Plugin] Backup A plugin that allows users to save every change and get back online quickly with one-click restores. [Plugin] Boost A feature to speed up the site and improve performance. [Plugin] Inspect [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Plugin] Migration [Plugin] Protect A plugin with features to protect a site: brute force protection, security scanning, and a WAF. [Plugin] Search A plugin to add an instant search modal to your site to help visitors find content faster. [Plugin] Social Issues about the Jetpack Social plugin [Plugin] Starter Plugin [Plugin] VideoPress A standalone plugin to add high-quality VideoPress videos to your site. [Tests] Includes Tests
Projects
None yet
Milestone
jetpack/12.9
Development

Successfully merging this pull request may close these issues.
2 participants
@sergeymitr @chrisbliss18