Don't clear sessions when clearing cache

[MegaphoneJon]

Overview

Clearing cache shouldn't break donations in progress, but it does.

Before

See above.

After

Nope

Comments

Original patch from @mlutfy with modifications to clear most, but not all, of civicrm_cache.

[civibot]

🤖 Thank you for contributing to CiviCRM! ❤️ We will need to test and review this 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...

• ➡️ PR Demo site (can be rebuilt with the command test this please).
• 📖 Review standards
• 🗒️ Review template (brief or verbose)

➡️ Online demo of this PR 🔗

[totten]

In this context, it receives the param $sessionReset. Notwithstanding the method-signature here, the actual/typical default should FALSE. (For purposes of cv flush, System.flush, civicrm/menu/rebuild, etc -- they all call via rebuildMenuAndCaches(...$sessionReset=FALSE)). It seems better to abide that flag, no?

[mlutfy]

if we change the param $sessionReset = FALSE by default, then add an "if" around Civi::cache('session')->clear(), then yes, it works as intended I think.

Tested with:

• cv flush
• "flush cache" from the admin UI
• cv api system.flush session=1 => will flush the QF cache (sessionReset=true)

[agileware-justin]

Thanks @MegaphoneJon 👏🏻

[mattwire]

At the Montreal sprint @MegaphoneJon and I agreed that we should get this into core. Quite a few of us have been running versions of this on client sites for quite a long time.

[mlutfy]

This would be great. Thank you for pushing this forward.

I did a bit more testing based on Tim's comment, and I think it would be sensible to:

• default sessionReset = FALSE in the function params
• add an "if" around the session flush line, instead of removing it

We can also strip most the comments out of the patch (ex: "ML SYMBIOTIC").

[mlutfy]

I took the liberty of applying the changes to the patch.

[mattwire]

Thanks @bgm. @MegaphoneJon what do you think of the updates?

[MegaphoneJon]

LGTM