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

ensure exception class supports getErrorData #28398

Merged

Conversation

MegaphoneJon
Copy link
Contributor

Overview

A recent change is to allow showing detailed errors to end users from AJAX where appropriate by adding a show_detailed_error param to the exception:

if (CRM_Core_Permission::check('view debug output') || ($e->getErrorData()['show_detailed_error'] ?? FALSE)) {

However, some AJAX API calls (notably System.check call Guzzle, and Guzzle exceptions don't have the getErrorData() method, so we never see the exception, we get a "method doesn't exist" message.

This adds a check that the method exists before calling it.

Before

Guzzle failures in System.check when called via AJAX API crashes on exception.

After

Guzzle failures in System.check when called via AJAX API are logged.

Comments

This feels messy to me and maybe it's in the wrong spot. Is it possible to intercept a Guzzle exception with catch and then emit a CRM_Core_Exception? But this is better in than out.

Copy link

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

@eileenmcnaughton
Copy link
Contributor

I don't see much downside in this - there is always the chance of an unanticipated exception bubbling up

@eileenmcnaughton
Copy link
Contributor

api\v4\Request\AjaxTest::testContactGetAndCreatePermissions
Undefined array key "show_detailed_error"

/home/homer/buildkit/build/build-0/web/sites/all/modules/civicrm/CRM/Api4/Page/AJAX.php:140
/home/homer/buildkit/build/build-0/web/sites/all/modules/civicrm/CRM/Api4/Page/AJAX.php:55
/home/homer/buildkit/build/build-0/web/sites/all/modules/civicrm/tests/phpunit/api/v4/Request/AjaxTest.php:239
/home/homer/buildkit/build/build-0/web/sites/all/modules/civicrm/tests/phpunit/api/v4/Request/AjaxTest.php:111
/home/homer/buildkit/extern/phpunit9/phpunit9.phar:2307

@MegaphoneJon
Copy link
Contributor Author

Weird on the test fail - I double-checked the order of precedence to make sure I didn't need extra parentheses, but let's add them in I guess.

@MegaphoneJon MegaphoneJon force-pushed the better-ajax-error-handling branch from 7b5c61b to 5a04c02 Compare December 4, 2023 19:23
@eileenmcnaughton eileenmcnaughton merged commit bc85514 into civicrm:master Dec 4, 2023
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