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

Connection: work around a WP user caching bug #40188

Merged
merged 4 commits into from
Nov 15, 2024

Conversation

sergeymitr
Copy link
Contributor

Proposed changes:

WP bug #62003 leads to inconsistent format of cached user data in certain circumstances.
It happens if only one field gets fetched from the database, so we add ID to work around the issue.

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://core.trac.wordpress.org/ticket/62003
p1731513241019199-slack-C05PV073SG3
p1725570377885549-slack-C7YPW6K40

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

No.

Testing instructions:

First try to reproduce the issue on trunk.

  1. Install and activate an object cache plugin (e.g. Docket Cache).
  2. Add this code snipped to your site:
add_action( 'plugins_loaded', function() {
	get_users( array( 'role' => 'administrator', 'orderby' => 'user_registered', 'fields'  => 'user_registered', 'number'  => 1 ) );
} );
  1. Connect Jetpack in site-only mode.
  2. Load Jetpack Dashboard.
  3. Clean the cache and remove the transient:
wp cache flush
wp transient delete jetpack_assumed_site_creation_date
  1. Reload Jetpack Dashboard and confirm you see the PHP warning in your debug.log:
PHP Warning:  Attempt to read property "user_registered" on string in ...
  1. Clean the cache and remove the transient (step 5).
  2. Checkout the branch, reload Jetpack Dashboard. Confirm you no longer see the warning.

@sergeymitr sergeymitr added [Type] Bug When a feature is broken and / or not performing as intended [Status] In Progress labels Nov 14, 2024
@sergeymitr sergeymitr added this to the Jetpack 14.1 milestone Nov 14, 2024
@sergeymitr sergeymitr self-assigned this Nov 14, 2024
Copy link
Contributor

github-actions bot commented Nov 14, 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 fix/connection-dotorg-user-cache-bug 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 fix/connection-dotorg-user-cache-bug
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin fix/connection-dotorg-user-cache-bug
    

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

Copy link
Contributor

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.


Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

@sergeymitr sergeymitr requested a review from a team November 14, 2024 17:38
@sergeymitr sergeymitr added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. and removed [Status] In Progress labels Nov 14, 2024
coder-karen
coder-karen previously approved these changes Nov 15, 2024
Copy link
Contributor

@coder-karen coder-karen left a comment

Choose a reason for hiding this comment

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

This tests well, thanks!

As an aside I'm curious - is the goal with this PR just to create a temporary workaround until and if the core bug gets fixed? Should we add a @todo or similar in order to have a reminder to come back to this in the future?

@sergeymitr
Copy link
Contributor Author

Thanks @coder-karen!
The code will probably be there for quite a while to support older WP versions.
Good point about the @todo tag, I'll add that.

@sergeymitr sergeymitr merged commit cd03f86 into trunk Nov 15, 2024
72 checks passed
@sergeymitr sergeymitr deleted the fix/connection-dotorg-user-cache-bug branch November 15, 2024 15:54
@github-actions github-actions bot removed the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label Nov 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package] Connection [Tests] Includes Tests [Type] Bug When a feature is broken and / or not performing as intended
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants