feat: add cidr matching, semver lte and semver gte constraints (#340)

Author: sighphyre

.github/workflows/sarif-and-test.yaml

@@ -51,7 +51,7 @@ jobs:
         uses: actions/checkout@v3
         with:
           repository: Unleash/client-specification
-          ref: v6.0.0
+          ref: v6.1.0
           path: client-specification
       - name: Run tests
         run: |

unleash-yggdrasil/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 edition = "2021"
 name = "unleash-yggdrasil"
-version = "0.21.0"
+version = "0.21.1"
 description = "This is the Unleash SDK domain logic extracted into a library to facilitate building your own Unleash SDKs in anything, anywhere."
 license = "MIT"
 
@@ -21,7 +21,7 @@ pest_derive = "2.8.3"
 lazy_static = "1.5.0"
 semver = "1.0.27"
 convert_case = "0.8.0"
-unleash-types = {version = "0.15.22", default-features = false}
+unleash-types = {version = "0.15.23", default-features = false}
 chrono = { version = "0.4.42", default-features = false, features = ["serde", "std"] }
 dashmap = "6.1.0"
 hostname = { version = "0.4.1", optional = true }

unleash-yggdrasil/src/lib.rs

@@ -35,7 +35,7 @@ use unleash_types::client_metrics::{MetricBucket, ToggleStats};
 
 pub type CompiledState = AHashMap<String, CompiledToggle>;
 
-pub const SUPPORTED_SPEC_VERSION: &str = "5.2.2";
+pub const SUPPORTED_SPEC_VERSION: &str = "6.1.0";
 const VARIANT_NORMALIZATION_SEED: u32 = 86028157;
 pub const CORE_VERSION: &str = env!("CARGO_PKG_VERSION");
 
@@ -954,6 +954,7 @@ mod test {
     #[test_case("19-delta-api-hydration.json"; "Delta hydration tests")]
     #[test_case("20-delta-api-events.json"; "Delta events tests")]
     #[test_case("21-regex-constraint-operators.json"; "Regex constraint operators")]
+    #[test_case("22-cidr-constraint-operators.json"; "Cidr constraints")]
 
     fn run_client_spec(spec_name: &str) {
         let spec = load_spec(spec_name);

unleash-yggdrasil/src/strategy_grammar.pest

@@ -82,8 +82,8 @@ constraint = {
     hostname_constraint = { hostname ~ in ~ string_list }
         hostname = _{ "hostname" }
         in = _{ "in" }
-    ip_constraint = { context_value ~ ip_contains_operation ~ string_list }
-        ip_contains_operation = _{ "contains_ip" }
+    ip_constraint = { context_value ~ in_cidr_operation ~ string_list }
+        in_cidr_operation = _{ "in_cidr" }
     string_fragment_constraint = { context_value ~ ( string_list_operation_without_case | string_list_operation ) ~ string_list }
     regex_constraint = { context_value ~ regex_operation ~ string }
     list_constraint = { context_value ~ list_operation ~ ( numeric_list | string_list | empty_list ) }
@@ -108,4 +108,4 @@ context_value = { random | user_id | session_id | remote_address | app_name | en
 expr = { term ~ (boolean_operation ~ term)* }
 term = _{ constraint | "(" ~ expr ~ ")" }
 
-strategy = _{ SOI ~ expr ~ EOI }
+strategy = _{ SOI ~ expr ~ EOI }

unleash-yggdrasil/src/strategy_parsing.rs

@@ -798,10 +798,27 @@ mod tests {
     #[test_case("3.0.0", "user_id >= 3.0.0", true)]
     #[test_case("3.0.0-beta.stuff", "user_id == 3.0.0-beta.stuff", true)]
     #[test_case("3.0.0-beta.stuff+build1", "user_id == 3.0.0-beta.stuff+build1", true)]
+    #[test_case("3.0.1", "user_id >= 3.0.1", true)]
+    #[test_case("3.0.2", "user_id >= 3.0.1", true)]
     fn test_semver_gt(user_id: &str, rule: &str, expected: bool) {
         run_test(user_id, rule, expected);
     }
 
+    #[test_case("30.0.0", "user_id <= 30.0.0", true)]
+    #[test_case("3.0.0", "user_id <= 3.0.0", true)]
+    #[test_case("3.0.0-beta", "user_id <= 3.0.0-beta", true)]
+    #[test_case("3.0.0-beta.2", "user_id <= 3.0.0-beta.1", false)]
+    #[test_case("3.0.0-beta", "user_id <= 3.0.0-alpha", false)]
+    #[test_case("3.0.1-beta", "user_id <= 3.0.1-alpha", false)]
+    #[test_case("3.0.0", "user_id <= 3.0.0-alpha", false)]
+    #[test_case("3.0.0-beta.stuff", "user_id <= 3.0.0-beta.stuff", true)]
+    #[test_case("3.0.0-beta.stuff+build1", "user_id <= 3.0.0-beta.stuff+build1", true)]
+    #[test_case("3.0.1", "user_id <= 3.0.1", true)]
+    #[test_case("3.0.2", "user_id <= 3.0.1", false)]
+    fn test_semver_lt(user_id: &str, rule: &str, expected: bool) {
+        run_test(user_id, rule, expected);
+    }
+
     fn run_test(user_id: &str, rule: &str, expected: bool) {
         let rule = compile_rule(rule).expect("");
         let context = context_from_user_id(user_id);
@@ -1209,7 +1226,7 @@ mod tests {
             .map(|x| format!("\"{}\"", x.trim()))
             .collect::<Vec<String>>();
 
-        let rule = format!("remote_address contains_ip [{}]", constraint_ips.join(","));
+        let rule = format!("remote_address in_cidr [{}]", constraint_ips.join(","));
         println!("Current rule {}", rule);
         let rule = compile_rule(&rule).unwrap();
 
@@ -1223,7 +1240,7 @@ mod tests {
 
     #[test]
     fn remote_address_constraint_never_matches_missing_context() {
-        let rule = compile_rule("remote_address contains_ip [\"127.0.0.1\"]").unwrap();
+        let rule = compile_rule("remote_address in_cidr [\"127.0.0.1\"]").unwrap();
         let context = Context::default();
 
         assert!(!rule(&context));

unleash-yggdrasil/src/strategy_upgrade.rs

@@ -214,7 +214,7 @@ fn upgrade_remote_address(strategy: &Strategy) -> String {
                 .map(|x| format!("\"{x}\""))
                 .collect::<Vec<String>>()
                 .join(", ");
-            format!("remote_address contains_ip [{ips}]")
+            format!("remote_address in_cidr [{ips}]")
         }
         None => "false".into(),
     }
@@ -297,6 +297,7 @@ fn is_stringy(op: &Operator) -> bool {
             | Operator::StrEndsWith
             | Operator::StrStartsWith
             | Operator::StrContains
+            | Operator::InCidr
     )
 }
 
@@ -335,6 +336,8 @@ fn upgrade_constraint(constraint: &Constraint) -> String {
         if constraint.operator == Operator::SemverEq
             || constraint.operator == Operator::SemverLt
             || constraint.operator == Operator::SemverGt
+            || constraint.operator == Operator::SemverLte
+            || constraint.operator == Operator::SemverGte
         {
             // A silly special case where we want to ingest
             // broken semver operators so we can reject them.
@@ -392,6 +395,9 @@ fn upgrade_operator(op: &Operator, case_insensitive: bool) -> Option<String> {
         Operator::SemverEq => Some("==".into()),
         Operator::SemverLt => Some("<".into()),
         Operator::SemverGt => Some(">".into()),
+        Operator::SemverLte => Some("<=".into()),
+        Operator::SemverGte => Some(">=".into()),
+        Operator::InCidr => Some("in_cidr".into()),
         Operator::Unknown(_) => None,
     }
 }
@@ -957,7 +963,7 @@ mod tests {
         let rule = upgrade_strategy(&strategy, &HashMap::new(), 0);
         assert_eq!(
             rule.as_str(),
-            "remote_address contains_ip [\"192.168.0.1\", \"192.168.0.2\", \"192.168.0.3\"]"
+            "remote_address in_cidr [\"192.168.0.1\", \"192.168.0.2\", \"192.168.0.3\"]"
         );
     }