10000 Added placeholders to all log messages instead of hardcoded values · symfony/symfony@c92fcdb · GitHub
[go: up one dir, main page]
Skip to content

Commit c92fcdb

Browse files
hasonhason
committed
Added placeholders to all log messages instead of hardcoded values
1 parent 586c58a commit c92fcdb

File tree

6 files changed

+20
-21
lines changed

6 files changed

+20
-21
lines changed

‎src/Symfony/Component/EventDispatcher/Debug/TraceableEventDispatcher.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,7 @@ private function postProcess($eventName)
259259
$info = $this->getListenerInfo($listener->getWrappedListener(), $eventName);
260260
if ($listener->wasCalled()) {
261261
if (null !== $this->logger) {
262-
$this->logger->debug(sprintf('Notified event "%s" to listener "%s".', $eventName, $info['pretty']));
262+
$this->logger->debug('Notified event "{event}" to listener "{listener}".', array('event' => $eventName, 'listener' => $info['pretty']));
263263
}
264264

265265
if (!isset($this->called[$eventName])) {
@@ -270,12 +270,12 @@ private function postProcess($eventName)
270270
}
271271

272272
if (null !== $this->logger && $skipped) {
273-
$this->logger->debug(sprintf('Listener "%s" was not called for event "%s".', $info['pretty'], $eventName));
273+
$this->logger->debug('Listener "{listener}" was not called for event "{event}".', array('listener' => $info['pretty'], 'event' => $eventName));
274274
}
275275

276276
if ($listener->stoppedPropagation()) {
277277
if (null !== $this->logger) {
278-
$this->logger->debug(sprintf('Listener "%s" stopped propagation of the event "%s".', $info['pretty'], $eventName));
278+
$this->logger->debug('Listener "{listener}" stopped propagation of the event "{event}".', array('listener' => $info['pretty'], 'event' => $eventName));
279279
}
280280

281281
$skipped = true;

‎src/Symfony/Component/EventDispatcher/Tests/Debug/TraceableEventDispatcherTest.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -110,8 +110,8 @@ public function testLogger()
110110
$tdispatcher->addListener('foo', $listener1 = function () {});
111111
$tdispatcher->addListener('foo', $listener2 = function () {});
112112

113-
$logger->expects($this->at(0))->method('debug')->with('Notified event "foo" to listener "closure".');
114-
$logger->expects($this->at(1))->method('debug')->with('Notified event "foo" to listener "closure".');
113+
$logger->expects($this->at(0))->method('debug')->with('Notified event "{event}" to listener "{listener}".', array('event' => 'foo', 'listener' => 'closure'));
114+
$logger->expects($this->at(1))->method('debug')->with('Notified event "{event}" to listener "{listener}".', array('event' => 'foo', 'listener' => 'closure'));
115115

116116
$tdispatcher->dispatch('foo');
117117
}
@@ -125,9 +125,9 @@ public function testLoggerWithStoppedEvent()
125125
$tdispatcher->addListener('foo', $listener1 = function (Event $event) { $event->stopPropagation(); });
126126
$tdispatcher->addListener('foo', $listener2 = function () {});
127127

128-
$logger->expects($this->at(0))->method('debug')->with('Notified event "foo" to listener "closure".');
129-
$logger->expects($this->at(1))->method('debug')->with('Listener "closure" stopped propagation of the event "foo".');
130-
$logger->expects($this->at(2))->method('debug')->with('Listener "closure" was not called for event "foo".');
128+
$logger->expects($this->at(0))->method('debug')->with('Notified event "{event}" to listener "{listener}".', array('event' => 'foo', 'listener' => 'closure'));
129+
$logger->expects($this->at(1))->method('debug')->with('Listener "{listener}" stopped propagation of the event "{event}".', array('event' => 'foo', 'listener' => 'closure'));
130+
$logger->expects($this->at(2))->method('debug')->with('Listener "{listener}" was not called for event "{event}".', array('event' => 'foo', 'listener' => 'closure'));
131131

132132
$tdispatcher->dispatch('foo');
133133
}

‎src/Symfony/Component/HttpKernel/EventListener/RouterListener.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,8 @@ public function onKernelRequest(GetResponseEvent $event)
104104
}
105105

106106
if (null !== $this->logger) {
107-
$this->logger->info(sprintf('Matched route "%s".', isset($parameters['_route']) ? $parameters['_route'] : 'n/a'), array(
107+
$this->logger->info('Matched route "{route}".', array(
108+
'route' => isset($parameters['_route']) ? $parameters['_route'] : 'n/a',
108109
'route_parameters' => $parameters,
109110
'request_uri' => $request->getUri(),
110111
));

‎src/Symfony/Component/HttpKernel/Tests/EventListener/RouterListenerTest.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ public function testSubRequestWithDifferentMethod()
132132
/**
133133
* @dataProvider getLoggingParameterData
134134
*/
135-
public function testLoggingParameter($parameter, $log)
135+
public function testLoggingParameter($parameter, $log, $parameters)
136136
{
137137
$requestMatcher = $this->getMock('Symfony\Component\Routing\Matcher\RequestMatcherInterface');
138138
$requestMatcher->expects($this->once())
@@ -142,7 +142,7 @@ public function testLoggingParameter($parameter, $log)
142142
$logger = $this->getMock('Psr\Log\LoggerInterface');
143143
$logger->expects($this->once())
144144
->method('info')
145-
->with($this->equalTo($log));
145+
->with($this->equalTo($log), $this->equalTo($parameters));
146146

147147
$kernel = $this->getMock('Symfony\Component\HttpKernel\HttpKernelInterface');
148148
$request = Request::create('http://localhost/');
@@ -154,8 +154,8 @@ public function testLoggingParameter($parameter, $log)
154154
public function getLoggingParameterData()
155155
{
156156
return array(
157-
array(array('_route' => 'foo'), 'Matched route "foo".'),
158-
array(array(), 'Matched route "n/a".'),
157+
array(array('_route' => 'foo'), 'Matched route "{route}".', array('route' => 'foo', 'route_parameters' => array('_route' => 'foo'), 'request_uri' => 'http://localhost/')),
158+
array(array(), 'Matched route "{route}".', array('route' => 'n/a', 'route_parameters' => array(), 'request_uri' => 'http://localhost/')),
159159
);
160160
}
161161
}

‎src/Symfony/Component/Routing/Generator/UrlGenerator.php

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -153,18 +153,18 @@ protected function doGenerate($variables, $defaults, $requirements, $tokens, $pa
153153

154154
$url = '';
155155
$optional = true;
156+
$message = 'Parameter "{parameter}" for route "{route}" must match "{expected}" ("{given}" given) to generate a corresponding URL.';
156157
foreach ($tokens as $token) {
157158
if ('variable' === $token[0]) {
158159
if (!$optional || !array_key_exists($token[3], $defaults) || null !== $mergedParams[$token[3]] && (string) $mergedParams[$token[3]] !== (string) $defaults[$token[3]]) {
159160
// check requirement
160161
if (null !== $this->strictRequirements && !preg_match('#^'.$token[2].'$#', $mergedParams[$token[3]])) {
161-
$message = sprintf('Parameter "%s" for route "%s" must match "%s" ("%s" given) to generate a corresponding URL.', $token[3], $name, $token[2], $mergedParams[$token[3]]);
162162
if ($this->strictRequirements) {
163-
throw new InvalidParameterException($message);
163+
throw new InvalidParameterException(strtr($message, array('{parameter}' => $token[3], '{route}' => $name, '{expected}' => $token[2], '{given}' => $mergedParams[$token[3]])));
164164
}
165165

166166
if ($this->logger) {
167-
$this->logger->error($message);
167+
$this->logger->error($message, array('parameter' => $token[3], 'route' => $name, 'expected' => $token[2], 'given' => $mergedParams[$token[3]]));
168168
}
169169

170170
return;
@@ -222,14 +222,12 @@ protected function doGenerate($variables, $defaults, $requirements, $tokens, $pa
222222
foreach ($hostTokens as $token) {
223223
if ('variable' === $token[0]) {
224224
if (null !== $this->strictRequirements && !preg_match('#^'.$token[2].'$#i', $mergedParams[$token[3]])) {
225-
$message = sprintf('Parameter "%s" for route "%s" must match "%s" ("%s" given) to generate a corresponding URL.', $token[3], $name, $token[2], $mergedParams[$token[3]]);
226-
227225
if ($this->strictRequirements) {
228-
throw new InvalidParameterException($message);
226+
throw new InvalidParameterException(strtr($message, array('{parameter}' => $token[3], '{route}' => $name, '{expected}' => $token[2], '{given}' => $mergedParams[$token[3]])));
229227
}
230228

231229
if ($this->logger) {
232-
$this->logger->error($message);
230+
$this->logger->error($message, array('parameter' => $token[3], 'route' => $name, 'expected' => $token[2], 'given' => $mergedParams[$token[3]]));
233231
}
234232

235233
return;

‎src/Symfony/Component/Security/Guard/Firewall/GuardAuthenticationListener.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ public function handle(GetResponseEvent $event)
7878

7979
if ($event->hasResponse()) {
8080
if (null !== $this->logger) {
81-
$this->logger->debug(sprintf('The "%s" authenticator set the response. Any later authenticator will not be called', get_class($guardAuthenticator)));
81+
$this->logger->debug('The "{authenticator}" authenticator set the response. Any later authenticator will not be called', array('authenticator' => get_class($guardAuthenticator)));
8282
}
8383

8484
break;

0 commit comments

Comments
 (0)
0