improved logging multiple factories

Author: mmelograno

src/SplitIO/Component/Common/Di.php

@@ -9,6 +9,13 @@
  */
 class Di
 {
+    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 reusing it throughout your application.";
+
+    const MULTIPLE_INSTANCES = "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.";
+
     private \SplitIO\Component\Log\Logger $logger;
 
     private array $factoryTracker = array();
@@ -68,33 +75,15 @@ public function __wakeup()
      */
     public static function trackFactory($apiKey)
     {
-        $tracked = 1;
-        if (isset(self::getInstance()->factoryTracker[$apiKey])) {
-            $currentInstances = self::getInstance()->factoryTracker[$apiKey];
-            if ($currentInstances == 1) {
-                self::getInstance()->getLogger()->warning(
-                    "Factory Instantiation: You already have 1 factory with this API Key. " .
-                    "We recommend keeping only one instance of the factory at all times " .
-                    "(Singleton pattern) and reusing it throughout your application."
-                );
-            } else {
-                self::getInstance()->getLogger()->warning(
-                    "Factory Instantiation: You already have " . $currentInstances . " factories with this API Key. " .
-                    "We recommend keeping only one instance of the factory at all times " .
-                    "(Singleton pattern) and reusing it throughout your application."
-                );
-            }
-            $tracked = $currentInstances + $tracked;
-        } elseif (count(self::getInstance()->factoryTracker) > 0) {
-            self::getInstance()->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."
-            );
+        $current = self::getInstance()->factoryTracker[$apiKey] ?? 0;
+        if ($current == 0) {
+            self::getInstance()->getLogger()->warning(self::MULTIPLE_INSTANCES);
+        } else {
+            self::getInstance()->getLogger()->warning(sprintf(self::SAME_APIKEY, $current));
         }
-        self::getInstance()->factoryTracker[$apiKey] = $tracked;
-        return $tracked;
+        $current += 1;
+        self::getInstance()->factoryTracker[$apiKey] = $current;
+        return $current;
     }
 
     /**

tests/Suite/InputValidation/FactoryTrackerTest.php

@@ -39,10 +39,10 @@ public function testMultipleClientInstantiation()
         $logger->expects($this->any())
             ->method('warning')
             ->with($this->logicalOr(
-                $this->equalTo("Factory Instantiation: You already have 1 factory with this API Key. "
+                $this->equalTo("Factory Instantiation: You already have 1 factory/factories with this API Key. "
                     . "We recommend keeping only one instance of the factory at all times (Singleton pattern) and reusing "
                     . "it throughout your application."),
-                $this->equalTo("Factory Instantiation: You already have 2 factories with this API Key. "
+                $this->equalTo("Factory Instantiation: You already have 2 factory/factories with this API Key. "
                     . "We recommend keeping only one instance of the factory at all times (Singleton pattern) and reusing "
                     . "it throughout your application."),
                 $this->equalTo("Factory Instantiation: You already have an instance of the Split factory. "