-
-
Notifications
You must be signed in to change notification settings - Fork 9.6k
[HttpKernel][FrameworkBundle] Add a minimalist default PSR-3 logger #24300
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
Closed
Closed
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 file contains hidden or 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 file contains hidden or 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 file contains hidden or 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 file contains hidden or 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
45 changes: 45 additions & 0 deletions
45
src/Symfony/Component/HttpKernel/DependencyInjection/LoggerPass.php
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
<?php | ||
|
||
/* | ||
* This file is part of the Symfony package. | ||
* | ||
* (c) Fabien Potencier <fabien@symfony.com> | ||
* | ||
* For the full copyright and license information, please view the LICENSE | ||
* file that was distributed with this source code. | ||
*/ | ||
|
||
namespace Symfony\Component\HttpKernel\DependencyInjection; | ||
|
||
use Psr\Log\LoggerInterface; | ||
use Psr\Log\LogLevel; | ||
use Symfony\Component\HttpKernel\Log\Logger; | ||
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface; | ||
use Symfony\Component\DependencyInjection\ContainerBuilder; | ||
|
||
/** | ||
* Registers the default logger if necessary. | ||
* | ||
* @author Kévin Dunglas <dunglas@gmail.com> | ||
*/ | ||
class LoggerPass implements CompilerPassInterface | ||
{ | ||
/** | ||
* {@inheritdoc} | ||
*/ | ||
public function process(ContainerBuilder $container) | ||
{ | ||
$alias = $container->setAlias(LoggerInterface::class, 'logger'); | ||
$alias->setPublic(false); | ||
|
||
if ($container->has('logger')) { | ||
return; | ||
} | ||
|
||
$loggerDefinition = $container->register('logger', Logger::class); | ||
$loggerDefinition->setPublic(false); | ||
if ($container->getParameter('kernel.debug')) { | ||
$loggerDefinition->addArgument(LogLevel::DEBUG); | ||
} | ||
} | ||
} |
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,98 @@ | ||
<?php | ||
|
||
/* | ||
* This file is part of the Symfony package. | ||
* | ||
* (c) Fabien Potencier <fabien@symfony.com> | ||
* | ||
* For the full copyright and license information, please view the LICENSE | ||
* file that was distributed with this source code. | ||
*/ | ||
|
||
namespace Symfony\Component\HttpKernel\Log; | ||
|
||
use Psr\Log\AbstractLogger; | ||
use Psr\Log\InvalidArgumentException; | ||
use Psr\Log\LogLevel; | ||
|
||
/** | ||
* Minimalist PSR-3 logger designed to write in stderr or any other stream. | ||
* | ||
* @author Kévin Dunglas <dunglas@gmail.com> | ||
*/ | ||
class Logger extends AbstractLogger | ||
{ | ||
private static $levels = array( | ||
LogLevel::DEBUG => 0, | ||
LogLevel::INFO => 1, | ||
LogLevel::NOTICE => 2, | ||
LogLevel::WARNING => 3, | ||
LogLevel::ERROR => 4, | ||
LogLevel::CRITICAL => 5, | ||
LogLevel::ALERT => 6, | ||
LogLevel::EMERGENCY => 7, | ||
); | ||
|
||
private $minLevelIndex; | ||
private $formatter; | ||
private $handle; | ||
|
||
public function __construct($minLevel = LogLevel::WARNING, $output = 'php://stderr', callable $formatter = null) | ||
{ | ||
if (!isset(self::$levels[$minLevel])) { | ||
throw new InvalidArgumentException(sprintf('The log level "%s" does not exist.', $minLevel)); | ||
} | ||
|
||
$this->minLevelIndex = self::$levels[$minLevel]; | ||
$this->formatter = $formatter ?: array($this, 'format'); | ||
if (false === $this->handle = @fopen($output, 'a')) { | ||
throw new InvalidArgumentException(sprintf('Unable to open "%s".', $output)); | ||
} | ||
} | ||
|
||
/** | ||
* {@inheritdoc} | ||
*/ | ||
public function log($level, $message, array $context = array()) | ||
{ | ||
if (!isset(self::$levels[$level])) { | ||
throw new InvalidArgumentException(sprintf('The log level "%s" does not exist.', $level)); | ||
} | ||
|
||
if (self::$levels[$level] < $this->minLevelIndex) { | ||
return; | ||
} | ||
|
||
$formatter = $this->formatter; | ||
fwrite($this->handle, $formatter($level, $message, $context)); | ||
} | ||
|
||
/** | ||
* @param string $level | ||
* @param string $message | ||
* @param array $context | ||
* | ||
* @return string | ||
*/ | ||
private function format($level, $message, array $context) | ||
{ | ||
if (false !== strpos($message, '{')) { | ||
$replacements = array(); | ||
foreach ($context as $key => $val) { | ||
if (null === $val || is_scalar($val) || (\is_object($val) && method_exists($val, '__toString'))) { | ||
$replacements["{{$key}}"] = $val; | ||
} elseif ($val instanceof \DateTimeInterface) { | ||
$replacements["{{$key}}"] = $val->format(\DateTime::RFC3339); | ||
} elseif (\is_object($val)) { | ||
$replacements["{{$key}}"] = '[object '.\get_class($val).']'; | ||
} else { | ||
$replacements["{{$key}}"] = '['.\gettype($val).']'; | ||
} | ||
} | ||
|
||
$message = strtr($message, $replacements); | ||
} | ||
|
||
return sprintf('%s [%s] %s', date(\DateTime::RFC3339), $level, $message).\PHP_EOL; | ||
} | ||
} |
68 changes: 68 additions & 0 deletions
68
src/Symfony/Component/HttpKernel/Tests/DependencyInjection/LoggerPassTest.php
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
<?php | ||
|
||
/* | ||
* This file is part of the Symfony package. | ||
* | ||
* (c) Fabien Potencier <fabien@symfony.com> | ||
* | ||
* For the full copyright and license information, please view the LICENSE | ||
* file that was distributed with this source code. | ||
*/ | ||
|
||
namespace Symfony\Component\HttpKernel\Tests\DependencyInjection; | ||
|
||
use PHPUnit\Framework\TestCase; | ||
use Psr\Log\LoggerInterface; | ||
use Psr\Log\LogLevel; | ||
use Symfony\Component\HttpKernel\DependencyInjection\LoggerPass; | ||
use Symfony\Component\HttpKernel\Log\Logger; | ||
use Symfony\Component\DependencyInjection\ContainerBuilder; | ||
|
||
/** | ||
* @author Kévin Dunglas <dunglas@gmail.com> | ||
*/ | ||
class LoggerPassTest extends TestCase | ||
{ | ||
public function testAlwaysSetAutowiringAlias() | ||
{ | ||
$container = new ContainerBuilder(); | ||
$container->register('logger', 'Foo'); | ||
|
||
(new LoggerPass())->process($container); | ||
|
||
$this->assertFalse($container->getAlias(LoggerInterface::class)->isPublic()); | ||
} | ||
|
||
public function testDoNotOverrideExistingLogger() | ||
{ | ||
$container = new ContainerBuilder(); | ||
$container->register('logger', 'Foo'); | ||
|
||
(new LoggerPass())->process($container); | ||
|
||
$this->assertSame('Foo', $container->getDefinition('logger')->getClass()); | ||
} | ||
|
||
public function testRegisterLogger() | ||
{ | ||
$container = new ContainerBuilder(); | ||
$container->setParameter('kernel.debug', false); | ||
|
||
(new LoggerPass())->process($container); | ||
|
||
$definition = $container->getDefinition('logger'); | ||
$this->assertSame(Logger::class, $definition->getClass()); | ||
$this->assertFalse($definition->isPublic()); | ||
} | ||
|
||
public function testSetMinLevelWhenDebugging() | ||
{ | ||
$container = new ContainerBuilder(); | ||
$container->setParameter('kernel.debug', true); | ||
|
||
(new LoggerPass())->process($container); | ||
|
||
$definition = $container->getDefinition('logger'); | ||
$this->assertSame(LogLevel::DEBUG, $definition->getArgument(0)); | ||
} | ||
} |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
missing $context
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
On purpose, the type is already documented by the typehint.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
when I did so on some of my PRs, stof told me we don't do partial doc blocks :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
but we ma also remove the docblock entirely :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Other types aren't inferable.