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] Convert _checkAccess to event listener #28890

Merged
merged 8 commits into from
Jan 11, 2024

Conversation

colemanw
Copy link
Member

@colemanw colemanw commented Jan 5, 2024

Overview

Fixes a FIXME that @totten left for me to fix in #20533

Also see https://lab.civicrm.org/dev/core/-/issues/4887

Before

// Note: $bao::_checkAccess() is a quasi-listener. TODO: Convert to straight-up listener.

After

Straight-up listener

Copy link

civibot bot commented Jan 5, 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 Jan 5, 2024
@colemanw colemanw changed the title Check access event [REF] Convert _checkAccess to event listener Jan 5, 2024
@artfulrobot
Copy link
Contributor

@colemanw I've read it through but not r-run it. I can see the tests pass, so insofar as we had test coverage for this then things look good. I'm not entirely sold on the event listener model for this: it seems to be a bit less clear (order of execution, reading the code is now a case of hunting for listeners) and it introduces a longer codepath to achieve the same thing, though I'm sure it's not enough to make a huge/noticeable difference, it's still more.

@colemanw
Copy link
Member Author

@artfulrobot I'm not entirely sold on the event listener model for this

I think the argument is that event listeners are standard across symfony-compatible php apps, whereas random-function-with-magic-name-that-starts-with-an-underscore-for-some-reason is just a weird little thing I made-up. So this takes us more in the standards-direction and also gets rid of the "two different ways of doing the same thing" motif which can be confusing to devs. And I'm not too attached to my weird little underscore-function to kill it off if it makes things more sane.

@colemanw
Copy link
Member Author

@artfulrobot I wasn't sure about test coverage either so I did a couple test runs locally and a draft commit while writing this pr just to make sure that if any of these conversions wasn't working properly at least one test would fail somewhere... and one did.
I would feel better if it was more than one! But it's something.

@artfulrobot
Copy link
Contributor

ok, over to you to merge then 👍

@artfulrobot artfulrobot added the merge ready PR will be merged after a few days if there are no objections label Jan 11, 2024
@colemanw colemanw merged commit bd2f5cd into civicrm:master Jan 11, 2024
3 checks passed
@colemanw colemanw deleted the checkAccessEvent branch January 11, 2024 12:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
master merge ready PR will be merged after a few days if there are no objections
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants