feature Sylius#13339 Add Support for Symfony 5.4 (AdamKasp)

This PR was merged into the 1.11-dev branch.

Discussion
----------

| Q               | A
| --------------- | -----
| Branch?         |  master
| Bug fix?        | no
| New feature?    |yes
| BC breaks?      | no
| Deprecations?   | no
| License         | MIT

<!--
 - Bug fixes must be submitted against the 1.10 branch
 - Features and deprecations must be submitted against the master branch
 - Make sure that the correct base branch is set

 To be sure you are not breaking any Backward Compatibilities, check the documentation:
 https://docs.sylius.com/en/latest/book/organization/backward-compatibility-promise.html
-->

Commits
-------

28a02a6 Prepare Sylius for support Symfony 5.4
d2c39e4 remove usage of symfony internal method
fef6243 bump symofny verion from 5.4.0-RC1 to 5.4
6339528 update argument in UsernamePasswordToken
2964e0e make workorounds over deprecated method in symofny 5.4

.github/workflows/application.yml

@@ -32,7 +32,7 @@ jobs:
             fail-fast: false
             matrix:
                 php: ["7.4", "8.0"]
-                symfony: ["^4.4", "5.2.*", "5.3.*"]
+                symfony: ["^4.4", "5.2.*", "5.3.*", "5.4.*"]
 
         steps:
             -
@@ -120,7 +120,7 @@ jobs:
             fail-fast: false
             matrix:
                 php: ["7.4", "8.0"]
-                symfony: ["^4.4", "5.2.*", "5.3.*"]
+                symfony: ["^4.4", "5.2.*", "5.3.*", "5.4.*"]
                 node: ["14.x"]
                 mysql: ["5.7", "8.0"]
 
@@ -249,7 +249,7 @@ jobs:
             fail-fast: false
             matrix:
                 php: ["7.4", "8.0"]
-                symfony: ["^4.4", "5.2.*", "5.3.*"]
+                symfony: ["^4.4", "5.2.*", "5.3.*", "5.4.*"]
                 node: ["14.x"]
                 mysql: ["5.7", "8.0"]
 

.github/workflows/packages.yml

@@ -49,7 +49,7 @@ jobs:
             fail-fast: false
             matrix:
                 php: ["7.4", "8.0"]
-                symfony: ["^4.4", "5.2.*"]
+                symfony: ["^4.4", "5.2.*", "5.3.*", "5.4.*"]
                 package: "${{ fromJson(needs.list.outputs.packages) }}"
 
         steps:

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>
 

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);
     }
 

src/Sylius/Bundle/ApiBundle/Controller/Payment/GetPaymentConfiguration.php

@@ -38,7 +38,10 @@ public function __construct(
     public function __invoke(Request $request): JsonResponse
     {
         /** @var PaymentInterface|null $payment */
-        $payment = $this->paymentRepository->findOneByOrderToken($request->get('paymentId'), $request->get('id'));
+        $payment = $this->paymentRepository->findOneByOrderToken(
+            $request->attributes->get('paymentId'),
+            $request->attributes->get('id')
+        );
 
         Assert::notNull($payment);
 

src/Sylius/Bundle/ApiBundle/Controller/UploadAvatarImageAction.php

@@ -57,7 +57,7 @@ public function __invoke(Request $request): ImageInterface
         $image->setFile($file);
 
         /** @var string $ownerIri */
-        $ownerIri = $request->get('owner');
+        $ownerIri = $request->request->get('owner');
         Assert::notEmpty($ownerIri);
 
         /** @var ResourceInterface|AdminUserInterface $owner */

src/Sylius/Bundle/CoreBundle/Command/SetupCommand.php

@@ -112,7 +112,7 @@ function ($value): string {
                     /** @var ConstraintViolationListInterface $errors */
                     $errors = $this->getContainer()->get('validator')->validate((string) $value, [new Email(), new NotBlank()]);
                     foreach ($errors as $error) {
-                        throw new \DomainException($error->getMessage());
+                        throw new \DomainException((string) $error->getMessage());
                     }
 
                     return $value;
@@ -191,7 +191,7 @@ function ($value): string {
                 /** @var ConstraintViolationListInterface $errors */
                 $errors = $this->getContainer()->get('validator')->validate($value, [new NotBlank()]);
                 foreach ($errors as $error) {
-                    throw new \DomainException($error->getMessage());
+                    throw new \DomainException((string) $error->getMessage());
                 }
 
                 return $value;

src/Sylius/Bundle/CoreBundle/Controller/ProductTaxonController.php

@@ -30,13 +30,14 @@ class ProductTaxonController extends ResourceController
      * @throws HttpException
      *
      * @deprecated This ajax action is deprecated and will be removed in Sylius 2.0 - use ProductTaxonController::updateProductTaxonsPositionsAction instead.
+     *
+     * @psalm-suppress DeprecatedMethod
      */
     public function updatePositionsAction(Request $request): Response
     {
         $configuration = $this->requestConfigurationFactory->create($this->metadata, $request);
         $this->isGrantedOr403($configuration, ResourceActions::UPDATE);
-        $productTaxons = $request->get('productTaxons');
-
+        $productTaxons = $this->getParameterFromRequest($request,'productTaxons');
         $this->validateCsrfProtection($request, $configuration);
 
         if ($this->shouldProductsPositionsBeUpdated($request, $productTaxons)) {
@@ -55,11 +56,14 @@ public function updatePositionsAction(Request $request): Response
         return new JsonResponse();
     }
 
+    /**
+     * @psalm-suppress DeprecatedMethod
+     */
     public function updateProductTaxonsPositionsAction(Request $request): Response
     {
         $configuration = $this->requestConfigurationFactory->create($this->metadata, $request);
         $this->isGrantedOr403($configuration, ResourceActions::UPDATE);
-        $productTaxons = $request->get('productTaxons');
+        $productTaxons = $this->getParameterFromRequest($request,'productTaxons');
 
         $this->validateCsrfProtection($request, $configuration);
 
@@ -103,4 +107,27 @@ private function updatePositions(string $position, int $id): void
         $productTaxonFromBase = $this->repository->findOneBy(['id' => $id]);
         $productTaxonFromBase->setPosition((int) $position);
     }
+
+    /**
+     * @return mixed
+     *
+     * @deprecated This function will be removed in Sylius 2.0, since Symfony 5.4, use explicit input sources instead
+     * based on Symfony\Component\HttpFoundation\Request::get
+     */
+    private function getParameterFromRequest(Request $request, string $key)
+    {
+        if ($request !== $result = $request->attributes->get($key, $request)) {
+            return $result;
+        }
+
+        if ($request->query->has($key)) {
+            return $request->query->all()[$key];
+        }
+
+        if ($request->request->has($key)) {
+            return $request->request->all()[$key];
+        }
+
+        return null;
+    }
 }

src/Sylius/Bundle/CoreBundle/Controller/ProductVariantController.php

@@ -25,12 +25,13 @@ class ProductVariantController extends ResourceController
 {
     /**
      * @throws HttpException
+     * @psalm-suppress DeprecatedMethod
      */
     public function updatePositionsAction(Request $request): Response
     {
         $configuration = $this->requestConfigurationFactory->create($this->metadata, $request);
         $this->isGrantedOr403($configuration, ResourceActions::UPDATE);
-        $productVariantsToUpdate = $request->get('productVariants');
+        $productVariantsToUpdate = $this->getParameterFromRequest($request, 'productVariants');
 
         if ($configuration->isCsrfProtectionEnabled() && !$this->isCsrfTokenValid('update-product-variant-position', (string) $request->request->get('_csrf_token'))) {
             throw new HttpException(Response::HTTP_FORBIDDEN, 'Invalid csrf token.');
@@ -54,4 +55,27 @@ public function updatePositionsAction(Request $request): Response
 
         return new JsonResponse();
     }
+
+    /**
+     * @return mixed
+     *
+     * @deprecated This function will be removed in Sylius 2.0, since Symfony 5.4, use explicit input sources instead
+     * based on Symfony\Component\HttpFoundation\Request::get
+     */
+    private function getParameterFromRequest(Request $request, string $key)
+    {
+        if ($request !== $result = $request->attributes->get($key, $request)) {
+            return $result;
+        }
+
+        if ($request->query->has($key)) {
+            return $request->query->all()[$key];
+        }
+
+        if ($request->request->has($key)) {
+            return $request->request->all()[$key];
+        }
+
+        return null;
+    }
 }

src/Sylius/Bundle/CoreBundle/Resources/config/services.xml

@@ -243,5 +243,7 @@
         <service class="Sylius\Bundle\CoreBundle\Mailer\OrderEmailManager" id="sylius.mailer.order_email_manager">
             <argument type="service" id="sylius.email_sender" />
         </service>
+
+        <service id="security.authentication_manager" alias="security.authentication.manager" />
     </services>
 </container>

src/Sylius/Bundle/CoreBundle/Security/UserImpersonator.php

@@ -40,12 +40,22 @@ public function __construct(SessionInterface $session, string $firewallContextNa
 
     public function impersonate(UserInterface $user): void
     {
-        $token = new UsernamePasswordToken(
-            $user,
-            $user->getPassword(),
-            $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();
 

src/Sylius/Bundle/OrderBundle/Controller/OrderController.php

@@ -127,14 +127,17 @@ public function saveAction(Request $request): Response
         );
     }
 
+    /**
+     * @psalm-suppress DeprecatedMethod
+     */
     public function clearAction(Request $request): Response
     {
         $configuration = $this->requestConfigurationFactory->create($this->metadata, $request);
 
         $this->isGrantedOr403($configuration, ResourceActions::DELETE);
         $resource = $this->getCurrentCart();
 
-        if ($configuration->isCsrfProtectionEnabled() && !$this->isCsrfTokenValid((string) $resource->getId(), $request->get('_csrf_token'))) {
+        if ($configuration->isCsrfProtectionEnabled() && !$this->isCsrfTokenValid((string) $resource->getId(), $this->getParameterFromRequest($request, '_csrf_token'))) {
             throw new HttpException(Response::HTTP_FORBIDDEN, 'Invalid csrf token.');
         }
 
@@ -194,4 +197,27 @@ protected function getEventDispatcher(): EventDispatcherInterface
     {
         return $this->container->get('event_dispatcher');
     }
+
+    /**
+     * @return mixed
+     *
+     * @deprecated This function will be removed in Sylius 2.0, since Symfony 5.4, use explicit input sources instead
+     * based on Symfony\Component\HttpFoundation\Request::get
+     */
+    private function getParameterFromRequest(Request $request, string $key)
+    {
+        if ($request !== $result = $request->attributes->get($key, $request)) {
+            return $result;
+        }
+
+        if ($request->query->has($key)) {
+            return $request->query->all()[$key];
+        }
+
+        if ($request->request->has($key)) {
+            return $request->request->all()[$key];
+        }
+
+        return null;
+    }
 }

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),
         ]);

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>