Merge pull request #198 from splitio/task/context

mmelograno · web-flow · commit bc0863279892 · 2023-01-17T15:55:24.000-03:00
replaced Di in favor of Context
diff --git a/src/SplitIO/Component/Cache/EventsCache.php b/src/SplitIO/Component/Cache/EventsCache.php
@@ -1,7 +1,7 @@
 <?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;
 
@@ -26,8 +26,7 @@ public function addEvent(EventQueueMessage $message)
     {
         $queueJSONmessage =  json_encode($message->toArray());
 
-        // @TODO REMOVE LOGGER DI
-        Di::getLogger()->debug("Adding event item into queue: ". $queueJSONmessage);
+        Context::getLogger()->debug("Adding event item into queue: ". $queueJSONmessage);
         return ($this->cache->rightPushInList(self::KEY_EVENTS_LIST, $queueJSONmessage) > 0);
     }
 }
diff --git a/src/SplitIO/Component/Cache/ImpressionCache.php b/src/SplitIO/Component/Cache/ImpressionCache.php
@@ -1,7 +1,7 @@
 <?php
 namespace SplitIO\Component\Cache;
 
-use SplitIO\Component\Common\Di;
+use SplitIO\Component\Common\Context;
 use SplitIO\Component\Cache\KeyFactory;
 use SplitIO\Sdk\QueueMetadataMessage;
 use SplitIO\Component\Cache\Pool;
@@ -44,8 +44,7 @@ function ($imp) use ($metadata) {
             $impressions
         );
 
-        // @TODO REMOVE LOGGER DI
-        Di::getLogger()->debug("Adding impressions into queue: ". implode(",", $toStore));
+        Context::getLogger()->debug("Adding impressions into queue: ". implode(",", $toStore));
         $count = $this->cache->rightPushInList(self::IMPRESSIONS_QUEUE_KEY, $toStore);
         if ($count == count($impressions)) {
             $this->cache->expireKey(self::IMPRESSIONS_QUEUE_KEY, self::IMPRESSION_KEY_DEFAULT_TTL);
diff --git a/src/SplitIO/Component/Cache/Pool.php b/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);
     }
 
diff --git a/src/SplitIO/Component/Cache/SegmentCache.php b/src/SplitIO/Component/Cache/SegmentCache.php
@@ -1,8 +1,6 @@
 <?php
 namespace SplitIO\Component\Cache;
 
-use SplitIO\Component\Common\Di;
-
 class SegmentCache implements SegmentCacheInterface
 {
     const KEY_SEGMENT_DATA = 'SPLITIO.segment.{segmentName}';
diff --git a/src/SplitIO/Component/Cache/SplitCache.php b/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';
diff --git a/src/SplitIO/Component/Cache/Storage/Adapter/PRedis.php b/src/SplitIO/Component/Cache/Storage/Adapter/PRedis.php
@@ -4,7 +4,7 @@
 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
@@ -170,7 +170,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'];
                 }
diff --git a/src/SplitIO/Component/Cache/Storage/Adapter/SafeRedisWrapper.php b/src/SplitIO/Component/Cache/Storage/Adapter/SafeRedisWrapper.php
@@ -4,7 +4,7 @@
 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 SafeRedisWrapper
@@ -32,9 +32,9 @@ public function get($key)
         try {
             return $this->cacheAdapter->get($key);
         } catch (\Exception $e) {
-            Di::getLogger()->critical("An error occurred getting " . $key . " from redis.");
-            Di::getLogger()->critical($e->getMessage());
-            Di::getLogger()->critical($e->getTraceAsString());
+            Context::getLogger()->critical("An error occurred getting " . $key . " from redis.");
+            Context::getLogger()->critical($e->getMessage());
+            Context::getLogger()->critical($e->getTraceAsString());
             return null;
         }
     }
@@ -53,9 +53,9 @@ public function fetchMany(array $keys = array())
         try {
             return $this->cacheAdapter->fetchMany($keys);
         } catch (\Exception $e) {
-            Di::getLogger()->critical("An error occurred getting " . json_encode($keys) . " from redis.");
-            Di::getLogger()->critical($e->getMessage());
-            Di::getLogger()->critical($e->getTraceAsString());
+            Context::getLogger()->critical("An error occurred getting " . json_encode($keys) . " from redis.");
+            Context::getLogger()->critical($e->getMessage());
+            Context::getLogger()->critical($e->getTraceAsString());
             return array();
         }
     }
@@ -70,9 +70,9 @@ public function isOnList($key, $value)
         try {
             return $this->cacheAdapter->isOnList($key, $value);
         } catch (\Exception $e) {
-            Di::getLogger()->critical("An error occurred for " . $key);
-            Di::getLogger()->critical($e->getMessage());
-            Di::getLogger()->critical($e->getTraceAsString());
+            Context::getLogger()->critical("An error occurred for " . $key);
+            Context::getLogger()->critical($e->getMessage());
+            Context::getLogger()->critical($e->getTraceAsString());
             return false;
         }
     }
@@ -86,9 +86,9 @@ public function getKeys($pattern = '*')
         try {
             return $this->cacheAdapter->getKeys($pattern);
         } catch (\Exception $e) {
-            Di::getLogger()->critical("An error occurred getting " . $pattern);
-            Di::getLogger()->critical($e->getMessage());
-            Di::getLogger()->critical($e->getTraceAsString());
+            Context::getLogger()->critical("An error occurred getting " . $pattern);
+            Context::getLogger()->critical($e->getMessage());
+            Context::getLogger()->critical($e->getTraceAsString());
             return array();
         }
     }
@@ -103,9 +103,9 @@ public function rightPushQueue($queueName, $item)
         try {
             return $this->cacheAdapter->rightPushQueue($queueName, $item);
         } catch (\Exception $e) {
-            Di::getLogger()->critical("An error occurred performing RPUSH into " . $queueName);
-            Di::getLogger()->critical($e->getMessage());
-            Di::getLogger()->critical($e->getTraceAsString());
+            Context::getLogger()->critical("An error occurred performing RPUSH into " . $queueName);
+            Context::getLogger()->critical($e->getMessage());
+            Context::getLogger()->critical($e->getTraceAsString());
             return 0;
         }
     }
@@ -120,9 +120,9 @@ public function expireKey($key, $ttl)
         try {
             return $this->cacheAdapter->expireKey($key, $ttl);
         } catch (\Exception $e) {
-            Di::getLogger()->critical("An error occurred setting expiration for " . $key);
-            Di::getLogger()->critical($e->getMessage());
-            Di::getLogger()->critical($e->getTraceAsString());
+            Context::getLogger()->critical("An error occurred setting expiration for " . $key);
+            Context::getLogger()->critical($e->getMessage());
+            Context::getLogger()->critical($e->getTraceAsString());
             return false;
         }
     }
diff --git a/src/SplitIO/Component/Common/Context.php b/src/SplitIO/Component/Common/Context.php
@@ -4,10 +4,10 @@
 use SplitIO\Component\Log\Logger;
 
 /**
- * Class Di
+ * Class Context
  * @package SplitIO\Common
  */
-class Di
+class Context
 {
     const SAME_APIKEY = "Factory Instantiation: You already have %s factory/factories with this API Key. "
         . "We recommend keeping only one instance of the factory at all times (Singleton pattern) and "
diff --git a/src/SplitIO/Engine.php b/src/SplitIO/Engine.php
@@ -6,7 +6,6 @@
 use SplitIO\Engine\Splitter;
 use SplitIO\Grammar\Condition\ConditionTypeEnum;
 use SplitIO\Sdk\Impressions\ImpressionLabel;
-use SplitIO\Component\Common\Di;
 
 class Engine
 {
diff --git a/src/SplitIO/Sdk.php b/src/SplitIO/Sdk.php
@@ -7,7 +7,7 @@
 use SplitIO\Exception\Exception;
 use SplitIO\Sdk\Factory\LocalhostSplitFactory;
 use SplitIO\Sdk\Factory\SplitFactory;
-use SplitIO\Component\Common\Di;
+use SplitIO\Component\Common\Context;
 use SplitIO\Engine\Splitter;
 use SplitIO\Component\Cache\Pool;
 
@@ -32,7 +32,7 @@ public static function factory($apiKey = 'localhost', array $options = array())
         $options['apiKey'] = $apiKey;
 
         //Tracking Factory Instantiation
-        Di::trackFactory($apiKey);
+        Context::trackFactory($apiKey);
 
         //Register Logger
         self::registerLogger((isset($options['log'])) ? $options['log'] : array());
@@ -57,7 +57,7 @@ public static function factory($apiKey = 'localhost', array $options = array())
     private static function registerLogger(array $options)
     {
         $logger = LoggerFactory::setupLogger($options);
-        Di::setLogger($logger);
+        Context::setLogger($logger);
     }
 
     private static function configureCache(array $options)
@@ -88,6 +88,6 @@ private static function configureCache(array $options)
 
     private static function setIP($ip)
     {
-        \SplitIO\Component\Common\Di::setIPAddress($ip);
+        \SplitIO\Component\Common\Context::setIPAddress($ip);
     }
 }
diff --git a/src/SplitIO/Sdk/Manager/SplitManager.php b/src/SplitIO/Sdk/Manager/SplitManager.php
@@ -2,7 +2,6 @@
 namespace SplitIO\Sdk\Manager;
 
 use \stdClass;
-use SplitIO\Component\Common\Di;
 use SplitIO\Grammar\Condition;
 use SplitIO\Grammar\Split;
 use SplitIO\Split as SplitApp;
diff --git a/src/SplitIO/Split.php b/src/SplitIO/Split.php
@@ -1,7 +1,7 @@
 <?php
 namespace SplitIO;
 
-use SplitIO\Component\Common\Di;
+use SplitIO\Component\Common\Context;
 
 class Split
 {
@@ -11,6 +11,6 @@ class Split
      */
     public static function logger()
     {
-        return Di::getLogger();
+        return Context::getLogger();
     }
 }
diff --git a/src/SplitIO/functions.php b/src/SplitIO/functions.php
@@ -71,7 +71,7 @@ function parseSplitsFile($fileContent)
 
 function getHostIpAddress()
 {
-    $diIpAddress = \SplitIO\Component\Common\Di::getIPAddress();
+    $diIpAddress = \SplitIO\Component\Common\Context::getIPAddress();
     if (!is_null($diIpAddress) && is_string($diIpAddress) && trim($diIpAddress)) {
         return $diIpAddress;
     } elseif (isset($_SERVER['SERVER_ADDR']) && is_string($_SERVER['SERVER_ADDR'])
diff --git a/tests/Suite/Attributes/SdkAttributesTest.php b/tests/Suite/Attributes/SdkAttributesTest.php
@@ -5,7 +5,6 @@
 use Monolog\Handler\ErrorLogHandler;
 use SplitIO\Component\Cache\SegmentCache;
 use SplitIO\Component\Cache\SplitCache;
-use SplitIO\Component\Common\Di;
 
 use SplitIO\Test\Utils;
 
diff --git a/tests/Suite/Component/TrafficTypeTests.php b/tests/Suite/Component/TrafficTypeTests.php
@@ -3,7 +3,7 @@
 
 use SplitIO\Component\Cache\SplitCache;
 use SplitIO\Test\Suite\Redis\ReflectiveTools;
-use SplitIO\Component\Common\Di;
+use SplitIO\Component\Common\Context;
 
 class TrafficTypeTest extends \PHPUnit\Framework\TestCase
 {
@@ -17,7 +17,7 @@ private function getMockedLogger()
                 'alert', 'notice', 'write', 'log'))
             ->getMock();
 
-        Di::setLogger($logger);
+            Context::setLogger($logger);
 
         return $logger;
     }
@@ -42,7 +42,7 @@ public function testTrafficTypeWarning()
 
         $this->assertEquals($keyTrafficType, 'SPLITIO.trafficType.abc');
 
-        $redisClient = ReflectiveTools::clientFromCachePool(Di::getCache());
+        $redisClient = ReflectiveTools::clientFromCachePool(Context::getCache());
         $redisClient->del($keyTrafficType);
 
         $splitCache = new SplitCache();
diff --git a/tests/Suite/DynamicConfigurations/SplitTest.php b/tests/Suite/DynamicConfigurations/SplitTest.php
@@ -1,7 +1,6 @@
 <?php
 namespace SplitIO\Test\Suite\Sdk;
 
-use SplitIO\Component\Common\Di;
 use SplitIO\Test\Suite\Redis\ReflectiveTools;
 use SplitIO\Component\Cache\SplitCache;
 use SplitIO\Grammar\Split;
diff --git a/tests/Suite/Engine/HashTest.php b/tests/Suite/Engine/HashTest.php
@@ -8,7 +8,6 @@
 use SplitIO\Engine\Hash\HashAlgorithmEnum;
 use SplitIO\Grammar\Split;
 use SplitIO\Test\Suite\Redis\ReflectiveTools;
-use SplitIO\Component\Common\Di;
 
 use SplitIO\Test\Utils;
 
diff --git a/tests/Suite/Engine/SplitterTest.php b/tests/Suite/Engine/SplitterTest.php
@@ -9,15 +9,15 @@
 use SplitIO\Engine\Hash\HashAlgorithmEnum;
 use SplitIO\Grammar\Split;
 use SplitIO\Engine;
-use SplitIO\Component\Common\Di;
+use SplitIO\Component\Common\Context;
 
 class SplitterTest extends \PHPUnit\Framework\TestCase
 {
 
     public function testDiLog()
     {
         $logger = LoggerFactory::setupLogger(array('adapter' => 'stdout', 'level' => 'error'));
-        Di::setLogger($logger);
+        Context::setLogger($logger);
 
         $this->assertTrue(true);
     }
diff --git a/tests/Suite/Matchers/MatchersTest.php b/tests/Suite/Matchers/MatchersTest.php
@@ -7,7 +7,6 @@
 use SplitIO\Component\Cache\SplitCache;
 use SplitIO\Grammar\Condition\Matcher;
 use SplitIO\Grammar\Condition\Matcher\DataType\DateTime;
-use SplitIO\Component\Common\Di;
 use SplitIO\Test\Suite\Redis\ReflectiveTools;
 use \ReflectionMethod;
 
diff --git a/tests/Suite/Redis/CacheInterfacesTest.php b/tests/Suite/Redis/CacheInterfacesTest.php
@@ -5,7 +5,7 @@
 use SplitIO\Component\Cache\Pool;
 use SplitIO\Component\Cache\SegmentCache;
 use SplitIO\Component\Cache\SplitCache;
-use SplitIO\Component\Common\Di;
+use SplitIO\Component\Common\Context;
 use SplitIO\Component\Cache\BlockUntilReadyCache;
 use SplitIO\Component\Log\Handler\Stdout;
 use SplitIO\Component\Log\Logger;
@@ -42,7 +42,7 @@ public function testDiLog()
 
         $logger = new Logger($logAdapter, LogLevelEnum::INFO);
 
-        Di::getInstance()->setLogger($logger);
+        Context::getInstance()->setLogger($logger);
 
         $this->assertTrue(true);
     }
diff --git a/tests/Suite/Redis/ReflectiveTools.php b/tests/Suite/Redis/ReflectiveTools.php
diff --git a/tests/Suite/Sdk/ImpressionsTest.php b/tests/Suite/Sdk/ImpressionsTest.php
diff --git a/tests/Suite/Sdk/SdkReadOnlyTest.php b/tests/Suite/Sdk/SdkReadOnlyTest.php
diff --git a/tests/Suite/TrafficAllocation/TrafficAllocationTest.php b/tests/Suite/TrafficAllocation/TrafficAllocationTest.php

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`<?php`
`2`	`2`	`namespace SplitIO\Component\Cache;`
`3`	`3`
`4`		`-use SplitIO\Component\Common\Di;`
	`4`	`+use SplitIO\Component\Common\Context;`
`5`	`5`	`use SplitIO\Sdk\Events\EventQueueMessage;`
`6`	`6`	`use SplitIO\Component\Cache\Pool;`
`7`	`7`
`@@ -26,8 +26,7 @@ public function addEvent(EventQueueMessage $message)`
`26`	`26`	`{`
`27`	`27`	`$queueJSONmessage = json_encode($message->toArray());`
`28`	`28`
`29`		`- // @TODO REMOVE LOGGER DI`
`30`		`- Di::getLogger()->debug("Adding event item into queue: ". $queueJSONmessage);`
	`29`	`+ Context::getLogger()->debug("Adding event item into queue: ". $queueJSONmessage);`
`31`	`30`	`return ($this->cache->rightPushInList(self::KEY_EVENTS_LIST, $queueJSONmessage) > 0);`
`32`	`31`	`}`
`33`	`32`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`
`4`	`4`	`use SplitIO\Component\Cache\Storage\Adapter\PRedis as PRedisAdapter;`
`5`	`5`	`use SplitIO\Component\Cache\Storage\Adapter\SafeRedisWrapper;`
`6`		`-use SplitIO\Component\Common\Di;`
	`6`	`+use SplitIO\Component\Common\Context;`
`7`	`7`
`8`	`8`	`class Pool extends CacheKeyTrait`
`9`	`9`	`{`
`@@ -39,7 +39,7 @@ public function __construct(array $options = array())`
`39`	`39`	`public function get($key)`
`40`	`40`	`{`
`41`	`41`	`$this->assertValidKey($key);`
`42`		`- Di::getLogger()->debug("Fetching item $key from cache");`
	`42`	`+ Context::getLogger()->debug("Fetching item $key from cache");`
`43`	`43`	`return $this->adapter->get($key);`
`44`	`44`	`}`
`45`	`45`
Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,6 @@`
`1`	`1`	`<?php`
`2`	`2`	`namespace SplitIO\Component\Cache;`
`3`	`3`
`4`		`-use SplitIO\Component\Common\Di;`
`5`		`-`
`6`	`4`	`class SegmentCache implements SegmentCacheInterface`
`7`	`5`	`{`
`8`	`6`	`const KEY_SEGMENT_DATA = 'SPLITIO.segment.{segmentName}';`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,6 @@`
`6`	`6`	`use SplitIO\Engine\Splitter;`
`7`	`7`	`use SplitIO\Grammar\Condition\ConditionTypeEnum;`
`8`	`8`	`use SplitIO\Sdk\Impressions\ImpressionLabel;`
`9`		`-use SplitIO\Component\Common\Di;`
`10`	`9`
`11`	`10`	`class Engine`
`12`	`11`	`{`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`	`use SplitIO\Exception\Exception;`
`8`	`8`	`use SplitIO\Sdk\Factory\LocalhostSplitFactory;`
`9`	`9`	`use SplitIO\Sdk\Factory\SplitFactory;`
`10`		`-use SplitIO\Component\Common\Di;`
	`10`	`+use SplitIO\Component\Common\Context;`
`11`	`11`	`use SplitIO\Engine\Splitter;`
`12`	`12`	`use SplitIO\Component\Cache\Pool;`
`13`	`13`
`@@ -32,7 +32,7 @@ public static function factory($apiKey = 'localhost', array $options = array())`
`32`	`32`	`$options['apiKey'] = $apiKey;`
`33`	`33`
`34`	`34`	`//Tracking Factory Instantiation`
`35`		`- Di::trackFactory($apiKey);`
	`35`	`+ Context::trackFactory($apiKey);`
`36`	`36`
`37`	`37`	`//Register Logger`
`38`	`38`	`self::registerLogger((isset($options['log'])) ? $options['log'] : array());`
`@@ -57,7 +57,7 @@ public static function factory($apiKey = 'localhost', array $options = array())`
`57`	`57`	`private static function registerLogger(array $options)`
`58`	`58`	`{`
`59`	`59`	`$logger = LoggerFactory::setupLogger($options);`
`60`		`- Di::setLogger($logger);`
	`60`	`+ Context::setLogger($logger);`
`61`	`61`	`}`
`62`	`62`
`63`	`63`	`private static function configureCache(array $options)`
`@@ -88,6 +88,6 @@ private static function configureCache(array $options)`
`88`	`88`
`89`	`89`	`private static function setIP($ip)`
`90`	`90`	`{`
`91`		`- \SplitIO\Component\Common\Di::setIPAddress($ip);`
	`91`	`+ \SplitIO\Component\Common\Context::setIPAddress($ip);`
`92`	`92`	`}`
`93`	`93`	`}`