Skip to content

sendImpressionEvent and TestData update #80

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 14, 2017
Merged

sendImpressionEvent and TestData update #80

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
150 changes: 92 additions & 58 deletions src/Optimizely/Optimizely.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,13 +94,14 @@ class Optimizely
* @param $skipJsonValidation boolean representing whether JSON schema validation needs to be performed.
* @param $userProfileService UserProfileServiceInterface
*/
public function __construct($datafile,
EventDispatcherInterface $eventDispatcher = null,
LoggerInterface $logger = null,
ErrorHandlerInterface $errorHandler = null,
$skipJsonValidation = false,
UserProfileServiceInterface $userProfileService = null)
{
public function __construct(
$datafile,
EventDispatcherInterface $eventDispatcher = null,
LoggerInterface $logger = null,
ErrorHandlerInterface $errorHandler = null,
$skipJsonValidation = false,
UserProfileServiceInterface $userProfileService = null
) {
$this->_isValid = true;
$this->_eventDispatcher = $eventDispatcher ?: new DefaultEventDispatcher();
$this->_logger = $logger ?: new NoOpLogger();
Expand All @@ -114,15 +115,13 @@ public function __construct($datafile,
}

try {
$this->_config = new ProjectConfig($datafile, $this->_logger, $this->_errorHandler);
}
catch (Throwable $exception) {
$this->_config = new ProjectConfig($datafile, $this->_logger, $this->_errorHandler);
} 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) {
} catch (Exception $exception) {
$this->_isValid = false;
$this->_logger = new DefaultLogger();
$this->_logger->log(Logger::ERROR, 'Provided "datafile" is in an invalid format.');
Expand Down Expand Up @@ -157,7 +156,8 @@ private function validateDatafile($datafile, $skipJsonValidation)
*
* @return boolean Representing whether all user inputs are valid.
*/
private function validateUserInputs($attributes, $eventTags = null) {
private function validateUserInputs($attributes, $eventTags = null)
{
if (!is_null($attributes) && !Validator::areAttributesValid($attributes)) {
$this->_logger->log(Logger::ERROR, 'Provided attributes are in an invalid format.');
$this->_errorHandler->handleError(
Expand Down Expand Up @@ -189,16 +189,20 @@ private function validateUserInputs($attributes, $eventTags = null) {
*
* @return Array Of objects where each object contains the ID of the experiment to track and the ID of the variation the user is bucketed into.
*/
private function getValidExperimentsForEvent($event, $userId, $attributes = null) {
private function getValidExperimentsForEvent($event, $userId, $attributes = null)
{
$validExperiments = [];
forEach ($event->getExperimentIds() as $experimentId) {
foreach ($event->getExperimentIds() as $experimentId) {
$experiment = $this->_config->getExperimentFromId($experimentId);
$experimentKey = $experiment->getKey();
$variationKey = $this->getVariation($experimentKey, $userId, $attributes);

if (is_null($variationKey)) {
$this->_logger->log(Logger::INFO, sprintf('Not tracking user "%s" for experiment "%s".',
$userId, $experimentKey));
$this->_logger->log(Logger::INFO, sprintf(
'Not tracking user "%s" for experiment "%s".',
$userId,
$experimentKey
));
continue;
}

Expand All @@ -209,6 +213,52 @@ private function getValidExperimentsForEvent($event, $userId, $attributes = null
return $validExperiments;
}

/**
* @param string Experiment key
* @param string Variation key
* @param string User ID
* @param array Associative array of user attributes
*/
protected function sendImpressionEvent($experimentKey, $variationKey, $userId, $attributes)
{
$impressionEvent = $this->_eventBuilder
->createImpressionEvent($this->_config, $experimentKey, $variationKey, $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(),
http_build_query($impressionEvent->getParams())
)
);

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()
));
}

$this->_notificationCenter->sendNotifications(
NotificationType::ACTIVATE,
array(
$this->_config->getExperimentFromKey($experimentKey),
$userId,
$attributes,
$this->_config->getVariationFromKey($experimentKey, $variationKey),
$impressionEvent
)
);
}

/**
* Buckets visitor and sends impression event to Optimizely.
*
Expand All @@ -228,30 +278,10 @@ public function activate($experimentKey, $userId, $attributes = null)
$variationKey = $this->getVariation($experimentKey, $userId, $attributes);
if (is_null($variationKey)) {
$this->_logger->log(Logger::INFO, sprintf('Not activating user "%s".', $userId));
return $variationKey;
return null;
}

$impressionEvent = $this->_eventBuilder
->createImpressionEvent($this->_config, $experimentKey, $variationKey, $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(), http_build_query($impressionEvent->getParams())
)
);

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()));
}
$this->sendImpressionEvent($experimentKey, $variationKey, $userId, $attributes);

return $variationKey;
}
Expand Down Expand Up @@ -307,20 +337,25 @@ public function track($eventKey, $userId, $attributes = null, $eventTags = null)
$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(), http_build_query($conversionEvent->getParams())
));
sprintf(
'Dispatching conversion event to URL %s with params %s.',
$conversionEvent->getUrl(),
http_build_query($conversionEvent->getParams())
)
);

try {
$this->_eventDispatcher->dispatchEvent($conversionEvent);
}
catch (Throwable $exception) {
} catch (Throwable $exception) {
$this->_logger->log(Logger::ERROR, sprintf(
'Unable to dispatch conversion event. Error %s', $exception->getMessage()));
}
catch (Exception $exception) {
'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()));
'Unable to dispatch conversion event. Error %s',
$exception->getMessage()
));
}

$this->_notificationCenter->sendNotifications(
Expand All @@ -333,7 +368,6 @@ public function track($eventKey, $userId, $attributes = null, $eventTags = null)
$conversionEvent
)
);

} else {
$this->_logger->log(
Logger::INFO,
Expand Down Expand Up @@ -377,16 +411,16 @@ public function getVariation($experimentKey, $userId, $attributes = null)
}

/**
* Force a user into a variation for a given experiment.
*
* @param $experimentKey string Key identifying the experiment.
* @param $userId string The user ID to be used for bucketing.
* @param $variationKey string The variation key specifies the variation which the user
* will be forced into. If null, then clear the existing experiment-to-variation mapping.
*
* Force a user into a variation for a given experiment.
*
* @param $experimentKey string Key identifying the experiment.
* @param $userId string The user ID to be used for bucketing.
* @param $variationKey string The variation key specifies the variation which the user
* will be forced into. If null, then clear the existing experiment-to-variation mapping.
*
* @return boolean A boolean value that indicates if the set completed successfully.
*/
public function setForcedVariation($experimentKey, $userId, $variationKey)
*/
public function setForcedVariation($experimentKey, $userId, $variationKey)
{
return $this->_config->setForcedVariation($experimentKey, $userId, $variationKey);
}
Expand Down
Loading