[Security] Improve LogoutUrlGenerator exception message

alamirault · fabpot · commit 59187f2040a5 · 2022-11-19T17:09:21.000+01:00
diff --git a/src/Symfony/Component/Security/Http/Logout/LogoutUrlGenerator.php b/src/Symfony/Component/Security/Http/Logout/LogoutUrlGenerator.php
@@ -151,6 +151,10 @@ private function getListener(?string $key): array
             }
         }
 
-        throw new \InvalidArgumentException('Unable to find the current firewall LogoutListener, please provide the provider key manually.');
+        if (null === $this->currentFirewallName) {
+            throw new \InvalidArgumentException('This request is not behind a firewall, pass the firewall name manually to generate a logout URL.');
+        }
+
+        throw new \InvalidArgumentException('Unable to find logout in the current firewall, pass the firewall name manually to generate a logout URL.');
     }
 }
diff --git a/src/Symfony/Component/Security/Http/Tests/Logout/LogoutUrlGeneratorTest.php b/src/Symfony/Component/Security/Http/Tests/Logout/LogoutUrlGeneratorTest.php
@@ -88,12 +88,22 @@ public function testGuessFromTokenWithoutFirewallNameFallbacksToCurrentFirewall(
         $this->assertSame('/logout', $this->generator->getLogoutPath());
     }
 
-    public function testUnableToGuessThrowsException()
+    public function testUnableToGuessWithoutCurrentFirewallThrowsException()
     {
         $this->expectException(\InvalidArgumentException::class);
-        $this->expectExceptionMessage('Unable to find the current firewall LogoutListener, please provide the provider key manually');
+        $this->expectExceptionMessage('This request is not behind a firewall, pass the firewall name manually to generate a logout URL.');
         $this->generator->registerListener('secured_area', '/logout', null, null);
 
         $this->generator->getLogoutPath();
     }
+
+    public function testUnableToGuessWithCurrentFirewallThrowsException()
+    {
+        $this->expectException(\InvalidArgumentException::class);
+        $this->expectExceptionMessage('Unable to find logout in the current firewall, pass the firewall name manually to generate a logout URL.');
+        $this->generator->registerListener('secured_area', '/logout', null, null);
+        $this->generator->setCurrentFirewall('admin');
+
+        $this->generator->getLogoutPath();
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -151,6 +151,10 @@ private function getListener(?string $key): array`
`151`	`151`	`}`
`152`	`152`	`}`
`153`	`153`
`154`		`- throw new \InvalidArgumentException('Unable to find the current firewall LogoutListener, please provide the provider key manually.');`
	`154`	`+ if (null === $this->currentFirewallName) {`
	`155`	`+ throw new \InvalidArgumentException('This request is not behind a firewall, pass the firewall name manually to generate a logout URL.');`
	`156`	`+ }`
	`157`	`+`
	`158`	`+ throw new \InvalidArgumentException('Unable to find logout in the current firewall, pass the firewall name manually to generate a logout URL.');`
`155`	`159`	`}`
`156`	`160`	`}`
Original file line number	Diff line number	Diff line change
`@@ -88,12 +88,22 @@ public function testGuessFromTokenWithoutFirewallNameFallbacksToCurrentFirewall(`
`88`	`88`	`$this->assertSame('/logout', $this->generator->getLogoutPath());`
`89`	`89`	`}`
`90`	`90`
`91`		`- public function testUnableToGuessThrowsException()`
	`91`	`+ public function testUnableToGuessWithoutCurrentFirewallThrowsException()`
`92`	`92`	`{`
`93`	`93`	`$this->expectException(\InvalidArgumentException::class);`
`94`		`- $this->expectExceptionMessage('Unable to find the current firewall LogoutListener, please provide the provider key manually');`
	`94`	`+ $this->expectExceptionMessage('This request is not behind a firewall, pass the firewall name manually to generate a logout URL.');`
`95`	`95`	`$this->generator->registerListener('secured_area', '/logout', null, null);`
`96`	`96`
`97`	`97`	`$this->generator->getLogoutPath();`
`98`	`98`	`}`
	`99`	`+`
	`100`	`+ public function testUnableToGuessWithCurrentFirewallThrowsException()`
	`101`	`+ {`
	`102`	`+ $this->expectException(\InvalidArgumentException::class);`
	`103`	`+ $this->expectExceptionMessage('Unable to find logout in the current firewall, pass the firewall name manually to generate a logout URL.');`
	`104`	`+ $this->generator->registerListener('secured_area', '/logout', null, null);`
	`105`	`+ $this->generator->setCurrentFirewall('admin');`
	`106`	`+`
	`107`	`+ $this->generator->getLogoutPath();`
	`108`	`+ }`
`99`	`109`	`}`