Restore private key provider

Author: lruozzi9

UPGRADE.md

@@ -6,7 +6,6 @@ In this version, we have updated the plugin to be compatible with version 2 of S
 - The route `@WebgriffeSyliusClerkPlugin/config/feed_routing.php` has been renamed to `@WebgriffeSyliusClerkPlugin/config/routes/feed.php`.
 - The file `@WebgriffeSyliusClerkPlugin/config/config.yaml` has been renamed to `@WebgriffeSyliusClerkPlugin/config/config.php`.
 - Various deprecated classes and their services have been removed. Please migrate to use the new feed v2 generation and the new API key providers as described in the documentation of the plugin.
-- The private_api_key configuration key under stores has been removed.
 
 ## From 2.x to 3.x
 

src/DependencyInjection/Configuration.php

@@ -30,6 +30,9 @@ public function getConfigTreeBuilder(): TreeBuilder
                             ->scalarNode('public_api_key')
                                 ->isRequired()
                             ->end()
+                            ->scalarNode('private_api_key')
+                                ->isRequired()
+                            ->end()
                             ->scalarNode('locale_code')
                                 ->defaultNull()
                             ->end()

src/Provider/ApiKeysProvider.php

@@ -13,6 +13,7 @@
      * @param array<array-key, array{
      *     channel_code: string,
      *     public_api_key: string,
+     *     private_api_key: string,
      *     locale_code?: string,
      * }> $storesConfiguration
      */
@@ -36,13 +37,13 @@ public function getPublicApiKey(
         }
         $atLeastOneConfigurationHasLocaleCode = array_reduce(
             $channelsConfiguration,
-            fn (bool $carry, array $storeConfiguration) => $carry || array_key_exists('locale_code', $storeConfiguration),
+            static fn (bool $carry, array $storeConfiguration) => $carry || array_key_exists('locale_code', $storeConfiguration),
             false,
         );
         if ($atLeastOneConfigurationHasLocaleCode) {
             $channelLocalesConfiguration = array_filter(
                 $channelsConfiguration,
-                fn (array $storeConfiguration) => array_key_exists('locale_code', $storeConfiguration) && $storeConfiguration['locale_code'] === $localeCode,
+                static fn (array $storeConfiguration) => array_key_exists('locale_code', $storeConfiguration) && $storeConfiguration['locale_code'] === $localeCode,
             );
             if (count($channelLocalesConfiguration) === 0) {
                 throw new ChannelApiKeysNotProvidedException('Configuration not found for channel ' . $channelCode . ' and locale ' . $localeCode);
@@ -59,4 +60,43 @@ public function getPublicApiKey(
 
         return reset($channelsConfiguration)['public_api_key'];
     }
+
+    #[\Override]
+    public function getPrivateApiKey(
+        ChannelInterface $channel,
+        string $localeCode,
+    ): string {
+        $channelsConfiguration = array_filter(
+            $this->storesConfiguration,
+            static fn (array $storeConfiguration) => $storeConfiguration['channel_code'] === (string) $channel->getCode(),
+        );
+        $channelCode = (string) $channel->getCode();
+        if (count($channelsConfiguration) === 0) {
+            throw new ChannelApiKeysNotProvidedException('Configuration not found for channel ' . $channelCode);
+        }
+        $atLeastOneConfigurationHasLocaleCode = array_reduce(
+            $channelsConfiguration,
+            static fn (bool $carry, array $storeConfiguration) => $carry || array_key_exists('locale_code', $storeConfiguration),
+            false,
+        );
+        if ($atLeastOneConfigurationHasLocaleCode) {
+            $channelLocalesConfiguration = array_filter(
+                $channelsConfiguration,
+                static fn (array $storeConfiguration) => array_key_exists('locale_code', $storeConfiguration) && $storeConfiguration['locale_code'] === $localeCode,
+            );
+            if (count($channelLocalesConfiguration) === 0) {
+                throw new ChannelApiKeysNotProvidedException('Configuration not found for channel ' . $channelCode . ' and locale ' . $localeCode);
+            }
+            if (count($channelLocalesConfiguration) > 1) {
+                throw new ChannelApiKeysNotProvidedException('Multiple configurations found for channel ' . $channelCode . ' and locale ' . $localeCode);
+            }
+
+            return reset($channelLocalesConfiguration)['private_api_key'];
+        }
+        if (count($channelsConfiguration) > 1) {
+            throw new ChannelApiKeysNotProvidedException('Multiple configurations found for channel ' . $channelCode);
+        }
+
+        return reset($channelsConfiguration)['private_api_key'];
+    }
 }

src/Provider/ApiKeysProviderInterface.php

@@ -16,4 +16,12 @@ public function getPublicApiKey(
         ChannelInterface $channel,
         string $localeCode,
     ): string;
+
+    /**
+     * @throws ChannelApiKeysNotProvidedException If the configuration for the given channel is not found.
+     */
+    public function getPrivateApiKey(
+        ChannelInterface $channel,
+        string $localeCode,
+    ): string;
 }

tests/TestApplication/config/config.yaml

@@ -15,9 +15,11 @@ webgriffe_sylius_clerk:
     stores:
         -   channel_code: FASHION_WEB
             public_api_key: public-key
+            private_api_key: 123abc
             locale_code: en_US
         -   channel_code: WEB-US
             public_api_key: public-key
+            private_api_key: 123abc
             locale_code: en_US
     pages:
         -