Cleanup: logging methods #880
Closed
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
Avoid a level of indirection my making the DSL logging keywords call $app->log directly, rather than calling the DSL 'log' keyword. This is a cleanup to help resolve the "magic number" of call frames to jump in the logger for reporting what triggered the log message. i.e. the `log` and `debug`, `info`, `warning` and `error` each need to jump the same nunmber of call frames to report what triggered the log message.
Generate log entries on hook execution by calling $app->log(), rather than the logging engine directly. This helps minimize the number of callers involved in generating log messages, which helps minimize the magic number of call frames to skip when reporting the caller in log messages. This approach also provides a single point to deal with future handling of log messages when no logging engine is defined for an app.
Now the DSL logging keywords call $app->log() directly, we need to skip one less call frame when reporting the caller. Updates the concole logger tests, as the 5th stack frame exists - and is the test file, thanks to Capture::Tiny adding the exact same number of frames in capturing the output.
|
👍 |
|
Merged, thanks! 👍 |
xsawyerx
added a commit
that referenced
this pull request
Apr 26, 2015
[ BUG FIXES ]
* GH #868: Fix incorrect access name in $error->throw. (cdmalon)
* GH #879, #883: Fix version numbering in packaging and tests.
(Russell Jenkins)
* File serving (send_file) won't call serializer. (Russell Jenkins)
* GH #892, #510: Workaround for multiple plugins with hooks.
(Russell Jenkins, Alberto Simões)
* GH #558: Remove "prefix" inconsistency with possibly missing postfixed
forward slash. (Sawyer X)
[ DOCUMENTATION ]
* GH #816, #874 Document session engine changes in migration documentation.
(Chenchen Zhao)
* GH #866, #870: Clarify that you cannot forward to a static file, why,
and two different ways of accomplishing it without forward.
(Sakshee Vijayvargia)
* GH #878: Rework example for optional named matching due to operator
precedence. (Andrew Solomon)
* GH #844: Document Simple session backend is the default. (Sawyer X)
[ ENHANCEMENT ]
* GH #869: Streaming file serving (send_file). (Russell Jenkins)
* GH #793: "prefix" now supports the path definition spec. (Sawyer X)
* GH #817, #845: Route spec under a prefix doesn't need to start with
a slash (but must without a prefix).
(Sawyer X, Russell Jenkins)
* GH #871: Use Safe.pm instead of eval with Dancer2::Serializer::Dumper.
(David Zurborg)
* GH #880: Reduce and cleanup different logging calls in order to handle
the stack frames traceback for logging classes. (Russell Jenkins)
* GH #857, #875: When failing to render in Template::Toolkit, make the
error reflect it's a TT error, not an internal one.
(valerycodes)
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.
The DSL keywords for logging (
debug,info,warninganderror) as well asRole::Hookablenow call thelogmethod on an app object.While this doesn't solve #791, it reduces the number of cases we need to deal with for the "magic" number of call stacks to skip to report the caller from 4 to 2.