Merge pull request #69 from flagship-io/update_usage_hit_allocation

update ANALYTIC_HIT_ALLOCATION
flagship-io · Feb 29, 2024 · 1172f2e · 1172f2e
2 parents 522bba7 + a41d6ef
commit 1172f2e
Show file tree

Hide file tree

Showing 16 changed files with 123 additions and 37 deletions.
diff --git a/src/Api/BatchingCachingStrategyAbstract.php b/src/Api/BatchingCachingStrategyAbstract.php
@@ -6,6 +6,7 @@
 use Flagship\Config\FlagshipConfig;
 use Flagship\Enum\FlagshipConstant;
 use Flagship\Enum\HitCacheFields;
+use Flagship\Enum\LogLevel;
 use Flagship\Enum\TroubleshootingLabel;
 use Flagship\Hit\Activate;
 use Flagship\Hit\ActivateBatch;
@@ -341,7 +342,7 @@ protected function sendActivateHit()
             $this->cacheHit($this->activatePoolQueue);
             $troubleshooting = new Troubleshooting();
             $troubleshooting->setLabel(TroubleshootingLabel::SEND_ACTIVATE_HIT_ROUTE_ERROR)
-                ->setLogLevel("ERROR")
+                ->setLogLevel(LogLevel::ERROR)
                 ->setVisitorId($this->flagshipInstanceId)
                 ->setFlagshipInstanceId($this->flagshipInstanceId)
                 ->setTraffic(100)
@@ -468,7 +469,7 @@ public function sendBatch()
             $this->cacheHit($this->hitsPoolQueue);
             $troubleshooting = new Troubleshooting();
             $troubleshooting->setLabel(TroubleshootingLabel::SEND_BATCH_HIT_ROUTE_RESPONSE_ERROR)
-                ->setLogLevel("ERROR")
+                ->setLogLevel(LogLevel::ERROR)
                 ->setVisitorId($this->flagshipInstanceId)
                 ->setFlagshipInstanceId($this->flagshipInstanceId)
                 ->setTraffic(100)

diff --git a/src/Api/NoBatchingContinuousCachingStrategy.php b/src/Api/NoBatchingContinuousCachingStrategy.php
@@ -3,6 +3,8 @@
 namespace Flagship\Api;
 
 use Flagship\Enum\FlagshipConstant;
+use Flagship\Enum\LogLevel;
+use Flagship\Enum\TroubleshootingLabel;
 use Flagship\Hit\Activate;
 use Flagship\Hit\ActivateBatch;
 use Flagship\Hit\UsageHit;
@@ -77,6 +79,22 @@ protected function sendHit(HitAbstract $hit)
                 [FlagshipConstant::SEND_HIT,
                     $this->getLogFormat($exception->getMessage(), $url, $requestBody, $header, $this->getNow() - $now)]
             );
+            $troubleshooting = new Troubleshooting();
+            $troubleshooting->setLabel(TroubleshootingLabel::SEND_HIT_ROUTE_ERROR)
+                ->setLogLevel(LogLevel::ERROR)
+                ->setVisitorId($this->flagshipInstanceId)
+                ->setFlagshipInstanceId($this->flagshipInstanceId)
+                ->setTraffic(100)
+                ->setConfig($this->config)
+                ->setHttpRequestBody($requestBody)
+                ->setHttpRequestHeaders($header)
+                ->setHttpRequestMethod("POST")
+                ->setHttpRequestUrl($url)
+                ->setHttpResponseBody($exception->getMessage())
+                ->setHttpResponseTime($this->getNow() - $now)
+            ;
+            $this->addTroubleshootingHit($troubleshooting);
+            $this->sendTroubleshootingQueue();
         }
     }
 
@@ -119,6 +137,23 @@ public function activateFlag(Activate $hit)
                 [FlagshipConstant::SEND_ACTIVATE,
                 $this->getLogFormat($exception->getMessage(), $url, $requestBody, $headers, $this->getNow() - $now)]
             );
+
+            $troubleshooting = new Troubleshooting();
+            $troubleshooting->setLabel(TroubleshootingLabel::SEND_ACTIVATE_HIT_ROUTE_ERROR)
+                ->setLogLevel(LogLevel::ERROR)
+                ->setVisitorId($this->flagshipInstanceId)
+                ->setFlagshipInstanceId($this->flagshipInstanceId)
+                ->setTraffic(100)
+                ->setConfig($this->config)
+                ->setHttpRequestBody($requestBody)
+                ->setHttpRequestHeaders($headers)
+                ->setHttpRequestMethod("POST")
+                ->setHttpRequestUrl($url)
+                ->setHttpResponseBody($exception->getMessage())
+                ->setHttpResponseTime($this->getNow() - $now)
+            ;
+            $this->addTroubleshootingHit($troubleshooting);
+            $this->sendTroubleshootingQueue();
         }
     }
 

diff --git a/src/Decision/ApiManager.php b/src/Decision/ApiManager.php
@@ -6,6 +6,7 @@
 use Exception;
 use Flagship\Enum\FlagshipConstant;
 use Flagship\Enum\FlagshipField;
+use Flagship\Enum\LogLevel;
 use Flagship\Enum\TroubleshootingLabel;
 use Flagship\Hit\Troubleshooting;
 use Flagship\Model\TroubleshootingData;
@@ -74,7 +75,7 @@ public function getCampaigns(VisitorAbstract $visitor)
 
             $troubleshooting = new Troubleshooting();
             $troubleshooting->setLabel(TroubleshootingLabel::GET_CAMPAIGNS_ROUTE_RESPONSE_ERROR)
-                ->setLogLevel("ERROR")
+                ->setLogLevel(LogLevel::ERROR)
                 ->setVisitorId($visitor->getVisitorId())
                 ->setAnonymousId($visitor->getAnonymousId())
                 ->setVisitorContext($visitor->getContext())

diff --git a/src/Decision/BucketingManager.php b/src/Decision/BucketingManager.php
@@ -77,7 +77,7 @@ public function __construct(HttpClientInterface $httpClient, BucketingConfig $co
      */
     protected function sendContext(VisitorAbstract $visitor)
     {
-        if (count($visitor->getContext()) <= self::NB_MIN_CONTEXT_KEYS) {
+        if (count($visitor->getContext()) <= self::NB_MIN_CONTEXT_KEYS || !$visitor->hasConsented()) {
             return;
         }
 
@@ -171,7 +171,7 @@ protected function getBucketingFile()
             $troubleshooting->setLabel(TroubleshootingLabel::SDK_BUCKETING_FILE_ERROR)
                 ->setFlagshipInstanceId($this->getFlagshipInstanceId())
                 ->setTraffic(0)
-                ->setLogLevel("ERROR")
+                ->setLogLevel(LogLevel::ERROR)
                 ->setConfig($this->getConfig())
                 ->setHttpRequestMethod("GET")
                 ->setHttpRequestUrl($url)
@@ -276,8 +276,7 @@ private function getVisitorCampaigns(
     ) {
         $visitorCampaigns = [];
         foreach ($variationGroups as $variationGroup) {
-            $check = $this->isMatchTargeting($variationGroup, $visitor);
-            if ($check) {
+            if ($this->isMatchTargeting($variationGroup, $visitor)) {
                 $variations = $this->getVariation(
                     $variationGroup,
                     $visitor
@@ -409,8 +408,7 @@ private function isMatchTargeting($variationGroup, VisitorAbstract $visitor)
 
             $innerTargetings = $targetingGroup[FlagshipField::FIELD_TARGETINGS];
 
-            $check = $this->checkAndTargeting($innerTargetings, $visitor);
-            if ($check) {
+            if ($this->checkAndTargeting($innerTargetings, $visitor)) {
                 return true;
             }
         }

diff --git a/src/Enum/FlagshipConstant.php b/src/Enum/FlagshipConstant.php
@@ -60,7 +60,7 @@ class FlagshipConstant
     /**
      * SDK version
      */
-    const SDK_VERSION = "3.2.0";
+    const SDK_VERSION = "3.2.1";
 
     const GET_FLAG = 'GET_FLAG';
 
@@ -205,5 +205,5 @@ class FlagshipConstant
     const LOG_FORMAT_RESPONSE_STATUS = 'RESPONSE_STATUS';
     const LOG_FORMAT_DURATION = 'DURATION';
 
-    const ANALYTIC_HIT_ALLOCATION = 20;
+    const ANALYTIC_HIT_ALLOCATION = 1;
 }
diff --git a/src/Enum/TroubleshootingLabel.php b/src/Enum/TroubleshootingLabel.php
@@ -22,4 +22,5 @@ class TroubleshootingLabel
     const SDK_BUCKETING_FILE_ERROR= "SDK_BUCKETING_FILE_ERROR";
     const SDK_BUCKETING_FILE = "SDK_BUCKETING_FILE";
     const SDK_CONFIG = "SDK_CONFIG";
+    const SEND_HIT_ROUTE_ERROR = 'SEND_HIT_ROUTE_ERROR';
 }
diff --git a/src/Hit/Diagnostic.php b/src/Hit/Diagnostic.php
@@ -73,6 +73,11 @@ class Diagnostic extends HitAbstract
      */
     private $sdkConfigMode;
 
+    /**
+     * @var numeric
+     */
+    private $sdkConfigLogLeve;
+
     /**
      * @var bool
      */
@@ -288,7 +293,6 @@ class Diagnostic extends HitAbstract
     private $flagshipInstanceId;
 
 
-
     public function __construct($type)
     {
         parent::__construct($type);
@@ -1293,6 +1297,26 @@ public function setHitContent($hitContent)
         return $this;
     }
 
+    /**
+     * @return float|int|string
+     */
+    public function getSdkConfigLogLeve()
+    {
+        return $this->sdkConfigLogLeve;
+    }
+
+    /**
+     * @param float|int|string $sdkConfigLogLeve
+     * @return Diagnostic
+     */
+    public function setSdkConfigLogLeve($sdkConfigLogLeve)
+    {
+        $this->sdkConfigLogLeve = $sdkConfigLogLeve;
+        return $this;
+    }
+
+
+
     public function toApiKeys()
     {
         $customVariable = [
@@ -1330,6 +1354,9 @@ public function toApiKeys()
         if ($this->getSdkStatus() !== null) {
             $customVariable["sdk.status"] = FlagshipStatus::getStatusName($this->getSdkStatus());
         }
+        if ($this->getSdkConfigLogLeve() !== null) {
+            $customVariable["sdk.config.logLevel"] = LogLevel::getLogName($this->getSdkConfigLogLeve());
+        }
         if ($this->getSdkConfigMode() !== null) {
             $customVariable["sdk.config.mode"] = DecisionMode::getDecisionModeName($this->getSdkConfigMode());
         }
@@ -1416,7 +1443,7 @@ public function toApiKeys()
         if (is_array($this->getVisitorContext())) {
             $context = $this->getVisitorContext();
             foreach ($context as $index => $item) {
-                $customVariable["visitor.context.$index"] = is_string($item) ?  $item : json_encode($item);
+                $customVariable["visitor.context.[$index]"] = is_string($item) ?  $item : json_encode($item);
             }
         }
 

diff --git a/src/Visitor/NoConsentStrategy.php b/src/Visitor/NoConsentStrategy.php
@@ -66,7 +66,7 @@ protected function fetchVisitorCampaigns(VisitorAbstract $visitor)
      */
     private function log($functionName)
     {
-        $this->logError(
+        $this->logInfo(
             $this->getVisitor()->getConfig(),
             sprintf(
                 FlagshipConstant::METHOD_DEACTIVATED_CONSENT_ERROR,

diff --git a/src/Visitor/PanicStrategy.php b/src/Visitor/PanicStrategy.php
@@ -22,7 +22,7 @@ class PanicStrategy extends DefaultStrategy
     public function setConsent($hasConsented)
     {
         $this->visitor->hasConsented = $hasConsented;
-        $this->logError(
+        $this->logInfo(
             $this->getVisitor()->getConfig(),
             sprintf(
                 FlagshipConstant::METHOD_DEACTIVATED_SEND_CONSENT_ERROR,
@@ -146,7 +146,7 @@ protected function fetchVisitorCampaigns(VisitorAbstract $visitor)
      */
     private function log($functionName)
     {
-        $this->logError(
+        $this->logInfo(
             $this->getVisitor()->getConfig(),
             sprintf(
                 FlagshipConstant::METHOD_DEACTIVATED_ERROR,

diff --git a/src/Visitor/VisitorStrategyAbstract.php b/src/Visitor/VisitorStrategyAbstract.php
@@ -365,10 +365,12 @@ public function sendSdkConfigAnalyticHit()
         }
         $uniqueId = $this->getVisitor()->getVisitorId() . $this->getCurrentDateTime()->format("Y-m-d");
         $hash = $this->getMurmurHash()->murmurHash3Int32($uniqueId);
-        $traffic = $hash % 100;
-        if ($traffic >= FlagshipConstant::ANALYTIC_HIT_ALLOCATION) {
+        $traffic = $hash % 1000;
+
+        if ($traffic > FlagshipConstant::ANALYTIC_HIT_ALLOCATION) {
             return;
         }
+
         $visitor = $this->getVisitor();
         $config = $this->getConfig();
         $bucketingUrl = null;
@@ -382,6 +384,7 @@ public function sendSdkConfigAnalyticHit()
             ->setLogLevel(LogLevel::INFO)
             ->setVisitorId($this->getFlagshipInstanceId())
             ->setSdkConfigMode($config->getDecisionMode())
+            ->setSdkConfigLogLeve($config->getLogLevel())
             ->setSdkConfigTimeout($config->getTimeout())
             ->setSdkConfigTrackingManagerConfigStrategy($config->getCacheStrategy())
             ->setSdkConfigBucketingUrl($bucketingUrl)
@@ -444,6 +447,7 @@ public function sendFetchFlagsTroubleshooting($troubleshootingData, $flagsDTO, $
             ->setVisitorIsAuthenticated(!!$visitor->getAnonymousId())
             ->setHttpResponseTime(($this->getNow() - $now))
             ->setSdkConfigMode($config->getDecisionMode())
+            ->setSdkConfigLogLeve($config->getLogLevel())
             ->setSdkConfigTimeout($config->getTimeout())
             ->setSdkConfigBucketingUrl($bucketingUrl)
             ->setSdkConfigFetchThirdPartyData($fetchThirdPartyData)

diff --git a/tests/Api/NoBatchingContinuousCachingStrategyTest.php b/tests/Api/NoBatchingContinuousCachingStrategyTest.php
@@ -142,7 +142,7 @@ public function testAddHitFailed()
             true,
             true,
             true,
-            ["cacheHit","flushHits","logErrorSprintf"]
+            ["cacheHit","flushHits","logErrorSprintf", "addTroubleshootingHit", "sendTroubleshootingQueue"]
         );
 
         $strategy->expects($this->never())->method("flushHits");
@@ -152,6 +152,7 @@ public function testAddHitFailed()
 
         $strategy->expects($this->once())->method("cacheHit")->with([$page]);
 
+
         $requestBody = $page->toApiKeys();
 
         $url = FlagshipConstant::HIT_EVENT_URL;
@@ -186,6 +187,9 @@ public function testAddHitFailed()
                 ]
             );
 
+        $strategy->expects($this->once())->method("addTroubleshootingHit");
+        $strategy->expects($this->once())->method("sendTroubleshootingQueue");
+
         $this->assertCount(0, $strategy->getHitsPoolQueue());
         $this->assertCount(0, $strategy->getActivatePoolQueue());
         $strategy->addHit($page);
@@ -381,7 +385,7 @@ public function testActivateFlagFailed()
             true,
             true,
             true,
-            ["cacheHit","flushHits","logErrorSprintf"]
+            ["cacheHit","flushHits","logErrorSprintf", "addTroubleshootingHit", "sendTroubleshootingQueue"]
         );
 
         $strategy->expects($this->never())->method("flushHits");
@@ -425,6 +429,8 @@ public function testActivateFlagFailed()
                     [FlagshipConstant::SEND_ACTIVATE, $logMessage ]
                 ]
             );
+        $strategy->expects($this->once())->method("addTroubleshootingHit");
+        $strategy->expects($this->once())->method("sendTroubleshootingQueue");
 
         $this->assertCount(0, $strategy->getHitsPoolQueue());
         $this->assertCount(0, $strategy->getActivatePoolQueue());

diff --git a/tests/Decision/BucketingManagerTest.php b/tests/Decision/BucketingManagerTest.php
@@ -215,19 +215,24 @@ public function testSendContext()
         $configManager->setConfig($config)->setTrackingManager($trackerManager);
         $visitor = new VisitorDelegate($containerMock, $configManager, $visitorId, false, $visitorContext, true);
 
-        $httpClientMock->expects($this->exactly(2))
+        $httpClientMock->expects($this->exactly(3))
             ->method('get')
             ->willReturn(
                 new HttpResponse(204, json_decode('{"campaigns":[{}]}', true))
             );
 
-        $trackerManager->expects($this->exactly(2))->method("addHit");
+        $trackerManager->expects($this->exactly(3))->method("addHit");
 
         $bucketingManager->getCampaignModifications($visitor);
 
         //Test empty context
         $visitor = new VisitorDelegate($containerMock, $configManager, $visitorId, false, [], true);
         $bucketingManager->getCampaignModifications($visitor);
+
+        //Test visitor has not consented
+        $visitor = new VisitorDelegate($containerMock, $configManager, $visitorId, false, $visitorContext, false);
+        $bucketingManager->getCampaignModifications($visitor);
+
     }
 
     public function testGetVariation()

diff --git a/tests/Hit/TroubleshootingTest.php b/tests/Hit/TroubleshootingTest.php
@@ -104,6 +104,7 @@ public function testConstruct()
             ->setStackOriginVersion($stackOriginVersion)
             ->setSdkStatus($sdkStatus)
             ->setSdkConfigMode($sdkConfigMode)
+            ->setSdkConfigLogLeve($config->getLogLevel())
             ->setSdkConfigCustomLogManager(true)
             ->setSdkConfigCustomCacheManager(true)
             ->setSdkConfigStatusListener(false)
@@ -162,6 +163,7 @@ public function testConstruct()
             'stack.origin.name' => $stackOriginName,
             'stack.origin.version' => $stackOriginVersion,
             'sdk.status' => FlagshipStatus::getStatusName($sdkStatus),
+            'sdk.config.logLevel' => LogLevel::getLogName($config->getLogLevel()),
             'sdk.config.mode' => DecisionMode::getDecisionModeName($sdkConfigMode),
             'sdk.config.customLogManager' => 'true',
             'sdk.config.customCacheManager' => 'true',
@@ -183,8 +185,8 @@ public function testConstruct()
             'http.response.code' => (string)$httpResponseCode,
             "http.response.body" => json_encode($httpResponseBody),
             'http.response.time' => (string)$httpResponseTime,
-            'visitor.context.key1' => 'value1',
-            'visitor.context.key2' => 'value2',
+            'visitor.context.[key1]' => 'value1',
+            'visitor.context.[key2]' => 'value2',
             'visitor.consent' => 'true',
             'visitor.assignments.key1' => 'value1',
             'visitor.assignments.key2' => 'value2',