implement feature flag

Author: JonasVHG

app/SearchAPI/SearchAPIServiceProvider.php

@@ -15,13 +15,18 @@ public function register(Container $pimple)
 
         $pimple['search_api'] = function (Container $pimple) {
 
+            $headers = [];
+            if ($pimple['search_api.use_client_ids']) {
+                $headers['X-Client-Id'] = $pimple['search_api.client_id'];
+            } else {
+                $headers['X-Api-Key'] = $pimple['search_api.api_key'];
+            }
+            $headers['X-Client-Properties'] = 'cluster|widgets, cluster|snowplow';
+
             $guzzleClient = new Client(
                 [
                     'base_uri' => $pimple['search_api.base_url'],
-                    'headers' => [
-                        'X-Api-Key' => $pimple['search_api.api_key'],
-                        'X-Client-Properties' => 'cluster|widgets, cluster|snowplow',
-                    ],
+                    'headers' => $headers,
                     'handler' => $this->getHandlerStack('search_api', $pimple),
                 ]
             );
@@ -36,7 +41,11 @@ public function register(Container $pimple)
             $config = $searchClient->getClient()->getConfig();
             $config['base_uri'] = $pimple['search_api_test.base_url'];
             $headers = $config['headers'] ?? [];
-            $headers['X-Api-Key'] = $pimple['search_api_test.api_key'];
+            if ($pimple['search_api.use_client_ids']) {
+                $headers['X-Client-Id'] = $pimple['search_api_test.client_id'];
+            } else {
+                $headers['X-Api-Key'] = $pimple['search_api_test.api_key'];
+            }
             $config['headers'] = $headers;
 
             $searchClient->setClient(new \GuzzleHttp\Client($config));

app/Widget/WidgetServiceProvider.php

@@ -66,7 +66,7 @@ public function register(Container $pimple)
 
             /** @var RequestContext $requestContext */
             $requestContext = $pimple['request_context'];
-            $renderer = new Renderer($pimple['widget_layout_manager'], $pimple['google_tag_manager'], $pimple['project_repository'], $pimple['search_api'], $pimple['search_api_test'], $pimple['curatoren_api'], $pimple['curatoren_api_test']);
+            $renderer = new Renderer($pimple['widget_layout_manager'], $pimple['google_tag_manager'], $pimple['project_repository'], $pimple['search_api'], $pimple['search_api_test'], $pimple['curatoren_api'], $pimple['curatoren_api_test'], $pimple['use_client_ids'] ?? false);
             $renderer->addSettings(['apiUrl' => $requestContext->getScheme() . '://' . $requestContext->getHost() . $requestContext->getBaseUrl() . '/widgets/api']);
 
             return $renderer;

src/Widget/Renderer.php

@@ -61,6 +61,11 @@ class Renderer implements RendererInterface
      */
     protected $curatorenClientTest;
 
+    /**
+     * @var bool
+     */
+    protected $useClientIds;
+
     /**
      * @var array
      */
@@ -82,7 +87,7 @@ class Renderer implements RendererInterface
      * @param $googleTagManagerId
      * @param ProjectServiceInterface $projectService
      */
-    public function __construct(WidgetPluginManager $widgetPluginManager, $googleTagManagerId, EntityRepository $projectRepository, SearchClientInterface $searchClient, SearchClientInterface $searchClientTest, CuratorenClient $curatorenClient, CuratorenClient $curatorenClientTest)
+    public function __construct(WidgetPluginManager $widgetPluginManager, $googleTagManagerId, EntityRepository $projectRepository, SearchClientInterface $searchClient, SearchClientInterface $searchClientTest, CuratorenClient $curatorenClient, CuratorenClient $curatorenClientTest, bool $useClientIds)
     {
         $this->widgetPluginManager = $widgetPluginManager;
         $this->googleTagManagerId = $googleTagManagerId;
@@ -91,6 +96,7 @@ public function __construct(WidgetPluginManager $widgetPluginManager, $googleTag
         $this->searchClientTest = $searchClientTest;
         $this->curatorenClient = $curatorenClient;
         $this->curatorenClientTest = $curatorenClientTest;
+        $this->useClientIds = $useClientIds;
     }
 
     public function addSettings(array $settings)
@@ -105,16 +111,22 @@ public function setProject(ProjectInterface $project)
         // If a project is not live yet. We should use the test api + test key.
         if ($project->getStatus() !== ProjectInterface::PROJECT_STATUS_ACTIVE) {
             $apiKey = $project->getTestApiKeySapi3();
+            $clientId = $project->getTestClientId();
             $config = $this->searchClientTest->getClient()->getConfig();
             $curatorenConfig =  $this->curatorenClientTest->getClient()->getConfig();
         } else {
             $config = $this->searchClient->getClient()->getConfig();
             $apiKey = $project->getLiveApiKeySapi3();
+            $clientId = $project->getLiveClientId();
             $curatorenConfig =  $this->curatorenClient->getClient()->getConfig();
         }
 
         $headers = $config['headers'] ?? [];
-        $headers['X-Api-Key'] = $apiKey;
+        if ($this->useClientIds) {
+            $headers['X-Client-Id'] = $clientId;
+        } else {
+            $headers['X-Api-Key'] = $apiKey;
+        }
         $config['headers'] = $headers;
 
         $this->searchClient->setClient(new \GuzzleHttp\Client($config));