refactor: add optgroups on AutocompleteResults

Author: jvancoillie

src/Autocomplete/src/AutocompleteResults.php

@@ -14,10 +14,12 @@
 final class AutocompleteResults
 {
     /**
-     * @param list<array{label: string, value: mixed}> $results
+     * @param list<array{text: string, value: mixed, group_by?: string}> $options
+     * @param list<array{label: string, value: string}>                  $optgroups
      */
     public function __construct(
-        public array $results,
+        public array $options,
+        public array $optgroups,
         public bool $hasNextPage,
     ) {
     }

src/Autocomplete/src/AutocompleteResultsExecutor.php

@@ -58,10 +58,8 @@ public function fetchResults(EntityAutocompleterInterface $autocompleter, string
 
         $nbPages = (int) ceil($paginator->count() / $queryBuilder->getMaxResults());
 
-        $results = [];
-
         $options = [];
-        $optgroupLabels = [];
+        $optgroups = [];
 
         if (null !== $groupBy = $autocompleter->getGroupBy()) {
             if (\is_string($groupBy)) {
@@ -78,42 +76,38 @@ public function fetchResults(EntityAutocompleterInterface $autocompleter, string
                     }
                 };
             }
+        }
 
-            if (\is_callable($groupBy)) {
-                foreach ($paginator as $entity) {
-                    $option = [
-                        'value' => $autocompleter->getValue($entity),
-                        'text' => $autocompleter->getLabel($entity),
-                    ];
+        if (\is_callable($groupBy)) {
+            $optgroupLabels = [];
 
-                    $groupLabels = $groupBy($entity, $option['value'], $option['text']);
+            foreach ($paginator as $entity) {
+                $option = [
+                    'value' => $autocompleter->getValue($entity),
+                    'text' => $autocompleter->getLabel($entity),
+                ];
 
-                    if (null !== $groupLabels) {
-                        $groupLabels = \is_array($groupLabels) ? array_map('strval', $groupLabels) : [(string) $groupLabels];
-                        $option['group_by'] = $groupLabels;
-                        $optgroupLabels = array_merge($optgroupLabels, $groupLabels);
-                    }
+                $groupLabels = $groupBy($entity, $option['value'], $option['text']);
 
-                    $options[] = $option;
+                if (null !== $groupLabels) {
+                    $groupLabels = \is_array($groupLabels) ? array_map('strval', $groupLabels) : [(string) $groupLabels];
+                    $option['group_by'] = $groupLabels;
+                    $optgroupLabels = array_merge($optgroupLabels, $groupLabels);
                 }
 
-                $results = [
-                    'options' => $options,
-                    'optgroups' => array_map(fn (string $label) => ['value' => $label, 'label' => $label],
-                        array_unique($optgroupLabels)),
-                ];
+                $options[] = $option;
             }
+
+            $optgroups = array_map(fn (string $label) => ['value' => $label, 'label' => $label], array_unique($optgroupLabels));
         } else {
             foreach ($paginator as $entity) {
                 $options[] = [
                     'value' => $autocompleter->getValue($entity),
                     'text' => $autocompleter->getLabel($entity),
                 ];
             }
-
-            $results = ['options' => $options];
         }
 
-        return new AutocompleteResults($results, $page < $nbPages);
+        return new AutocompleteResults($options, $optgroups, $page < $nbPages);
     }
 }

src/Autocomplete/src/Controller/EntityAutocompleteController.php

@@ -52,7 +52,7 @@ public function __invoke(string $alias, Request $request): Response
         }
 
         return new JsonResponse([
-            'results' => $data->results,
+            'results' => ['options' => $data->options, 'optgroups' => $data->optgroups],
             'next_page' => $nextPage,
         ]);
     }

src/Autocomplete/tests/Integration/WiringTest.php

@@ -47,7 +47,7 @@ public function testWiringWithoutForm(): void
         $executor = $kernel->getContainer()->get('public.results_executor');
         $autocompleter = $kernel->getContainer()->get(CustomProductAutocompleter::class);
         $data = $executor->fetchResults($autocompleter, '', 1);
-        $this->assertCount(3, $data->results['options']);
+        $this->assertCount(3, $data->options);
         $this->assertFalse($data->hasNextPage);
     }
 
@@ -63,16 +63,16 @@ public function testWiringWithManyResults(): void
         $executor = $kernel->getContainer()->get('public.results_executor');
         $autocompleter = $kernel->getContainer()->get(CustomProductAutocompleter::class);
         $data = $executor->fetchResults($autocompleter, '', 1);
-        $this->assertCount(10, $data->results['options']);
+        $this->assertCount(10, $data->options);
         $this->assertTrue($data->hasNextPage);
         $data = $executor->fetchResults($autocompleter, '', 2);
-        $this->assertCount(10, $data->results['options']);
+        $this->assertCount(10, $data->options);
         $this->assertTrue($data->hasNextPage);
         $data = $executor->fetchResults($autocompleter, '', 3);
-        $this->assertCount(2, $data->results['options']);
+        $this->assertCount(2, $data->options);
         $this->assertFalse($data->hasNextPage);
         $data = $executor->fetchResults($autocompleter, '', 4);
-        $this->assertCount(0, $data->results['options']);
+        $this->assertCount(0, $data->options);
         $this->assertFalse($data->hasNextPage);
     }
 
@@ -92,7 +92,7 @@ public function testWiringWithoutFormAndGroupByOption(): void
         $executor = $kernel->getContainer()->get('public.results_executor');
         $autocompleter = $kernel->getContainer()->get(CustomGroupByProductAutocompleter::class);
         $data = $executor->fetchResults($autocompleter, '', 1);
-        $this->assertCount(3, $data->results['options']);
-        $this->assertCount(2, $data->results['optgroups']);
+        $this->assertCount(3, $data->options);
+        $this->assertCount(2, $data->optgroups);
     }
 }