Merge pull request #191 from splitio/develop

Release 7.1.4

Author: mmelograno

.github/workflows/ci.yml

@@ -19,7 +19,7 @@ jobs:
           - 6379:6379
     strategy:
       matrix:
-        version: ['7.3', '8.0']
+        version: ['7.3', '8.0', '8.1']
     steps:
       - name: Checkout code
         uses: actions/checkout@v2

CHANGES.txt

@@ -1,3 +1,8 @@
+7.1.4 (Sep 6, 2022)
+ - Updated dependencies to allow `psr/log` 2 and 3.
+ - Removed `phpdocumentor/phpdocumentor` dependency.
+ - Added `PSR3LoggerAdapter` to support `psr/log: 1 - 3` versions.
+
 7.1.3 (Aug 24, 2022)
  - Updated `predis` dependency to `^2.0`.
 

README.md

@@ -5,7 +5,7 @@
 This SDK is designed to work with Split, the platform for controlled rollouts, serving features to your users via the Split feature flag to manage your complete customer experience.
 
 ## Compatibility
-This SDK is compatible with PHP 5.6 and above.
+This SDK is compatible with PHP 7.3 and above.
 
 ## Getting started
 Below is a simple example that describes the instantiation and most basic usage of our SDK.

composer.json

@@ -23,14 +23,13 @@
 
   "require": {
     "php": ">=7.3",
-    "psr/log": "~1.0",
+    "psr/log": "1 - 3",
     "predis/predis": "^2.0",
-    "symfony/yaml": ">=5.3"
+    "symfony/yaml": "^5.3|^6.0"
   },
 
   "require-dev": {
     "phpunit/phpunit": "^9.0.0",
-    "phpdocumentor/phpdocumentor": "3.*",
     "squizlabs/php_codesniffer": "3.*",
     "rogervila/php-sonarqube-scanner": "1.1.0"
   },

src/SplitIO/Component/Common/Di.php

@@ -118,7 +118,7 @@ public static function get($key)
     /**
      * @param LoggerInterface $logger
      */
-    public static function setLogger(LoggerInterface $logger)
+    public static function setLogger($logger)
     {
         self::set(self::KEY_LOG, $logger);
     }

src/SplitIO/Component/Common/ServiceProvider.php

@@ -3,7 +3,7 @@
 
 class ServiceProvider
 {
-    public static function registerLogger(\Psr\Log\LoggerInterface $logger)
+    public static function registerLogger($logger)
     {
         Di::setLogger($logger);
     }

src/SplitIO/Component/Initialization/LoggerFactory.php

@@ -0,0 +1,60 @@
+<?php
+namespace SplitIO\Component\Initialization;
+
+use Psr\Log\LogLevel;
+use SplitIO\Component\Log\Logger;
+use SplitIO\Component\Log\PSR3LoggerAdapter;
+use SplitIO\Component\Log\LogLevelEnum;
+use SplitIO\Component\Log\Handler\Echos;
+use SplitIO\Component\Log\Handler\Stdout;
+use SplitIO\Component\Log\Handler\Syslog;
+use SplitIO\Component\Log\Handler\VoidHandler;
+
+class LoggerFactory
+{
+    /**
+     * Builds defaultLogger
+     *
+     * @param $options
+     * @return SplitIO\Component\Log\Handler
+     */
+    private static function buildAdapter(array $options)
+    {
+        $adapter = (isset($options['adapter'])) ? $options['adapter'] : null;
+
+        switch ($adapter) {
+            case 'stdout':
+                return new Stdout();
+
+            case 'echo':
+                return new Echos();
+
+            case 'void':
+                return new VoidHandler();
+
+            case 'syslog':
+            default:
+                return new Syslog();
+        }
+    }
+
+    /**
+     * Builds logger
+     *
+     * @param $options
+     * @return SplitIO\Component\Log\Logger
+     */
+    public static function setupLogger(array $options)
+    {
+        $level = (isset($options['level'])) ? $options['level'] : null;
+        if (!LogLevelEnum::isValid($level)) {
+            $level = LogLevel::WARNING;
+        }
+
+        if (!isset($options['psr3-instance'])) {
+            return new Logger(self::buildAdapter($options), $level);
+        }
+
+        return new Logger(new PSR3LoggerAdapter($options['psr3-instance']), $level);
+    }
+}

src/SplitIO/Component/Initialization/LoggerTrait.php

@@ -11,7 +11,7 @@
  * Implement PSR-3 interface
  * @package SplitIO\Component\Log
  */
-class Logger extends LoggerTrait implements LoggerInterface
+class Logger extends LoggerTrait
 {
     /**
      * @var null|LogHandlerInterface

src/SplitIO/Component/Log/Logger.php

@@ -0,0 +1,48 @@
+<?php
+namespace SplitIO\Component\Log;
+
+use Psr\Log\LoggerInterface;
+use SplitIO\Component\Log\Handler\LogHandlerInterface;
+
+/**
+ * Class PSR3LoggerAdapter
+ * Logger Handler for PSR3
+ * @package namespace SplitIO\Component\Log;
+ */
+class PSR3LoggerAdapter implements LogHandlerInterface
+{
+    /**
+     * @var LogHandlerInterface
+     */
+    private $logger;
+
+    /**
+     * Logger constructor
+     * @param LoggerInterface $logger
+     */
+    public function __construct(LoggerInterface $logger)
+    {
+        $this->logger = $logger;
+    }
+
+    /**
+     * Log messages for PSR3
+     * @param $logLevel
+     * @param $message
+     */
+    public function write($logLevel, $message)
+    {
+        if (!is_string($message) || !$message instanceof Stringable) {
+            try {
+                $this->logger->log($logLevel, json_encode($message));
+            } catch (\Exception $e) {
+                $this->logger->log(
+                    LogLevel::ERROR,
+                    "error serializing non-stringable object when trying to log message of type " + gettype($message)
+                );
+            }
+        } else {
+            $this->logger->log($logLevel, $message);
+        }
+    }
+}

src/SplitIO/Component/Log/PSR3LoggerAdapter.php

@@ -2,7 +2,8 @@
 namespace SplitIO;
 
 use SplitIO\Component\Initialization\CacheTrait;
-use SplitIO\Component\Initialization\LoggerTrait;
+use SplitIO\Component\Initialization\LoggerFactory;
+use SplitIO\Component\Common\ServiceProvider;
 use SplitIO\Exception\Exception;
 use SplitIO\Sdk\Factory\LocalhostSplitFactory;
 use SplitIO\Sdk\Factory\SplitFactory;
@@ -61,14 +62,8 @@ public static function factory($apiKey = 'localhost', array $options = array())
      */
     private static function registerLogger(array $options)
     {
-        if (isset($options['psr3-instance'])) {
-            LoggerTrait::addLogger(null, null, $options['psr3-instance']);
-        } else {
-            $adapter = (isset($options['adapter'])) ? $options['adapter'] : null;
-            $level = (isset($options['level'])) ? $options['level'] : null;
-
-            LoggerTrait::addLogger($adapter, $level);
-        }
+        $logger = LoggerFactory::setupLogger($options);
+        ServiceProvider::registerLogger($logger);
     }
 
     private static function registerCache(array $options)

src/SplitIO/Sdk.php

@@ -3,5 +3,5 @@
 
 class Version
 {
-    const CURRENT = '7.1.3';
+    const CURRENT = '7.1.4';
 }

src/SplitIO/Version.php

@@ -1,7 +1,8 @@
 <?php
 namespace SplitIO\Test\Suite\Engine;
 
-use SplitIO\Component\Initialization\LoggerTrait;
+use SplitIO\Component\Initialization\LoggerFactory;
+use SplitIO\Component\Common\ServiceProvider;
 use SplitIO\Component\Log\LogLevelEnum;
 use SplitIO\Engine\Splitter;
 use SplitIO\Grammar\Condition\Partition;
@@ -15,7 +16,8 @@ class SplitterTest extends \PHPUnit\Framework\TestCase
 
     public function testDiLog()
     {
-        LoggerTrait::addLogger('stdout', LogLevelEnum::ERROR);
+        $logger = LoggerFactory::setupLogger(array('adapter' => 'stdout', 'level' => 'error'));
+        ServiceProvider::registerLogger($logger);
 
         $this->assertTrue(true);
     }

tests/Suite/Engine/SplitterTest.php

@@ -2,8 +2,6 @@
 namespace SplitIO\Test\Suite\Sdk;
 
 use \stdClass;
-use Monolog\Logger;
-use Monolog\Handler\ErrorLogHandler;
 use SplitIO\Component\Common\Di;
 use SplitIO\Test\Suite\Redis\ReflectiveTools;
 use SplitIO\Component\Cache\ImpressionCache;
@@ -14,6 +12,7 @@
 use SplitIO\Component\Cache\SplitCache;
 use SplitIO\Sdk\Client;
 
+use SplitIO\Test\Suite\Sdk\Helpers\CustomLogger;
 use SplitIO\Test\Utils;
 
 class SdkClientTest extends \PHPUnit\Framework\TestCase
@@ -427,8 +426,12 @@ public function testCustomLog()
     {
         Di::set(Di::KEY_FACTORY_TRACKER, false);
         // create a log channel
-        $log = new Logger('SplitIO');
-        $log->pushHandler(new ErrorLogHandler(ErrorLogHandler::OPERATING_SYSTEM, Logger::INFO));
+        $log = $this
+            ->getMockBuilder('Psr\Log\LoggerInterface')
+            ->disableOriginalConstructor()
+            ->setMethods(array('warning', 'debug', 'error', 'info', 'critical', 'emergency',
+                'alert', 'notice', 'write', 'log'))
+            ->getMock();
 
         $parameters = array('scheme' => 'redis', 'host' => REDIS_HOST, 'port' => REDIS_PORT, 'timeout' => 881);
         $options = array('prefix' => TEST_PREFIX);
@@ -472,8 +475,13 @@ public function testInvalidCacheAdapter()
     public function testCacheExceptionReturnsControl()
     {
         Di::set(Di::KEY_FACTORY_TRACKER, false);
-        $log = new Logger('SplitIO');
-        $log->pushHandler(new ErrorLogHandler(ErrorLogHandler::OPERATING_SYSTEM, Logger::INFO));
+
+        $log = $this
+            ->getMockBuilder('Psr\Log\LoggerInterface')
+            ->disableOriginalConstructor()
+            ->setMethods(array('warning', 'debug', 'error', 'info', 'critical', 'emergency',
+                'alert', 'notice', 'write', 'log'))
+            ->getMock();
 
         $parameters = array('scheme' => 'redis', 'host' => REDIS_HOST, 'port' => REDIS_PORT, 'timeout' => 881);
         $options = array();