feature #625 [Autocomplete] Allow to edit route (simondaigre, weaverryan)

This PR was merged into the 2.x branch.

Discussion
----------

[Autocomplete] Allow to edit route

| Q             | A
| ------------- | ---
| Bug fix?      | no
| New feature?  | yes
| Tickets       | Fix #...
| License       | MIT

Same issue as #562 but for Autocomplete component.
`@weaverryan` `@kbond` let me know if this implementation is OK for you, then I will add tests, docs & changelog.

Commits
-------

70e2276 [Autocomplete] Tweaking new route customization docs
c3f06ba [Autocomplete] Allow to edit  route

Author: weaverryan

src/Autocomplete/CHANGELOG.md

@@ -5,6 +5,9 @@
 -   Add `assets/src` to `.gitattributes` to exclude them from the installation
 -   Fix minCharacters option default value handling when using a falsy value like 0.
 -   Fix TypeScript types
+-   Add a new `route` parameter to `AsEntityAutocompleteField`, which allows to choose another route for Ajax calls.
+-   Fix minCharacters option default value handling when using a falsy value like 0.
+-   Fix TypeScript types
 
 ## 2.6.0
 

src/Autocomplete/doc/index.rst

@@ -277,6 +277,34 @@ all of the options - separated by the ``delimiter`` - will be sent as a string.
 You *can* add autocompletion to this via the ``autocomplete_url`` option - but you'll
 likely need to create your own :ref:`custom autocomplete endpoint <custom-autocomplete-endpoint>`.
 
+Customizing the AJAX URL/Route
+------------------------------
+
+.. versionadded:: 2.7
+
+    The ability to specify the route was added in Twig Components 2.7.
+
+The default route for the Ajax calls used by the Autocomplete component is ``/autocomplete/{alias}/``.
+Sometimes it may be useful to customize this URL - e.g. so that the URL lives
+under a specific firewall.
+
+To use another route, first declare it:
+
+.. code-block:: yaml
+
+    # config/routes/attributes.yaml
+    ux_entity_autocomplete_admin:
+        controller: ux.autocomplete.entity_autocomplete_controller
+        path: '/admin/autocomplete/{alias}'
+
+Then specify this new route on the attribute::
+
+    // src/Form/FoodAutocompleteField.php
+
+    #[AsEntityAutocompleteField(route: 'ux_entity_autocomplete_admin')]
+    class FoodAutocompleteField
+    // ...
+
 Extending Tom Select
 --------------------
 
@@ -493,10 +521,10 @@ consider registering the needed type extension ``AutocompleteChoiceTypeExtension
 
     // tests/Form/Type/TestedTypeTest.php
     namespace App\Tests\Form\Type;
-    
+
     use Symfony\Component\Form\Test\TypeTestCase;
     use Symfony\UX\Autocomplete\Form\AutocompleteChoiceTypeExtension;
-    
+
     class TestedTypeTest extends TypeTestCase
     {
         protected function getTypeExtensions(): array
@@ -505,7 +533,7 @@ consider registering the needed type extension ``AutocompleteChoiceTypeExtension
                 new AutocompleteChoiceTypeExtension(),
             ];
         }
-    
+
         // ... your tests
     }
 

src/Autocomplete/src/Form/AsEntityAutocompleteField.php

@@ -23,6 +23,7 @@ class AsEntityAutocompleteField
 {
     public function __construct(
         private ?string $alias = null,
+        private string $route = 'ux_entity_autocomplete',
     ) {
     }
 
@@ -31,6 +32,11 @@ public function getAlias(): ?string
         return $this->alias;
     }
 
+    public function getRoute(): string
+    {
+        return $this->route;
+    }
+
     public static function shortName(string $class): string
     {
         $string = new UnicodeString($class);

src/Autocomplete/src/Form/ParentEntityAutocompleteType.php

@@ -41,7 +41,7 @@ public function buildForm(FormBuilderInterface $builder, array $options)
         }
 
         // Use the provided URL, or auto-generate from the provided alias
-        $autocompleteUrl = $options['autocomplete_url'] ?? $this->urlGenerator->generate('ux_entity_autocomplete', [
+        $autocompleteUrl = $options['autocomplete_url'] ?? $this->urlGenerator->generate($attribute->getRoute(), [
             'alias' => $attribute->getAlias() ?: AsEntityAutocompleteField::shortName(\get_class($formType)),
         ]);
 

src/Autocomplete/tests/Fixtures/Form/AlternateRouteAutocompleteType.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace Symfony\UX\Autocomplete\Tests\Fixtures\Form;
+
+use Symfony\Component\Form\AbstractType;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+use Symfony\UX\Autocomplete\Form\AsEntityAutocompleteField;
+use Symfony\UX\Autocomplete\Form\ParentEntityAutocompleteType;
+use Symfony\UX\Autocomplete\Tests\Fixtures\Entity\Ingredient;
+
+#[AsEntityAutocompleteField(route: 'ux_autocomplete_alternate')]
+class AlternateRouteAutocompleteType extends AbstractType
+{
+    public function configureOptions(OptionsResolver $resolver)
+    {
+        $resolver->setDefaults([
+            'class' => Ingredient::class,
+            'choice_label' => function(Ingredient $ingredient) {
+                return $ingredient->getName();
+            },
+            'multiple' => true,
+        ]);
+    }
+
+    public function getParent(): string
+    {
+        return ParentEntityAutocompleteType::class;
+    }
+}

src/Autocomplete/tests/Fixtures/Kernel.php

@@ -158,5 +158,8 @@ protected function configureRoutes(RoutingConfigurator $routes): void
             ->prefix('/test/autocomplete');
 
         $routes->add('test_form', '/test-form')->controller('kernel::testForm');
+
+        $routes->add('ux_autocomplete_alternate', '/alt/test/autocomplete/{alias}')
+            ->controller('ux.autocomplete.entity_autocomplete_controller');
     }
 }

src/Autocomplete/tests/Functional/CustomAutocompleterTest.php

@@ -104,4 +104,22 @@ public function testItReturns404OnBadAlias(): void
             ->assertStatus(404)
         ;
     }
+
+    public function testItWorksWithCustomRoute(): void
+    {
+        $product = ProductFactory::createOne(['name' => 'foo']);
+        ProductFactory::createOne(['name' => 'bar']);
+        ProductFactory::createOne(['name' => 'foo and bar']);
+
+        $this->browser()
+            ->throwExceptions()
+            ->get('/alt/test/autocomplete/custom_product')
+            ->assertSuccessful()
+            ->assertJsonMatches('length(results)', 3)
+            ->assertJsonMatches('results[0].value', $product->getId())
+            ->assertJsonMatches('results[0].text', 'foo')
+            ->get('/test/autocomplete/custom_product?query=bar')
+            ->assertJsonMatches('length(results)', 2)
+        ;
+    }
 }