introduce INFO_DEPRECATION_LOG event #2409
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This adds an event to dbg_deprecated(). This allows plugins to handle deprecation warnings. One example would be @cosmocode/dokuwiki-plugin-sentry One thing I don't like, but don't know how to avaoid is that this function used to abort super early when $conf['allowdebug'] wasn't set. However for the sentry plugin you probably would want logs, but still do not show any debugging to end users (which allow debug would do). So now the backtrace is always built, the event triggered and then everything is sent to dbglog() which may simply throw everything away. Suggestions on how to improve this welcome.
micgro42
approved these changes
Jun 1, 2018
There was a problem hiding this comment.
You could change the condition to
if($event->advise_before() && $conf['allowdebug']) {
That might make the intent a bit clearer.
As an alternative: is it possible to query whether any handlers are registered for an event? If that is possible one could make an early return check for $conf['allowdebug'] and no handlers registered for event
Nonetheless, this event should work fine as it is now 👍
Sometimes, preparing the data for an event is expensive and only needed if the event is actually handled. This allows for a quick check before actually preparing and triggering the event.
now the method is aborting early again unless the data is actually used
|
@micgro42 I added a mechanism to check if there are registered handlers. Can you have a look again? |
|
Looks good (though I havn't had time to try it yet) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds an event to dbg_deprecated(). This allows plugins to handle deprecation warnings. One example would be https://github.com/cosmocode/dokuwiki-plugin-sentry
One thing I don't like, but don't know how to avaoid is that this function used to abort super early when $conf['allowdebug'] wasn't set.
However for the sentry plugin you probably would want logs, but still do not show any debugging to end users (which allow debug would do).
So now the backtrace is always built, the event triggered and then everything is sent to dbglog() which may simply throw everything away.
Suggestions on how to improve this welcome.