keep old format if group_by is not set

jvancoillie · jvancoillie · commit fcdafdd9592f · 2023-02-09T15:11:25.000+01:00
diff --git a/src/Autocomplete/CHANGELOG.md b/src/Autocomplete/CHANGELOG.md
@@ -2,20 +2,18 @@
 
 ## 2.8.0
 
-- Added support for using `Option Group`: the JSON format with option groupe takes two entries
-  `options` and `optgroups`
+-   Added support for using `Option Group`: the JSON format with option groupe takes two entries
+    `options` and `optgroups`
 
 ```json
 {
-  "results": {
-    "options": [
-      {"value": "1", "text": "Pizza", "group_by": ["food"]},
-      {"value": "2", "text": "Banana", "group_by": ["food"]}
-    ],
-    "optgroups":[
-      {"value":"food","label":"food"}
-    ]
-  }
+    "results": {
+        "options": [
+            { "value": "1", "text": "Pizza", "group_by": ["food"] },
+            { "value": "2", "text": "Banana", "group_by": ["food"] }
+        ],
+        "optgroups": [{ "value": "food", "label": "food" }]
+    }
 }
 ```
 
diff --git a/src/Autocomplete/assets/test/controller.test.ts b/src/Autocomplete/assets/test/controller.test.ts
@@ -108,32 +108,28 @@ describe('AutocompleteController', () => {
         fetchMock.mock(
             '/path/to/autocomplete?query=',
             JSON.stringify({
-                results: {
-                    options: [
-                        {
-                            value: 3,
-                            text: 'salad'
-                        },
-                    ]
-                },
+                results: [
+                    {
+                        value: 3,
+                        text: 'salad'
+                    },
+                ]
             }),
         );
 
         fetchMock.mock(
             '/path/to/autocomplete?query=foo',
             JSON.stringify({
-                results: {
-                    options: [
-                        {
-                            value: 1,
-                            text: 'pizza'
-                        },
-                        {
-                            value: 2,
-                            text: 'popcorn'
-                        }
-                    ]
-                },
+                results: [
+                    {
+                        value: 1,
+                        text: 'pizza'
+                    },
+                    {
+                        value: 2,
+                        text: 'popcorn'
+                    }
+                ]
             }),
         );
 
@@ -309,7 +305,7 @@ describe('AutocompleteController', () => {
         });
     });
 
-    it('connect with ajax URL and group_by option', async () => {
+    it('group related options', async () => {
         const container = mountDOM(`
             <label for="the-select">Items</label>
             <select
diff --git a/src/Autocomplete/src/AutocompleteResults.php b/src/Autocomplete/src/AutocompleteResults.php
@@ -23,4 +23,16 @@ public function __construct(
         public bool $hasNextPage,
     ) {
     }
+
+    /**
+     * @return array{options: array{text: string, value: mixed, group_by?: string}, optgroups: array{label: string, value: string}}
+     */
+    public function getResults(): array
+    {
+        if (!empty($this->optgroups)) {
+            return ['options' => $this->options, 'optgroups' => $this->optgroups];
+        }
+
+        return $this->options;
+    }
 }
diff --git a/src/Autocomplete/src/Controller/EntityAutocompleteController.php b/src/Autocomplete/src/Controller/EntityAutocompleteController.php
@@ -50,7 +50,7 @@ public function __invoke(string $alias, Request $request): Response
         }
 
         return new JsonResponse([
-            'results' => ['options' => $data->options, 'optgroups' => $data->optgroups],
+            'results' => $data->getResults(),
             'next_page' => $nextPage,
         ]);
     }
diff --git a/src/Autocomplete/tests/Functional/CustomAutocompleterTest.php b/src/Autocomplete/tests/Functional/CustomAutocompleterTest.php
@@ -35,11 +35,11 @@ public function testItReturnsBasicResults(): void
             ->throwExceptions()
             ->get('/test/autocomplete/custom_product')
             ->assertSuccessful()
-            ->assertJsonMatches('length(results.options)', 3)
-            ->assertJsonMatches('results.options[0].value', $product->getId())
-            ->assertJsonMatches('results.options[0].text', 'foo')
+            ->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.options)', 2)
+            ->assertJsonMatches('length(results)', 2)
         ;
     }
 
@@ -54,8 +54,8 @@ public function testItUsesTheCustomQuery(): void
             ->throwExceptions()
             ->get('/test/autocomplete/custom_product?query=foo')
             ->assertSuccessful()
-            ->assertJsonMatches('length(results.options)', 1)
-            ->assertJsonMatches('results.options[0].text', 'foo')
+            ->assertJsonMatches('length(results)', 1)
+            ->assertJsonMatches('results[0].text', 'foo')
         ;
     }
 
@@ -69,11 +69,11 @@ public function testItOnlySearchedOnSearchableFields(): void
             // search on name or description
             ->get('/test/autocomplete/custom_product?query=foo')
             ->assertSuccessful()
-            ->assertJsonMatches('length(results.options)', 2)
+            ->assertJsonMatches('length(results)', 2)
             ->get('/test/autocomplete/custom_product?query=50')
             // price should not be searched
-            ->assertJsonMatches('length(results.options)', 1)
-            ->assertJsonMatches('results.options[0].text', 'bar')
+            ->assertJsonMatches('length(results)', 1)
+            ->assertJsonMatches('results[0].text', 'bar')
         ;
     }
 
@@ -93,7 +93,7 @@ public function testItEnforcesSecurity(): void
                 ],
             ])
             ->assertSuccessful()
-            ->assertJsonMatches('length(results.options)', 3)
+            ->assertJsonMatches('length(results)', 3)
         ;
     }
 
diff --git a/src/Autocomplete/tests/Functional/FieldAutocompleterTest.php b/src/Autocomplete/tests/Functional/FieldAutocompleterTest.php
@@ -33,11 +33,11 @@ public function testItReturnsBasicResults(): void
             ->throwExceptions()
             ->get('/test/autocomplete/category_autocomplete_type')
             ->assertSuccessful()
-            ->assertJsonMatches('length(results.options)', 2)
-            ->assertJsonMatches('results.options[0].value', (string) $category->getId())
-            ->assertJsonMatches('results.options[0].text', '<strong>foo and baz</strong>')
+            ->assertJsonMatches('length(results)', 2)
+            ->assertJsonMatches('results[0].value', (string) $category->getId())
+            ->assertJsonMatches('results[0].text', '<strong>foo and baz</strong>')
             ->get('/test/autocomplete/category_autocomplete_type?query=bar')
-            ->assertJsonMatches('length(results.options)', 1)
+            ->assertJsonMatches('length(results)', 1)
         ;
     }
 
@@ -51,8 +51,8 @@ public function testItUsesTheCustomQuery(): void
             // query already ONLY returns items matching "foo"
             ->get('/test/autocomplete/category_autocomplete_type?query=bar')
             ->assertSuccessful()
-            ->assertJsonMatches('length(results.options)', 1)
-            ->assertJsonMatches('results.options[0].text', '<strong>foo and bar</strong>')
+            ->assertJsonMatches('length(results)', 1)
+            ->assertJsonMatches('results[0].text', '<strong>foo and bar</strong>')
         ;
     }
 
@@ -74,7 +74,7 @@ public function testItEnforcesSecurity(): void
                 ],
             ])
             ->assertSuccessful()
-            ->assertJsonMatches('length(results.options)', 3)
+            ->assertJsonMatches('length(results)', 3)
         ;
     }
 
@@ -98,7 +98,7 @@ public function testItWorksWithoutAChoiceLabel(): void
             ->throwExceptions()
             ->get('/test/autocomplete/category_no_choice_label_autocomplete_type?query=foo')
             ->assertSuccessful()
-            ->assertJsonMatches('length(results.options)', 5)
+            ->assertJsonMatches('length(results)', 5)
         ;
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ public function __invoke(string $alias, Request $request): Response`
`50`	`50`	`}`
`51`	`51`
`52`	`52`	`return new JsonResponse([`
`53`		`- 'results' => ['options' => $data->options, 'optgroups' => $data->optgroups],`
	`53`	`+ 'results' => $data->getResults(),`
`54`	`54`	`'next_page' => $nextPage,`
`55`	`55`	`]);`
`56`	`56`	`}`
Original file line number	Diff line number	Diff line change
`@@ -35,11 +35,11 @@ public function testItReturnsBasicResults(): void`
`35`	`35`	`->throwExceptions()`
`36`	`36`	`->get('/test/autocomplete/custom_product')`
`37`	`37`	`->assertSuccessful()`
`38`		`- ->assertJsonMatches('length(results.options)', 3)`
`39`		`- ->assertJsonMatches('results.options[0].value', $product->getId())`
`40`		`- ->assertJsonMatches('results.options[0].text', 'foo')`
	`38`	`+ ->assertJsonMatches('length(results)', 3)`
	`39`	`+ ->assertJsonMatches('results[0].value', $product->getId())`
	`40`	`+ ->assertJsonMatches('results[0].text', 'foo')`
`41`	`41`	`->get('/test/autocomplete/custom_product?query=bar')`
`42`		`- ->assertJsonMatches('length(results.options)', 2)`
	`42`	`+ ->assertJsonMatches('length(results)', 2)`
`43`	`43`	`;`
`44`	`44`	`}`
`45`	`45`
`@@ -54,8 +54,8 @@ public function testItUsesTheCustomQuery(): void`
`54`	`54`	`->throwExceptions()`
`55`	`55`	`->get('/test/autocomplete/custom_product?query=foo')`
`56`	`56`	`->assertSuccessful()`
`57`		`- ->assertJsonMatches('length(results.options)', 1)`
`58`		`- ->assertJsonMatches('results.options[0].text', 'foo')`
	`57`	`+ ->assertJsonMatches('length(results)', 1)`
	`58`	`+ ->assertJsonMatches('results[0].text', 'foo')`
`59`	`59`	`;`
`60`	`60`	`}`
`61`	`61`
`@@ -69,11 +69,11 @@ public function testItOnlySearchedOnSearchableFields(): void`
`69`	`69`	`// search on name or description`
`70`	`70`	`->get('/test/autocomplete/custom_product?query=foo')`
`71`	`71`	`->assertSuccessful()`
`72`		`- ->assertJsonMatches('length(results.options)', 2)`
	`72`	`+ ->assertJsonMatches('length(results)', 2)`
`73`	`73`	`->get('/test/autocomplete/custom_product?query=50')`
`74`	`74`	`// price should not be searched`
`75`		`- ->assertJsonMatches('length(results.options)', 1)`
`76`		`- ->assertJsonMatches('results.options[0].text', 'bar')`
	`75`	`+ ->assertJsonMatches('length(results)', 1)`
	`76`	`+ ->assertJsonMatches('results[0].text', 'bar')`
`77`	`77`	`;`
`78`	`78`	`}`
`79`	`79`
`@@ -93,7 +93,7 @@ public function testItEnforcesSecurity(): void`
`93`	`93`	`],`
`94`	`94`	`])`
`95`	`95`	`->assertSuccessful()`
`96`		`- ->assertJsonMatches('length(results.options)', 3)`
	`96`	`+ ->assertJsonMatches('length(results)', 3)`
`97`	`97`	`;`
`98`	`98`	`}`
`99`	`99`
Original file line number	Diff line number	Diff line change
`@@ -33,11 +33,11 @@ public function testItReturnsBasicResults(): void`
`33`	`33`	`->throwExceptions()`
`34`	`34`	`->get('/test/autocomplete/category_autocomplete_type')`
`35`	`35`	`->assertSuccessful()`
`36`		`- ->assertJsonMatches('length(results.options)', 2)`
`37`		`- ->assertJsonMatches('results.options[0].value', (string) $category->getId())`
`38`		`- ->assertJsonMatches('results.options[0].text', '<strong>foo and baz</strong>')`
	`36`	`+ ->assertJsonMatches('length(results)', 2)`
	`37`	`+ ->assertJsonMatches('results[0].value', (string) $category->getId())`
	`38`	`+ ->assertJsonMatches('results[0].text', '<strong>foo and baz</strong>')`
`39`	`39`	`->get('/test/autocomplete/category_autocomplete_type?query=bar')`
`40`		`- ->assertJsonMatches('length(results.options)', 1)`
	`40`	`+ ->assertJsonMatches('length(results)', 1)`
`41`	`41`	`;`
`42`	`42`	`}`
`43`	`43`
`@@ -51,8 +51,8 @@ public function testItUsesTheCustomQuery(): void`
`51`	`51`	`// query already ONLY returns items matching "foo"`
`52`	`52`	`->get('/test/autocomplete/category_autocomplete_type?query=bar')`
`53`	`53`	`->assertSuccessful()`
`54`		`- ->assertJsonMatches('length(results.options)', 1)`
`55`		`- ->assertJsonMatches('results.options[0].text', '<strong>foo and bar</strong>')`
	`54`	`+ ->assertJsonMatches('length(results)', 1)`
	`55`	`+ ->assertJsonMatches('results[0].text', '<strong>foo and bar</strong>')`
`56`	`56`	`;`
`57`	`57`	`}`
`58`	`58`
`@@ -74,7 +74,7 @@ public function testItEnforcesSecurity(): void`
`74`	`74`	`],`
`75`	`75`	`])`
`76`	`76`	`->assertSuccessful()`
`77`		`- ->assertJsonMatches('length(results.options)', 3)`
	`77`	`+ ->assertJsonMatches('length(results)', 3)`
`78`	`78`	`;`
`79`	`79`	`}`
`80`	`80`
`@@ -98,7 +98,7 @@ public function testItWorksWithoutAChoiceLabel(): void`
`98`	`98`	`->throwExceptions()`
`99`	`99`	`->get('/test/autocomplete/category_no_choice_label_autocomplete_type?query=foo')`
`100`	`100`	`->assertSuccessful()`
`101`		`- ->assertJsonMatches('length(results.options)', 5)`
	`101`	`+ ->assertJsonMatches('length(results)', 5)`
`102`	`102`	`;`
`103`	`103`	`}`
`104`	`104`	`}`