properly handle exceptions in translator listener

xabbuh · xabbuh · commit d3a0a5545566 · 2014-10-08T22:39:21.000+02:00
The `setLocale()` method can throw an `\InvalidArgumentException` when
an invalid locale has been passed. These exceptions must be handled by
the `TranslatorListener` which should then pass the request's default
locale instead.
diff --git a/src/Symfony/Component/HttpKernel/EventListener/TranslatorListener.php b/src/Symfony/Component/HttpKernel/EventListener/TranslatorListener.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\HttpKernel\EventListener;
 
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Event\GetResponseEvent;
 use Symfony\Component\HttpKernel\Event\FinishRequestEvent;
 use Symfony\Component\HttpKernel\KernelEvents;
@@ -36,14 +37,16 @@ public function __construct(TranslatorInterface $translator, RequestStack $reque
 
     public function onKernelRequest(GetResponseEvent $event)
     {
-        $this->translator->setLocale($event->getRequest()->getLocale());
+        $this->setLocale($event->getRequest());
     }
 
     public function onKernelFinishRequest(FinishRequestEvent $event)
     {
-        if (null !== $parentRequest = $this->requestStack->getParentRequest()) {
-            $this->translator->setLocale($parentRequest->getLocale());
+        if (null === $parentRequest = $this->requestStack->getParentRequest()) {
+            return;
         }
+
+        $this->setLocale($parentRequest);
     }
 
     public static function getSubscribedEvents()
@@ -54,4 +57,13 @@ public static function getSubscribedEvents()
             KernelEvents::FINISH_REQUEST => array(array('onKernelFinishRequest', 0)),
         );
     }
+
+    private function setLocale(Request $request)
+    {
+        try {
+            $this->translator->setLocale($request->getLocale());
+        } catch (\InvalidArgumentException $e) {
+            $this->translator->setLocale($request->getDefaultLocale());
+        }
+    }
 }
diff --git a/src/Symfony/Component/HttpKernel/Tests/EventListener/TranslatorListenerTest.php b/src/Symfony/Component/HttpKernel/Tests/EventListener/TranslatorListenerTest.php
@@ -41,6 +41,21 @@ public function testLocaleIsSetInOnKernelRequest()
         $this->listener->onKernelRequest($event);
     }
 
+    public function testDefaultLocaleIsUsedOnExceptionsInOnKernelRequest()
+    {
+        $this->translator
+            ->expects($this->at(0))
+            ->method('setLocale')
+            ->will($this->throwException(new \InvalidArgumentException()));
+        $this->translator
+            ->expects($this->at(1))
+            ->method('setLocale')
+            ->with($this->equalTo('en'));
+
+        $event = new GetResponseEvent($this->createHttpKernel(), $this->createRequest('fr'), HttpKernelInterface::MASTER_REQUEST);
+        $this->listener->onKernelRequest($event);
+    }
+
     public function testLocaleIsSetInOnKernelFinishRequestWhenParentRequestExists()
     {
         $this->translator
@@ -63,6 +78,22 @@ public function testLocaleIsNotSetInOnKernelFinishRequestWhenParentRequestDoesNo
         $this->listener->onKernelFinishRequest($event);
     }
 
+    public function testDefaultLocaleIsUsedOnExceptionsInOnKernelFinishRequest()
+    {
+        $this->translator
+            ->expects($this->at(0))
+            ->method('setLocale')
+            ->will($this->throwException(new \InvalidArgumentException()));
+        $this->translator
+            ->expects($this->at(1))
+            ->method('setLocale')
+            ->with($this->equalTo('en'));
+
+        $this->setMasterRequest($this->createRequest('fr'));
+        $event = new FinishRequestEvent($this->createHttpKernel(), $this->createRequest('de'), HttpKernelInterface::SUB_REQUEST);
+        $this->listener->onKernelFinishRequest($event);
+    }
+
     private function createHttpKernel()
     {
         return $this->getMock('Symfony\Component\HttpKernel\HttpKernelInterface');

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@`
`12`	`12`	`namespace Symfony\Component\HttpKernel\EventListener;`
`13`	`13`
`14`	`14`	`use Symfony\Component\EventDispatcher\EventSubscriberInterface;`
	`15`	`+use Symfony\Component\HttpFoundation\Request;`
`15`	`16`	`use Symfony\Component\HttpKernel\Event\GetResponseEvent;`
`16`	`17`	`use Symfony\Component\HttpKernel\Event\FinishRequestEvent;`
`17`	`18`	`use Symfony\Component\HttpKernel\KernelEvents;`
`@@ -36,14 +37,16 @@ public function __construct(TranslatorInterface $translator, RequestStack $reque`
`36`	`37`
`37`	`38`	`public function onKernelRequest(GetResponseEvent $event)`
`38`	`39`	`{`
`39`		`- $this->translator->setLocale($event->getRequest()->getLocale());`
	`40`	`+ $this->setLocale($event->getRequest());`
`40`	`41`	`}`
`41`	`42`
`42`	`43`	`public function onKernelFinishRequest(FinishRequestEvent $event)`
`43`	`44`	`{`
`44`		`- if (null !== $parentRequest = $this->requestStack->getParentRequest()) {`
`45`		`- $this->translator->setLocale($parentRequest->getLocale());`
	`45`	`+ if (null === $parentRequest = $this->requestStack->getParentRequest()) {`
	`46`	`+ return;`
`46`	`47`	`}`
	`48`	`+`
	`49`	`+ $this->setLocale($parentRequest);`
`47`	`50`	`}`
`48`	`51`
`49`	`52`	`public static function getSubscribedEvents()`
`@@ -54,4 +57,13 @@ public static function getSubscribedEvents()`
`54`	`57`	`KernelEvents::FINISH_REQUEST => array(array('onKernelFinishRequest', 0)),`
`55`	`58`	`);`
`56`	`59`	`}`
	`60`	`+`
	`61`	`+ private function setLocale(Request $request)`
	`62`	`+ {`
	`63`	`+ try {`
	`64`	`+ $this->translator->setLocale($request->getLocale());`
	`65`	`+ } catch (\InvalidArgumentException $e) {`
	`66`	`+ $this->translator->setLocale($request->getDefaultLocale());`
	`67`	`+ }`
	`68`	`+ }`
`57`	`69`	`}`