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

Rename 'Provider' entity to 'SmsProvider' #29555

Merged
merged 1 commit into from
Mar 1, 2024

Conversation

colemanw
Copy link
Member

@colemanw colemanw commented Mar 1, 2024

Overview

Fixes a longstanding fixme to rename a badly-named entity.

Before

This FIXME was added in 2013!

// FIXME: DAO should be renamed CRM_SMS_DAO_SmsProvider
// But this would impact SMS extensions so need to coordinate
// Probably best approach is to migrate them to use the api and decouple them from core BAOs

After

Renamed. Won't impact extensions because class_aliases have been added.

Technical Details

This is the same solution we've used for other entities that needed to be renamed. class_alias works well to preserve backward-compatibility.

Comments

Targeting the RC because this API was added very recently in #28510

Copy link

civibot bot commented Mar 1, 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 🔗

@eileenmcnaughton
Copy link
Contributor

OK - test cover should be good on these changes

@colemanw
Copy link
Member Author

colemanw commented Mar 1, 2024

@eileenmcnaughton I added this FIXME 10 years ago!
Better late than never.

@eileenmcnaughton
Copy link
Contributor

@colemanw well done! But, I bet I can find an older fixme....

@eileenmcnaughton
Copy link
Contributor

@colemanw what got you onto fixing this - I thought it might have come out of looking at #29475 - but that one doesn't touch this I don't think

@eileenmcnaughton
Copy link
Contributor

dang test fail is real - ironically the one I wanted to tag ornery

api_v3_SyntaxConformanceTest::testCustomDataGet with data set #75 ('SmsProvider')
Undefined array key "Provider"

/home/homer/buildkit/build/build-4/web/sites/all/modules/civicrm/CRM/Core/DAO/AllCoreTables.php:365
/home/homer/buildkit/build/build-4/web/sites/all/modules/civicrm/tests/phpunit/api/v3/SyntaxConformanceTest.php:869
/home/homer/buildkit/build/build-4/web/sites/all/modules/civicrm/tests/phpunit/CiviTest/CiviUnitTestCase.php:247
/home/homer/buildkit/extern/phpunit9/phpunit9.phar:2307

Renames BAO, DAO & Api4 'Provider' to 'SmsProvider', as the previous name
was too ambiguous. This fixes a 10-year-old FIXME!
@colemanw
Copy link
Member Author

colemanw commented Mar 1, 2024

@eileenmcnaughton I had just missed a couple spots. Good thing the test caught it!

@colemanw
Copy link
Member Author

colemanw commented Mar 1, 2024

@eileenmcnaughton what got you onto fixing this?

At the sprint we wanted to finish some AdminUI work, and we looked at #28512 but got confused because we couldn't find the SmsProvider api entity... then finally realized that it does exist just has a terrible name.

@colemanw colemanw merged commit c178664 into civicrm:5.71 Mar 1, 2024
2 of 3 checks passed
@colemanw colemanw deleted the smsProvider branch March 1, 2024 16:47
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