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

Search kit action links cleanup #26839

Merged
merged 3 commits into from
Jul 16, 2023

Conversation

colemanw
Copy link
Member

@colemanw colemanw commented Jul 15, 2023

Overview

Followup to #26794 with some improvements to the code to make it more efficient and responsive. Also improves the UX by hiding links the user can't actually click on.

Technical Details

  • Breaks a large function apart that was doing too many things.
  • Reduces ajax bloat by only sending the name of the action per row rather than the entire action definition.
  • Improves responsiveness by pre-fetching action metadata when action links are present in the results.
  • Improves UX by hiding action links the user does not have permission to run (previously was only checking coarse-grained permissions, now it's checking fine-grained ACLs per row).
  • Fixes links for RelationshipCache-based searches.

@civibot
Copy link

civibot bot commented Jul 15, 2023

Thank you for contributing to CiviCRM! ❤️ We will need to test and review the 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

@civibot civibot bot added the master label Jul 15, 2023
@eileenmcnaughton
Copy link
Contributor

api\v4\SearchDisplay\SearchRunTest::testActionAndTaskLinks
Undefined array key "action"

/home/homer/buildkit/build/build-3/web/sites/all/modules/civicrm/ext/search_kit/Civi/Api4/Action/SearchDisplay/AbstractRunAction.php:477
/home/homer/buildkit/build/build-3/web/sites/all/modules/civicrm/ext/search_kit/Civi/Api4/Action/SearchDisplay/AbstractRunAction.php:456
/home/homer/buildkit/build/build-3/web/sites/all/modules/civicrm/ext/search_kit/Civi/Api4/Action/SearchDisplay/AbstractRunAction.php:446
/home/homer/buildkit/build/build-3/web/sites/all/modules/civicrm/ext/search_kit/Civi/Api4/Action/SearchDisplay/AbstractRunAction.php:264
/home/homer/buildkit/build/build-3/web/sites/all/modules/civicrm/ext/search_kit/Civi/Api4/Action/SearchDisplay/AbstractRunAction.php:136
/home/homer/buildkit/build/build-3/web/sites/all/modules/civicrm/ext/search_kit/Civi/Api4/Action/SearchDisplay/Run.php:121
/home/homer/buildkit/build/build-3/web/sites/all/modules/civicrm/ext/search_kit/Civi/Api4/Action/SearchDisplay/AbstractRunAction.php:113
/home/homer/buildkit/build/build-3/web/sites/all/modules/civicrm/Civi/Api4/Provider/ActionObjectProvider.php:72
/home/homer/buildkit/build/build-3/web/sites/all/modules/civicrm/Civi/API/Kernel.php:158
/home/homer/buildkit/build/build-3/web/sites/all/modules/civicrm/Civi/Api4/Generic/AbstractAction.php:249
/home/homer/buildkit/build/build-3/web/sites/all/modules/civicrm/ext/search_kit/Civi/Api4/Action/SearchDisplay/AbstractRunAction.php:89
/home/homer/buildkit/build/build-3/web/sites/all/modules/civicrm/api/api.php:85
/home/homer/buildkit/build/build-3/web/sites/all/modules/civicrm/ext/search_kit/tests/phpunit/api/v4/SearchDisplay/SearchRunTest.php:294
/home/homer/buildkit/extern/phpunit8/phpunit8.phar:1721

@colemanw colemanw force-pushed the searchKitActionLinksCleanup branch from 14ad0ef to f5a57e7 Compare July 15, 2023 15:09
@eileenmcnaughton
Copy link
Contributor

@colemanw my one concern about this is that we are seeing some speed issues related to the links. I think the worst of it might be the fixed one with the downloads - but I'm just wondering if this will increase api calls & by how much? It looks like maybe just once per Search load?

@colemanw
Copy link
Member Author

@eileenmcnaughton yea I've been looking at that. I think the speed issues can be further improved with a bit of caching. But I don't think this PR is making it significantly worse.

@eileenmcnaughton eileenmcnaughton merged commit 5f20a03 into civicrm:master Jul 16, 2023
@eileenmcnaughton eileenmcnaughton deleted the searchKitActionLinksCleanup branch July 16, 2023 04:13
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.

2 participants