Populate log and error messages (#6)

Author: aliabbasrizvi

src/Optimizely/Bucketer.php

@@ -15,8 +15,10 @@
  * limitations under the License.
  */
 namespace Optimizely;
+use Monolog\Logger;
 use Optimizely\Entity\Experiment;
 use Optimizely\Entity\Variation;
+use Optimizely\Logger\LoggerInterface;
 
 /**
  * Class Bucketer
@@ -45,6 +47,20 @@ class Bucketer
      */
     private static $MAX_HASH_VALUE = 0x100000000;
 
+    /**
+     * @var LoggerInterface Logger for logging messages.
+     */
+    private $_logger;
+
+    /**
+     * Bucketer constructor.
+     * @param LoggerInterface $logger
+     */
+    public function __construct(LoggerInterface $logger)
+    {
+        $this->_logger = $logger;
+    }
+
     /**
      * Generate a hash value to be used in determining which variation the user will be put in.
      *
@@ -82,8 +98,8 @@ private function findBucket($userId, $parentId, $trafficAllocations)
     {
         // Generate bucketing ID based on combination of user ID and experiment ID or group ID.
         $bucketingId = $userId.$parentId;
-
         $bucketingNumber = $this->generateBucketValue($bucketingId);
+        $this->_logger->log(Logger::DEBUG, sprintf('Assigned bucket %s to user "%s".', $bucketingNumber, $userId));
 
         forEach ($trafficAllocations as $trafficAllocation)
         {
@@ -116,6 +132,12 @@ public function bucket(ProjectConfig $config, Experiment $experiment, $userId)
         if (!is_null($forcedVariations) && isset($forcedVariations[$userId])) {
             $variationKey = $forcedVariations[$userId];
             $variation = $config->getVariationFromKey($experiment->getKey(), $variationKey);
+            if ($variationKey) {
+                $this->_logger->log(
+                    Logger::INFO,
+                    sprintf('User "%s" is forced in variation "%s".', $userId, $variationKey)
+                );
+            }
             return $variation;
         }
 
@@ -129,21 +151,37 @@ public function bucket(ProjectConfig $config, Experiment $experiment, $userId)
 
             $userExperimentId = $this->findBucket($userId, $group->getId(), $group->getTrafficAllocation());
             if (is_null($userExperimentId)) {
+                $this->_logger->log(Logger::INFO, sprintf('User "%s" is in no experiment.', $userId));
                 return new Variation();
             }
 
             if ($userExperimentId != $experiment->getId()) {
+                $this->_logger->log(
+                    Logger::INFO,
+                    sprintf('User "%s" is not in experiment %s of group %s.',
+                        $userId, $experiment->getKey(), $experiment->getGroupId()
+                    ));
                 return new Variation();
             }
+
+            $this->_logger->log(Logger::INFO,
+                sprintf('User "%s" is in experiment %s of group %s.',
+                    $userId, $experiment->getKey(), $experiment->getGroupId()
+                ));
         }
 
         // Bucket user if not in whitelist and in group (if any).
         $variationId = $this->findBucket($userId, $experiment->getId(), $experiment->getTrafficAllocation());
         if (!is_null($variationId)) {
             $variation = $config->getVariationFromId($experiment->getKey(), $variationId);
+            $this->_logger->log(Logger::INFO,
+                sprintf('User "%s" is in variation %s of experiment %s.',
+                    $userId, $variation->getKey(), $experiment->getKey()
+                ));
             return $variation;
         }
 
+        $this->_logger->log(Logger::INFO,  sprintf('User "%s" is in no variation.', $userId));
         return new Variation();
     }
 }

src/Optimizely/Event/Builder/EventBuilder.php

@@ -38,12 +38,12 @@ class EventBuilder
     /**
      * @var string URL to send impression event to.
      */
-    private static $IMPRESSION_ENDPOINT = 'https://p13nlog.dz.optimizely.com/log/decision';
+    private static $IMPRESSION_ENDPOINT = 'https://logx.optimizely.com/log/decision';
 
     /**
      * @var string URL to send conversion event to.
      */
-    private static $CONVERSION_ENDPOINT = 'https://p13nlog.dz.optimizely.com/log/event';
+    private static $CONVERSION_ENDPOINT = 'https://logx.optimizely.com/log/event';
 
     /**
      * @var string HTTP method to be used when making call to log endpoint.

src/Optimizely/Optimizely.php

@@ -16,9 +16,13 @@
  */
 namespace Optimizely;
 
+use Doctrine\Instantiator\Exception\InvalidArgumentException;
 use Exception;
-use Optimizely\Entity\Experiment;
+use Optimizely\Exceptions\InvalidAttributeException;
 use Throwable;
+use Monolog\Logger;
+use Optimizely\Entity\Experiment;
+use Optimizely\Logger\DefaultLogger;
 use Optimizely\ErrorHandler\ErrorHandlerInterface;
 use Optimizely\ErrorHandler\NoOpErrorHandler;
 use Optimizely\Event\Builder\EventBuilder;
@@ -65,6 +69,11 @@ class Optimizely
      */
     private $_eventBuilder;
 
+    /**
+     * @var boolean Denotes whether Optimizely object is valid or not.
+     */
+    private $_isValid;
+
     /**
      * Optimizely constructor for managing Full Stack PHP projects.
      *
@@ -80,17 +89,35 @@ public function __construct($datafile,
                                 ErrorHandlerInterface $errorHandler = null,
                                 $skipJsonValidation = false)
     {
+        $this->_isValid = true;
         $this->_eventDispatcher = $eventDispatcher ?: new DefaultEventDispatcher();
-        $this->_logger = $logger ?: new NoOpLogger();;
-        $this->_errorHandler = $errorHandler ?: new NoOpErrorHandler();;
+        $this->_logger = $logger ?: new NoOpLogger();
+        $this->_errorHandler = $errorHandler ?: new NoOpErrorHandler();
+
+        if (!$this->validateInputs($datafile, $skipJsonValidation)) {
+            $this->_isValid = false;
+            $this->_logger = new DefaultLogger();
+            $this->_logger->log(Logger::ERROR, 'Provided "datafile" has invalid schema.');
+            return;
+        }
 
-        $this->validateInputs($datafile, $skipJsonValidation);
         try {
-          $this->_config = new ProjectConfig($datafile);
+          $this->_config = new ProjectConfig($datafile, $this->_logger, $this->_errorHandler);
         }
-        catch (Throwable $exception) {}
-        catch (Exception $exception) {}
-        $this->_bucketer = new Bucketer();
+        catch (Throwable $exception) {
+            $this->_isValid = false;
+            $this->_logger = new DefaultLogger();
+            $this->_logger->log(Logger::ERROR, 'Provided "datafile" is in an invalid format.');
+            return;
+        }
+        catch (Exception $exception) {
+            $this->_isValid = false;
+            $this->_logger = new DefaultLogger();
+            $this->_logger->log(Logger::ERROR, 'Provided "datafile" is in an invalid format.');
+            return;
+        }
+
+        $this->_bucketer = new Bucketer($this->_logger);
         $this->_eventBuilder = new EventBuilder($this->_bucketer);
     }
 
@@ -119,9 +146,16 @@ private function validateInputs($datafile, $skipJsonValidation)
      */
     private function validatePreconditions($experiment, $userId, $attributes)
     {
-        //@TODO(ali): Insert attributes validation
+        if (!is_null($attributes) && !Validator::areAttributesValid($attributes)) {
+            $this->_logger->log(Logger::ERROR, 'Provided attributes are in an invalid format.');
+            $this->_errorHandler->handleError(
+                new InvalidAttributeException('Provided attributes are in an invalid format.')
+            );
+            return false;
+        }
 
         if (!$experiment->isExperimentRunning()) {
+            $this->_logger->log(Logger::INFO, sprintf('Experiment "%s" is not running.', $experiment->getKey()));
             return false;
         }
 
@@ -130,6 +164,10 @@ private function validatePreconditions($experiment, $userId, $attributes)
         }
 
         if (!Validator::isUserInExperiment($this->_config, $experiment, $attributes)) {
+            $this->_logger->log(
+                Logger::INFO,
+                sprintf('User "%s" does not meet conditions to be in experiment "%s".', $userId, $experiment->getKey())
+            );
             return false;
         }
 
@@ -147,27 +185,52 @@ private function validatePreconditions($experiment, $userId, $attributes)
      */
     public function activate($experimentKey, $userId, $attributes = null)
     {
+        if (!$this->_isValid) {
+            $this->_logger->log(Logger::ERROR, 'Datafile has invalid format. Failing "activate".');
+            return null;
+        }
+
         $experiment = $this->_config->getExperimentFromKey($experimentKey);
 
         if (is_null($experiment->getKey())) {
+            $this->_logger->log(Logger::INFO, sprintf('Not activating user "%s".', $userId));
             return null;
         }
 
         if (!$this->validatePreconditions($experiment, $userId, $attributes)) {
+            $this->_logger->log(Logger::INFO, sprintf('Not activating user "%s".', $userId));
             return null;
         }
 
         $variation = $this->_bucketer->bucket($this->_config, $experiment, $userId);
         $variationKey = $variation->getKey();
 
         if (is_null($variationKey)) {
+            $this->_logger->log(Logger::INFO, sprintf('Not activating user "%s".', $userId));
             return $variationKey;
         }
 
         $impressionEvent = $this->_eventBuilder
             ->createImpressionEvent($this->_config, $experiment, $variation->getId(), $userId, $attributes);
+        $this->_logger->log(Logger::INFO, sprintf('Activating user "%s" in experiment "%s".', $userId, $experimentKey));
+        $this->_logger->log(
+            Logger::DEBUG,
+            sprintf('Dispatching impression event to URL %s with params %s.',
+                $impressionEvent->getUrl(), implode(',', $impressionEvent->getParams())
+            )
+        );
 
-        $this->_eventDispatcher->dispatchEvent($impressionEvent);
+        try {
+            $this->_eventDispatcher->dispatchEvent($impressionEvent);
+        }
+        catch (Throwable $exception) {
+            $this->_logger->log(Logger::ERROR, sprintf(
+                'Unable to dispatch impression event. Error %s', $exception->getMessage()));
+        }
+        catch (Exception $exception) {
+            $this->_logger->log(Logger::ERROR, sprintf(
+                'Unable to dispatch impression event. Error %s', $exception->getMessage()));
+        }
 
         return $variationKey;
     }
@@ -182,13 +245,23 @@ public function activate($experimentKey, $userId, $attributes = null)
      */
     public function track($eventKey, $userId, $attributes = null, $eventValue = null)
     {
+        if (!$this->_isValid) {
+            $this->_logger->log(Logger::ERROR, 'Datafile has invalid format. Failing "track".');
+            return;
+        }
+
         if (!is_null($attributes) && !Validator::areAttributesValid($attributes)) {
+            $this->_logger->log(Logger::ERROR, 'Provided attributes are in an invalid format.');
+            $this->_errorHandler->handleError(
+                new InvalidAttributeException('Provided attributes are in an invalid format.')
+            );
             return;
         }
 
         $event = $this->_config->getEvent($eventKey);
 
         if (is_null($event->getKey())) {
+            $this->_logger->log(Logger::ERROR, sprintf('Not tracking user "%s" for event "%s".', $userId, $eventKey));
             return;
         }
 
@@ -198,6 +271,9 @@ public function track($eventKey, $userId, $attributes = null, $eventValue = null
             $experiment = $this->_config->getExperimentFromId($experimentId);
             if ($this->validatePreconditions($experiment, $userId, $attributes)) {
                 array_push($validExperiments, $experiment);
+            } else {
+                $this->_logger->log(Logger::INFO, sprintf('Not tracking user "%s" for experiment "%s".',
+                    $userId, $experiment->getKey()));
             }
         }
 
@@ -211,7 +287,30 @@ public function track($eventKey, $userId, $attributes = null, $eventValue = null
                     $attributes,
                     $eventValue
                 );
-            $this->_eventDispatcher->dispatchEvent($conversionEvent);
+            $this->_logger->log(Logger::INFO, sprintf('Tracking event "%s" for user "%s".', $eventKey, $userId));
+            $this->_logger->log(
+                Logger::DEBUG,
+                sprintf('Dispatching conversion event to URL %s with params %s.',
+                    $conversionEvent->getUrl(), implode(',', $conversionEvent->getParams())
+                ));
+
+            try {
+                $this->_eventDispatcher->dispatchEvent($conversionEvent);
+            }
+            catch (Throwable $exception) {
+                $this->_logger->log(Logger::ERROR, sprintf(
+                    'Unable to dispatch conversion event. Error %s', $exception->getMessage()));
+            }
+            catch (Exception $exception) {
+                $this->_logger->log(Logger::ERROR, sprintf(
+                    'Unable to dispatch conversion event. Error %s', $exception->getMessage()));
+            }
+
+        } else {
+            $this->_logger->log(
+                Logger::INFO,
+                sprintf('There are no valid experiments for event "%s" to track.', $eventKey)
+            );
         }
     }
 
@@ -226,6 +325,11 @@ public function track($eventKey, $userId, $attributes = null, $eventValue = null
      */
     public function getVariation($experimentKey, $userId, $attributes = null)
     {
+        if (!$this->_isValid) {
+            $this->_logger->log(Logger::ERROR, 'Datafile has invalid format. Failing "getVariation".');
+            return null;
+        }
+
         $experiment = $this->_config->getExperimentFromKey($experimentKey);
 
         if (is_null($experiment->getKey())) {