[#18027] Deprecate onAuthenticationSuccess() - it's simple enough to implement

weaverryan · weaverryan · commit 0db1655bce00 · 2016-03-12T12:14:01.000-05:00
diff --git a/src/Symfony/Component/Security/Guard/Authenticator/AbstractFormLoginAuthenticator.php b/src/Symfony/Component/Security/Guard/Authenticator/AbstractFormLoginAuthenticator.php
@@ -41,9 +41,13 @@ abstract protected function getLoginUrl();
      * login page directly), this returns the URL the user should be redirected
      * to after logging in successfully (e.g. your homepage).
      *
+     * @deprecated Implement onAuthenticationFailure() instead of needing this function.
      * @return string
      */
-    abstract protected function getDefaultSuccessRedirectUrl();
+    protected function getDefaultSuccessRedirectUrl()
+    {
+        throw new \Exception(sprintf('You must implement onAuthenticationSuccess() or getDefaultSuccessRedirectURL() in %s.', get_class($this)));
+    }
 
     /**
      * Override to change what happens after a bad username/password is submitted.
@@ -72,6 +76,8 @@ public function onAuthenticationFailure(Request $request, AuthenticationExceptio
      */
     public function onAuthenticationSuccess(Request $request, TokenInterface $token, $providerKey)
     {
+        @trigger_error(sprintf('The AbstractFormLoginAuthenticator::onAuthenticationSuccess() implementation was deprecated in Symfony 3.1 and will be removed in Symfony 4.0. You should implement this method yourself in %s and remove getDefaultSuccessRedirectUrl().', get_class($this)), E_USER_DEPRECATED);
+
         // if the user hit a secure page and start() was called, this was
         // the URL they were on, and probably where you want to redirect to
         $targetPath = $this->getTargetPath($request->getSession(), $providerKey);
diff --git a/src/Symfony/Component/Security/Guard/Tests/Authenticator/AbstractFormLoginAuthenticatorTest.php b/src/Symfony/Component/Security/Guard/Tests/Authenticator/AbstractFormLoginAuthenticatorTest.php
@@ -0,0 +1,67 @@
+<?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\Security\Guard\Tests\Authenticator;
+
+use Symfony\Component\HttpFoundation\RedirectResponse;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\Security\Core\Exception\AuthenticationException;
+use Symfony\Component\Security\Core\User\UserInterface;
+use Symfony\Component\Security\Core\User\UserProviderInterface;
+use Symfony\Component\Security\Guard\Authenticator\AbstractFormLoginAuthenticator;
+class AbstractFormLoginAuthenticatorTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @group legacy
+     */
+    public function testLegacyWithLoginUrl()
+    {
+        $request = new Request();
+        $request->setSession($this->getMock('Symfony\Component\HttpFoundation\Session\Session'));
+
+        $authenticator = new LegacyFormLoginAuthenticator();
+        /** @var RedirectResponse $actualResponse */
+        $actualResponse = $authenticator->onAuthenticationSuccess(
+            $request,
+            $this->getMock('Symfony\Component\Security\Core\Authentication\Token\TokenInterface'),
+            'provider_key'
+        );
+
+        $this->assertEquals(
+            '/default_url',
+            $actualResponse->getTargetUrl()
+        );
+    }
+}
+
+class LegacyFormLoginAuthenticator extends AbstractFormLoginAuthenticator
+{
+    protected function getDefaultSuccessRedirectUrl()
+    {
+        return '/default_url';
+    }
+
+    protected function getLoginUrl()
+    {
+    }
+
+    public function getCredentials(Request $request)
+    {
+    }
+
+    public function getUser($credentials, UserProviderInterface $userProvider)
+    {
+    }
+
+    public function checkCredentials($credentials, UserInterface $user)
+    {
+    }
+}
