Skip to content

InListSemver Matcher implementation. #234

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 3, 2024
Merged

InListSemver Matcher implementation. #234

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
89f5500
InListSemver Matcher implementation.
sanzmauro Apr 29, 2024
12d23a6
polishing
sanzmauro Apr 29, 2024
a4990f7
Merge pull request #235 from splitio/semver-polishing
sanzmauro May 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions src/SplitIO/Grammar/Condition/Matcher.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
use SplitIO\Grammar\Condition\Matcher\EqualToSemver;
use SplitIO\Grammar\Condition\Matcher\GreaterThanOrEqualTo;
use SplitIO\Grammar\Condition\Matcher\GreaterThanOrEqualToSemver;
use SplitIO\Grammar\Condition\Matcher\InListSemver;
use SplitIO\Grammar\Condition\Matcher\LessThanOrEqualTo;
use SplitIO\Grammar\Condition\Matcher\LessThanOrEqualToSemver;
use SplitIO\Grammar\Condition\Matcher\Segment;
Expand Down Expand Up @@ -48,6 +49,7 @@ class Matcher
const GREATER_THAN_OR_EQUAL_TO_SEMVER = 'GREATER_THAN_OR_EQUAL_TO_SEMVER';
const LESS_THAN_OR_EQUAL_TO_SEMVER = 'LESS_THAN_OR_EQUAL_TO_SEMVER';
const BETWEEN_SEMVER = 'BETWEEN_SEMVER';
const IN_LIST_SEMVER = 'IN_LIST_SEMVER';

public static function factory($matcher)
{
Expand Down Expand Up @@ -158,6 +160,11 @@ public static function factory($matcher)
is_array($matcher['betweenStringMatcherData']))
? $matcher['betweenStringMatcherData'] : null;
return new BetweenSemver($data, $negate, $attribute);
case self::IN_LIST_SEMVER:
$data = (isset($matcher['whitelistMatcherData']['whitelist']) &&
is_array($matcher['whitelistMatcherData']['whitelist']))
? $matcher['whitelistMatcherData']['whitelist'] : null;
return new InListSemver($data, $negate, $attribute);
// @codeCoverageIgnoreStart
default:
throw new UnsupportedMatcherException("Unable to create matcher for matcher type: " . $matcherType);
Expand Down
3 changes: 2 additions & 1 deletion src/SplitIO/Grammar/Condition/Matcher/BetweenSemver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@ protected function evalKey($key)
return false;
}

$result = SemverComparer::do($keySemver, $this->startTarget) >= 0 && SemverComparer::do($keySemver, $this->endTarget) <= 0;
$result = SemverComparer::do($keySemver, $this->startTarget) >= 0
&& SemverComparer::do($keySemver, $this->endTarget) <= 0;

SplitApp::logger()->debug($this->startTarget->getVersion() . " <= "
. $keySemver->getVersion() . " <= " . $this->endTarget->getVersion()
Expand Down
2 changes: 1 addition & 1 deletion src/SplitIO/Grammar/Condition/Matcher/EqualToSemver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ protected function evalKey($key)
return false;
}

$result = SemverComparer::Equals($this->toCompare, $keySemver);
$result = SemverComparer::equals($this->toCompare, $keySemver);

SplitApp::logger()->debug($this->toCompare->getVersion() . " == "
. $keySemver->getVersion() . " | Result: " . $result);
Expand Down
51 changes: 51 additions & 0 deletions src/SplitIO/Grammar/Condition/Matcher/InListSemver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
<?php
namespace SplitIO\Grammar\Condition\Matcher;

use SplitIO\Grammar\Condition\Matcher;
use SplitIO\Grammar\Semver\Semver;
use SplitIO\Grammar\Semver\SemverComparer;

class InListSemver extends AbstractMatcher
{
private $targetList;

public function __construct($targetList, $negate = false, $attribute = null)
{
$this->targetList = array();
parent::__construct(Matcher::IN_LIST_SEMVER, $negate, $attribute);

if (is_array($targetList)) {
foreach ($targetList as $item) {
$toAdd = Semver::build($item);

if ($toAdd != null) {
array_push($this->targetList, $toAdd);
}
}
}
}

/**
*
* @param mixed $key
*/
protected function evalKey($key)
{
if ($key == null || !is_string($key) || count($this->targetList) == 0) {
return false;
}

$keySemver = Semver::build($key);
if ($keySemver == null) {
return false;
}

foreach ($this->targetList as $item) {
if (SemverComparer::equals($keySemver, $item)) {
return true;
}
}

return false;
}
}
33 changes: 33 additions & 0 deletions tests/Suite/Matchers/MatchersTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -622,6 +622,39 @@ public function testBetweenSemverMatcher()
$this->assertFalse($matcher->evaluate('2.2.2'));
}

public function testInListSemverMatcher()
{
$this->setupSplitApp();

$condition = array(
'matcherType' => 'IN_LIST_SEMVER',
'whitelistMatcherData' => array(
'whitelist' => array(
'1.1.1',
'2.2.2',
'3.3.3',
)
)
);

$matcher = Matcher::factory($condition);
$this->assertTrue($matcher->evaluate('1.1.1'));
$this->assertTrue($matcher->evaluate('2.2.2'));
$this->assertTrue($matcher->evaluate('3.3.3'));
$this->assertFalse($matcher->evaluate(null));
$this->assertFalse($matcher->evaluate(''));
$this->assertFalse($matcher->evaluate('4.22.25'));
$this->assertFalse($matcher->evaluate('10.0.0'));

$condition = array(
'matcherType' => 'IN_LIST_SEMVER',
'whitelistMatcherData' => null
);

$matcher = Matcher::factory($condition);
$this->assertFalse($matcher->evaluate('2.2.2'));
}

public static function tearDownAfterClass(): void
{
Utils\Utils::cleanCache();
Expand Down
16 changes: 16 additions & 0 deletions tests/Suite/Sdk/SdkClientTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,6 +314,22 @@ public function testClientSemverMatchers()
$this->validateLastImpression($redisClient, 'between_semver_flag', 'user1', 'off');
$this->assertEquals('off', $splitSdk->getTreatment('user1', 'between_semver_flag', array('version' => '1.4.7')));
$this->validateLastImpression($redisClient, 'between_semver_flag', 'user1', 'off');

//Assertions InListSemver
//
$this->assertEquals('v1', $splitSdk->getTreatment('user1', 'inlist_semver_flag', array('version' => '6.7.8')));
$this->validateLastImpression($redisClient, 'inlist_semver_flag', 'user1', 'v1');
$this->assertEquals('v1', $splitSdk->getTreatment('user1', 'inlist_semver_flag', array('version' => '1.1.1-alpha')));
$this->validateLastImpression($redisClient, 'inlist_semver_flag', 'user1', 'v1');
$this->assertEquals('v1', $splitSdk->getTreatment('user1', 'inlist_semver_flag', array('version' => '2.2.2+meta')));
$this->validateLastImpression($redisClient, 'inlist_semver_flag', 'user1', 'v1');

$this->assertEquals('off', $splitSdk->getTreatment('user1', 'inlist_semver_flag', array('version' => '2.2.2')));
$this->validateLastImpression($redisClient, 'inlist_semver_flag', 'user1', 'off');
$this->assertEquals('off', $splitSdk->getTreatment('user1', 'inlist_semver_flag', array('version' => '1.1.1')));
$this->validateLastImpression($redisClient, 'inlist_semver_flag', 'user1', 'off');
$this->assertEquals('off', $splitSdk->getTreatment('user1', 'inlist_semver_flag', array('version' => '8.6.0-rc.2')));
$this->validateLastImpression($redisClient, 'inlist_semver_flag', 'user1', 'off');
}

public function testClientWithUnsupportedMatcher()
Expand Down
53 changes: 53 additions & 0 deletions tests/Suite/Sdk/files/splitChanges.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -689,6 +689,59 @@
]
}
]
},
{
"orgId": null,
"environment": null,
"trafficTypeId": null,
"trafficTypeName": null,
"name": "inlist_semver_flag",
"seed": -1222652054,
"status": "ACTIVE",
"killed": false,
"defaultTreatment": "off",
"sets": [],
"configurations": {
"on": "{\"size\":15,\"test\":20}",
"of": "{\"size\":15,\"defTreatment\":true}"
},
"conditions": [
{
"matcherGroup": {
"combiner": "AND",
"matchers": [
{
"keySelector": {
"trafficType": "user",
"attribute": "version"
},
"matcherType": "IN_LIST_SEMVER",
"negate": false,
"userDefinedSegmentMatcherData": null,
"whitelistMatcherData": {
"whitelist": [
"6.7.8",
"2.2.2+meta",
"1.1.1-alpha",
"8.6.0-rc.1",
"9.6.0-beta.1"
]
}
}
]
},
"partitions": [
{
"treatment": "v1",
"size": 100
},
{
"treatment": "v2",
"size": 0
}
]
}
]
}
],
"since": -1,
Expand Down
20 changes: 10 additions & 10 deletions tests/Suite/Semver/ComparerTests.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ public function testGreaterThanOrEqualTo()
$semver1 = Semver::build($v1);
$semver2 = Semver::build($v2);

$this->assertTrue(SemverComparer::Do($semver1, $semver2) >= 0);
$this->assertTrue(SemverComparer::Do($semver1, $semver1) >= 0);
$this->assertTrue(SemverComparer::Do($semver2, $semver2) >= 0);
$this->assertFalse(SemverComparer::Do($semver2, $semver1) >= 0);
$this->assertTrue(SemverComparer::do($semver1, $semver2) >= 0);
$this->assertTrue(SemverComparer::do($semver1, $semver1) >= 0);
$this->assertTrue(SemverComparer::do($semver2, $semver2) >= 0);
$this->assertFalse(SemverComparer::do($semver2, $semver1) >= 0);
}

fclose($handle);
Expand All @@ -44,10 +44,10 @@ public function testLessThanOrEqualTo()
$semver1 = Semver::build($v1);
$semver2 = Semver::build($v2);

$this->assertFalse(SemverComparer::Do($semver1, $semver2) <= 0);
$this->assertTrue(SemverComparer::Do($semver2, $semver1) <= 0);
$this->assertTrue(SemverComparer::Do($semver1, $semver1) <= 0);
$this->assertTrue(SemverComparer::Do($semver2, $semver2) <= 0);
$this->assertFalse(SemverComparer::do($semver1, $semver2) <= 0);
$this->assertTrue(SemverComparer::do($semver2, $semver1) <= 0);
$this->assertTrue(SemverComparer::do($semver1, $semver1) <= 0);
$this->assertTrue(SemverComparer::do($semver2, $semver2) <= 0);
}

fclose($handle);
Expand All @@ -71,7 +71,7 @@ public function testEquals()
$semver2 = Semver::build($c2);
$expected = (bool) $c3;

$this->assertEquals($expected, SemverComparer::Equals($semver1, $semver2), $semver1->getVersion() . " - " . $semver2->getVersion() . " | " . $expected);
$this->assertEquals($expected, SemverComparer::equals($semver1, $semver2), $semver1->getVersion() . " - " . $semver2->getVersion() . " | " . $expected);
}

fclose($handle);
Expand All @@ -96,7 +96,7 @@ public function testBetween()
$semver2 = Semver::build($c2);
$semver3 = Semver::build($c3);

$result = SemverComparer::Do($semver2, $semver1) >= 0 && SemverComparer::Do($semver2, $semver3) <= 0;
$result = SemverComparer::do($semver2, $semver1) >= 0 && SemverComparer::do($semver2, $semver3) <= 0;

$this->assertEquals((bool) $c4, $result);
}
Expand Down