4536635044

Build Type

github

Committed by GitHub

Commit Message

Merge 019774507 into 34bebf03a

Pull Request Pull Request #265: [FSSDK-8940] Correct return type hints

Run Details

2871 of 2957 relevant lines covered (97.09%)

63.82 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

95.78

/src/Optimizely/Optimizely.php

<?php
/**
 * Copyright 2016-2022, Optimizely
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
namespace Optimizely;

use Exception;
use Optimizely\Config\DatafileProjectConfig;
use Optimizely\Entity\Variation;
use Optimizely\Exceptions\InvalidAttributeException;
use Optimizely\Exceptions\InvalidEventTagException;
use Throwable;
use Monolog\Logger;
use Optimizely\Decide\OptimizelyDecideOption;
use Optimizely\Decide\OptimizelyDecision;
use Optimizely\Decide\OptimizelyDecisionMessage;
use Optimizely\DecisionService\DecisionService;
use Optimizely\DecisionService\FeatureDecision;
use Optimizely\OptimizelyDecisionContext;
use Optimizely\Entity\Experiment;
use Optimizely\Entity\FeatureVariable;
use Optimizely\Enums\DecisionNotificationTypes;
use Optimizely\ErrorHandler\ErrorHandlerInterface;
use Optimizely\ErrorHandler\NoOpErrorHandler;
use Optimizely\Event\Builder\EventBuilder;
use Optimizely\Event\Dispatcher\DefaultEventDispatcher;
use Optimizely\Event\Dispatcher\EventDispatcherInterface;
use Optimizely\Logger\LoggerInterface;
use Optimizely\Logger\NoOpLogger;
use Optimizely\Notification\NotificationCenter;
use Optimizely\Notification\NotificationType;
use Optimizely\OptimizelyConfig\OptimizelyConfigService;
use Optimizely\OptimizelyUserContext;
use Optimizely\ProjectConfigManager\HTTPProjectConfigManager;
use Optimizely\ProjectConfigManager\ProjectConfigManagerInterface;
use Optimizely\ProjectConfigManager\StaticProjectConfigManager;
use Optimizely\UserProfile\UserProfileServiceInterface;
use Optimizely\Utils\Errors;
use Optimizely\Utils\Validator;
use Optimizely\Utils\VariableTypeUtils;

/**
 * Class Optimizely
 *
 * @package Optimizely
 */
class Optimizely
{
    const EVENT_KEY = 'Event Key';
    const EXPERIMENT_KEY = 'Experiment Key';
    const FEATURE_FLAG_KEY = 'Feature Flag Key';
    const USER_ID = 'User ID';
    const VARIABLE_KEY = 'Variable Key';
    const VARIATION_KEY = 'Variation Key';

    /**
     * @var DatafileProjectConfig
     */
    private $_config;

    /**
     * @var DecisionService
     */
    private $_decisionService;

    /**
     * @var ErrorHandlerInterface
     */
    private $_errorHandler;

    /**
     * @var EventDispatcherInterface
     */
    private $_eventDispatcher;

    /**
     * @var EventBuilder
     */
    private $_eventBuilder;

    /**
     * @var boolean Denotes whether Optimizely object is valid or not.
     */
    private $_isValid;

    /**
     * @var LoggerInterface
     */
    private $_logger;

    /**
     * @var array A default list of options for decision making.
     */
    private $defaultDecideOptions;

    /**
     * @var ProjectConfigManagerInterface
     */
    public $configManager;

    /**
     * @var NotificationCenter
     */
    public $notificationCenter;

    /**
     * Optimizely constructor for managing Feature Experimentation PHP projects.
     *
     * @param $datafile string JSON string representing the project.
     * @param $eventDispatcher EventDispatcherInterface
     * @param $logger LoggerInterface
     * @param $errorHandler ErrorHandlerInterface
     * @param $skipJsonValidation boolean representing whether JSON schema validation needs to be performed.
     * @param $userProfileService UserProfileServiceInterface
     * @param $configManager ProjectConfigManagerInterface provides ProjectConfig through getConfig method.
     * @param $notificationCenter NotificationCenter
     * @param $sdkKey string uniquely identifying the datafile corresponding to project and environment combination. Must provide at least one of datafile or sdkKey.
     */
    public function __construct(
        $datafile,
        EventDispatcherInterface $eventDispatcher = null,
        LoggerInterface $logger = null,
        ErrorHandlerInterface $errorHandler = null,
        $skipJsonValidation = false,
        UserProfileServiceInterface $userProfileService = null,
        ProjectConfigManagerInterface $configManager = null,
        NotificationCenter $notificationCenter = null,
        $sdkKey = null,
        array $defaultDecideOptions = []
    ) {
        $this->_isValid = true;
        $this->_eventDispatcher = $eventDispatcher ?: new DefaultEventDispatcher();
        $this->_logger = $logger ?: new NoOpLogger();
        $this->_errorHandler = $errorHandler ?: new NoOpErrorHandler();
        $this->_eventBuilder = new EventBuilder($this->_logger);
        $this->_decisionService = new DecisionService($this->_logger, $userProfileService);
        $this->notificationCenter = $notificationCenter ?: new NotificationCenter($this->_logger, $this->_errorHandler);
        $this->configManager = $configManager;

        if ($this->configManager === null) {
            if ($sdkKey) {
                $this->configManager = new HTTPProjectConfigManager($sdkKey, null, null, true, $datafile, $skipJsonValidation, $this->_logger, $this->_errorHandler, $this->notificationCenter);
            } else {
                $this->configManager = new StaticProjectConfigManager($datafile, $skipJsonValidation, $this->_logger, $this->_errorHandler);
            }
        }

        $this->defaultDecideOptions = $defaultDecideOptions;
    }

    /**
     * Returns DatafileProjectConfig instance.
     * @return DatafileProjectConfig DatafileProjectConfig instance or null
     */
    protected function getConfig()
    {
        $config = $this->configManager->getConfig();
        return $config instanceof DatafileProjectConfig ? $config : null;
    }

    /**
     * Helper function to validate user inputs into the API methods.
     *
     * @param $attributes array Associative array of user attributes
     * @param $eventTags array Hash representing metadata associated with an event.
     *
     * @return boolean Representing whether all user inputs are valid.
     */
    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(
                new InvalidAttributeException('Provided attributes are in an invalid format.')
            );
            return false;
        }

        if (!is_null($eventTags)) {
            if (!Validator::areEventTagsValid($eventTags)) {
                $this->_logger->log(Logger::ERROR, 'Provided event tags are in an invalid format.');
                $this->_errorHandler->handleError(
                    new InvalidEventTagException('Provided event tags are in an invalid format.')
                );
                return false;
            }
        }

        return true;
    }

    /**
     * @param  DatafileProjectConfig DatafileProjectConfig instance
     * @param  string        Experiment ID
     * @param  string        Variation key
     * @param  string        Flag key
     * @param  string        Rule key
     * @param  string        Rule type
     * @param  boolean       Feature enabled
     * @param  string        User ID
     * @param  array         Associative array of user attributes
     */
    protected function sendImpressionEvent($config, $experimentId, $variationKey, $flagKey, $ruleKey, $ruleType, $enabled, $userId, $attributes)
    {
        $experimentKey = $config->getExperimentFromId($experimentId)->getKey();
        $impressionEvent = $this->_eventBuilder
            ->createImpressionEvent($config, $experimentId, $variationKey, $flagKey, $ruleKey, $ruleType, $enabled, $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(),
                json_encode($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(
                $config->getExperimentFromId($experimentId),
                $userId,
                $attributes,
                $config->getVariationFromKeyByExperimentId($experimentId, $variationKey),
                $impressionEvent
            )
        );
    }

    /**
     * Create a context of the user for which decision APIs will be called.
     *
     * A user context will be created successfully even when the SDK is not fully configured yet.
     *
     * @param $userId string The user ID to be used for bucketing.
     * @param $userAttributes array A Hash representing user attribute names and values.
     *
     * @return OptimizelyUserContext|null An OptimizelyUserContext associated with this OptimizelyClient,
     *                                    or null If user attributes are not in valid format.
     */
    public function createUserContext($userId, array $userAttributes = [])
    {
        // We do not check if config is ready as UserContext can be created even when SDK is not ready.

        // validate userId
        if (!$this->validateInputs(
            [
                self::USER_ID => $userId
            ]
        )
        ) {
            return null;
        }

        // validate attributes
        if (!$this->validateUserInputs($userAttributes)) {
            return null;
        }

        return new OptimizelyUserContext($this, $userId, $userAttributes);
    }

    /**
     * Returns a decision result (OptimizelyDecision) for a given flag key and a user context, which contains all data required to deliver the flag.
     *
     * If the SDK finds an error, it'll return a `decision` with null for `variationKey`. The decision will include an error message in `reasons`
     *
     * @param $userContext OptimizelyUserContext context of the user for which decision will be called.
     * @param $key string A flag key for which a decision will be made.
     * @param $decideOptions array A list of options for decision making.
     *
     * @return OptimizelyDecision A decision result
     */
    public function decide(OptimizelyUserContext $userContext, $key, array $decideOptions = [])
    {
        $decideReasons = [];

        // check if SDK is ready
        $config = $this->getConfig();
        if ($config === null) {
            $this->_logger->log(Logger::ERROR, sprintf(Errors::INVALID_DATAFILE, __FUNCTION__));
            $decideReasons[] = OptimizelyDecisionMessage::SDK_NOT_READY;
            return new OptimizelyDecision(null, null, null, null, $key, $userContext, $decideReasons);
        }

        // validate that key is a string
        if (!$this->validateInputs(
            [
                self::FEATURE_FLAG_KEY => $key
            ]
        )
        ) {
            $errorMessage = sprintf(OptimizelyDecisionMessage::FLAG_KEY_INVALID, $key);
            $this->_logger->log(Logger::ERROR, $errorMessage);
            $decideReasons[] = $errorMessage;
            return new OptimizelyDecision(null, null, null, null, $key, $userContext, $decideReasons);
        }


        // validate that key maps to a feature flag
        $featureFlag = $config->getFeatureFlagFromKey($key);
        if ($featureFlag && (!$featureFlag->getId())) {
            // Error logged in DatafileProjectConfig - getFeatureFlagFromKey
            $decideReasons[] = sprintf(OptimizelyDecisionMessage::FLAG_KEY_INVALID, $key);
            return new OptimizelyDecision(null, null, null, null, $key, $userContext, $decideReasons);
        }

        // merge decide options and default decide options
        $decideOptions = array_merge($decideOptions, $this->defaultDecideOptions);

        // create optimizely decision result
        $userId = $userContext->getUserId();
        $userAttributes = $userContext->getAttributes();
        $variationKey = null;
        $featureEnabled = false;
        $ruleKey = null;
        $experimentId = null;
        $flagKey = $key;
        $allVariables = [];
        $decisionEventDispatched = false;

        // get decision
        $decision = null;
        // check forced-decisions first
        $context = new OptimizelyDecisionContext($flagKey, $ruleKey);
        list($forcedDecisionResponse, $reasons) = $this->_decisionService->findValidatedForcedDecision($context, $config, $userContext);
        if ($forcedDecisionResponse) {
            $decision = new FeatureDecision(null, $forcedDecisionResponse, FeatureDecision::DECISION_SOURCE_FEATURE_TEST, $decideReasons);
        } else {
            // regular decision
            $decision = $this->_decisionService->getVariationForFeature(
                $config,
                $featureFlag,
                $userContext,
                $decideOptions
            );
        }
        $decideReasons = array_merge($decideReasons, $reasons);
        $decideReasons = array_merge($decideReasons, $decision->getReasons());
        $variation = $decision->getVariation();

        if ($variation) {
            $variationKey = $variation->getKey();
            $featureEnabled = $variation->getFeatureEnabled();
            if ($decision->getExperiment()) {
                $ruleKey = $decision->getExperiment()->getKey();
                $experimentId = $decision->getExperiment()->getId();
            }
        } else {
            $variationKey = null;
            $ruleKey = null;
            $experimentId = null;
        }

        // send impression only if decide options do not contain DISABLE_DECISION_EVENT
        if (!in_array(OptimizelyDecideOption::DISABLE_DECISION_EVENT, $decideOptions)) {
            $sendFlagDecisions = $config->getSendFlagDecisions();
            $source = $decision->getSource();

            // send impression for rollout when sendFlagDecisions is enabled.
            if ($source == FeatureDecision::DECISION_SOURCE_FEATURE_TEST || $sendFlagDecisions) {
                $this->sendImpressionEvent(
                    $config,
                    $experimentId,
                    $variationKey === null ? '' : $variationKey,
                    $flagKey,
                    $ruleKey === null ? '' : $ruleKey,
                    $source,
                    $featureEnabled,
                    $userId,
                    $userAttributes
                );

                $decisionEventDispatched = true;
            }
        }

        // Generate all variables map if decide options doesn't include excludeVariables
        if (!in_array(OptimizelyDecideOption::EXCLUDE_VARIABLES, $decideOptions)) {
            foreach ($featureFlag->getVariables() as $variable) {
                $allVariables[$variable->getKey()] = $this->getFeatureVariableValueFromVariation(
                    $flagKey,
                    $variable->getKey(),
                    null,
                    $featureEnabled,
                    $variation,
                    $userId
                );
            }
        }

        $shouldIncludeReasons = in_array(OptimizelyDecideOption::INCLUDE_REASONS, $decideOptions);

        // send notification
        $this->notificationCenter->sendNotifications(
            NotificationType::DECISION,
            array(
                DecisionNotificationTypes::FLAG,
                $userId,
                $userAttributes,
                (object) array(
                    'flagKey'=> $flagKey,
                    'enabled'=> $featureEnabled,
                    'variables' => $allVariables,
                    'variationKey' => $variationKey,
                    'ruleKey' => $ruleKey,
                    'reasons' => $shouldIncludeReasons ? $decideReasons:[],
                    'decisionEventDispatched' => $decisionEventDispatched
                )
            )
        );

        return new OptimizelyDecision(
            $variationKey,
            $featureEnabled,
            $allVariables,
            $ruleKey,
            $flagKey,
            $userContext,
            $shouldIncludeReasons ? $decideReasons:[]
        );
    }

    /**
     * Returns a hash of decision results (OptimizelyDecision) for all active flag keys.
     *
     * @param $userContext OptimizelyUserContext context of the user for which decision will be called.
     * @param $decideOptions array A list of options for decision making.
     *
     * @return array Hash of decisions containing flag keys as hash keys and corresponding decisions as their values.
     */
    public function decideAll(OptimizelyUserContext $userContext, array $decideOptions = [])
    {
        // check if SDK is ready
        $config = $this->getConfig();
        if ($config === null) {
            $this->_logger->log(Logger::ERROR, sprintf(Errors::INVALID_DATAFILE, __FUNCTION__));
            return [];
        }

        // get all feature keys
        $keys = [];
        $featureFlags = $config->getFeatureFlags();
        foreach ($featureFlags as $feature) {
            $keys [] = $feature->getKey();
        }

        return $this->decideForKeys($userContext, $keys, $decideOptions);
    }

    /**
     * Returns a hash of decision results (OptimizelyDecision) for multiple flag keys and a user context.
     *
     * If the SDK finds an error for a key, the response will include a decision for the key showing `reasons` for the error.
     *
     * The SDK will always return hash of decisions. When it can not process requests, it'll return an empty hash after logging the errors.
     *
     * @param $userContext OptimizelyUserContext context of the user for which decision will be called.
     * @param $keys array A list of flag keys for which the decisions will be made.
     * @param $decideOptions array A list of options for decision making.
     *
     * @return array Hash of decisions containing flag keys as hash keys and corresponding decisions as their values.
     */
    public function decideForKeys(OptimizelyUserContext $userContext, array $keys, array $decideOptions = [])
    {
        // check if SDK is ready
        $config = $this->getConfig();
        if ($config === null) {
            $this->_logger->log(Logger::ERROR, sprintf(Errors::INVALID_DATAFILE, __FUNCTION__));
            return [];
        }

        // merge decide options and default decide options
        $decideOptions = array_merge($decideOptions, $this->defaultDecideOptions);

        $enabledFlagsOnly = in_array(OptimizelyDecideOption::ENABLED_FLAGS_ONLY, $decideOptions);
        $decisions = [];

        foreach ($keys as $key) {
            $decision = $this->decide($userContext, $key, $decideOptions);
            if (!$enabledFlagsOnly || $decision->getEnabled() === true) {
                $decisions [$key] = $decision;
            }
        }

        return $decisions;
    }

    /**
     * Buckets visitor and sends impression event to Optimizely.
     *
     * @param $experimentKey string Key identifying the experiment.
     * @param $userId string ID for user.
     * @param $attributes array Attributes of the user.
     *
     * @return null|string Representing the variation key.
     */
    public function activate($experimentKey, $userId, $attributes = null)
    {
        $config = $this->getConfig();
        if ($config === null) {
            $this->_logger->log(Logger::ERROR, sprintf(Errors::INVALID_DATAFILE, __FUNCTION__));
            return null;
        }

        if (!$this->validateInputs(
            [
                self::EXPERIMENT_KEY =>$experimentKey,
                self::USER_ID => $userId
            ]
        )
        ) {
            return null;
        }

        $variationKey = $this->getVariation($experimentKey, $userId, $attributes);
        if (is_null($variationKey)) {
            $this->_logger->log(Logger::INFO, sprintf('Not activating user "%s".', $userId));
            return null;
        }
        $experimentId = $config->getExperimentFromKey($experimentKey)->getId();

        $this->sendImpressionEvent($config, $experimentId, $variationKey, '', $experimentKey, FeatureDecision::DECISION_SOURCE_EXPERIMENT, true, $userId, $attributes);

        return $variationKey;
    }

    /**
     * Gets OptimizelyConfig object for the current ProjectConfig.
     *
     * @return OptimizelyConfig Representing current ProjectConfig.
     */
    public function getOptimizelyConfig()
    {
        $config = $this->getConfig();
        if ($config === null) {
            $this->_logger->log(Logger::ERROR, sprintf(Errors::INVALID_DATAFILE, __FUNCTION__));
            return null;
        }

        $optConfigService = new OptimizelyConfigService($config);

        return $optConfigService->getConfig();
    }

    /**
     * Send conversion event to Optimizely.
     *
     * @param $eventKey string Event key representing the event which needs to be recorded.
     * @param $userId string ID for user.
     * @param $attributes array Attributes of the user.
     * @param $eventTags array Hash representing metadata associated with the event.
     */
    public function track($eventKey, $userId, $attributes = null, $eventTags = null)
    {
        $config = $this->getConfig();
        if ($config === null) {
            $this->_logger->log(Logger::ERROR, sprintf(Errors::INVALID_DATAFILE, __FUNCTION__));
            return;
        }

        if (!$this->validateInputs(
            [
                self::EVENT_KEY =>$eventKey,
                self::USER_ID => $userId
            ]
        )
        ) {
            return null;
        }

        if (!$this->validateUserInputs($attributes, $eventTags)) {
            return;
        }

        $event = $config->getEvent($eventKey);

        if (is_null($event->getKey())) {
            $this->_logger->log(Logger::INFO, sprintf('Not tracking user "%s" for event "%s".', $userId, $eventKey));
            return;
        }

        $conversionEvent = $this->_eventBuilder
            ->createConversionEvent(
                $config,
                $eventKey,
                $userId,
                $attributes,
                $eventTags
            );

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

        $this->notificationCenter->sendNotifications(
            NotificationType::TRACK,
            array(
                $eventKey,
                $userId,
                $attributes,
                $eventTags,
                $conversionEvent
            )
        );
    }

    /**
     * Get variation where user will be bucketed.
     *
     * @param $experimentKey string Key identifying the experiment.
     * @param $userId string ID for user.
     * @param $attributes array Attributes of the user.
     *
     * @return null|string Representing the variation key.
     */
    public function getVariation($experimentKey, $userId, $attributes = null)
    {
        // TODO: Config should be passed as param when this is called from activate but
        // since PHP is single-threaded we can leave this for now.
        $config = $this->getConfig();
        if ($config === null) {
            $this->_logger->log(Logger::ERROR, sprintf(Errors::INVALID_DATAFILE, __FUNCTION__));
            return null;
        }

        if (!$this->validateInputs(
            [
                self::EXPERIMENT_KEY =>$experimentKey,
                self::USER_ID => $userId
            ]
        )
        ) {
            return null;
        }

        $experiment = $config->getExperimentFromKey($experimentKey);

        if (is_null($experiment->getKey())) {
            return null;
        }

        if (!$this->validateUserInputs($attributes)) {
            return null;
        }

        $userContext = $this->createUserContext($userId, $attributes ? $attributes : []);
        list($variation, $reasons) = $this->_decisionService->getVariation($config, $experiment, $userContext);
        $variationKey = ($variation === null) ? null : $variation->getKey();

        if ($config->isFeatureExperiment($experiment->getId())) {
            $decisionNotificationType = DecisionNotificationTypes::FEATURE_TEST;
        } else {
            $decisionNotificationType = DecisionNotificationTypes::AB_TEST;
        }

        $attributes = $attributes ?: [];
        $this->notificationCenter->sendNotifications(
            NotificationType::DECISION,
            array(
                $decisionNotificationType,
                $userId,
                $attributes,
                (object) array(
                    'experimentKey'=> $experiment->getKey(),
                    'variationKey'=> $variationKey
                )
            )
        );

        return $variationKey;
    }

    /**
     * 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)
    {
        $config = $this->getConfig();
        if ($config === null) {
            $this->_logger->log(Logger::ERROR, sprintf(Errors::INVALID_DATAFILE, __FUNCTION__));
            return false;
        }

        if (!$this->validateInputs(
            [
                self::EXPERIMENT_KEY =>$experimentKey,
                self::USER_ID => $userId
            ]
        )) {
            return false;
        }
        return $this->_decisionService->setForcedVariation($config, $experimentKey, $userId, $variationKey);
    }

    /**
     * Gets the forced variation for a given user and experiment.
     *
     * @param $experimentKey string Key identifying the experiment.
     * @param $userId string The user ID to be used for bucketing.
     *
     * @return string|null The forced variation key.
     */
    public function getForcedVariation($experimentKey, $userId)
    {
        $config = $this->getConfig();
        if ($config === null) {
            $this->_logger->log(Logger::ERROR, sprintf(Errors::INVALID_DATAFILE, __FUNCTION__));
            return null;
        }

        if (!$this->validateInputs(
            [
                self::EXPERIMENT_KEY =>$experimentKey,
                self::USER_ID => $userId
            ]
        )) {
            return null;
        }

        list($forcedVariation, $reasons)  = $this->_decisionService->getForcedVariation($config, $experimentKey, $userId);
        if (isset($forcedVariation)) {
            return $forcedVariation->getKey();
        } else {
            return null;
        }
    }

    /**
     * Determine whether a feature is enabled.
     * Sends an impression event if the user is bucketed into an experiment using the feature.
     *
     * @param string Feature flag key
     * @param string User ID
     * @param array Associative array of user attributes
     *
     * @return boolean
     */
    public function isFeatureEnabled($featureFlagKey, $userId, $attributes = null)
    {
        $config = $this->getConfig();
        if ($config === null) {
            $this->_logger->log(Logger::ERROR, sprintf(Errors::INVALID_DATAFILE, __FUNCTION__));
            return false;
        }

        if (!$this->validateInputs(
            [
                self::FEATURE_FLAG_KEY =>$featureFlagKey,
                self::USER_ID => $userId
            ]
        )
        ) {
            return false;
        }

        $featureFlag = $config->getFeatureFlagFromKey($featureFlagKey);
        if ($featureFlag && (!$featureFlag->getId())) {
            // Error logged in DatafileProjectConfig - getFeatureFlagFromKey
            return false;
        }

        //validate feature flag
        if (!Validator::isFeatureFlagValid($config, $featureFlag)) {
            return false;
        }

        $featureEnabled = false;
        $userContext = $this->createUserContext($userId, $attributes?: []);
        $decision = $this->_decisionService->getVariationForFeature($config, $featureFlag, $userContext);
        $variation = $decision->getVariation();

        if ($config->getSendFlagDecisions() && ($decision->getSource() == FeatureDecision::DECISION_SOURCE_ROLLOUT || !$variation)) {
            if ($variation) {
                $featureEnabled = $variation->getFeatureEnabled();
            }
            $ruleKey = $decision->getExperiment() ? $decision->getExperiment()->getKey() : '';
            $experimentId = $decision->getExperiment() ? $decision->getExperiment()->getId() : '';
            $this->sendImpressionEvent($config, $experimentId, $variation ? $variation->getKey() : '', $featureFlagKey, $ruleKey, $decision->getSource(), $featureEnabled, $userId, $attributes);
        }

        if ($variation) {
            $experimentKey = $decision->getExperiment()->getKey();
            $experimentId = $decision->getExperiment()->getId();
            $featureEnabled = $variation->getFeatureEnabled();
            if ($decision->getSource() == FeatureDecision::DECISION_SOURCE_FEATURE_TEST) {
                $sourceInfo = (object) array(
                    'experimentKey'=> $experimentKey,
                    'variationKey'=> $variation->getKey()
                );

                $this->sendImpressionEvent($config, $experimentId, $variation->getKey(), $featureFlagKey, $experimentKey, $decision->getSource(), $featureEnabled, $userId, $attributes);
            } else {
                $this->_logger->log(Logger::INFO, "The user '{$userId}' is not being experimented on Feature Flag '{$featureFlagKey}'.");
            }
        }

        $attributes = is_null($attributes) ? [] : $attributes;
        $this->notificationCenter->sendNotifications(
            NotificationType::DECISION,
            array(
                DecisionNotificationTypes::FEATURE,
                $userId,
                $attributes,
                (object) array(
                    'featureKey'=>$featureFlagKey,
                    'featureEnabled'=> $featureEnabled,
                    'source'=> $decision->getSource(),
                    'sourceInfo'=> isset($sourceInfo) ? $sourceInfo : (object) array()
                )
            )
        );

        if ($featureEnabled == true) {
            $this->_logger->log(Logger::INFO, "Feature Flag '{$featureFlagKey}' is enabled for user '{$userId}'.");
            return $featureEnabled;
        }

        $this->_logger->log(Logger::INFO, "Feature Flag '{$featureFlagKey}' is not enabled for user '{$userId}'.");
        return false;
    }

    /**
     * Get keys of all feature flags which are enabled for the user
     *
     * @param  string User ID
     * @param  array Associative array of user attributes
     * @return array List of feature flag keys
     */
    public function getEnabledFeatures($userId, $attributes = null)
    {
        $enabledFeatureKeys = [];

        $config = $this->getConfig();
        if ($config === null) {
            $this->_logger->log(Logger::ERROR, sprintf(Errors::INVALID_DATAFILE, __FUNCTION__));
            return $enabledFeatureKeys;
        }

        if (!$this->validateInputs(
            [
                self::USER_ID => $userId
            ]
        )
        ) {
            return $enabledFeatureKeys;
        }

        $featureFlags = $config->getFeatureFlags();
        foreach ($featureFlags as $feature) {
            $featureKey = $feature->getKey();
            if ($this->isFeatureEnabled($featureKey, $userId, $attributes) === true) {
                $enabledFeatureKeys[] = $featureKey;
            }
        }

        return $enabledFeatureKeys;
    }

    /**
     * Get value of the specified variable in the feature flag.
     *
     * @param string Feature flag key
     * @param string Variable key
     * @param string User ID
     * @param array  Associative array of user attributes
     * @param string Variable type
     *
     * @return string|boolean|number|array|null Value of the variable cast to the appropriate
     *                                          type, or null if the feature key is invalid, the
     *                                          variable key is invalid, or there is a mismatch
     *                                          with the type of the variable
     */
    public function getFeatureVariableValueForType(
        $featureFlagKey,
        $variableKey,
        $userId,
        $attributes = null,
        $variableType = null
    ) {
        $config = $this->getConfig();
        if ($config === null) {
            $this->_logger->log(Logger::ERROR, sprintf(Errors::INVALID_DATAFILE, FeatureVariable::getFeatureVariableMethodName($variableType)));
            return null;
        }

        if (!$this->validateInputs(
            [
                self::FEATURE_FLAG_KEY => $featureFlagKey,
                self::VARIABLE_KEY => $variableKey,
                self::USER_ID => $userId
            ]
        )
        ) {
            return null;
        }

        $featureFlag = $config->getFeatureFlagFromKey($featureFlagKey);
        if ($featureFlag && (!$featureFlag->getId())) {
            // Error logged in DatafileProjectConfig - getFeatureFlagFromKey
            return null;
        }
        $userContext = $this->createUserContext($userId, $attributes? $attributes : []);
        $decision = $this->_decisionService->getVariationForFeature($config, $featureFlag, $userContext);
        $variation = $decision->getVariation();
        $experiment = $decision->getExperiment();
        $featureEnabled = $variation !== null ? $variation->getFeatureEnabled() : false;
        $variableValue = $this->getFeatureVariableValueFromVariation($featureFlagKey, $variableKey, $variableType, $featureEnabled, $variation, $userId);
        // returning as variable not found or type is invalid
        if ($variableValue === null) {
            return null;
        }
        if ($variation && $decision->getSource() == FeatureDecision::DECISION_SOURCE_FEATURE_TEST) {
            $sourceInfo = (object) array(
                'experimentKey'=> $experiment->getKey(),
                'variationKey'=> $variation->getKey()
            );
        }

        $attributes = $attributes ?: [];
        $this->notificationCenter->sendNotifications(
            NotificationType::DECISION,
            array(
                DecisionNotificationTypes::FEATURE_VARIABLE,
                $userId,
                $attributes,
                (object) array(
                    'featureKey'=>$featureFlagKey,
                    'featureEnabled'=> $featureEnabled,
                    'variableKey'=> $variableKey,
                    'variableType'=> $variableType,
                    'variableValue'=> $variableValue,
                    'source'=> $decision->getSource(),
                    'sourceInfo'=> isset($sourceInfo) ? $sourceInfo : (object) array()
                )
            )
        );

        return $variableValue;
    }

    /**
     * Get the Boolean value of the specified variable in the feature flag.
     *
     * @param string Feature flag key
     * @param string Variable key
     * @param string User ID
     * @param array  Associative array of user attributes
     *
     * @return string boolean variable value / null
     */
    public function getFeatureVariableBoolean($featureFlagKey, $variableKey, $userId, $attributes = null)
    {
        return $this->getFeatureVariableValueForType(
            $featureFlagKey,
            $variableKey,
            $userId,
            $attributes,
            FeatureVariable::BOOLEAN_TYPE
        );
    }

    /**
     * Get the Integer value of the specified variable in the feature flag.
     *
     * @param string Feature flag key
     * @param string Variable key
     * @param string User ID
     * @param array  Associative array of user attributes
     *
     * @return string integer variable value / null
     */
    public function getFeatureVariableInteger($featureFlagKey, $variableKey, $userId, $attributes = null)
    {
        return $this->getFeatureVariableValueForType(
            $featureFlagKey,
            $variableKey,
            $userId,
            $attributes,
            FeatureVariable::INTEGER_TYPE
        );
    }

    /**
     * Get the Double value of the specified variable in the feature flag.
     *
     * @param string Feature flag key
     * @param string Variable key
     * @param string User ID
     * @param array  Associative array of user attributes
     *
     * @return string double variable value / null
     */
    public function getFeatureVariableDouble($featureFlagKey, $variableKey, $userId, $attributes = null)
    {
        return $this->getFeatureVariableValueForType(
            $featureFlagKey,
            $variableKey,
            $userId,
            $attributes,
            FeatureVariable::DOUBLE_TYPE
        );
    }

    /**
     * Get the String value of the specified variable in the feature flag.
     *
     * @param string Feature flag key
     * @param string Variable key
     * @param string User ID
     * @param array  Associative array of user attributes
     *
     * @return string variable value / null
     */
    public function getFeatureVariableString($featureFlagKey, $variableKey, $userId, $attributes = null)
    {
        return $this->getFeatureVariableValueForType(
            $featureFlagKey,
            $variableKey,
            $userId,
            $attributes,
            FeatureVariable::STRING_TYPE
        );
    }

    /**
    * Get the JSON value of the specified variable in the feature flag.
    *
    * @param string Feature flag key
    * @param string Variable key
    * @param string User ID
    * @param array  Associative array of user attributes
    *
    * @return array Associative array of json variable including key and value
    */
    public function getFeatureVariableJSON($featureFlagKey, $variableKey, $userId, $attributes = null)
    {
        return $this->getFeatureVariableValueForType(
            $featureFlagKey,
            $variableKey,
            $userId,
            $attributes,
            FeatureVariable::JSON_TYPE
        );
    }

    /**
     * Returns values for all the variables attached to the given feature
     *
     * @param string Feature flag key
     * @param string User ID
     * @param array  Associative array of user attributes
     *
     * @return array|null array of all the variables, or null if the feature key is invalid
     */
    public function getAllFeatureVariables($featureFlagKey, $userId, $attributes = null)
    {
        $config = $this->getConfig();
        if ($config === null) {
            $this->_logger->log(Logger::ERROR, sprintf(Errors::INVALID_DATAFILE, __FUNCTION__));
            return null;
        }

        if (!$this->validateInputs(
            [
                self::FEATURE_FLAG_KEY => $featureFlagKey,
                self::USER_ID => $userId
            ]
        )
        ) {
            return null;
        }

        $featureFlag = $config->getFeatureFlagFromKey($featureFlagKey);
        if ($featureFlag && (!$featureFlag->getId())) {
            return null;
        }

        $decision = $this->_decisionService->getVariationForFeature($config, $featureFlag, $this->createUserContext($userId, $attributes));
        $variation = $decision->getVariation();
        $experiment = $decision->getExperiment();
        $featureEnabled = $variation !== null ? $variation->getFeatureEnabled() : false;

        $allVariables = [];
        foreach ($featureFlag->getVariables() as $variable) {
            $allVariables[$variable->getKey()] = $this->getFeatureVariableValueFromVariation(
                $featureFlagKey,
                $variable->getKey(),
                null,
                $featureEnabled,
                $variation,
                $userId
            );
        }

        $sourceInfo = (object) array();
        if ($variation && $decision->getSource() == FeatureDecision::DECISION_SOURCE_FEATURE_TEST) {
            $sourceInfo = (object) array(
                'experimentKey'=> $experiment->getKey(),
                'variationKey'=> $variation->getKey()
            );
        }

        $attributes = $attributes ?: [];
        
        $this->notificationCenter->sendNotifications(
            NotificationType::DECISION,
            array(
                DecisionNotificationTypes::ALL_FEATURE_VARIABLES,
                $userId,
                $attributes,
                (object)array(
                    'featureKey' => $featureFlagKey,
                    'featureEnabled' => $featureEnabled,
                    'variableValues' => $allVariables,
                    'source' => $decision->getSource(),
                    'sourceInfo' => $sourceInfo
                )
            )
        );

        return $allVariables;
    }

    /**
     * Get the value of the specified variable on the basis of its status and usage
     *
     * @param string    Feature flag key
     * @param string    Variable key
     * @param boolean   Feature Status
     * @param Variation for feature
     * @param string    User Id
     *
     * @return string|boolean|number|array|null Value of the variable cast to the appropriate
     *                                          type, or null if the feature key is invalid, the
     *                                          variable key is invalid, or there is a mismatch
     *                                          with the type of the variable
     */
    private function getFeatureVariableValueFromVariation($featureFlagKey, $variableKey, $variableType, $featureEnabled, $variation, $userId)
    {
        $config = $this->getConfig();
        $variable = $config->getFeatureVariableFromKey($featureFlagKey, $variableKey);
        if (!$variable) {
            // Error message logged in ProjectConfigInterface- getFeatureVariableFromKey
            return null;
        }
        if ($variableType && $variableType != $variable->getType()) {
            $this->_logger->log(
                Logger::ERROR,
                "Variable is of type '{$variable->getType()}', but you requested it as type '{$variableType}'."
            );
            return null;
        }
        $variableValue = $variable->getDefaultValue();
        if ($variation === null) {
            $this->_logger->log(
                Logger::INFO,
                "User '{$userId}' is not in experiment or rollout, ".
                "returning default value '{$variableValue}'."
            );
        } else {
            if ($featureEnabled) {
                $variableUsage = $variation->getVariableUsageById($variable->getId());
                if ($variableUsage) {
                    $variableValue = $variableUsage->getValue();
                    $this->_logger->log(
                        Logger::INFO,
                        "Returning variable value '{$variableValue}' for variable key '{$variableKey}' ".
                        "of feature flag '{$featureFlagKey}'."
                    );
                } else {
                    $this->_logger->log(
                        Logger::INFO,
                        "Variable value is not defined. Returning the default variable value '{$variableValue}'."
                    );
                }
            } else {
                $this->_logger->log(
                    Logger::INFO,
                    "Feature '{$featureFlagKey}' is not enabled for user '{$userId}'. ".
                    "Returning the default variable value '{$variableValue}'."
                );
            }
        }

        if (!is_null($variableValue)) {
            $variableValue = VariableTypeUtils::castStringToType($variableValue, $variable->getType(), $this->_logger);
        }
        return $variableValue;
    }

    /**
     * Determine if the instance of the Optimizely client is valid.
     * An instance can be deemed invalid if it was not initialized
     * properly due to an invalid datafile being passed in.
     *
     * @return True if the Optimizely instance is valid.
     *         False if the Optimizely instance is not valid.
     */
    public function isValid()
    {
        if (!$this->getConfig()) {
            $this->_logger->log(
                Logger::ERROR,
                Errors::NO_CONFIG
            );
            return false;
        }
        return true;
    }

    /**
    * Calls Validator::validateNonEmptyString for each value in array
    * Logs for each invalid value
    *
    * @param array values to validate
    * @param logger
    *
    * @return bool True if all of the values are valid, False otherwise
    */
    protected function validateInputs(array $values, $logLevel = Logger::ERROR)
    {
        $isValid = true;
        if (array_key_exists(self::USER_ID, $values)) {
            // Empty str is a valid user ID
            if (!is_string($values[self::USER_ID])) {
                $this->_logger->log(Logger::ERROR, sprintf(Errors::INVALID_FORMAT, self::USER_ID));
                $isValid = false;
            }
            unset($values[self::USER_ID]);
        }

        foreach ($values as $key => $value) {
            if (!Validator::validateNonEmptyString($value)) {
                $isValid = false;
                $message = sprintf(Errors::INVALID_FORMAT, $key);
                $this->_logger->log($logLevel, $message);
            }
        }

        return $isValid;
    }
}

optimizely / php-sdk / 4536635044

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous