FRW-7936 Allow to provide store name as part of URL path. (#11121)

FRW-7936 Allow to provide store name as part of URL path.
spryker · Nov 28, 2024 · fac365d · fac365d
1 parent fbbc2f4
commit fac365d
Show file tree

Hide file tree

Showing 14 changed files with 260 additions and 6 deletions.
diff --git a/composer.json b/composer.json
@@ -12,12 +12,15 @@
         "spryker/laminas": "^1.0.0",
         "spryker/log": "^3.0.0",
         "spryker/router-extension": "^1.0.0",
+        "spryker/store": "^1.19.0",
         "spryker/symfony": "^3.5.0"
     },
     "require-dev": {
         "spryker/application": "*",
         "spryker/code-sniffer": "*",
+        "spryker/config": "*",
         "spryker/event-dispatcher": "*",
+        "spryker/storage": "*",
         "spryker/testify": "*",
         "spryker/util-text": "*"
     },

diff --git a/src/Spryker/Shared/Router/RouterConstants.php b/src/Spryker/Shared/Router/RouterConstants.php
@@ -144,4 +144,14 @@ interface RouterConstants
      * @var string
      */
     public const PROJECT_NAMESPACES = 'PROJECT_NAMESPACES';
+
+    /**
+     * Specification:
+     *  - Returns true if the store routing is enabled.
+     *
+     * @api
+     *
+     * @var string
+     */
+    public const IS_STORE_ROUTING_ENABLED = 'ROUTER:IS_STORE_ROUTING_ENABLED';
 }
diff --git a/src/Spryker/Shared/Router/Transfer/router.transfer.xml b/src/Spryker/Shared/Router/Transfer/router.transfer.xml
@@ -10,4 +10,8 @@
     <transfer name="RouterActionCollection">
         <property name="actions" type="string[]" singular="action"/>
     </transfer>
+
+    <transfer name="Store">
+        <property name="name" type="string"/>
+    </transfer>
 </transfers>
diff --git a/src/Spryker/Yves/Router/Dependency/Client/RouterToStoreClientBridge.php b/src/Spryker/Yves/Router/Dependency/Client/RouterToStoreClientBridge.php
@@ -0,0 +1,34 @@
+<?php
+
+/**
+ * Copyright © 2016-present Spryker Systems GmbH. All rights reserved.
+ * Use of this software requires acceptance of the Evaluation License Agreement. See LICENSE file.
+ */
+
+namespace Spryker\Yves\Router\Dependency\Client;
+
+use Generated\Shared\Transfer\StoreTransfer;
+
+class RouterToStoreClientBridge implements RouterToStoreClientInterface
+{
+    /**
+     * @var \Spryker\Client\Store\StoreClientInterface
+     */
+    protected $storeClient;
+
+    /**
+     * @param \Spryker\Client\Store\StoreClientInterface $storeClient
+     */
+    public function __construct($storeClient)
+    {
+        $this->storeClient = $storeClient;
+    }
+
+    /**
+     * @return \Generated\Shared\Transfer\StoreTransfer
+     */
+    public function getCurrentStore(): StoreTransfer
+    {
+        return $this->storeClient->getCurrentStore();
+    }
+}
diff --git a/src/Spryker/Yves/Router/Dependency/Client/RouterToStoreClientInterface.php b/src/Spryker/Yves/Router/Dependency/Client/RouterToStoreClientInterface.php
@@ -0,0 +1,18 @@
+<?php
+
+/**
+ * Copyright © 2016-present Spryker Systems GmbH. All rights reserved.
+ * Use of this software requires acceptance of the Evaluation License Agreement. See LICENSE file.
+ */
+
+namespace Spryker\Yves\Router\Dependency\Client;
+
+use Generated\Shared\Transfer\StoreTransfer;
+
+interface RouterToStoreClientInterface
+{
+    /**
+     * @return \Generated\Shared\Transfer\StoreTransfer
+     */
+    public function getCurrentStore(): StoreTransfer;
+}
diff --git a/src/Spryker/Yves/Router/Plugin/RouterEnhancer/StorePrefixRouterEnhancerPlugin.php b/src/Spryker/Yves/Router/Plugin/RouterEnhancer/StorePrefixRouterEnhancerPlugin.php
@@ -13,9 +13,15 @@
 
 /**
  * @method \Spryker\Yves\Router\RouterConfig getConfig()
+ * @method \Spryker\Yves\Router\RouterFactory getFactory()
  */
 class StorePrefixRouterEnhancerPlugin extends AbstractRouterEnhancerPlugin
 {
+    /**
+     * @var string
+     */
+    protected const PARAMETER_STORE = 'store';
+
     /**
      * @var string|null
      */
@@ -52,7 +58,7 @@ public function beforeMatch(string $pathinfo, RequestContext $requestContext): s
     public function afterMatch(array $parameters, RequestContext $requestContext): array
     {
         if ($this->currentStore !== null) {
-            $parameters['store'] = $this->currentStore;
+            $parameters[static::PARAMETER_STORE] = $this->currentStore;
         }
 
         return $parameters;
@@ -83,11 +89,11 @@ public function afterGenerate(string $url, RequestContext $requestContext, int $
      */
     protected function findStore(RequestContext $requestContext): ?string
     {
-        if ($requestContext->hasParameter('store')) {
-            return $requestContext->getParameter('store');
-        }
-
-        return null;
+        return $requestContext->hasParameter(static::PARAMETER_STORE) && $requestContext->getParameter(static::PARAMETER_STORE) !== null
+            ? $requestContext->getParameter(static::PARAMETER_STORE)
+            : ($this->getConfig()->isStoreRoutingEnabled()
+                ? $this->getFactory()->getStoreClient()->getCurrentStore()->getNameOrFail()
+                : null);
     }
 
     /**

diff --git a/src/Spryker/Yves/Router/RouterConfig.php b/src/Spryker/Yves/Router/RouterConfig.php
@@ -136,4 +136,17 @@ public function getAllowedStores(): array
             'US',
         ];
     }
+
+    /**
+     * Specification:
+     * - Returns true if the store routing is enabled.
+     *
+     * @api
+     *
+     * @return bool
+     */
+    public function isStoreRoutingEnabled(): bool
+    {
+        return $this->get(RouterConstants::IS_STORE_ROUTING_ENABLED, false);
+    }
 }
diff --git a/src/Spryker/Yves/Router/RouterDependencyProvider.php b/src/Spryker/Yves/Router/RouterDependencyProvider.php
@@ -9,6 +9,7 @@
 
 use Spryker\Yves\Kernel\AbstractBundleDependencyProvider;
 use Spryker\Yves\Kernel\Container;
+use Spryker\Yves\Router\Dependency\Client\RouterToStoreClientBridge;
 
 /**
  * @method \Spryker\Yves\Router\RouterConfig getConfig()
@@ -35,6 +36,11 @@ class RouterDependencyProvider extends AbstractBundleDependencyProvider
      */
     public const ROUTER_ENHANCER_PLUGINS = 'ROUTER_ENHANCER_PLUGINS';
 
+    /**
+     * @var string
+     */
+    public const CLIENT_STORE = 'CLIENT_STORE';
+
     /**
      * @param \Spryker\Yves\Kernel\Container $container
      *
@@ -46,6 +52,7 @@ public function provideDependencies(Container $container)
         $container = $this->addRouterEnhancerPlugins($container);
         $container = $this->addRouteProvider($container);
         $container = $this->addPostAddRouteManipulator($container);
+        $container = $this->addStoreClient($container);
 
         return $container;
     }
@@ -137,4 +144,18 @@ protected function getPostAddRouteManipulator(): array
     {
         return [];
     }
+
+    /**
+     * @param \Spryker\Yves\Kernel\Container $container
+     *
+     * @return \Spryker\Yves\Kernel\Container
+     */
+    protected function addStoreClient(Container $container): Container
+    {
+        $container->set(static::CLIENT_STORE, function (Container $container) {
+            return new RouterToStoreClientBridge($container->getLocator()->store()->client());
+        });
+
+        return $container;
+    }
 }
diff --git a/src/Spryker/Yves/Router/RouterFactory.php b/src/Spryker/Yves/Router/RouterFactory.php
@@ -10,6 +10,7 @@
 use Spryker\Shared\Router\Cache\CacheInterface;
 use Spryker\Yves\Kernel\AbstractFactory;
 use Spryker\Yves\Router\Cache\Cache;
+use Spryker\Yves\Router\Dependency\Client\RouterToStoreClientInterface;
 use Spryker\Yves\Router\Loader\ClosureLoader;
 use Spryker\Yves\Router\Loader\LoaderInterface;
 use Spryker\Yves\Router\Resolver\RequestRequestValueResolver;
@@ -219,4 +220,12 @@ public function createCache(): CacheInterface
     {
         return new Cache($this->createRouter(), $this->getConfig());
     }
+
+    /**
+     * @return \Spryker\Yves\Router\Dependency\Client\RouterToStoreClientInterface
+     */
+    public function getStoreClient(): RouterToStoreClientInterface
+    {
+        return $this->getProvidedDependency(RouterDependencyProvider::CLIENT_STORE);
+    }
 }
diff --git a/...rTest/Yves/Router/Plugin/YvesRouterPluginWithLanguageAndStorePrefixRouterEnhancerTest.php b/...rTest/Yves/Router/Plugin/YvesRouterPluginWithLanguageAndStorePrefixRouterEnhancerTest.php
@@ -41,6 +41,7 @@ public function setUp(): void
     {
         parent::setUp();
 
+        $this->tester->setupStorageRedisConfig();
         $this->tester->mockEnvironmentConfig(RouterConstants::YVES_IS_CACHE_ENABLED, false);
 
         $this->tester->mockFactoryMethod('getRouteProviderPlugins', [
@@ -123,6 +124,7 @@ public function testGenerateReturnsUrlWithLanguageAndStoreWhenLanguageAndStoreAr
      */
     public function testGenerateReturnsUrlWithoutLanguageAndStoreWhenLanguageAndStoreAreNotInContext(string $url, string $routeName): void
     {
+        $this->tester->mockEnvironmentConfig(RouterConstants::IS_STORE_ROUTING_ENABLED, false);
         $routerPlugin = new YvesRouterPlugin();
         $routerPlugin->setFactory($this->tester->getFactory());
 
@@ -133,6 +135,28 @@ public function testGenerateReturnsUrlWithoutLanguageAndStoreWhenLanguageAndStor
         $this->assertSame($url, $generatedUrl);
     }
 
+    /**
+     * @dataProvider generatorWithoutLanguageAndStoreDataProviderWithStoreRoutingEnabled
+     *
+     * @param string $url
+     * @param string $routeName
+     *
+     * @return void
+     */
+    public function testGenerateReturnsUrlWithoutLanguageAndStoreWhenLanguageAndStoreAreNotInContextWithStoreRoutingEnabled(
+        string $url,
+        string $routeName
+    ): void {
+        $this->tester->mockEnvironmentConfig(RouterConstants::IS_STORE_ROUTING_ENABLED, true);
+        $routerPlugin = new YvesRouterPlugin();
+        $routerPlugin->setFactory($this->tester->getFactory());
+        $router = $routerPlugin->getRouter();
+
+        $generatedUrl = $router->generate($routeName);
+
+        $this->assertSame($url, $generatedUrl);
+    }
+
     /**
      * @return array<array<string>>
      */
@@ -169,4 +193,15 @@ public function generatorWithoutLanguageAndStoreDataProvider(): array
             ['/foo', 'foo'],
         ];
     }
+
+    /**
+     * @return array<array<string>>
+     */
+    public function generatorWithoutLanguageAndStoreDataProviderWithStoreRoutingEnabled(): array
+    {
+        return [
+            ['/DE', 'home'],
+            ['/DE/foo', 'foo'],
+        ];
+    }
 }
diff --git a/...rTest/Yves/Router/Plugin/YvesRouterPluginWithStoreAndLanguagePrefixRouterEnhancerTest.php b/...rTest/Yves/Router/Plugin/YvesRouterPluginWithStoreAndLanguagePrefixRouterEnhancerTest.php
@@ -100,6 +100,7 @@ public function testGenerateReturnsUrlWithStoreAndLanguageWhenStoreAndLanguageAr
      */
     public function testGenerateReturnsUrlWithoutStoreAndLanguageWhenStoreAndLanguageAreNotInContextParameter(): void
     {
+        $this->tester->mockEnvironmentConfig(RouterConstants::IS_STORE_ROUTING_ENABLED, false);
         $routerPlugin = new YvesRouterPlugin();
         $routerPlugin->setFactory($this->tester->getFactory());
 
@@ -109,4 +110,20 @@ public function testGenerateReturnsUrlWithoutStoreAndLanguageWhenStoreAndLanguag
 
         $this->assertSame('/foo', $url);
     }
+
+    /**
+     * @return void
+     */
+    public function testGenerateReturnsUrlWithoutStoreAndLanguageWhenStoreAndLanguageAreNotInContextParameterWithStoreRoutingEnabled(): void
+    {
+        $this->tester->mockEnvironmentConfig(RouterConstants::IS_STORE_ROUTING_ENABLED, true);
+        $routerPlugin = new YvesRouterPlugin();
+        $routerPlugin->setFactory($this->tester->getFactory());
+
+        $router = $routerPlugin->getRouter();
+
+        $url = $router->generate('foo');
+
+        $this->assertSame('/DE/foo', $url);
+    }
 }
diff --git a/tests/SprykerTest/Yves/Router/Plugin/YvesRouterPluginWithStorePrefixRouterEnhancerTest.php b/tests/SprykerTest/Yves/Router/Plugin/YvesRouterPluginWithStorePrefixRouterEnhancerTest.php
@@ -111,6 +111,28 @@ public function testGenerateReturnsUrlWithStoreWhenStoreIsInContext(string $url,
      */
     public function testGenerateReturnsUrlWithoutStoreWhenStoreIsNotInContext(string $url, string $routeName): void
     {
+        $this->tester->mockEnvironmentConfig(RouterConstants::IS_STORE_ROUTING_ENABLED, false);
+        $routerPlugin = new YvesRouterPlugin();
+        $routerPlugin->setFactory($this->tester->getFactory());
+
+        $router = $routerPlugin->getRouter();
+
+        $generatedUrl = $router->generate($routeName);
+
+        $this->assertSame($url, $generatedUrl);
+    }
+
+    /**
+     * @dataProvider generatorWithoutLanguageAndStoreDataProviderWithStoreRoutingEnabled
+     *
+     * @param string $url
+     * @param string $routeName
+     *
+     * @return void
+     */
+    public function testGenerateReturnsUrlWithoutStoreWhenStoreIsNotInContextWithStoreRoutingEnabled(string $url, string $routeName): void
+    {
+        $this->tester->mockEnvironmentConfig(RouterConstants::IS_STORE_ROUTING_ENABLED, true);
         $routerPlugin = new YvesRouterPlugin();
         $routerPlugin->setFactory($this->tester->getFactory());
 
@@ -157,4 +179,15 @@ public function generatorWithoutLanguageAndStoreDataProvider(): array
             ['/foo', 'foo'],
         ];
     }
+
+    /**
+     * @return array<array<string>>
+     */
+    public function generatorWithoutLanguageAndStoreDataProviderWithStoreRoutingEnabled(): array
+    {
+        return [
+            ['/DE', 'home'],
+            ['/DE/foo', 'foo'],
+        ];
+    }
 }