[WIP] Allowing Multiple Factory Instantiation

.github/workflows/ci.yml

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

CHANGES.txt

@@ -1,3 +1,7 @@
+8.0.0 (Jan XX, 2023)
+ - BREAKING CHANGE: Removed support from versions older than PHP 7.4.
+ - BREAKING CHANGE: Added support for Multiple Factory Instantiation.
+
 7.1.5 (Oct 28, 2022)
  - Updated phpdocs for `ClientInterface`.
 

LICENSE

@@ -1,4 +1,4 @@
-Copyright © 2022 Split Software, Inc.
+Copyright © 2023 Split Software, Inc.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

composer.json

@@ -22,7 +22,7 @@
   "bin": ["bin/splitio"],
 
   "require": {
-    "php": ">=7.3",
+    "php": ">=7.4",
     "psr/log": "1 - 3",
     "predis/predis": "^2.0",
     "symfony/yaml": "^5.3|^6.0"
@@ -31,7 +31,8 @@
   "require-dev": {
     "phpunit/phpunit": "^9.0.0",
     "squizlabs/php_codesniffer": "3.*",
-    "rogervila/php-sonarqube-scanner": "1.1.0"
+    "rogervila/php-sonarqube-scanner": "1.1.0",
+    "mockery/mockery": "^1.5"
   },
 
   "autoload": {

phpunit.xml.dist

@@ -24,12 +24,15 @@
         <testsuite name="component">
             <directory suffix="Test.php">tests/Suite/Component/</directory>
         </testsuite>
-                <testsuite name="dynamic_configurations">
+        <testsuite name="dynamic_configurations">
             <directory suffix="Test.php">tests/Suite/DynamicConfigurations/</directory>
         </testsuite>
         <testsuite name="engine">
             <directory suffix="Test.php">tests/Suite/Engine/</directory>
         </testsuite>
+        <testsuite name="traffic_allocation">
+            <directory suffix="Test.php">tests/Suite/TrafficAllocation/</directory>
+        </testsuite>
         <testsuite name="input_validation">
             <directory suffix="Test.php">tests/Suite/InputValidation/</directory>
         </testsuite>
@@ -55,6 +58,7 @@
             <directory suffix="Test.php">tests/Suite/Component/</directory>
             <directory suffix="Test.php">tests/Suite/DynamicConfigurations/</directory>
             <directory suffix="Test.php">tests/Suite/Engine/</directory>
+            <directory suffix="Test.php">tests/Suite/TrafficAllocation/</directory>
             <directory suffix="Test.php">tests/Suite/InputValidation/</directory>
             <directory suffix="Test.php">tests/Suite/Matchers/</directory>
             <directory suffix="Test.php">tests/Suite/Metrics/</directory>

src/SplitIO/Component/Cache/EventsCache.php

@@ -1,18 +1,32 @@
 <?php
 namespace SplitIO\Component\Cache;
 
-use SplitIO\Component\Common\Di;
+use SplitIO\Component\Common\Context;
 use SplitIO\Sdk\Events\EventQueueMessage;
+use SplitIO\Component\Cache\Pool;
 
 class EventsCache
 {
     const KEY_EVENTS_LIST = "SPLITIO.events";
 
-    public static function addEvent(EventQueueMessage $message)
+    /**
+     * @var \SplitIO\Component\Cache\Pool
+     */
+    private $cache;
+
+    /**
+     * @param \SplitIO\Component\Cache\Pool $cache
+     */
+    public function __construct(Pool $cache)
+    {
+        $this->cache = $cache;
+    }
+
+    public function addEvent(EventQueueMessage $message)
     {
         $queueJSONmessage =  json_encode($message->toArray());
 
-        Di::getLogger()->debug("Adding event item into queue: ". $queueJSONmessage);
-        return (Di::getCache()->rightPushInList(self::KEY_EVENTS_LIST, $queueJSONmessage) > 0);
+        Context::getLogger()->debug("Adding event item into queue: ". $queueJSONmessage);
+        return ($this->cache->rightPushInList(self::KEY_EVENTS_LIST, $queueJSONmessage) > 0);
     }
 }

src/SplitIO/Component/Cache/ImpressionCache.php

@@ -1,15 +1,28 @@
 <?php
 namespace SplitIO\Component\Cache;
 
-use SplitIO\Component\Common\Di;
-use SplitIO\Component\Cache\KeyFactory;
+use SplitIO\Component\Common\Context;
 use SplitIO\Sdk\QueueMetadataMessage;
+use SplitIO\Component\Cache\Pool;
 
 class ImpressionCache
 {
     const IMPRESSIONS_QUEUE_KEY = "SPLITIO.impressions";
     const IMPRESSION_KEY_DEFAULT_TTL = 3600;
 
+    /**
+     * @var \SplitIO\Component\Cache\Pool
+     */
+    private $cache;
+
+    /**
+     * @param \SplitIO\Component\Cache\Pool $cache
+     */
+    public function __construct(Pool $cache)
+    {
+        $this->cache = $cache;
+    }
+
     public function logImpressions($impressions, QueueMetadataMessage $metadata)
     {
         $toStore = array_map(
@@ -30,10 +43,10 @@ function ($imp) use ($metadata) {
             $impressions
         );
 
-        Di::getLogger()->debug("Adding impressions into queue: ". implode(",", $toStore));
-        $count = Di::getCache()->rightPushInList(self::IMPRESSIONS_QUEUE_KEY, $toStore);
+        Context::getLogger()->debug("Adding impressions into queue: ". implode(",", $toStore));
+        $count = $this->cache->rightPushInList(self::IMPRESSIONS_QUEUE_KEY, $toStore);
         if ($count == count($impressions)) {
-            Di::getCache()->expireKey(self::IMPRESSIONS_QUEUE_KEY, self::IMPRESSION_KEY_DEFAULT_TTL);
+            $this->cache->expireKey(self::IMPRESSIONS_QUEUE_KEY, self::IMPRESSION_KEY_DEFAULT_TTL);
         }
         return ($count >= count($impressions));
     }

src/SplitIO/Component/Cache/Pool.php

@@ -3,7 +3,7 @@
 
 use SplitIO\Component\Cache\Storage\Adapter\PRedis as PRedisAdapter;
 use SplitIO\Component\Cache\Storage\Adapter\SafeRedisWrapper;
-use SplitIO\Component\Common\Di;
+use SplitIO\Component\Common\Context;
 
 class Pool extends CacheKeyTrait
 {
@@ -39,7 +39,7 @@ public function __construct(array $options = array())
     public function get($key)
     {
         $this->assertValidKey($key);
-        Di::getLogger()->debug("Fetching item ** $key ** from cache");
+        Context::getLogger()->debug("Fetching item ** $key ** from cache");
         return $this->adapter->get($key);
     }
 

src/SplitIO/Component/Cache/SegmentCache.php

@@ -1,14 +1,25 @@
 <?php
 namespace SplitIO\Component\Cache;
 
-use SplitIO\Component\Common\Di;
-
 class SegmentCache implements SegmentCacheInterface
 {
     const KEY_SEGMENT_DATA = 'SPLITIO.segment.{segmentName}';
 
     const KEY_TILL_CACHED_ITEM = 'SPLITIO.segment.{segment_name}.till';
 
+    /**
+     * @var \SplitIO\Component\Cache\Pool
+     */
+    private $cache;
+
+    /**
+     * @param \SplitIO\Component\Cache\Pool $cache
+     */
+    public function __construct(Pool $cache)
+    {
+        $this->cache = $cache;
+    }
+
     private static function getCacheKeyForSegmentData($segmentName)
     {
         return str_replace('{segmentName}', $segmentName, self::KEY_SEGMENT_DATA);
@@ -27,7 +38,7 @@ private static function getCacheKeyForSinceParameter($segmentName)
     public function isInSegment($segmentName, $key)
     {
         $segmentDataKey = self::getCacheKeyForSegmentData($segmentName);
-        return Di::getCache()->isItemOnList($segmentDataKey, $key);
+        return $this->cache->isItemOnList($segmentDataKey, $key);
     }
 
     /**
@@ -36,7 +47,7 @@ public function isInSegment($segmentName, $key)
      */
     public function getChangeNumber($segmentName)
     {
-        $since = Di::getCache()->get(self::getCacheKeyForSinceParameter($segmentName));
+        $since = $this->cache->get(self::getCacheKeyForSinceParameter($segmentName));
         // empty check for nullable value
         return (empty($since)) ? -1 : $since;
     }

src/SplitIO/Component/Cache/SplitCache.php

@@ -1,8 +1,6 @@
 <?php
 namespace SplitIO\Component\Cache;
 
-use SplitIO\Component\Common\Di;
-
 class SplitCache implements SplitCacheInterface
 {
     const KEY_TILL_CACHED_ITEM = 'SPLITIO.splits.till';
@@ -11,6 +9,19 @@ class SplitCache implements SplitCacheInterface
 
     const KEY_TRAFFIC_TYPE_CACHED = 'SPLITIO.trafficType.{trafficTypeName}';
 
+    /**
+     * @var \SplitIO\Component\Cache\Pool
+     */
+    private $cache;
+
+    /**
+     * @param \SplitIO\Component\Cache\Pool $cache
+     */
+    public function __construct(Pool $cache)
+    {
+        $this->cache = $cache;
+    }
+
     private static function getCacheKeyForSinceParameter()
     {
         return self::KEY_TILL_CACHED_ITEM;
@@ -33,11 +44,11 @@ private static function getSplitNameFromCacheKey($key)
     }
 
     /**
-     * @return long
+     * @return int
      */
     public function getChangeNumber()
     {
-        $since = Di::getCache()->get(self::getCacheKeyForSinceParameter());
+        $since = $this->cache->get(self::getCacheKeyForSinceParameter());
         // empty check for nullable value
         return (empty($since)) ? -1 : $since;
     }
@@ -48,18 +59,16 @@ public function getChangeNumber()
      */
     public function getSplit($splitName)
     {
-        $cache = Di::getCache();
-        return $cache->get(self::getCacheKeyForSplit($splitName));
+        return $this->cache->get(self::getCacheKeyForSplit($splitName));
     }
 
     /**
      * @param array $splitNames
-     * @return string JSON representation
+     * @return array
      */
     public function getSplits($splitNames)
     {
-        $cache = Di::getCache();
-        $cacheItems = $cache->fetchMany(array_map('self::getCacheKeyForSplit', $splitNames));
+        $cacheItems = $this->cache->fetchMany(array_map('self::getCacheKeyForSplit', $splitNames));
         $toReturn = array();
         foreach ($cacheItems as $key => $value) {
             $toReturn[self::getSplitNameFromCacheKey($key)] = $value;
@@ -72,8 +81,7 @@ public function getSplits($splitNames)
      */
     public function getSplitNames()
     {
-        $cache = Di::getCache();
-        $splitKeys = $cache->getKeys(self::getCacheKeySearchPattern());
+        $splitKeys = $this->cache->getKeys(self::getCacheKeySearchPattern());
         return array_map('self::getSplitNameFromCacheKey', $splitKeys);
     }
 
@@ -97,9 +105,7 @@ private static function getCacheKeyForTrafficType($trafficType)
      */
     public function trafficTypeExists($trafficType)
     {
-        $cache = Di::getCache();
-
-        $count = $cache->get(self::getCacheKeyForTrafficType($trafficType));
+        $count = $this->cache->get(self::getCacheKeyForTrafficType($trafficType));
         // empty check for nullable value
         return (empty($count) || $count < 1) ? false : true;
     }

src/SplitIO/Component/Cache/SplitCacheInterface.php

@@ -4,7 +4,7 @@
 interface SplitCacheInterface
 {
     /**
-     * @return long
+     * @return int
      */
     public function getChangeNumber();
 

src/SplitIO/Component/Cache/Storage/Adapter/PRedis.php

@@ -2,9 +2,8 @@
 namespace SplitIO\Component\Cache\Storage\Adapter;
 
 use SplitIO\Component\Cache\Storage\Exception\AdapterException;
-use SplitIO\Component\Cache\Item;
 use SplitIO\Component\Utils as SplitIOUtils;
-use SplitIO\Component\Common\Di;
+use SplitIO\Component\Common\Context;
 
 /**
  * Class PRedis
@@ -109,7 +108,7 @@ private function selectKeyHashTag($options)
             return $this->getDefaultKeyHashTag($options); // defaulting to keyHashTag or {SPLITIO}
         }
         $keyHashTags = $options['keyHashTags'];
-        $msg = $this->isValidConfigArray($keyHashTags, 'keyHashTags'); // check if is valid array
+        $msg = $this->isValidConfigArray($keyHashTags, 'keyHashTag'); // check if is valid array
         if (!is_null($msg)) {
             throw new AdapterException($msg);
         }
@@ -170,7 +169,7 @@ private function getRedisConfiguration($options)
         } else {
             // @TODO remove this statement when replication will be deprecated
             if (isset($_options['replication'])) {
-                Di::getLogger()->warning("'replication' option was deprecated please use 'distributedStrategy'");
+                Context::getLogger()->warning("'replication' option was deprecated please use 'distributedStrategy'");
                 if (!isset($_options['distributedStrategy'])) {
                     $_options['distributedStrategy'] = $_options['replication'];
                 }