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

[REF] Faster pseudoconstant name lookups #32261

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

Conversation

MegaphoneJon
Copy link
Contributor

Overview

Profiling shows that we spend an inordinate amount of time converting pseudoconstant IDs into names. This is a performance fix.

Before

Slow.

After

Fast.

Comments

A few things going on here:

  • This function is called a LOT, so even small differences will be magnified.
  • We're calling the expensive function once, not once per value (in multivalued fields).
  • There's a comment that says that CRM_Core_PseudoConstant::getlabel() is a cached function - but that's not necessarily true in places where the BAO overrides buildOptions().
  • buildOptions is deprecated, so we remove calls to it.

Copy link

civibot bot commented Feb 28, 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 28, 2025
@colemanw
Copy link
Member

It's true that CRM_Core_DAO::buildOptions is annotated as @deprecated, but there are a couple slight differences which maybe we don't want to deal with in this legacy search function. One of them is handling for non-core fields added via fields_callback, which we've re-added support for:

civicrm-core/CRM/Core/DAO.php

Lines 2943 to 2946 in 8f164fe

// Legacy handling for hook-based fields from `fields_callback`
if (!$entity->getField($fieldName)) {
return CRM_Core_PseudoConstant::get(static::class, $legacyFieldName, [], $context);
}

@MegaphoneJon MegaphoneJon force-pushed the faster-pseudoconstant-names branch from c216461 to 9c072fc Compare February 28, 2025 22:33
@MegaphoneJon MegaphoneJon force-pushed the faster-pseudoconstant-names branch from 9c072fc to 0eb6a2a Compare February 28, 2025 22:36
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.

2 participants