unsupported matcher implementation

splitio · Apr 24, 2024 · 2841fd1 · 2841fd1
1 parent ffacf6f
commit 2841fd1
Show file tree

Hide file tree

Showing 8 changed files with 174 additions and 15 deletions.
diff --git a/src/SplitIO/Exception/UnsupportedMatcherException.php b/src/SplitIO/Exception/UnsupportedMatcherException.php
@@ -0,0 +1,7 @@
+<?php
+namespace SplitIO\Exception;
+
+class UnsupportedMatcherException extends \LogicException
+{
+
+}
diff --git a/src/SplitIO/Grammar/Condition.php b/src/SplitIO/Grammar/Condition.php
@@ -2,15 +2,17 @@
 namespace SplitIO\Grammar;
 
 use SplitIO\Exception\InvalidMatcherException;
-use SplitIO\Split as SplitApp;
 use SplitIO\Grammar\Condition\Combiner\AndCombiner;
 use SplitIO\Grammar\Condition\Combiner\CombinerEnum;
 use SplitIO\Grammar\Condition\Combiner\Factor\NotFactor;
+use SplitIO\Grammar\Condition\ConditionTypeEnum;
 use SplitIO\Grammar\Condition\Matcher;
-use SplitIO\Grammar\Condition\Partition;
 use SplitIO\Grammar\Condition\Matcher\AbstractMatcher;
-use SplitIO\Grammar\Condition\ConditionTypeEnum;
 use SplitIO\Grammar\Condition\Matcher\Dependency;
+use SplitIO\Grammar\Condition\Partition;
+use SplitIO\Grammar\Condition\Partition\TreatmentEnum;
+use SplitIO\Sdk\Impressions\ImpressionLabel;
+use SplitIO\Split as SplitApp;
 
 class Condition
 {
@@ -115,6 +117,31 @@ public function match($key, array $attributes = null, $bucketingKey = null)
         return false;
     }
 
+    public static function getDefaultCondition()
+    {
+        return new Condition(array(
+            'conditionType' => ConditionTypeEnum::WHITELIST,
+            'matcherGroup' => array(
+                'combiner' => CombinerEnum::_AND,
+                'matchers' => array(
+                    array(
+                        'matcherType' => Matcher::ALL_KEYS,
+                        'negate' => false,
+                        'userDefinedSegmentMatcherData' => null,
+                        'whitelistMatcherData' => null
+                    )
+                )
+            ),
+            'partitions' => array(
+                array(
+                    'treatment' => TreatmentEnum::CONTROL,
+                    'size' => 100
+                )
+            ),
+            'label' => ImpressionLabel::UNSUPPORTED_MATCHER
+        ));
+    }
+
     /**
      * @return array|null
      */

diff --git a/src/SplitIO/Grammar/Condition/Matcher.php b/src/SplitIO/Grammar/Condition/Matcher.php
@@ -1,6 +1,7 @@
 <?php
 namespace SplitIO\Grammar\Condition;
 
+use SplitIO\Exception\UnsupportedMatcherException;
 use SplitIO\Grammar\Condition\Matcher\All;
 use SplitIO\Grammar\Condition\Matcher\Between;
 use SplitIO\Grammar\Condition\Matcher\EqualTo;
@@ -131,7 +132,7 @@ public static function factory($matcher)
                 return new Regex($data, $negate, $attribute);
             // @codeCoverageIgnoreStart
             default:
-                return null;
+                throw new UnsupportedMatcherException("Unable to create matcher for matcher type: ");
         }
         // @codeCoverageIgnoreEnd
     }

diff --git a/src/SplitIO/Grammar/Split.php b/src/SplitIO/Grammar/Split.php
@@ -1,8 +1,10 @@
 <?php
 namespace SplitIO\Grammar;
 
-use SplitIO\Split as SplitApp;
+use SplitIO\Component\Common\Di;
 use SplitIO\Engine\Hash\HashAlgorithmEnum;
+use SplitIO\Split as SplitApp;
+
 
 class Split
 {
@@ -56,9 +58,14 @@ public function __construct(array $split)
         SplitApp::logger()->info("Constructing Feature Flag: ".$this->name);
 
         if (isset($split['conditions']) && is_array($split['conditions'])) {
-            $this->conditions = array();
-            foreach ($split['conditions'] as $condition) {
-                $this->conditions[] = new Condition($condition);
+            try {
+                $this->conditions = array();
+                foreach ($split['conditions'] as $condition) {
+                    $this->conditions[] = new Condition($condition);
+                }
+            } catch (\Exception $e) {
+                Di::getLogger()->debug($e->getMessage());
+                $this->conditions = array(Condition::getDefaultCondition());
             }
         }
     }

diff --git a/src/SplitIO/Sdk/Impressions/ImpressionLabel.php b/src/SplitIO/Sdk/Impressions/ImpressionLabel.php
@@ -48,4 +48,11 @@ class ImpressionLabel
      * Label: exception
      */
     const EXCEPTION = "exception";
+
+    /**
+     * Condition: unsupported matcher
+     * Treatment: control
+     * Label: targeting rule type unsupported by sdk
+     */
+    const UNSUPPORTED_MATCHER = "targeting rule type unsupported by sdk";
 }
diff --git a/tests/Suite/Matchers/MatchersTest.php b/tests/Suite/Matchers/MatchersTest.php
@@ -1,18 +1,13 @@
 <?php
 namespace SplitIO\Test\Suite\Sdk;
 
-use Monolog\Logger;
-use Monolog\Handler\ErrorLogHandler;
-use SplitIO\Component\Cache\SegmentCache;
-use SplitIO\Component\Cache\SplitCache;
 use SplitIO\Grammar\Condition\Matcher;
-use SplitIO\Grammar\Condition\Matcher\DataType\DateTime;
 use SplitIO\Component\Common\Di;
 use \ReflectionMethod;
 
 use SplitIO\Test\Utils;
 
-class MatcherTest extends \PHPUnit\Framework\TestCase
+class MatchersTest extends \PHPUnit\Framework\TestCase
 {
     private function setupSplitApp()
     {
@@ -503,6 +498,16 @@ public function testBooleanMatcher()
         $this->assertEquals($meth->invoke($matcher2, 'ff'), false);
     }
 
+    public function testUnsupportedMatcher()
+    {
+        $condition = array(
+            'matcherType' => 'NEW_MATCHER_TYPE',
+        );
+
+        $this->expectException('\SplitIO\Exception\UnsupportedMatcherException');
+        Matcher::factory($condition);
+    }
+
     public static function tearDownAfterClass(): void
     {
         Utils\Utils::cleanCache();

diff --git a/tests/Suite/Sdk/SdkClientTest.php b/tests/Suite/Sdk/SdkClientTest.php
@@ -191,7 +191,8 @@ private function validateLastImpression(
         $key,
         $treatment,
         $machineName = 'unknown',
-        $machineIP = 'unknown'
+        $machineIP = 'unknown',
+        $label = ''
     ) {
         $raw = $redisClient->rpop(ImpressionCache::IMPRESSIONS_QUEUE_KEY);
         $parsed = json_decode($raw, true);
@@ -200,6 +201,10 @@ private function validateLastImpression(
         $this->assertEquals($parsed['i']['t'], $treatment);
         $this->assertEquals($parsed['m']['i'], $machineIP);
         $this->assertEquals($parsed['m']['n'], $machineName);
+
+        if ($label != '') {
+            $this->assertEquals($parsed['i']['r'], $label);
+        }
     }
 
     public function testSplitManager()
@@ -236,6 +241,42 @@ public function testSplitManager()
         $this->assertEquals('["set_a","set_b","set_c"]', json_encode($split_views["flagsets_feature"]->getSets()));
     }
 
+    public function testClientWithUnsupportedMatcher()
+    {
+        Di::set(Di::KEY_FACTORY_TRACKER, false);
+        //Testing version string
+        $this->assertTrue(is_string(\SplitIO\version()));
+
+        $parameters = array(
+            'scheme' => 'redis',
+            'host' => REDIS_HOST,
+            'port' => REDIS_PORT,
+            'timeout' => 881,
+        );
+        $options = array('prefix' => TEST_PREFIX);
+
+        $sdkConfig = array(
+            'log' => array('adapter' => 'stdout'),
+            'cache' => array('adapter' => 'predis', 'parameters' => $parameters, 'options' => $options)
+        );
+
+        //Initializing the SDK instance.
+        $splitFactory = \SplitIO\Sdk::factory('asdqwe123456', $sdkConfig);
+        $splitSdk = $splitFactory->client();
+        $splitManager = $splitFactory->manager();
+
+        //Populating the cache.
+        Utils\Utils::addSplitsInCache(file_get_contents(__DIR__."/files/splitChanges.json"));
+        Utils\Utils::addSegmentsInCache(file_get_contents(__DIR__."/files/segmentEmployeesChanges.json"));
+        Utils\Utils::addSegmentsInCache(file_get_contents(__DIR__."/files/segmentHumanBeignsChanges.json"));
+
+        $redisClient = ReflectiveTools::clientFromCachePool(Di::getCache());
+
+        //Assertions
+        $this->assertEquals('control', $splitSdk->getTreatment('user1', 'unsupported_matcher'));
+        $this->validateLastImpression($redisClient, 'unsupported_matcher', 'user1', 'control', 'unknown', 'unknown', 'targeting rule type unsupported by sdk');
+    }
+
     public function testClient()
     {
         Di::set(Di::KEY_FACTORY_TRACKER, false);

diff --git a/tests/Suite/Sdk/files/splitChanges.json b/tests/Suite/Sdk/files/splitChanges.json
@@ -438,6 +438,70 @@
                     ]
                 }
             ]
+        },
+        {
+            "orgId": null,
+            "environment": null,
+            "trafficTypeId": null,
+            "trafficTypeName": null,
+            "name": "unsupported_matcher",
+            "seed": -1222652054,
+            "status": "ACTIVE",
+            "killed": false,
+            "defaultTreatment": "off",
+            "sets": ["set_a", "set_b", "set_c"],
+            "configurations": {
+                "on": "{\"size\":15,\"test\":20}",
+                "of": "{\"size\":15,\"defTreatment\":true}"
+            },
+            "conditions": [
+                {
+                    "matcherGroup": {
+                        "combiner": "AND",
+                        "matchers": [
+                            {
+                                "matcherType": "ALL_KEYS",
+                                "negate": false,
+                                "userDefinedSegmentMatcherData": null,
+                                "whitelistMatcherData": null
+                            }
+                        ]
+                    },
+                    "partitions": [
+                        {
+                            "treatment": "on",
+                            "size": 100
+                        },
+                        {
+                            "treatment": "off",
+                            "size": 0
+                        }
+                    ]
+                },
+                {
+                    "matcherGroup": {
+                        "combiner": "AND",
+                        "matchers": [
+                            {
+                                "matcherType": "WRONG_MATCHER",
+                                "negate": false,
+                                "userDefinedSegmentMatcherData": null,
+                                "whitelistMatcherData": {
+                                    "whitelist": [
+                                        "whitelisted_user"
+                                    ]
+                                }
+                            }
+                        ]
+                    },
+                    "partitions": [
+                        {
+                            "treatment": "on",
+                            "size": 100
+                        }
+                    ]
+                }
+            ]
         }
     ],
     "since": -1,