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

Optimize Change Log Viewing For A Contact #31125

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

Conversation

shahrukh-compuco
Copy link

Overview

This pr optimizes the code for viewing the change logs for a contact.

Technical Details

Currently during fetching the change log for a contact we also fetch information for modifier contact here once for each row from the log table. This can give timeout errors on big databases as each call to the function getDisplayAndImage results in one query being executed. Even if same modifier changed the one contact multiple times we will have multiple queries for fetching same information for same modifier.

This pr changes the code to store the modifier information in an array and only query the modifier info if its not already available in the array thus results in significantly lesser number of queries for large change logs.

Copy link

civibot bot commented Sep 17, 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 Sep 17, 2024
shahrukh-compuco pushed a commit to compucorp/civicrm-core that referenced this pull request Sep 17, 2024
shahrukh-compuco pushed a commit to compucorp/civicrm-core that referenced this pull request Sep 17, 2024
shahrukh-compuco pushed a commit to compucorp/civicrm-core that referenced this pull request Sep 17, 2024
shahrukh-compuco pushed a commit to compucorp/civicrm-core that referenced this pull request Sep 17, 2024
$logEntries[] = [
'id' => $log->modified_id,
'name' => $displayName,
'image' => $contactImage,
'name' => $log->modified_id && $modifiers[$log->modified_id]['name'] ? $modifiers[$log->modified_id]['name'] : '',
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this should be better done as $modifiers[$log->modified_id]['name'] ?? '' right @eileenmcnaughton ?

Copy link
Member

Choose a reason for hiding this comment

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

I agree. @shahrukh-compuco can you make that change please?

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