Add function for setting max query execution time to core

[eileenmcnaughton]

Overview

Add function for setting max query execution time to core

Before

@twomice has figured out how to leverage mysql / mariaDB max execution variable in an extension but it is not available to core / other extensions

https://github.com/JoineryHQ/com.joineryhq.dupmon/blob/master/CRM/Dupmon/Util.php#L126-L131

After

New Core functions
CRM_Core_DAO::getMaxExecutionTime()
CRM_Core_DAO::setMaxExecutionTime()

With recommended usage being

$autoClean = CRM_Utils_AutoClean::swapMaxExecutionTime(800);
$autoClean->cleanup();

Technical Details

We don't know if there are any non-handled edge cases - hopefully tests can try a few sql versions....

However, this currently has no core callers outside of the unit test so we can add it cautiously.

I propose we follow up by adding a core caller in hook_civicrm_findExistingDuplicates() - this core code currently has no users as it is only called when the new hidden, installed on upgrade and new installs legacydedupefinder extension is enabled. This is allowing is to roll out less tested but more performant dedupe methodology.

We would need to determine a core setting to replace the one in https://github.com/JoineryHQ/com.joineryhq.dupmon/blob/master/CRM/Dupmon/Util.php#L194C6-L194C27 and possibly think about managing the migration with @twomice - either a version check or cutting a new extension release for 6.1 would do it

Comments

[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]

Ooh, neat idea.

[twomice]

I've unsubscribed, but please ping me again if you think I can help.

[twomice]

Cool doings, though, @eileenmcnaughton !

[demeritcowboy]

I tried this out (mariadb). It seems to work (DB Error thrown when query exceeds the time limit). One thing that my read of the docblock was off and I struggled for a bit trying to figure out that you have to assign the autoclean to a variable. Maybe the order of the wording in the docblock, e.g. change

   * avoids the situation where someone changes the above line to
   * the self-reverting (because `__destruct` is implicitly called)
   * `CRM_Utils_AutoClean::swapMaxExecutionTime(800);`

to something like

   * avoids the situation where someone just calls
   * `CRM_Utils_AutoClean::swapMaxExecutionTime(800);`
   * without assigning it to a variable (because `__destruct` is implicitly called)

[demeritcowboy]

Does this need percent signs? Similarly line 280.

[eileenmcnaughton]

@demeritcowboy I thought that - I took it from @twomice - Allan can you confirm?