refactor #12034 [API][Product] Change identifier for shop endpoint from slug to code (GSadee)

lchrusciel · web-flow · commit 42987c8e3041 · 2020-11-13T12:07:43.000+01:00
This PR was merged into the 1.9-dev branch. Discussion ---------- | Q | A | --------------- | ----- | Branch? | master | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Related tickets | based on Sylius/Sylius#11925 | License | MIT Commits ------- 58ce6bd3d4745cb281ed97374f2324fd9e0af66d [API][Product] Change identifier for shop endpoint from slug to code
diff --git a/DataProvider/ProductItemDataProvider.php b/DataProvider/ProductItemDataProvider.php
@@ -47,13 +47,11 @@ public function getItem(string $resourceClass, $id, string $operationName = null
         }
 
         Assert::keyExists($context, ContextKeys::CHANNEL);
-        Assert::keyExists($context, ContextKeys::LOCALE_CODE);
 
         /** @var ChannelInterface $channel */
         $channel = $context[ContextKeys::CHANNEL];
-        $locale = $context[ContextKeys::LOCALE_CODE];
 
-        return $this->productRepository->findOneByChannelAndSlug($channel, $locale, $id);
+        return $this->productRepository->findOneByChannelAndCode($channel, $id);
     }
 
     public function supports(string $resourceClass, string $operationName = null, array $context = []): bool
diff --git a/Resources/config/api_resources/Product.xml b/Resources/config/api_resources/Product.xml
@@ -71,7 +71,7 @@
                 <attribute name="method">GET</attribute>
                 <attribute name="path">/shop/products/{id}</attribute>
                 <attribute name="openapi_context">
-                    <attribute name="summary">Use $slug to retrieve a product resource.</attribute>
+                    <attribute name="summary">Use code to retrieve a product resource.</attribute>
                 </attribute>
             </itemOperation>
 
diff --git a/spec/DataProvider/ProductItemDataProviderSpec.php b/spec/DataProvider/ProductItemDataProviderSpec.php
@@ -41,25 +41,7 @@ function it_throws_an_exception_if_context_has_no_channel(): void
     {
         $this
             ->shouldThrow(\InvalidArgumentException::class)
-            ->during('getItem', [
-                ProductInterface::class,
-                'ford',
-                Request::METHOD_GET,
-                [ContextKeys::LOCALE_CODE => 'en_US'],
-            ])
-        ;
-    }
-
-    function it_throws_an_exception_if_context_has_no_locale_code(ChannelInterface $channel): void
-    {
-        $this
-            ->shouldThrow(\InvalidArgumentException::class)
-            ->during('getItem', [
-                ProductInterface::class,
-                'ford',
-                Request::METHOD_GET,
-                [ContextKeys::CHANNEL => $channel],
-            ])
+            ->during('getItem', [ProductInterface::class, 'ford', Request::METHOD_GET, []])
         ;
     }
 
@@ -75,12 +57,7 @@ function it_provides_product_by_code_for_a_logged_in_admin_user(
         $productRepository->findOneByCode('FORD_FOCUS')->willReturn($product);
 
         $this
-            ->getItem(
-                ProductInterface::class,
-                'FORD_FOCUS',
-                Request::METHOD_GET,
-                []
-            )
+            ->getItem(ProductInterface::class, 'FORD_FOCUS', Request::METHOD_GET, [])
             ->shouldReturn($product)
         ;
     }
@@ -95,7 +72,7 @@ function it_provides_product_by_slug_for_a_logged_in_shop_user(
         $userContext->getUser()->willReturn($user);
         $user->getRoles()->willReturn([]);
 
-        $productRepository->findOneByChannelAndSlug($channel, 'en_US', 'FORD_FOCUS')->willReturn($product);
+        $productRepository->findOneByChannelAndCode($channel, 'FORD_FOCUS')->willReturn($product);
 
         $this
             ->getItem(
@@ -104,7 +81,6 @@ function it_provides_product_by_slug_for_a_logged_in_shop_user(
                 Request::METHOD_GET,
                 [
                     ContextKeys::CHANNEL => $channel,
-                    ContextKeys::LOCALE_CODE => 'en_US',
                 ]
             )
             ->shouldReturn($product)
@@ -119,7 +95,7 @@ function it_provides_product_by_slug_if_there_is_no_logged_in_user(
     ): void {
         $userContext->getUser()->willReturn(null);
 
-        $productRepository->findOneByChannelAndSlug($channel, 'en_US', 'FORD_FOCUS')->willReturn($product);
+        $productRepository->findOneByChannelAndCode($channel, 'FORD_FOCUS')->willReturn($product);
 
         $this
             ->getItem(
@@ -128,7 +104,6 @@ function it_provides_product_by_slug_if_there_is_no_logged_in_user(
                 Request::METHOD_GET,
                 [
                     ContextKeys::CHANNEL => $channel,
-                    ContextKeys::LOCALE_CODE => 'en_US',
                 ]
             )
             ->shouldReturn($product)

Original file line number	Diff line number	Diff line change
`@@ -47,13 +47,11 @@ public function getItem(string $resourceClass, $id, string $operationName = null`
`47`	`47`	`}`
`48`	`48`
`49`	`49`	`Assert::keyExists($context, ContextKeys::CHANNEL);`
`50`		`- Assert::keyExists($context, ContextKeys::LOCALE_CODE);`
`51`	`50`
`52`	`51`	`/** @var ChannelInterface $channel */`
`53`	`52`	`$channel = $context[ContextKeys::CHANNEL];`
`54`		`- $locale = $context[ContextKeys::LOCALE_CODE];`
`55`	`53`
`56`		`- return $this->productRepository->findOneByChannelAndSlug($channel, $locale, $id);`
	`54`	`+ return $this->productRepository->findOneByChannelAndCode($channel, $id);`
`57`	`55`	`}`
`58`	`56`
`59`	`57`	`public function supports(string $resourceClass, string $operationName = null, array $context = []): bool`