Merge pull request #222 from splitio/task/flagsetsintoMF

Task/flagsetsinto mf

Author: mmelograno

CHANGES.txt

@@ -2,6 +2,16 @@
  - BREAKING CHANGE: Removed support from versions older than PHP 7.4.
  - BREAKING CHANGE: Added support for Multiple Factory Instantiation.
 
+7.2.0 (Jan 24, 2024)
+ - Added support for Flag Sets on the SDK, which enables grouping feature flags and interacting with the group rather than individually (more details in our documentation):
+  - Added new variations of the get treatment methods to support evaluating flags in given flag set/s.
+   - getTreatmentsByFlagSet and getTreatmentsByFlagSets
+   - getTreatmentWithConfigByFlagSets and getTreatmentsWithConfigByFlagSets
+  - Added `defaultTreatment` and `sets` properties to the `SplitView` object returned by the `split` and `splits` methods of the SDK manager.
+
+7.1.8 (Jul 24, 2023)
+ - Fixed input validation for empty keys.
+
 7.1.7 (May 16, 2023)
  - Updated terminology on the SDKs codebase to be more aligned with current standard without causing a breaking change. The core change is the term split for feature flag on things like logs and phpdoc comments.
  - Fixed php 8.2 warnings in code.

src/SplitIO/Component/Cache/Pool.php

@@ -83,4 +83,9 @@ public function expireKey($key, $ttl)
     {
         return $this->adapter->expireKey($key, $ttl);
     }
+
+    public function sMembers($key)
+    {
+        return $this->adapter->sMembers($key);
+    }
 }

src/SplitIO/Component/Cache/SplitCache.php

@@ -9,6 +9,8 @@ class SplitCache implements SplitCacheInterface
 
     const KEY_TRAFFIC_TYPE_CACHED = 'SPLITIO.trafficType.{trafficTypeName}';
 
+    const KEY_FLAG_SET_CACHED = 'SPLITIO.flagSet.{set}';
+
     /**
      * @var \SplitIO\Component\Cache\Pool
      */
@@ -37,6 +39,11 @@ private static function getCacheKeyForSplit($splitName)
         return str_replace('{splitName}', $splitName, self::KEY_SPLIT_CACHED_ITEM);
     }
 
+    private static function getCacheKeyForFlagSet($flagSet)
+    {
+        return str_replace('{set}', $flagSet, self::KEY_FLAG_SET_CACHED);
+    }
+
     private static function getSplitNameFromCacheKey($key)
     {
         $cacheKeyPrefix = self::getCacheKeyForSplit('');
@@ -87,6 +94,22 @@ public function getSplitNames()
         return array_map([self::class, 'getSplitNameFromCacheKey'], $splitKeys);
     }
 
+    /**
+     * @param array(string) List of flag set names
+     * @return array(string) List of all feature flag names by flag sets
+     */
+    public function getNamesByFlagSets($flagSets)
+    {
+        $toReturn = array();
+        if (empty($flagSets)) {
+            return $toReturn;
+        }
+        foreach ($flagSets as $flagSet) {
+            $toReturn[$flagSet] = $this->cache->sMembers(self::getCacheKeyForFlagSet($flagSet));
+        }
+        return $toReturn;
+    }
+
     /**
      * @return array(string) List of all split JSON strings
      */

src/SplitIO/Component/Cache/SplitCacheInterface.php

@@ -13,4 +13,10 @@ public function getChangeNumber();
      * @return string JSON representation
      */
     public function getSplit($splitName);
+
+    /**
+     * @param array(string) List of flag set names
+     * @return array(string) List of all feature flag names by flag sets
+     */
+    public function getNamesByFlagSets($flagSets);
 }

src/SplitIO/Component/Cache/Storage/Adapter/CacheStorageAdapterInterface.php

@@ -37,4 +37,10 @@ public function rightPushQueue($queueName, $item);
      * @return boolean
      */
     public function expireKey($key, $ttl);
+
+    /**
+     * @param string $key
+     * @return mixed
+     */
+    public function sMembers($key);
 }

src/SplitIO/Component/Cache/Storage/Adapter/PRedis.php

@@ -184,6 +184,15 @@ public function isOnList($key, $value)
         return $this->client->sIsMember($key, $value);
     }
 
+    /**
+     * @param string $key
+     * @return mixed
+     */
+    public function sMembers($key)
+    {
+        return $this->client->smembers($key);
+    }
+
     public function getKeys($pattern = '*')
     {
         $keys = $this->client->keys($pattern);

src/SplitIO/Component/Cache/Storage/Adapter/SafeRedisWrapper.php

@@ -123,4 +123,20 @@ public function expireKey($key, $ttl)
             return false;
         }
     }
+
+    /**
+     * @param string $key
+     * @return mixed
+     */
+    public function sMembers($key)
+    {
+        try {
+            return $this->cacheAdapter->sMembers($key);
+        } catch (\Exception $e) {
+            Context::getLogger()->critical("An error occurred performing SMEMBERS for " . $key);
+            Context::getLogger()->critical($e->getMessage());
+            Context::getLogger()->critical($e->getTraceAsString());
+            return array();
+        }
+    }
 }

src/SplitIO/Grammar/Split.php

@@ -31,6 +31,7 @@ class Split
     private $trafficAllocationSeed = null;
 
     private $configurations = null;
+    private $sets = null;
 
     public function __construct(array $split)
     {
@@ -50,6 +51,7 @@ public function __construct(array $split)
             $split['trafficAllocationSeed'] : null;
         $this->configurations = isset($split['configurations']) && count($split['configurations']) > 0 ?
             $split['configurations'] : null;
+        $this->sets = isset($split['sets']) ? $split['sets'] : array();
 
         SplitApp::logger()->info("Constructing Feature Flag: ".$this->name);
 
@@ -167,4 +169,12 @@ public function getConfigurations()
     {
         return $this->configurations;
     }
+
+    /**
+     * @return array|null
+     */
+    public function getSets()
+    {
+        return $this->sets;
+    }
 }

src/SplitIO/Metrics.php

@@ -5,11 +5,6 @@
 
 class Metrics
 {
-    const MNAME_SDK_GET_TREATMENT = 'sdk.getTreatment';
-    const MNAME_SDK_GET_TREATMENT_WITH_CONFIG = 'sdk.getTreatmentWithConfig';
-    const MNAME_SDK_GET_TREATMENTS = 'sdk.getTreatments';
-    const MNAME_SDK_GET_TREATMENTS_WITH_CONFIG = 'sdk.getTreatmentsWithConfig';
-
     public static function startMeasuringLatency()
     {
         return Latency::startMeasuringLatency();