Merge pull request #196 from splitio/task/DiLogger

Task/di logger

Author: mmelograno

src/SplitIO/Component/Common/Di.php

@@ -1,29 +1,25 @@
 <?php
 namespace SplitIO\Component\Common;
 
-use Psr\Log\LoggerInterface;
-use SplitIO\Component\Cache\Pool;
+use SplitIO\Component\Log\Logger;
 
 /**
  * Class Di
  * @package SplitIO\Common
  */
 class Di
 {
-    const KEY_LOG = 'SPLIT-LOGGER';
+    private \SplitIO\Component\Log\Logger $logger;
 
-    const KEY_FACTORY_TRACKER = 'FACTORY-TRACKER';
+    private int $factoryTracker = 0;
+
+    private string $ipAddress = "";
 
     /**
      * @var Singleton The reference to *Singleton* instance of this class
      */
     private static $instance;
 
-    /**
-     * @var array
-     */
-    private $container = array();
-
     /**
      * Returns the *Singleton* instance of this class.
      *
@@ -67,57 +63,54 @@ public function __wakeup()
     }
 
     /**
-     * @param $key
-     * @param $instance
+     * @return int
      */
-    private function setKey($key, $instance)
+    public static function trackFactory()
     {
-        $this->container[$key] = $instance;
+        self::getInstance()->factoryTracker += 1;
+        return self::getInstance()->factoryTracker;
     }
 
     /**
-     * @param $key
-     * @return mixed
+     * @param \SplitIO\Component\Log\Logger $logger
      */
-    private function getKey($key)
+    public static function setLogger(Logger $logger)
     {
-        return (isset($this->container[$key])) ? $this->container[$key] : null;
-    }
-
-    /**
-     * Set an object instance with its key
-     * @param $key
-     * @param $instance
-     */
-    public static function set($key, $instance)
-    {
-        self::getInstance()->setKey($key, $instance);
+        if (!isset(self::getInstance()->logger)) {
+            self::getInstance()->logger = $logger;
+            return;
+        }
+        self::getInstance()->logger->debug("logger was set before, ignoring new instance provided");
     }
 
     /**
-     * Given a key returns the object instance associated with this.
-     * @param $key
-     * @return mixed
+     * @return \SplitIO\Component\Log\Logger
      */
-    public static function get($key)
+    public static function getLogger()
     {
-        return self::getInstance()->getKey($key);
+        if (!isset(self::getInstance()->logger)) {
+            throw new Exception("logger was not set yet");
+        }
+        return self::getInstance()->logger;
     }
 
-
     /**
-     * @param LoggerInterface $logger
+     * @param string $ip
      */
-    public static function setLogger($logger)
+    public static function setIPAddress(string $ip)
     {
-        self::set(self::KEY_LOG, $logger);
+        if (empty(self::getInstance()->ipAddress)) {
+            self::getInstance()->ipAddress = $ip;
+            return;
+        }
+        self::getInstance()->getLogger()->debug("IPAddress was set before, ignoring new instance provided");
     }
 
     /**
-     * @return null|\Psr\Log\LoggerInterface
+     * @return string
      */
-    public static function getLogger()
+    public static function getIPAddress()
     {
-        return self::get(self::KEY_LOG);
+        return self::getInstance()->ipAddress;
     }
 }

src/SplitIO/Component/Common/ServiceProvider.php

@@ -1,7 +1,6 @@
 <?php
 namespace SplitIO\Grammar\Condition\Matcher;
 
-use SplitIO\Split as SplitApp;
 use SplitIO\Grammar\Condition\Matcher;
 
 class ContainsString extends AbstractMatcher

src/SplitIO/Grammar/Condition/Matcher/ContainsString.php

@@ -1,7 +1,6 @@
 <?php
 namespace SplitIO\Grammar\Condition\Matcher;
 
-use SplitIO\Split as SplitApp;
 use SplitIO\Grammar\Condition\Matcher;
 
 class EndsWith extends AbstractMatcher

src/SplitIO/Grammar/Condition/Matcher/EndsWith.php

@@ -1,7 +1,6 @@
 <?php
 namespace SplitIO\Grammar\Condition\Matcher;
 
-use SplitIO\Split as SplitApp;
 use SplitIO\Grammar\Condition\Matcher;
 
 class EqualToBoolean extends AbstractMatcher

src/SplitIO/Grammar/Condition/Matcher/EqualToBoolean.php

@@ -1,7 +1,6 @@
 <?php
 namespace SplitIO\Grammar\Condition\Matcher;
 
-use SplitIO\Split as SplitApp;
 use SplitIO\Grammar\Condition\Matcher;
 
 class Regex extends AbstractMatcher

src/SplitIO/Grammar/Condition/Matcher/Regex.php

@@ -1,7 +1,6 @@
 <?php
 namespace SplitIO\Grammar\Condition\Matcher;
 
-use SplitIO\Split as SplitApp;
 use SplitIO\Grammar\Condition\Matcher;
 
 class StartsWith extends AbstractMatcher

src/SplitIO/Grammar/Condition/Matcher/StartsWith.php

@@ -1,7 +1,6 @@
 <?php
 namespace SplitIO\Grammar\Condition\Matcher;
 
-use SplitIO\Split as SplitApp;
 use SplitIO\Grammar\Condition\Matcher;
 
 class Whitelist extends AbstractMatcher

src/SplitIO/Grammar/Condition/Matcher/Whitelist.php

@@ -31,20 +31,15 @@ public static function factory($apiKey = 'localhost', array $options = array())
         //Adding API Key into args array.
         $options['apiKey'] = $apiKey;
 
-        if (self::instanceExists()) {
-            return null;
-        }
+        //Tracking Factory Instantiation
         self::registerInstance();
 
-        if ($apiKey == 'localhost') {
-            //Register Logger
-            self::registerLogger((isset($options['log'])) ? $options['log'] : array());
+        //Register Logger
+        self::registerLogger((isset($options['log'])) ? $options['log'] : array());
 
+        if ($apiKey == 'localhost') {
             return new LocalhostSplitFactory($options);
         } else {
-            //Register Logger
-            self::registerLogger((isset($options['log'])) ? $options['log'] : array());
-
             //Register Cache
             $cache = self::configureCache((isset($options['cache'])) ? $options['cache'] : array());
 
@@ -62,7 +57,7 @@ public static function factory($apiKey = 'localhost', array $options = array())
     private static function registerLogger(array $options)
     {
         $logger = LoggerFactory::setupLogger($options);
-        ServiceProvider::registerLogger($logger);
+        Di::setLogger($logger);
     }
 
     private static function configureCache(array $options)
@@ -93,31 +88,18 @@ private static function configureCache(array $options)
 
     private static function setIP($ip)
     {
-        \SplitIO\Component\Common\Di::set('ipAddress', $ip);
-    }
-
-    /**
-     * Check factory instance
-     */
-    private static function instanceExists()
-    {
-        $value = Di::get(Di::KEY_FACTORY_TRACKER);
-        /* TODO MULTIPLE ALLOW
-        if (is_null($value) || !$value) {
-            return false;
-        }
-        Di::getLogger()->critical("Factory Instantiation: creating multiple factories is not possible. "
-            . "You have already created a factory.");
-        return true;
-        */
-        return false;
+        \SplitIO\Component\Common\Di::setIPAddress($ip);
     }
 
     /**
      * Register factory instance
      */
     private static function registerInstance()
     {
-        Di::set(Di::KEY_FACTORY_TRACKER, true);
+        if (Di::trackFactory() > 1) {
+            Di::getLogger()->warning("Factory Instantiation: You already have an instance of the Split factory. "
+            . "Make sure you definitely want this additional instance. We recommend keeping only one instance of "
+            . "the factory at all times (Singleton pattern) and reusing it throughout your application.");
+        }
     }
 }

src/SplitIO/Sdk.php

@@ -1,7 +1,6 @@
 <?php
 namespace SplitIO;
 
-use SplitIO\Split as SplitApp;
 use SplitIO\Grammar\Condition\Partition\TreatmentEnum;
 
 function version()
@@ -72,7 +71,7 @@ function parseSplitsFile($fileContent)
 
 function getHostIpAddress()
 {
-    $diIpAddress = \SplitIO\Component\Common\Di::get('ipAddress');
+    $diIpAddress = \SplitIO\Component\Common\Di::getIPAddress();
     if (!is_null($diIpAddress) && is_string($diIpAddress) && trim($diIpAddress)) {
         return $diIpAddress;
     } elseif (isset($_SERVER['SERVER_ADDR']) && is_string($_SERVER['SERVER_ADDR'])