NEXT-7952 - Merge request body and request parameter

With this change the request parameter and the request body are merged for http methods other than GET. This is needed to e.g. have the "limit=1" available in the payload for the search of products, etc. Closes #429
shopwareBoostDay · Dec 16, 2021 · 59d0db9 · 59d0db9
1 parent de7d7ec
commit 59d0db9
Show file tree

Hide file tree

Showing 3 changed files with 102 additions and 1 deletion.
diff --git a/...sed/2021-12-16-merge-request-body-and-request-parameter-for-admin-api-search.md b/...sed/2021-12-16-merge-request-body-and-request-parameter-for-admin-api-search.md
@@ -0,0 +1,9 @@
+---
+title: Merge request body and request parameter for admin API search
+issue: NEXT-7952
+author: Manuel Selbach
+author_email: [email protected] 
+author_github: manuelselbach
+___
+# Administration
+* With this change the request parameter and the request body are merged for http methods other than GET and with that it is possible to have a limited response for e.g. a product search in the administration.
diff --git a/src/Core/Content/Test/Product/Api/ProductApiTest.php b/src/Core/Content/Test/Product/Api/ProductApiTest.php
@@ -233,6 +233,97 @@ public function testIncludesWithJsonApi(): void
         static::assertEmpty($products['included']);
     }
 
+    public function testApiWithLimitSetByQueryParameter(): void
+    {
+        $ids = new TestDataCollection(Context::createDefaultContext());
+
+        $data = [
+            [
+                'id' => $ids->create('product'),
+                'name' => 'test',
+                'productNumber' => Uuid::randomHex(),
+                'stock' => 10,
+                'price' => [
+                    ['currencyId' => Defaults::CURRENCY, 'gross' => 15, 'net' => 10, 'linked' => false],
+                ],
+                'manufacturer' => ['name' => 'test'],
+                'tax' => ['name' => 'test', 'taxRate' => 15],
+            ],
+            [
+                'id' => $ids->create('product_2'),
+                'name' => 'test 2',
+                'productNumber' => Uuid::randomHex(),
+                'stock' => 5,
+                'price' => [
+                    ['currencyId' => Defaults::CURRENCY, 'gross' => 15, 'net' => 10, 'linked' => false],
+                ],
+                'manufacturer' => ['name' => 'test'],
+                'tax' => ['name' => 'test', 'taxRate' => 15],
+            ],
+        ];
+
+        $this->getContainer()->get('product.repository')
+            ->create($data, Context::createDefaultContext());
+
+        $this->getBrowser()->request('POST', '/api/search/product?limit=1', [], [], [], '');
+
+        $response = $this->getBrowser()->getResponse();
+        static::assertSame(Response::HTTP_OK, $response->getStatusCode());
+
+        $products = json_decode($response->getContent(), true);
+        static::assertCount(1, $products['data']);
+    }
+
+    public function testApiWithLimitSetByBody(): void
+    {
+        $ids = new TestDataCollection(Context::createDefaultContext());
+
+        $data = [
+            [
+                'id' => $ids->create('product'),
+                'name' => 'test',
+                'productNumber' => Uuid::randomHex(),
+                'stock' => 10,
+                'price' => [
+                    ['currencyId' => Defaults::CURRENCY, 'gross' => 15, 'net' => 10, 'linked' => false],
+                ],
+                'manufacturer' => ['name' => 'test'],
+                'tax' => ['name' => 'test', 'taxRate' => 15],
+            ],
+            [
+                'id' => $ids->create('product_2'),
+                'name' => 'test 2',
+                'productNumber' => Uuid::randomHex(),
+                'stock' => 5,
+                'price' => [
+                    ['currencyId' => Defaults::CURRENCY, 'gross' => 15, 'net' => 10, 'linked' => false],
+                ],
+                'manufacturer' => ['name' => 'test'],
+                'tax' => ['name' => 'test', 'taxRate' => 15],
+            ],
+        ];
+
+        $this->getContainer()->get('product.repository')
+            ->create($data, Context::createDefaultContext());
+
+        $this->getBrowser()->request(
+            'POST',
+            '/api/search/product',
+            [],
+            [],
+            [],
+            json_encode([
+                'limit' => 1,
+            ])
+        );
+
+        $response = $this->getBrowser()->getResponse();
+        static::assertSame(Response::HTTP_OK, $response->getStatusCode());
+
+        $products = json_decode($response->getContent(), true);
+        static::assertCount(1, $products['data']);
+    }
+
     public function testIncludesWithRelationships(): void
     {
         $ids = new TestDataCollection(Context::createDefaultContext());

diff --git a/src/Core/Framework/DataAbstractionLayer/Search/RequestCriteriaBuilder.php b/src/Core/Framework/DataAbstractionLayer/Search/RequestCriteriaBuilder.php
@@ -55,7 +55,8 @@ public function handleRequest(Request $request, Criteria $criteria, EntityDefini
         if ($request->getMethod() === Request::METHOD_GET) {
             $criteria = $this->fromArray($request->query->all(), $criteria, $definition, $context, $request->attributes->getInt('version'));
         } else {
-            $criteria = $this->fromArray($request->request->all(), $criteria, $definition, $context, $request->attributes->getInt('version'));
+            $payload = array_merge($request->request->all(), $request->query->all());
+            $criteria = $this->fromArray($payload, $criteria, $definition, $context, $request->attributes->getInt('version'));
         }
 
         $this->validator->validate($definition->getEntityName(), $criteria, $context);