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

Flush Redis prevnext cache when clearing civicrm_cache #27113

Merged
merged 1 commit into from Aug 28, 2023

Conversation

eileenmcnaughton
Copy link
Contributor

@eileenmcnaughton eileenmcnaughton commented Aug 21, 2023

Overview

Flush Redis prevnext cache when clearing civicrm_cache

Before

There is actually nowhere in CiviCRM where the Redis Prev-next cache is flushed. It is possible to flush using eval - ie

 cv php:eval "\Civi::service('prevnext')->deleteItem();"

but in normal operations it is never flushed

After

It would be flushed in the same instances as the civicrm-cache table is cleared

Technical Details

Once we get Redis to start expiring it won't be so necessary to flush the cache - but it should be possible to flush it 'somehow' via the api/ I'm a bit on the fence between this & something a bit more opt-in.

Comments

@civibot
Copy link

civibot bot commented Aug 21, 2023

Thank you for contributing to CiviCRM! ❤️ We will need to test and review the PR. 👷

Introduction for new contributors
  • If this is your first PR, an admin will greenlight automated testing with the command ok to test or add to whitelist.
  • A series of tests will automatically run. You can see the results at the bottom of this page (if there are any problems, it will include a link to see what went wrong).
  • A demo site will be built where anyone can try out a version of CiviCRM that includes your changes.
  • If this process needs to be repeated, an admin will issue the command test this please to rerun tests and build a new demo site.
  • Before this PR can be merged, it needs to be reviewed. Please keep in mind that reviewers are volunteers, and their response time can vary from a few hours to a few weeks depending on their availability and their knowledge of this particular part of CiviCRM.
  • A great way to speed up this process is to "trade reviews" with someone - find an open PR that you feel able to review, and leave a comment like "I'm reviewing this now, could you please review mine?" (include a link to yours). You don't have to wait for a response to get started (and you don't have to stop at one!) the more you review, the faster this process goes for everyone 😄
  • To ensure that you are credited properly in the final release notes, please add yourself to contributor-key.yml
  • For more information about contributing, see CONTRIBUTING.md.
Quick links for reviewers

@civibot civibot bot added the master label Aug 21, 2023
@eileenmcnaughton eileenmcnaughton changed the title Flush Redis prevnext cache when clearing civicrm_cache Flush Redis prevnext cache when clearing civicrm_cache Aug 21, 2023
@johntwyman
Copy link
Contributor

I'm entirely comfortable with the Redis cache being cleared at the same time.

// Clear the Redis prev-next cache, if there is one.
// Since we truncated the civicrm_cache table it is logical to also remove
// the same from the Redis cache here.
\Civi::service('prevnext')->deleteItem();
Copy link
Member

@totten totten Aug 24, 2023

Choose a reason for hiding this comment

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

I think the comment is correct - clearing civicrm_cache in the normal case implies that you can clear prevnext in the Redis case. It should be said that this isn't really parity between SQL and Redis. For that, it would need something like:

  1. When flushing, delete all Redis keys based on the site-prefix.
  2. Fix the oddball Redis keys which lack site-prefix. (Like, ahem, prevnext...)

(Ok, for completeness, another way to reach parity is to rework the prefixes -- instead of literal site-prefix, map each prefix to redis database id. Then FLUSHDB or SWAPDB become options. But that's not easier.)

Anyway, it certainly sounds more conservative (safer) to just flush the part you care about. And in that approach, I'm quite glad there's a comment to explain the thinking. (These cache-clear functions are a bit of maze, and you often have to scratch your head at each junction of the maze.)

@totten
Copy link
Member

totten commented Aug 24, 2023

I'm a bit on the fence between this & something a bit more opt-in.

I think it's functionally safe to merge. Flagging "Merge ready" (in case you want to mull any further).

@totten totten added the merge ready PR will be merged after a few days if there are no objections label Aug 24, 2023
@seamuslee001
Copy link
Contributor

ok this has been merge ready long enough

@seamuslee001 seamuslee001 merged commit 708cb1a into civicrm:master Aug 28, 2023
3 checks passed
@seamuslee001 seamuslee001 deleted the redis_flush branch August 28, 2023 22:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
master merge ready PR will be merged after a few days if there are no objections
Projects
None yet
4 participants