New feature: added mage_run_installed_exception event when uncatched exception is thrown

[pquerner]

Description (*)

This will add a new event called mage_installed_exception.
It will be thrown when OpenMage is installed and an uncatched exception is handled in the Mage::run method.

Using this new event it is possible to attach a exception facility, such as (Sentry)[https://sentry.io/].

Related Pull Requests

None

Fixed Issues (if relevant)

None, it got converted to a discussion: #3510

Manual testing scenarios (*)

1. Throw exception anywhere thats unhandled by itself. For instance in an controller.

Mage::throwException('Dummy exception');

4. It will finally be catched in Mage::run
5. Listen to the new event, and do whatever you want with the exception. A use case has been discussed here: New event: mage_installed_exception (to i.e. forward exceptions to a 3rd party error logger, such as Sentry) #3510

Questions or comments

Contribution checklist (*)

• Pull request has a meaningful description of its purpose
• All commits are accompanied by meaningful commit messages
• All automated tests passed successfully (all builds are green)
• Add yourself to contributors list

[fballiano]

@pquerner what do you think about this pr and its relation with #3957?

[pquerner]

I think having 1 event as shown here is enough to even implement this new Error library or any library for that matter. I don't really see the need to have more than that event.

Also it makes sure that the exception caught can only be from cgi context, as the ::printException can be called from different places, which ought to be handled either in the core or at the listener place (which I currently dont see in the 1 module implementing)

[fballiano]

not really because there's still the need to override the default error handler and that needs to be in the initEnvironment, so at least 2 events are needed.

I'll check if the event added in this pr could be used also in the context of Ignition and get back here.

@empiricompany

[fballiano]

@empiricompany could you test your ignition module listening to mage_run_exception and mage_installed_exception (i've to say i don't love the name, although technically correct) instead of the ones added in #3957?

[pquerner]

My sentry implementation uses controller_action_predispatch to change the default error handler (cgi) and default for cli. (cron)

The new event core_app_init_environment_after would make it more visible for cgi, I agree. But for cron this should not get executed if I read that code correctly.

[fballiano]

we'll test the ignition module with a mix of your other PR and this one and see if it works, probably the mix of the two will be the best implementation ;-)

[fballiano]

i'd try to decide a name for this event and merge it asap so that we can test the Ignition thing with this new even and see if that's enough

[fballiano]

since we kinda already had consensus, if nothing comes up I'll merge this tomorrow