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

Api4 - Use global cache for entityFields #32210

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

colemanw
Copy link
Member

Overview

Api4 performance improvement: fewer calls to getFields, more caching.
Fixes dev/core#5757

Technical Details

Instead of caching entityFields once per instance, cache once per entity/action.

Copy link

civibot bot commented Feb 25, 2025

🤖 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 25, 2025
// Also reset $_entityFields
$entityFieldsProperty = $reflection->getProperty('_entityFields');
$entityFieldsProperty->setAccessible(TRUE);
$entityFieldsProperty->setValue($apiRequest, NULL);
Copy link
Member Author

Choose a reason for hiding this comment

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

With the changes to entityFields caching being moved out of the class itself, this is no longer necessary. The above lines changing _entityName will have the same effect since entityFields now keys its cache off of that.

@MegaphoneJon
Copy link
Contributor

Hi @colemanw - this is a tremendous boost in both speed and RAM savings. This call used to consume 190MB, now it consumes 1.6MB. It used to take 36.4 seconds while sending 1000 emails, now it takes 0.3 seconds.

Now, having removed that bottleneck, I can see that there's a place where the API3 getfields is used in rendering tokens. I'm going to try to convert that to API4 and see what that gets us.

@seamuslee001
Copy link
Contributor

Some of the test failures seem to be related here @colemanw

Fixes dev/core#5757

Instead of caching entityFields once per instance, cache once per entity/action.
@seamuslee001
Copy link
Contributor

@colemanw I think the test fails relate still

@colemanw
Copy link
Member Author

@seamuslee001 no those same 7 tests are failing for other PRs.

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

Successfully merging this pull request may close these issues.

3 participants