feat: Add Authenticated Datafile Support (#200)

oakbani · web-flow · commit 6acd713549fb · 2020-06-24T12:07:34.000-07:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,10 @@
+# Optimizely PHP SDK Changelog
+
+## [Unreleased]
+
+### New Features:
+- Added support for authenticated datafiles. `HTTPProjectConfigManager` now accepts `datafileAccessToken` to be able to fetch authenticated datafiles.
+
 ## 3.3.1
 May 28th, 2020
 
diff --git a/README.md b/README.md
@@ -32,10 +32,10 @@ Create the Optimizely client, for example:
 $optimizely = new Optimizely(<<DATAFILE>>);
 ```
 
-Or you may also use OptimizelyFactory method to create an optimizely client using your SDK key and an optional fallback datafile. Using this method internally creates an HTTPProjectConfigManager. See [HTTPProjectConfigManager](#http_config_manager) for further detail.
+Or you may also use OptimizelyFactory method to create an optimizely client using your SDK key, an optional fallback datafile and an optional datafile access token. Using this method internally creates an HTTPProjectConfigManager. See [HTTPProjectConfigManager](#http_config_manager) for further detail.
 
 ```php
-$optimizelyClient = OptimizelyFactory::createDefaultInstance("your-sdk-key", <<DATAFILE>>);
+$optimizelyClient = OptimizelyFactory::createDefaultInstance("your-sdk-key", <<DATAFILE>>, <<DATAFILE_AUTH_TOKEN>>);
 ```
 To access your HTTPProjectConfigManager:
 
diff --git a/src/Optimizely/Enums/ProjectConfigManagerConstants.php b/src/Optimizely/Enums/ProjectConfigManagerConstants.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright 2019, Optimizely
+ * Copyright 2019-2020, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -27,7 +27,12 @@ class ProjectConfigManagerConstants
    /**
     * @const String Default URL Template to use if only SDK key is provided.
     */
-    const DEFAULT_URL_TEMPLATE = "https://cdn.optimizely.com/datafiles/%s.json";
+    const DEFAULT_DATAFILE_URL_TEMPLATE = "https://cdn.optimizely.com/datafiles/%s.json";
+
+    /**
+    * @const  String Default URL Template to use if Access token is provided along with the SDK key.
+    */
+    const AUTHENTICATED_DATAFILE_URL_TEMPLATE = "https://config.optimizely.com/datafiles/auth/%s.json";
 
    /**
     * @const String to use while fetching the datafile.
diff --git a/src/Optimizely/OptimizelyFactory.php b/src/Optimizely/OptimizelyFactory.php
@@ -17,6 +17,7 @@
 namespace Optimizely;
 
 use Optimizely\Optimizely;
+use Optimizely\ProjectConfigManager\HTTPProjectConfigManager;
 
 /**
  * Class OptimizelyFactory
@@ -25,18 +26,34 @@
  */
 class OptimizelyFactory
 {
-    public static function createDefaultInstance($sdkKey, $fallbackDatafile = null)
-    {
+    public static function createDefaultInstance(
+        $sdkKey,
+        $datafile = null,
+        $datafileAccessToken = null
+    ) {
+        $configManager = new HTTPProjectConfigManager(
+            $sdkKey,
+            null,
+            null,
+            true,
+            $datafile,
+            false,
+            null,
+            null,
+            null,
+            $datafileAccessToken
+        );
+
         return new Optimizely(
-            $fallbackDatafile,
             null,
             null,
             null,
             null,
             null,
             null,
+            $configManager,
             null,
-            $sdkKey
+            null
         );
     }
 }
diff --git a/src/Optimizely/ProjectConfigManager/HTTPProjectConfigManager.php b/src/Optimizely/ProjectConfigManager/HTTPProjectConfigManager.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright 2019, Optimizely Inc and Contributors
+ * Copyright 2019-2020, Optimizely Inc and Contributors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -72,6 +72,11 @@ class HTTPProjectConfigManager implements ProjectConfigManagerInterface
      */
     private $_notificationCenter;
 
+    /**
+    * @var String datafile access token.
+    */
+    private $datafileAccessToken;
+
     public function __construct(
         $sdkKey = null,
         $url = null,
@@ -81,12 +86,16 @@ public function __construct(
         $skipJsonValidation = false,
         LoggerInterface $logger = null,
         ErrorHandlerInterface $errorHandler = null,
-        NotificationCenter $notificationCenter = null
+        NotificationCenter $notificationCenter = null,
+        $datafileAccessToken = null
     ) {
         $this->_skipJsonValidation = $skipJsonValidation;
         $this->_logger = $logger ?: new NoOpLogger();
         $this->_errorHandler = $errorHandler ?: new NoOpErrorHandler();
         $this->_notificationCenter = $notificationCenter ?: new NotificationCenter($this->_logger, $this->_errorHandler);
+        $this->datafileAccessToken = $datafileAccessToken;
+        $this->isDatafileAccessTokenValid = Validator::validateNonEmptyString($this->datafileAccessToken);
+
         $this->httpClient = new HttpClient();
         $this->_url = $this->getUrl($sdkKey, $url, $urlTemplate);
 
@@ -127,7 +136,11 @@ protected function getUrl($sdkKey, $url, $urlTemplate)
         }
 
         if (!Validator::validateNonEmptyString($urlTemplate)) {
-            $urlTemplate = ProjectConfigManagerConstants::DEFAULT_URL_TEMPLATE;
+            if ($this->isDatafileAccessTokenValid) {
+                $urlTemplate = ProjectConfigManagerConstants::AUTHENTICATED_DATAFILE_URL_TEMPLATE;
+            } else {
+                $urlTemplate = ProjectConfigManagerConstants::DEFAULT_DATAFILE_URL_TEMPLATE;
+            }
         }
 
         $url = sprintf($urlTemplate, $sdkKey);
@@ -158,11 +171,16 @@ public function fetch()
      */
     protected function fetchDatafile()
     {
-        $headers = null;
+        $headers = [];
 
         // Add If-Modified-Since header.
         if (Validator::validateNonEmptyString($this->_lastModifiedSince)) {
-            $headers = array(ProjectConfigManagerConstants::IF_MODIFIED_SINCE => $this->_lastModifiedSince);
+            $headers[ProjectConfigManagerConstants::IF_MODIFIED_SINCE] = $this->_lastModifiedSince;
+        }
+
+        // Add Authorization header if access token available.
+        if ($this->isDatafileAccessTokenValid) {
+            $headers['Authorization'] = "Bearer {$this->datafileAccessToken}";
         }
 
         $options = [
diff --git a/tests/OptimizelyFactoryTest.php b/tests/OptimizelyFactoryTest.php
@@ -20,6 +20,7 @@
 use GuzzleHttp\Client;
 use GuzzleHttp\Handler\MockHandler;
 use GuzzleHttp\HandlerStack;
+use GuzzleHttp\Middleware;
 use GuzzleHttp\Psr7\Response;
 use Optimizely\OptimizelyFactory;
 use Optimizely\ProjectConfigManager\HTTPProjectConfigManager;
@@ -57,4 +58,46 @@ public function testDefaultInstance()
 
         $this->assertEquals('3', $optimizelyClient->configManager->getConfig()->getRevision());
     }
+
+    public function testDefaultInstanceWithAccessToken()
+    {
+        $optimizelyClient = OptimizelyFactory::createDefaultInstance(
+            "some-sdk-key",
+            null,
+            "some_token"
+        );
+
+        // Mock http client to return a valid datafile
+        $mock = new MockHandler([
+            new Response(200, [], $this->typedAudiencesDataFile)
+        ]);
+
+        $container = [];
+        $history = Middleware::history($container);
+        $handler = HandlerStack::create($mock);
+        $handler->push($history);
+
+        $client = new Client(['handler' => $handler]);
+        $httpClient = new \ReflectionProperty(HTTPProjectConfigManager::class, 'httpClient');
+        $httpClient->setAccessible(true);
+        $httpClient->setValue($optimizelyClient->configManager, $client);
+
+        /// Fetch datafile
+        $optimizelyClient->configManager->fetch();
+
+        $this->assertEquals('3', $optimizelyClient->configManager->getConfig()->getRevision());
+
+        // assert that https call is made to mock as expected.
+        $transaction = $container[0];
+        $this->assertEquals(
+            'https://config.optimizely.com/datafiles/auth/some-sdk-key.json',
+            $transaction['request']->getUri()
+        );
+
+        // assert that headers include authorization access token
+        $this->assertEquals(
+            'Bearer some_token',
+            $transaction['request']->getHeaders()['Authorization'][0]
+        );
+    }
 }
diff --git a/tests/ProjectConfigManagerTests/HTTPProjectConfigManagerTest.php b/tests/ProjectConfigManagerTests/HTTPProjectConfigManagerTest.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright 2019, Optimizely
+ * Copyright 2019-2020, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,6 +21,7 @@
 use GuzzleHttp\Client;
 use GuzzleHttp\Handler\MockHandler;
 use GuzzleHttp\HandlerStack;
+use GuzzleHttp\Middleware;
 use GuzzleHttp\Psr7\Response;
 use Monolog\Logger;
 use Optimizely\Config\DatafileProjectConfig;
@@ -329,6 +330,24 @@ public function testGetUrlReturnsURLWhenSdkKeyAndTemplateAreNonEmptyString()
         $this->assertEquals($url, 'https://custom/datafiles/sdk_key.json');
     }
 
+    public function testGetUrlReturnsURLWhenSdkKeyAndTemplateAndAccessTokenAreNonEmptyString()
+    {
+        $url_template = "https://custom/datafiles/%s.json";
+
+        $configManagerMock = $this->getMockBuilder(HTTPProjectConfigManagerTester::class)
+            ->setConstructorArgs(array('sdk_key', null, $url_template, false, DATAFILE, false,
+                                    $this->loggerMock, $this->errorHandlerMock, null, 'some_token'))
+            ->setMethods(array('fetch'))
+            ->getMock();
+
+        $this->errorHandlerMock->expects($this->never())
+           ->method('handleError');
+
+        $url = $configManagerMock->getUrl('sdk_key', null, $url_template);
+
+        $this->assertEquals($url, 'https://custom/datafiles/sdk_key.json');
+    }
+
     public function testGetUrlReturnsURLUsingDefaultTemplateWhenTemplateIsEmptyString()
     {
         $configManagerMock = $this->getMockBuilder(HTTPProjectConfigManagerTester::class)
@@ -345,6 +364,22 @@ public function testGetUrlReturnsURLUsingDefaultTemplateWhenTemplateIsEmptyStrin
         $this->assertEquals($url, 'https://cdn.optimizely.com/datafiles/sdk_key.json');
     }
 
+    public function testGetUrlReturnsAuthDatafileURLWhenTemplateIsEmptyAndTokenIsProvided()
+    {
+        $configManagerMock = $this->getMockBuilder(HTTPProjectConfigManagerTester::class)
+            ->setConstructorArgs(array('sdk_key', null, null, false, DATAFILE, false,
+                                    $this->loggerMock, $this->errorHandlerMock, null, 'some_token'))
+            ->setMethods(array('fetch'))
+            ->getMock();
+
+        $this->errorHandlerMock->expects($this->never())
+           ->method('handleError');
+
+        $url = $configManagerMock->getUrl('sdk_key', null, null);
+
+        $this->assertEquals($url, 'https://config.optimizely.com/datafiles/auth/sdk_key.json');
+    }
+
     public function testHandleResponseReturnsFalseForSameDatafilesRevisions()
     {
         $configManagerMock = $this->getMockBuilder(HTTPProjectConfigManagerTester::class)
@@ -367,4 +402,51 @@ public function testHandleResponseReturnsFalseForSameDatafilesRevisions()
         $this->assertSame($config->getRevision(), $datafile['revision']);
         $this->assertFalse($configManagerMock->handleResponse(DATAFILE));
     }
+
+    public function testAuthTokenInRequestHeaderWhenTokenIsProvided()
+    {
+        $configManager = new HTTPProjectConfigManager(
+            'sdk_key',
+            null,
+            null,
+            null,
+            null,
+            null,
+            null,
+            null,
+            null,
+            'access_token'
+        );
+
+        // Mock http client to return a valid datafile
+        $mock = new MockHandler([
+            new Response(200, [], null)
+        ]);
+
+        $container = [];
+        $history = Middleware::history($container);
+        $handler = HandlerStack::create($mock);
+        $handler->push($history);
+
+        $client = new Client(['handler' => $handler]);
+        $httpClient = new \ReflectionProperty(HTTPProjectConfigManager::class, 'httpClient');
+        $httpClient->setAccessible(true);
+        $httpClient->setValue($configManager, $client);
+
+        // Fetch datafile
+        $configManager->fetch();
+
+        // assert that https call is made to mock as expected.
+        $transaction = $container[0];
+        $this->assertEquals(
+            'https://config.optimizely.com/datafiles/auth/sdk_key.json',
+            $transaction['request']->getUri()
+        );
+
+        // assert that headers include authorization access token
+        $this->assertEquals(
+            'Bearer access_token',
+            $transaction['request']->getHeaders()['Authorization'][0]
+        );
+    }
 }
