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

Optimize term count update during post status transition #6793

Open
wants to merge 8 commits into
base: trunk
Choose a base branch
from

Conversation

pbearne
Copy link

@pbearne pbearne commented Jun 12, 2024

The modification ensures that term counts are only updated when the post's status has truly changed. This reduces unnecessary operations, improving performance when there is no status change on a post.

Trac ticket: https://core.trac.wordpress.org/ticket/42522

The modification ensures that term counts are only updated when the post's status has truly changed. This reduces unnecessary operations, improving performance when there is no status change on a post.
Copy link

github-actions bot commented Jun 12, 2024

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Unlinked Accounts

The following contributors have not linked their GitHub and WordPress.org accounts: @paul.

Contributors, please read how to link your accounts to ensure your work is properly credited in WordPress releases.

Core Committers: Use this line as a base for the props when committing in SVN:

Props pbearne, peterwilsoncc.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

Copy link

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

  • The Plugin and Theme Directories cannot be accessed within Playground.
  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

Copy link
Contributor

@peterwilsoncc peterwilsoncc left a comment

Choose a reason for hiding this comment

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

This change makes sense.

My one concern is for custom taxonomies using the update_count_callback feature. Although I can not see how that would be a problem unless they're using the count column for a non-standard purpose.

Are you able to add some tests to ensure:

  • Updating a post without changing the status doesn't attempt to update the count
    • I think checking the action edited_term_taxonomy does not fire will be suitable
    • Check that the count before and after is the same
  • Updating a post to change the post status does update the count
    • increases by one when published
    • decreases by one when unpublished
  • Modifying the terms without changing the post status triggers a recount/count is as expected
  • anything else you think I've missed.

The commit adds various PHPUnit tests for the "_update_term_count_on_transition_post_status" function. The tests cover multiple scenarios including updates in term count when a post is published, moved to the trash, restored, permanently deleted, or removed from a term.
Copy link
Contributor

@peterwilsoncc peterwilsoncc left a comment

Choose a reason for hiding this comment

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

Thanks Paul, I've added a couple of suggestions fo the tests to avoid repeating work unnecessarily

pbearne and others added 5 commits June 17, 2024 14:27
The commit substitutes instance variables for static ones in tests related to post status transitions. This refactor improves consistency in referencing these values and optimizes performance by invoking these values directly instead of through instance references.
Copy link
Contributor

@peterwilsoncc peterwilsoncc left a comment

Choose a reason for hiding this comment

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

I can't figure out why the unrelated tests have started failing.

For the most part they look to be arrays returning in a different order but I can't see how this change would affect that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants