[Autocomplete] Apply PHP CS Fixer fixes

Author: jakubtobiasz

src/Autocomplete/src/Checksum/ChecksumCalculator.php

@@ -14,13 +14,12 @@
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpFoundation\UriSigner;
 use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
 use Symfony\UX\Autocomplete\AutocompleteResultsExecutor;
 use Symfony\UX\Autocomplete\AutocompleterRegistry;
-use Symfony\UX\Autocomplete\Checksum\ChecksumCalculator;
-use Symfony\UX\Autocomplete\Form\AutocompleteChoiceTypeExtension;
 use Symfony\UX\Autocomplete\OptionsAwareEntityAutocompleterInterface;
 
 /**
@@ -34,7 +33,7 @@ public function __construct(
         private AutocompleterRegistry $autocompleteFieldRegistry,
         private AutocompleteResultsExecutor $autocompleteResultsExecutor,
         private UrlGeneratorInterface $urlGenerator,
-        private ChecksumCalculator $checksumCalculator,
+        private UriSigner $uriSigner,
     ) {
     }
 
@@ -76,15 +75,13 @@ private function getExtraOptions(Request $request): array
             return [];
         }
 
-        $extraOptions = $this->getDecodedExtraOptions($request->query->getString(self::EXTRA_OPTIONS));
+        ray($request, $this->uriSigner->checkRequest($request));
 
-        if (!\array_key_exists(AutocompleteChoiceTypeExtension::CHECKSUM_KEY, $extraOptions)) {
-            throw new BadRequestHttpException('The extra options are missing the checksum.');
+        if (!$this->uriSigner->checkRequest($request)) {
+            throw new BadRequestHttpException('The URI has been tampered with.');
         }
 
-        $this->validateChecksum($extraOptions[AutocompleteChoiceTypeExtension::CHECKSUM_KEY], $extraOptions);
-
-        return $extraOptions;
+        return $this->getDecodedExtraOptions($request->query->getString(self::EXTRA_OPTIONS));
     }
 
     /**
@@ -94,20 +91,4 @@ private function getDecodedExtraOptions(string $extraOptions): array
     {
         return json_decode(base64_decode($extraOptions), true, flags: \JSON_THROW_ON_ERROR);
     }
-
-    /**
-     * @param array<string, scalar> $extraOptions
-     */
-    private function validateChecksum(string $checksum, array $extraOptions): void
-    {
-        $extraOptionsWithoutChecksum = array_filter(
-            $extraOptions,
-            fn (string $key) => AutocompleteChoiceTypeExtension::CHECKSUM_KEY !== $key,
-            \ARRAY_FILTER_USE_KEY,
-        );
-
-        if ($checksum !== $this->checksumCalculator->calculateForArray($extraOptionsWithoutChecksum)) {
-            throw new BadRequestHttpException('The extra options have been tampered with.');
-        }
-    }
 }

src/Autocomplete/src/Controller/EntityAutocompleteController.php

@@ -21,7 +21,6 @@
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 use Symfony\UX\Autocomplete\AutocompleteResultsExecutor;
 use Symfony\UX\Autocomplete\AutocompleterRegistry;
-use Symfony\UX\Autocomplete\Checksum\ChecksumCalculator;
 use Symfony\UX\Autocomplete\Controller\EntityAutocompleteController;
 use Symfony\UX\Autocomplete\Doctrine\DoctrineRegistryWrapper;
 use Symfony\UX\Autocomplete\Doctrine\EntityMetadataFactory;
@@ -117,7 +116,7 @@ private function registerBasicServices(ContainerBuilder $container): void
                 new Reference('ux.autocomplete.autocompleter_registry'),
                 new Reference('ux.autocomplete.results_executor'),
                 new Reference('router'),
-                new Reference('ux.autocomplete.checksum_calculator'),
+                new Reference('uri_signer'),
             ])
             ->addTag('controller.service_arguments')
         ;
@@ -129,13 +128,6 @@ private function registerBasicServices(ContainerBuilder $container): void
             ])
             ->addTag('maker.command')
         ;
-
-        $container
-            ->register('ux.autocomplete.checksum_calculator', ChecksumCalculator::class)
-            ->setArguments([
-                '%kernel.secret%',
-            ])
-        ;
     }
 
     private function registerFormServices(ContainerBuilder $container): void
@@ -158,7 +150,7 @@ private function registerFormServices(ContainerBuilder $container): void
         $container
             ->register('ux.autocomplete.choice_type_extension', AutocompleteChoiceTypeExtension::class)
             ->setArguments([
-                new Reference('ux.autocomplete.checksum_calculator'),
+                new Reference('uri_signer'),
                 new Reference('translator', ContainerInterface::IGNORE_ON_INVALID_REFERENCE),
             ])
             ->addTag('form.type_extension');

src/Autocomplete/src/DependencyInjection/AutocompleteExtension.php

@@ -16,10 +16,10 @@
 use Symfony\Component\Form\Extension\Core\Type\TextType;
 use Symfony\Component\Form\FormInterface;
 use Symfony\Component\Form\FormView;
+use Symfony\Component\HttpFoundation\UriSigner;
 use Symfony\Component\OptionsResolver\Options;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 use Symfony\Contracts\Translation\TranslatorInterface;
-use Symfony\UX\Autocomplete\Checksum\ChecksumCalculator;
 
 /**
  * Initializes the autocomplete Stimulus controller for any fields with the "autocomplete" option.
@@ -28,10 +28,8 @@
  */
 final class AutocompleteChoiceTypeExtension extends AbstractTypeExtension
 {
-    public const CHECKSUM_KEY = '@checksum';
-
     public function __construct(
-        private readonly ChecksumCalculator $checksumCalculator,
+        private readonly UriSigner $uriSigner,
         private readonly ?TranslatorInterface $translator = null,
     ) {
     }
@@ -86,6 +84,7 @@ public function finishView(FormView $view, FormInterface $form, array $options):
 
         if ($options['extra_options']) {
             $values['url'] = $this->getUrlWithExtraOptions($values['url'], $options['extra_options']);
+            $values['url'] = $this->uriSigner->sign($values['url']);
         }
 
         $values['loading-more-text'] = $this->trans($options['loading_more_text']);
@@ -105,7 +104,6 @@ private function getUrlWithExtraOptions(string $url, array $extraOptions): strin
     {
         $this->validateExtraOptions($extraOptions);
 
-        $extraOptions[self::CHECKSUM_KEY] = $this->checksumCalculator->calculateForArray($extraOptions);
         $extraOptions = base64_encode(json_encode($extraOptions));
 
         return sprintf(

src/Autocomplete/src/Form/AutocompleteChoiceTypeExtension.php

@@ -1,14 +1,15 @@
 <?php
 
-namespace Symfony\UX\Autocomplete\Tests\Fixtures\Autocompleter;
+/*
+ * 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.
+ */
 
-use Doctrine\ORM\EntityRepository;
-use Doctrine\ORM\QueryBuilder;
-use Symfony\Component\HttpFoundation\RequestStack;
-use Symfony\Bundle\SecurityBundle\Security;
-use Symfony\UX\Autocomplete\Doctrine\EntitySearchUtil;
-use Symfony\UX\Autocomplete\EntityAutocompleterInterface;
-use Symfony\UX\Autocomplete\Tests\Fixtures\Entity\Product;
+namespace Symfony\UX\Autocomplete\Tests\Fixtures\Autocompleter;
 
 class CustomGroupByProductAutocompleter extends CustomProductAutocompleter
 {

src/Autocomplete/tests/Fixtures/Autocompleter/CustomGroupByProductAutocompleter.php

@@ -1,5 +1,14 @@
 <?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\UX\Autocomplete\Tests\Fixtures\Autocompleter;
 
 use Doctrine\ORM\EntityRepository;
@@ -14,9 +23,8 @@ class CustomProductAutocompleter implements EntityAutocompleterInterface
 {
     public function __construct(
         private RequestStack $requestStack,
-        private EntitySearchUtil $entitySearchUtil
-    )
-    {
+        private EntitySearchUtil $entitySearchUtil,
+    ) {
     }
 
     public function getEntityClass(): string

src/Autocomplete/tests/Fixtures/Autocompleter/CustomProductAutocompleter.php

@@ -1,10 +1,18 @@
 <?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\UX\Autocomplete\Tests\Fixtures\Entity;
 
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\Common\Collections\Collection;
-use Doctrine\DBAL\Types\Types;
 use Doctrine\ORM\Mapping as ORM;
 
 #[ORM\Entity()]

src/Autocomplete/tests/Fixtures/Entity/Category.php

@@ -1,5 +1,14 @@
 <?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\UX\Autocomplete\Tests\Fixtures\Entity;
 
 use Doctrine\ORM\Mapping as ORM;

src/Autocomplete/tests/Fixtures/Entity/Ingredient.php

@@ -1,5 +1,14 @@
 <?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\UX\Autocomplete\Tests\Fixtures\Entity;
 
 use Doctrine\Common\Collections\ArrayCollection;

src/Autocomplete/tests/Fixtures/Entity/Product.php

@@ -1,30 +1,39 @@
 <?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\UX\Autocomplete\Tests\Fixtures\Factory;
 
 use Doctrine\ORM\EntityRepository;
 use Symfony\UX\Autocomplete\Tests\Fixtures\Entity\Category;
-use Zenstruck\Foundry\RepositoryProxy;
 use Zenstruck\Foundry\ModelFactory;
 use Zenstruck\Foundry\Proxy;
+use Zenstruck\Foundry\RepositoryProxy;
 
 /**
  * @extends ModelFactory<Category>
  *
- * @method static Category|Proxy createOne(array $attributes = [])
- * @method static Category[]|Proxy[] createMany(int $number, array|callable $attributes = [])
- * @method static Category|Proxy find(object|array|mixed $criteria)
- * @method static Category|Proxy findOrCreate(array $attributes)
- * @method static Category|Proxy first(string $sortedField = 'id')
- * @method static Category|Proxy last(string $sortedField = 'id')
- * @method static Category|Proxy random(array $attributes = [])
- * @method static Category|Proxy randomOrCreate(array $attributes = []))
- * @method static Category[]|Proxy[] all()
- * @method static Category[]|Proxy[] findBy(array $attributes)
- * @method static Category[]|Proxy[] randomSet(int $number, array $attributes = []))
- * @method static Category[]|Proxy[] randomRange(int $min, int $max, array $attributes = []))
+ * @method static Category|Proxy                   createOne(array $attributes = [])
+ * @method static Category[]|Proxy[]               createMany(int $number, array|callable $attributes = [])
+ * @method static Category|Proxy                   find(object|array|mixed $criteria)
+ * @method static Category|Proxy                   findOrCreate(array $attributes)
+ * @method static Category|Proxy                   first(string $sortedField = 'id')
+ * @method static Category|Proxy                   last(string $sortedField = 'id')
+ * @method static Category|Proxy                   random(array $attributes = [])
+ * @method static Category|Proxy                   randomOrCreate(array $attributes = []))
+ * @method static Category[]|Proxy[]               all()
+ * @method static Category[]|Proxy[]               findBy(array $attributes)
+ * @method static Category[]|Proxy[]               randomSet(int $number, array $attributes = []))
+ * @method static Category[]|Proxy[]               randomRange(int $min, int $max, array $attributes = []))
  * @method static EntityRepository|RepositoryProxy repository()
- * @method Category|Proxy create(array|callable $attributes = [])
+ * @method        Category|Proxy                   create(array|callable $attributes = [])
  */
 final class CategoryFactory extends ModelFactory
 {