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

Pass specific ids rather than ids array #27274

Merged
merged 1 commit into from
Sep 4, 2023

Conversation

eileenmcnaughton
Copy link
Contributor

Overview

Pass specific ids rather than ids array

Before

It is unclear when we pass ids what ids we care about - we call some nasty functions to load these ids & because the usage is hard to track it is hard to stop calling the functions. In this case the only value from $ids actually used is $eventID. In addition it grabs the $participantID from a creepy array relatedObjects when we already know it

After

Pass in the actually-used ids and stop passing in ids. Also stop setting an id that we never use (related_contact). Stop passing in unused $input

Technical Details

The function is called from one well-tested place. It also receives a variable it does not use ($input)
image

Comments

@civibot
Copy link

civibot bot commented Sep 4, 2023

🤖 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 4, 2023
@eileenmcnaughton eileenmcnaughton force-pushed the gather branch 3 times, most recently from 6fd2d7b to 0bf03e6 Compare September 4, 2023 02:00
It is unclear when we pass ids what ids we care about (& in general how many ids we are using from the
various functions). In fact 2 specific IDs are used (one from the _relatedObjects array) so pass
these in and stop passing in ids. Also stop setting an id that we never use
@colemanw
Copy link
Member

colemanw commented Sep 4, 2023

I feel much better about merging stuff like this now that the form has solid test coverage!

@colemanw colemanw merged commit cc534e9 into civicrm:master Sep 4, 2023
@colemanw colemanw deleted the gather branch September 4, 2023 11:56
@eileenmcnaughton
Copy link
Contributor Author

@colemanw actually this is from our complete payment flow - which has some of the earliest unit tests in CiviCRM.

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