make workorounds over deprecated method in symofny 5.4

lchrusciel · Dec 2, 2021 · 2964e0e · 2964e0e
1 parent 6339528
commit 2964e0e
Show file tree

Hide file tree

Showing 11 changed files with 105 additions and 9 deletions.
diff --git a/config/packages/security.yaml b/config/packages/security.yaml
@@ -1,4 +1,5 @@
 security:
+    always_authenticate_before_granting: true
     providers:
         sylius_admin_user_provider:
             id: sylius.admin_user_provider.email_or_name_based

diff --git a/psalm.xml b/psalm.xml
@@ -119,6 +119,7 @@
                 <referencedMethod name="Symfony\Component\Security\Core\User\UserInterface::getUsername" /> <!-- deprecated in Symfony 5.3 -->
                 <referencedMethod name="Symfony\Component\Security\Core\User\UserProviderInterface::loadUserByUsername" /> <!-- deprecated in Symfony 5.3 -->
                 <referencedMethod name="Faker\Generator::__get"/>
+                <referencedMethod name="Symfony\Component\Security\Core\Authentication\Token\AbstractToken::isAuthenticated" /> <!-- deprecated in Symfony 5.4 -->
             </errorLevel>
         </DeprecatedMethod>
 
@@ -202,6 +203,7 @@
                 <referencedFunction name="Symfony\Contracts\EventDispatcher\EventDispatcherInterface::dispatch" />
                 <referencedFunction name="Symfony\Component\HttpKernel\Config\FileLocator::__construct" />
                 <referencedFunction name="Symfony\Contracts\EventDispatcher\EventDispatcherInterface::dispatch" />
+                <referencedFunction name="Symfony\Component\Security\Core\Authentication\Token\UsernamePasswordToken::__construct" /> <!-- removed parameter in Symfony 5.4 -->
             </errorLevel>
             <errorLevel type="suppress">
                 <referencedFunction name="Doctrine\ORM\Query\Expr::andX" />
@@ -225,6 +227,7 @@
             <errorLevel type="info">
                 <referencedFunction name="Symfony\Component\EventDispatcher\EventDispatcherInterface::dispatch" />
                 <referencedFunction name="SyliusLabs\AssociationHydrator\AssociationHydrator::__construct" />
+                <referencedFunction name="Symfony\Component\Security\Core\Authentication\Token\UsernamePasswordToken::__construct" />
             </errorLevel>
         </InvalidArgument>
 

diff --git a/src/Sylius/Behat/Service/SecurityService.php b/src/Sylius/Behat/Service/SecurityService.php
@@ -43,7 +43,13 @@ public function __construct(SessionInterface $session, CookieSetterInterface $co
 
     public function logIn(UserInterface $user): void
     {
-        $token = new UsernamePasswordToken($user, $user->getPassword(), $this->firewallContextName, $user->getRoles());
+        /** @deprecated parameter credential was deprecated in Symfony 5.4, so in Sylius 1.11 too, in Sylius 2.0 providing 4 arguments will be prohibited. */
+        if (3 === (new \ReflectionClass(UsernamePasswordToken::class))->getConstructor()->getNumberOfParameters()) {
+            $token = new UsernamePasswordToken($user, $this->firewallContextName, $user->getRoles());
+        } else {
+            $token = new UsernamePasswordToken($user, $user->getPassword(), $this->firewallContextName, $user->getRoles());
+        }
+
         $this->setToken($token);
     }
 

diff --git a/src/Sylius/Bundle/CoreBundle/Resources/config/services.xml b/src/Sylius/Bundle/CoreBundle/Resources/config/services.xml
@@ -288,5 +288,7 @@
         </service>
 
         <service id="Sylius\Bundle\CoreBundle\Calculator\DelayStampCalculatorInterface" class="Sylius\Bundle\CoreBundle\Calculator\DelayStampCalculator"/>
+
+        <service id="security.authentication_manager" alias="security.authentication.manager" />
     </services>
 </container>
diff --git a/src/Sylius/Bundle/CoreBundle/Security/UserImpersonator.php b/src/Sylius/Bundle/CoreBundle/Security/UserImpersonator.php
@@ -40,11 +40,22 @@ public function __construct(SessionInterface $session, string $firewallContextNa
 
     public function impersonate(UserInterface $user): void
     {
-        $token = new UsernamePasswordToken(
-            $user,
-            $this->firewallContextName,
-            array_map(/** @param object|string $role */ static function ($role): string { return (string) $role; }, $user->getRoles())
-        );
+        /** @deprecated parameter credential was deprecated in Symfony 5.4, so in Sylius 1.11 too, in Sylius 2.0 providing 4 arguments will be prohibited. */
+        if (3 === (new \ReflectionClass(UsernamePasswordToken::class))->getConstructor()->getNumberOfParameters()) {
+            $token = new UsernamePasswordToken(
+                $user,
+                $this->firewallContextName,
+                array_map(/** @param object|string $role */ static function ($role): string { return (string) $role; }, $user->getRoles())
+            );
+        } else {
+            $token = new UsernamePasswordToken(
+                $user,
+                $user->getPassword(),
+                $this->firewallContextName,
+                array_map(/** @param object|string $role */ static function ($role): string { return (string) $role; }, $user->getRoles())
+            );
+        }
+
         $this->session->set($this->sessionTokenParameter, serialize($token));
         $this->session->save();
 

diff --git a/src/Sylius/Bundle/ProductBundle/Controller/ProductSlugController.php b/src/Sylius/Bundle/ProductBundle/Controller/ProductSlugController.php
@@ -13,17 +13,38 @@
 
 namespace Sylius\Bundle\ProductBundle\Controller;
 
+use Sylius\Component\Product\Generator\SlugGeneratorInterface;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 
 class ProductSlugController extends AbstractController
 {
+    private ?SlugGeneratorInterface $slugGenerator;
+
+    public function __construct(?SlugGeneratorInterface $slugGenerator = null)
+    {
+        $this->slugGenerator = $slugGenerator;
+
+        if ($this->slugGenerator === null) {
+            @trigger_error(sprintf('Not passing a $slugGenerator to %s constructor is deprecated since Sylius 1.11 and will be prohibited in Sylius 2.0.', self::class), \E_USER_DEPRECATED);
+        }
+    }
+
+    /**
+     * @psalm-suppress DeprecatedMethod
+     */
     public function generateAction(Request $request): Response
     {
         $name = $request->query->get('name');
 
+        if ($this->slugGenerator !== null) {
+            return new JsonResponse([
+                'slug' => $this->slugGenerator->generate((string) $name),
+            ]);
+        }
+
         return new JsonResponse([
             'slug' => $this->get('sylius.generator.slug')->generate($name),
         ]);

diff --git a/src/Sylius/Bundle/ProductBundle/Resources/config/services.xml b/src/Sylius/Bundle/ProductBundle/Resources/config/services.xml
@@ -20,6 +20,7 @@
         <defaults public="true" />
 
         <service id="sylius.controller.product_slug" class="Sylius\Bundle\ProductBundle\Controller\ProductSlugController">
+            <argument type="service" id="sylius.generator.slug" />
             <call method="setContainer">
                 <argument type="service" id="service_container" />
             </call>

diff --git a/src/Sylius/Bundle/UserBundle/Controller/SecurityController.php b/src/Sylius/Bundle/UserBundle/Controller/SecurityController.php
@@ -15,18 +15,45 @@
 
 use Sylius\Bundle\UserBundle\Form\Type\UserLoginType;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\Form\FormFactoryInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Security\Http\Authentication\AuthenticationUtils;
 use Webmozart\Assert\Assert;
 
 class SecurityController extends AbstractController
 {
+    private ?AuthenticationUtils $authenticationUtils;
+
+    private ?FormFactoryInterface $formFactory;
+
+    public function __construct(?AuthenticationUtils $authenticationUtils = null, ?FormFactoryInterface $formFactory = null)
+    {
+        $this->authenticationUtils = $authenticationUtils;
+        $this->formFactory = $formFactory;
+
+        if ($this->authenticationUtils === null) {
+            @trigger_error(sprintf('Not passing a $authenticationUtils to %s constructor is deprecated since Sylius 1.11 and will be prohibited in Sylius 2.0.', self::class), \E_USER_DEPRECATED);
+        }
+
+        if ($this->formFactory === null) {
+            @trigger_error(sprintf('Not passing a $formFactory to %s constructor is deprecated since Sylius 1.11 and will be prohibited in Sylius 2.0.', self::class), \E_USER_DEPRECATED);
+        }
+    }
+
     /**
      * Login form action.
+     *
+     * @psalm-suppress DeprecatedMethod
      */
     public function loginAction(Request $request): Response
     {
-        $authenticationUtils = $this->get('security.authentication_utils');
+        if ($this->authenticationUtils !== null) {
+            $authenticationUtils = $this->authenticationUtils;
+        } else {
+            $authenticationUtils = $this->get('security.authentication_utils');
+        }
+
         $error = $authenticationUtils->getLastAuthenticationError();
         $lastUsername = $authenticationUtils->getLastUsername();
 
@@ -36,7 +63,12 @@ public function loginAction(Request $request): Response
         Assert::notNull($template, 'Template is not configured.');
 
         $formType = $options['form'] ?? UserLoginType::class;
-        $form = $this->get('form.factory')->createNamed('', $formType);
+
+        if ($this->formFactory !== null) {
+            $form = $this->formFactory->createNamed('', $formType);
+        } else {
+            $form = $this->get('form.factory')->createNamed('', $formType);
+        }
 
         return $this->render($template, [
             'form' => $form->createView(),

diff --git a/src/Sylius/Bundle/UserBundle/Resources/config/services.xml b/src/Sylius/Bundle/UserBundle/Resources/config/services.xml
@@ -40,6 +40,8 @@
 
         <!-- Controllers -->
         <service id="sylius.controller.user_security" class="Sylius\Bundle\UserBundle\Controller\SecurityController">
+            <argument type="service" id="security.authentication_utils" />
+            <argument type="service" id="form.factory" />
             <call method="setContainer">
                 <argument type="service" id="service_container" />
             </call>

diff --git a/src/Sylius/Bundle/UserBundle/Security/UserLogin.php b/src/Sylius/Bundle/UserBundle/Security/UserLogin.php
@@ -58,8 +58,18 @@ public function login(UserInterface $user, ?string $firewallName = null): void
 
     protected function createToken(UserInterface $user, string $firewallName): UsernamePasswordToken
     {
+        /** @deprecated parameter credential was deprecated in Symfony 5.4, so in Sylius 1.11 too, in Sylius 2.0 providing 4 arguments will be prohibited. */
+        if (3 === (new \ReflectionClass(UsernamePasswordToken::class))->getConstructor()->getNumberOfParameters()) {
+            return new UsernamePasswordToken(
+                $user,
+                $firewallName,
+                array_map(/** @param object|string $role */ static function ($role): string { return (string) $role; }, $user->getRoles())
+            );
+        }
+
         return new UsernamePasswordToken(
             $user,
+            null,
             $firewallName,
             array_map(/** @param object|string $role */ static function ($role): string { return (string) $role; }, $user->getRoles())
         );

diff --git a/tests/Controller/AdminProductAjaxTest.php b/tests/Controller/AdminProductAjaxTest.php
@@ -65,7 +65,14 @@ private function authenticateAdminUser(): void
         $session = self::$container->get('session');
         $firewallName = 'admin';
         $firewallContext = 'admin';
-        $token = new UsernamePasswordToken($user, null, $firewallName, $user->getRoles());
+
+        /** @deprecated parameter credential was deprecated in Symfony 5.4, so in Sylius 1.11 too, in Sylius 2.0 providing 4 arguments will be prohibited. */
+        if (3 === (new \ReflectionClass(UsernamePasswordToken::class))->getConstructor()->getNumberOfParameters()) {
+            $token = new UsernamePasswordToken($user, $firewallName, $user->getRoles());
+        } else {
+            $token = new UsernamePasswordToken($user, null, $firewallName, $user->getRoles());
+        }
+
         $session->set(sprintf('_security_%s', $firewallContext), serialize($token));
         $session->save();