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

ReferenceDynamic - Save lots of irrelevant queries when finding backreferences #29381

Merged
merged 1 commit into from
Mar 1, 2024

Conversation

colemanw
Copy link
Member

Overview

Follows up on 834f598 to fix a long-standing FIXME in the dynamic reference code.

Before

Checking for dynamic backreferences searched every other entity in the database, not just relevant ones, with a fixme about it in the code.

After

Fixme fixed.

Technical Details

When this code was first written most dynamic references had an open-ended entity_table target column which could theoretically join to anything. Over the years we've been adding whitelists to those columns since most of these entities were only intended for a handful of possible targets. So at the time of writing this fixme, there was no reliable way to use a whitelist to limit the scope of reference searches across the database. Now, for most entities, there is.

A few are still missing whitelists so this grandfathers them in with the old behavior. For all the rest, finding references should be faster and make more sense.

…ble references

Before - Checking for dynamic backreferences was not limited to only relevant entities, with a fixme about it in the code.
After - Fixme fixed.
Copy link

civibot bot commented Feb 13, 2024

🤖 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...

➡️ Online demo of this PR 🔗

@civibot civibot bot added the master label Feb 13, 2024
@colemanw colemanw changed the title ReferenceDynamic - Save lots of irrelevant queries when looking up ta… ReferenceDynamic - Save lots of irrelevant queries when finding backreferences Feb 13, 2024
@mattwire mattwire merged commit 8cfd323 into civicrm:master Mar 1, 2024
3 checks passed
@eileenmcnaughton eileenmcnaughton deleted the getRefs branch March 1, 2024 21:19
@eileenmcnaughton
Copy link
Contributor

whoops - looks like this PR is causing test fails - one of the functions it calls got deprecated since the tests passed against it

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

Successfully merging this pull request may close these issues.

3 participants