jetpack icon indicating copy to clipboard operation
jetpack copied to clipboard

Add mechanism to track previously working plugins

Open CodeyGuyDylan opened this issue 1 year ago • 2 comments

Proposed changes:

  • Adding a frequently updated array that tracks what plugins were active before user or site disconnection

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

P2: pbNhbs-aGl-p2#comment-22247 PT: pbNhbs-akp-p2

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

No, I don't think we'll need to be adding any tracks for this

Testing instructions:

  1. Checkout this branch via the Jetpack Beta plugin or your local dev environment (If you want to do extensive testing, you'll probably want to set up your local dev environment and log the results of $historically_active_modules here in this function so you can see when it is being updated more clearly)
  2. Connect your site and user account to the site
  3. Make sure you do not have the Social sharing features active and the social plugin is not installed image
  4. Go to My Jetpack, and in the console, log out myJetpackInitialState.lifeCycleStats.historicallyActiveModules. If you have not activated anything manually, the array should only be [ 'creator', 'extras', 'stats' ] as they are activated by a user connection only
  5. Select Activate on the Social card and reload the page (the backend is updated in realtime, the frontend is not, so you'll need the page refresh)
  6. Log out the historicallyActiveModules again and you should see that social has been added to the array image (Note: AI had been active on my site when I was making these testing instructions, ignore that one)
  7. Now disconnect your site and user account
  8. Check historicallyActiveModules again and you should still see Social in the list even though it is now not working because of the connection issue
  9. Now reconnect at least your user connection and go to /admin.php?page=jetpack#/sharing and disable the social modules
  10. Go back to My Jetpack and check the historicallyActiveModules variable and it should now have "social" removed since it was disabled manually image

For extra testing you can follow the scenario where

  1. You disable the social module while you are user connected
  2. Disconnect your user account
  3. Go to My Jetpack to make sure Social is still removed from the array as it should be

Also feel free to try any scenarios you can think of so that this array is accurate when it needs to be

CodeyGuyDylan avatar May 24 '24 17:05 CodeyGuyDylan

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/mechanism-to-track-previously-working-plugins 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 add/mechanism-to-track-previously-working-plugins
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin add/mechanism-to-track-previously-working-plugins
    

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] avatar May 24 '24 17:05 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.

github-actions[bot] avatar May 24 '24 17:05 github-actions[bot]