feat: getFlag Batching

sakshamg1304 · rohitesh-wingify · commit 3b700b85e926 · 2025-12-11T09:12:55.000+05:30
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,12 +5,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [1.14.0] - 2025-01-XX
+## [1.15.0] - 2025-12-10
+
+### Added
+
+- Added batch event processing to optimize network calls during GetFlag operations. Multiple impression events are now collected and sent in a single batch request
+
+## [1.14.0] - 2025-11-26
 
 ### Fixed
 
 - Fixed GET requests (settings calls) to always use cURL instead of sockets for improved reliability.
 
+
 ## [1.13.0] - 2025-10-10
 
 ### Added
@@ -263,4 +270,4 @@ $vwoClient->setAlias('userId', 'aliasId');
     // set Attribute
     $setAttribute = $vwoClient->setAttribute('attribute-name', 'attribute-value', $userContext);
 
-    ```
+    ```
diff --git a/composer.json b/composer.json
@@ -1,7 +1,7 @@
 {
     "name": "vwo/vwo-fme-php-sdk",
 
-    "version": "1.14.0",
+    "version": "1.15.0",
     "keywords": ["vwo", "fme", "sdk"],
     "license": "Apache-2.0",
     "authors": [{
diff --git a/src/Api/GetFlag.php b/src/Api/GetFlag.php
@@ -37,6 +37,9 @@
 use vwo\Utils\ImpressionUtil;
 use vwo\Utils\GetFlagResultUtil;
 use vwo\Utils\RuleEvaluationUtil;
+use vwo\Utils\NetworkUtil;
+use vwo\Enums\EventEnum;
+use vwo\Services\SettingsService;
 
 class GetFlag
 {
@@ -57,6 +60,7 @@ public function get(
         $evaluatedFeatureMap = [];
         $storageService = new StorageService();
         $ruleStatus = [];
+        $batchPayload = [];
 
         // Get feature object from feature key
         $feature = FunctionUtil::getFeatureFromKey($settings, $featureKey);
@@ -155,6 +159,18 @@ public function get(
                 );
 
                 if ($evaluateRuleResult['preSegmentationResult']) {
+                    $payload = $evaluateRuleResult['payload'];
+                    if(!$isDebuggerUsed) {
+                        if(SettingsService::instance()->isGatewayServiceProvided && $payload !== null) {
+                            ImpressionUtil::SendImpressionForVariationShown($settings, $payload, $context);
+                        } else {
+                            //push this payload to the batch payload
+                            if($payload !== null) {
+                                $batchPayload[] = $payload;
+                            }
+                        }
+                    }
+                    
                     $evaluatedFeatureMap[$featureKey] = [
                         'rolloutId' => $rule->getId(),
                         'rolloutKey' => $rule->getKey(),
@@ -180,12 +196,24 @@ public function get(
                     $this->updateIntegrationsDecisionObject($passedRolloutCampaign, $variation, $passedRulesInformation, $decision);
 
                     if (!$isDebuggerUsed) {
-                        ImpressionUtil::createAndSendImpressionForVariationShown(
+                        //push this payload to the batch payload
+                        $networkUtil = new NetworkUtil();
+                        $payload = $networkUtil->getTrackUserPayloadData(
                             $settings,
+                            EventEnum::VWO_VARIATION_SHOWN,
                             $passedRolloutCampaign->getId(),
                             $variation->getId(),
                             $context
                         );
+
+                        if(SettingsService::instance()->isGatewayServiceProvided && $payload !== null) {
+                            ImpressionUtil::SendImpressionForVariationShown($settings, $payload, $context);
+                        } else {
+                            //push this payload to the batch payload
+                            if($payload !== null) {
+                                $batchPayload[] = $payload;
+                            }
+                        }
                     }
                 }
             }
@@ -218,6 +246,14 @@ public function get(
                         $experimentRulesToEvaluate[] = $rule;
                     } else {
                         $isEnabled = true;
+                        $payload = $evaluateRuleResult['payload'];
+                        if(SettingsService::instance()->isGatewayServiceProvided && $payload !== null) {
+                            ImpressionUtil::SendImpressionForVariationShown($settings, $payload, $context);
+                        } else {
+                            if($payload !== null) {
+                                $batchPayload[] = $payload;
+                            }
+                        }
                         $experimentVariationToReturn = $evaluateRuleResult['whitelistedObject']['variation'];
 
                         $passedRulesInformation = array_merge($passedRulesInformation, [
@@ -245,12 +281,23 @@ public function get(
                     $this->updateIntegrationsDecisionObject($campaign, $variation, $passedRulesInformation, $decision);
 
                     if (!$isDebuggerUsed) {
-                        ImpressionUtil::createAndSendImpressionForVariationShown(
+                        // Construct payload data for tracking the user
+                        $networkUtil = new NetworkUtil();
+                        $payload = $networkUtil->getTrackUserPayloadData(
                             $settings,
+                            EventEnum::VWO_VARIATION_SHOWN,
                             $campaign->getId(),
                             $variation->getId(),
                             $context
                         );
+                        if(SettingsService::instance()->isGatewayServiceProvided && $payload !== null) {
+                            ImpressionUtil::SendImpressionForVariationShown($settings, $payload, $context);
+                        } else {
+                            //push this payload to the batch payload
+                            if($payload !== null) {
+                                $batchPayload[] = $payload;
+                            }
+                        }
                     }
                 }
             }
@@ -282,12 +329,23 @@ public function get(
             ));
 
             if (!$isDebuggerUsed) {
-                ImpressionUtil::createAndSendImpressionForVariationShown(
+                // Construct payload data for tracking the user
+                $networkUtil = new NetworkUtil();
+                $payload = $networkUtil->getTrackUserPayloadData(
                     $settings,
+                    EventEnum::VWO_VARIATION_SHOWN,
                     $feature->getImpactCampaign()->getCampaignId(),
                     $isEnabled ? 2 : 1,
                     $context
                 );
+                if(SettingsService::instance()->isGatewayServiceProvided && $payload !== null) {
+                    ImpressionUtil::SendImpressionForVariationShown($settings, $payload, $context);
+                } else {
+                    //push this payload to the batch payload
+                    if($payload !== null) {
+                        $batchPayload[] = $payload;
+                    }
+                }
             }
         }
 
@@ -299,6 +357,10 @@ public function get(
             $variablesForEvaluatedFlag = $rolloutVariationToReturn->getVariables();
         }
 
+        if(!SettingsService::instance()->isGatewayServiceProvided) {
+            ImpressionUtil::SendImpressionForVariationShownInBatch($batchPayload);
+        }
+
         return new GetFlagResultUtil($isEnabled, $variablesForEvaluatedFlag, $ruleStatus);
     }
 
diff --git a/src/Constants/Constants.php b/src/Constants/Constants.php
@@ -40,7 +40,7 @@ class Constants {
     const DEFAULT_EVENTS_PER_REQUEST = 100;
     const SDK_NAME = 'vwo-fme-php-sdk';
 
-    const SDK_VERSION = '1.14.0';
+    const SDK_VERSION = '1.15.0';
     const AP = 'server';
 
     const SETTINGS = 'settings';
diff --git a/src/Enums/HeadersEnum.php b/src/Enums/HeadersEnum.php
@@ -21,5 +21,6 @@
 class HeadersEnum {
     const USER_AGENT = 'X-Device-User-Agent';
     const IP = 'VWO-X-Forwarded-For';
+    const AUTHORIZATION = 'Authorization';
 }
 ?>
diff --git a/src/Enums/UrlEnum.php b/src/Enums/UrlEnum.php
@@ -25,7 +25,7 @@ class UrlEnum {
     const TRACK_USER = '/server-side/track-user';
     const TRACK_GOAL = '/server-side/track-goal';
     const PUSH = '/server-side/push';
-    const BATCH_EVENTS = '/server-side/batch-events';
+    const BATCH_EVENTS = '/server-side/batch-events-v2';
     const EVENTS = '/events/t';
     const ATTRIBUTE_CHECK = '/check-attribute';
     const GET_USER_DATA = '/get-user-details';
diff --git a/src/Utils/ImpressionUtil.php b/src/Utils/ImpressionUtil.php
@@ -22,9 +22,19 @@
 use vwo\Enums\EventEnum;
 use vwo\Utils\NetworkUtil;
 use vwo\Models\User\ContextModel;
+use vwo\Enums\HeadersEnum;
+use vwo\Services\SettingsService;
+use vwo\Services\UrlService;
+use vwo\Enums\UrlEnum;
+use vwo\Packages\NetworkLayer\Manager\NetworkManager;
+use vwo\Packages\NetworkLayer\Models\RequestModel;
+use vwo\Packages\Logger\Core\LogManager;
 
 class ImpressionUtil
 {
+    private $accountId;
+    
+
     /**
      * Creates and sends an impression for a variation shown event.
      * This function constructs the necessary properties and payload for the event
@@ -35,10 +45,9 @@ class ImpressionUtil
      * @param int $variationId - The ID of the variation shown to the user.
      * @param ContextModel $context - The user context model containing user-specific data.
      */
-    public static function createAndSendImpressionForVariationShown(
+    public static function SendImpressionForVariationShown(
         SettingsModel $settings,
-        $campaignId,
-        $variationId,
+        $payload,
         ContextModel $context
     ) {
         // Get base properties for the event
@@ -50,17 +59,75 @@ public static function createAndSendImpressionForVariationShown(
             $context->getIpAddress()
         );
 
-        // Construct payload data for tracking the user
-        $payload = $networkUtil->getTrackUserPayloadData(
-            $settings,
-            EventEnum::VWO_VARIATION_SHOWN,
-            $campaignId,
-            $variationId,
-            $context
-        );
-
         // Send the constructed properties and payload as a POST request
         $networkUtil->sendPostApiRequest($properties, $payload);
     }
+
+    /**
+     * Sends a batch of events to the VWO server.
+     *
+     * @param array $batchPayload The batch payload to send.
+     * @return bool True if the batch of events was sent successfully, false otherwise.
+     */
+    public static function SendImpressionForVariationShownInBatch($batchPayload) {
+        return self::sendBatchEvents($batchPayload);
+    }
+
+    /**
+     * Sends a batch of events to the VWO server.
+     *
+     * @param array $batchPayload The batch payload to send.
+     * @return bool True if the batch of events was sent successfully, false otherwise.
+     */
+    private static function sendBatchEvents($batchPayload) {
+        $accountId = SettingsService::instance()->accountId ?? null;
+        $retryConfig = NetworkManager::instance()->getRetryConfig();
+
+        $networkUtil = new NetworkUtil();
+        $properties = $networkUtil->getEventBatchingQueryParams($accountId);
+        $headers = [];
+        $headers[HeadersEnum::AUTHORIZATION] = SettingsService::instance()->sdkKey;
+        
+        $eventCount = is_array($batchPayload) ? count($batchPayload) : 1;
+        $batchPayload = [
+            'ev' => $batchPayload
+        ];
+
+
+        $request = new RequestModel(
+            UrlService::getBaseUrl(),
+            'POST',
+            UrlEnum::BATCH_EVENTS,
+            $properties,
+            $batchPayload,
+            $headers,
+            SettingsService::instance()->protocol,
+            SettingsService::instance()->port,
+            $retryConfig
+        );
+
+        try {
+            $response = NetworkManager::instance()->post($request);
+            $statusCode = $response->getStatusCode();
+            
+            // When shouldWaitForTrackingCalls is false, socket connections are used (fire-and-forget)
+            // No status code is available, so we don't log success (we can't verify it)
+            if ($statusCode === null) {
+                LogManager::instance()->info('Impression sent to VWO server via socket connection for ' . $eventCount . ' events.');
+                return true;
+            }
+            
+            if ($statusCode == 200) {
+                LogManager::instance()->info('Impression sent successfully for ' . $eventCount . ' events.');
+                return true;
+            } else {
+                LogManager::instance()->error('Impression failed to send for ' . $eventCount . ' events');
+                return false;
+            }
+        } catch (\Exception $e) {
+            LogManager::instance()->error('Error occurred while sending impressions. Error:' . $e->getMessage());
+            return false;
+        }
+    }
 }
 
diff --git a/src/Utils/NetworkUtil.php b/src/Utils/NetworkUtil.php
@@ -121,6 +121,7 @@ public function getEventBatchingQueryParams($accountId)
             'a' => $accountId,
             'sd' => Constants::SDK_NAME,
             'sv' => $sdkVersion,
+            'env' => SettingsService::instance()->sdkKey
         ];
 
         return $path;
diff --git a/src/Utils/RuleEvaluationUtil.php b/src/Utils/RuleEvaluationUtil.php
@@ -25,7 +25,9 @@
 use vwo\Utils\DataTypeUtil;
 use vwo\Utils\DecisionUtil;
 use vwo\Utils\ImpressionUtil;
+use vwo\Utils\NetworkUtil;
 use vwo\Models\User\ContextModel;
+use vwo\Enums\EventEnum;
 
 class RuleEvaluationUtil
 {
@@ -57,6 +59,7 @@ public static function evaluateRule($settings, $feature, $campaign, $context, &$
             $storageService,
             $decision
         );
+        $payload = null;
 
         // If pre-segmentation is successful and a whitelisted object exists, proceed to send an impression
         if ($preSegmentationResult && DataTypeUtil::isObject($whitelistedObject) && count((array) $whitelistedObject) > 0) {
@@ -66,16 +69,16 @@ public static function evaluateRule($settings, $feature, $campaign, $context, &$
                 'experimentKey' => $campaign->getKey(),
                 'experimentVariationId' => $whitelistedObject['variationId'],
             ]);
-
             // Send an impression for the variation shown
             // if settings passed in init options is true, then we don't need to send an impression
             if (!$isDebuggerUsed) {
-                ImpressionUtil::createAndSendImpressionForVariationShown($settings, $campaign->getId(), $whitelistedObject['variation']->getId(), $context);
+                $networkUtil = new NetworkUtil();
+                $payload = $networkUtil->getTrackUserPayloadData($settings, EventEnum::VWO_VARIATION_SHOWN, $campaign->getId(), $whitelistedObject['variation']->getId(), $context);
             }
         }
 
         // Return the results of the evaluation
-        return ['preSegmentationResult' => $preSegmentationResult, 'whitelistedObject' => $whitelistedObject, 'updatedDecision' => $decision];
+        return ['preSegmentationResult' => $preSegmentationResult, 'whitelistedObject' => $whitelistedObject, 'updatedDecision' => $decision, 'payload' => $payload];
     }
 }
 ?>

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "vwo/vwo-fme-php-sdk",`
`3`	`3`
`4`		`- "version": "1.14.0",`
	`4`	`+ "version": "1.15.0",`
`5`	`5`	`"keywords": ["vwo", "fme", "sdk"],`
`6`	`6`	`"license": "Apache-2.0",`
`7`	`7`	`"authors": [{`
Original file line number	Diff line number	Diff line change
`@@ -21,5 +21,6 @@`
`21`	`21`	`class HeadersEnum {`
`22`	`22`	`const USER_AGENT = 'X-Device-User-Agent';`
`23`	`23`	`const IP = 'VWO-X-Forwarded-For';`
	`24`	`+ const AUTHORIZATION = 'Authorization';`
`24`	`25`	`}`
`25`	`26`	`?>`