ref(rules): Move rules DSL to relay-protocol (#2608)

getsentry · Oct 16, 2023 · 4ed7d5f · 4ed7d5f
1 parent e5bc283
commit 4ed7d5f
Show file tree

Hide file tree

Showing 16 changed files with 77 additions and 64 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -31,6 +31,7 @@
 - Introduce a dedicated usage metric for transactions that replaces the duration metric. ([#2571](https://github.com/getsentry/relay/pull/2571), [#2589](https://github.com/getsentry/relay/pull/2589))
 - Restore the profiling killswitch. ([#2573](https://github.com/getsentry/relay/pull/2573))
 - Add `scraping_attempts` field to the event schema. ([#2575](https://github.com/getsentry/relay/pull/2575))
+- Move `condition.rs` from `relay-sampling` to `relay-protocol`. ([#2608](https://github.com/getsentry/relay/pull/2608))
 
 ## 23.9.1
 

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/relay-cabi/src/processing.rs b/relay-cabi/src/processing.rs
@@ -20,8 +20,7 @@ use relay_event_schema::protocol::{Event, VALID_PLATFORMS};
 use relay_pii::{
     selector_suggestions_from_value, DataScrubbingConfig, PiiConfig, PiiConfigError, PiiProcessor,
 };
-use relay_protocol::{Annotated, Remark};
-use relay_sampling::condition::RuleCondition;
+use relay_protocol::{Annotated, Remark, RuleCondition};
 use relay_sampling::SamplingConfig;
 
 use crate::core::{RelayBuf, RelayStr};

diff --git a/relay-dynamic-config/Cargo.toml b/relay-dynamic-config/Cargo.toml
@@ -21,6 +21,7 @@ relay-common = { path = "../relay-common" }
 relay-filter = { path = "../relay-filter" }
 relay-event-normalization = { path = "../relay-event-normalization" }
 relay-pii = { path = "../relay-pii" }
+relay-protocol  = { path = "../relay-protocol" }
 relay-quotas = { path = "../relay-quotas" }
 relay-sampling = { path = "../relay-sampling" }
 serde = { workspace = true }

diff --git a/relay-dynamic-config/src/defaults.rs b/relay-dynamic-config/src/defaults.rs
@@ -1,6 +1,6 @@
 use relay_base_schema::data_category::DataCategory;
 use relay_common::glob2::LazyGlob;
-use relay_sampling::condition::RuleCondition;
+use relay_protocol::RuleCondition;
 
 use crate::feature::Feature;
 use crate::metrics::{MetricExtractionConfig, MetricSpec, TagMapping, TagSpec};

diff --git a/relay-dynamic-config/src/metrics.rs b/relay-dynamic-config/src/metrics.rs
@@ -4,7 +4,7 @@ use std::collections::BTreeSet;
 
 use relay_base_schema::data_category::DataCategory;
 use relay_common::glob2::LazyGlob;
-use relay_sampling::condition::RuleCondition;
+use relay_protocol::RuleCondition;
 use serde::{Deserialize, Serialize};
 
 use crate::project::ProjectConfig;

diff --git a/relay-protocol/Cargo.toml b/relay-protocol/Cargo.toml
@@ -11,14 +11,17 @@ publish = false
 
 [dependencies]
 num-traits = "0.2.12"
+relay-common = { path = "../relay-common" }
 relay-protocol-derive = { path = "../relay-protocol-derive", optional = true }
 schemars = { workspace = true, optional = true }
 serde = { workspace = true }
 serde_json = { workspace = true }
 smallvec = { workspace = true }
 uuid = { workspace = true }
+unicase = "2.6.0"
 
 [dev-dependencies]
+insta = { workspace = true }
 similar-asserts = { workspace = true }
 
 [features]

diff --git a/relay-sampling/src/condition.rs → relay-protocol/src/condition.rs b/relay-sampling/src/condition.rs → relay-protocol/src/condition.rs
@@ -3,11 +3,11 @@
 //! The root type is [`RuleCondition`].
 
 use relay_common::glob3::GlobPatterns;
-use relay_protocol::{Getter, Val};
 use serde::{Deserialize, Serialize};
 use serde_json::{Number, Value};
 
 use crate::utils;
+use crate::{Getter, Val};
 
 /// Options for [`EqCondition`].
 #[derive(Debug, Clone, Serialize, Deserialize, Default, PartialEq)]
@@ -326,7 +326,7 @@ impl NotCondition {
 /// # Example
 ///
 /// ```
-/// use relay_sampling::condition::RuleCondition;
+/// use relay_protocol::RuleCondition;
 ///
 /// let condition = !RuleCondition::eq("obj.status", "invalid");
 /// ```
@@ -343,7 +343,7 @@ pub enum RuleCondition {
     /// # Example
     ///
     /// ```
-    /// use relay_sampling::condition::RuleCondition;
+    /// use relay_protocol::RuleCondition;
     ///
     /// let condition = RuleCondition::eq("obj.status", "invalid");
     /// ```
@@ -354,7 +354,7 @@ pub enum RuleCondition {
     /// # Example
     ///
     /// ```
-    /// use relay_sampling::condition::RuleCondition;
+    /// use relay_protocol::RuleCondition;
     ///
     /// let condition = RuleCondition::gte("obj.length", 10);
     /// ```
@@ -365,7 +365,7 @@ pub enum RuleCondition {
     /// # Example
     ///
     /// ```
-    /// use relay_sampling::condition::RuleCondition;
+    /// use relay_protocol::RuleCondition;
     ///
     /// let condition = RuleCondition::lte("obj.length", 10);
     /// ```
@@ -376,7 +376,7 @@ pub enum RuleCondition {
     /// # Example
     ///
     /// ```
-    /// use relay_sampling::condition::RuleCondition;
+    /// use relay_protocol::RuleCondition;
     ///
     /// let condition = RuleCondition::gt("obj.length", 10);
     /// ```
@@ -387,7 +387,7 @@ pub enum RuleCondition {
     /// # Example
     ///
     /// ```
-    /// use relay_sampling::condition::RuleCondition;
+    /// use relay_protocol::RuleCondition;
     ///
     /// let condition = RuleCondition::lt("obj.length", 10);
     /// ```
@@ -398,7 +398,7 @@ pub enum RuleCondition {
     /// # Example
     ///
     /// ```
-    /// use relay_sampling::condition::RuleCondition;
+    /// use relay_protocol::RuleCondition;
     ///
     /// let condition = RuleCondition::glob("obj.name", "error: *");
     /// ```
@@ -409,7 +409,7 @@ pub enum RuleCondition {
     /// # Example
     ///
     /// ```
-    /// use relay_sampling::condition::RuleCondition;
+    /// use relay_protocol::RuleCondition;
     ///
     /// let condition = RuleCondition::eq("obj.status", "invalid")
     ///     | RuleCondition::eq("obj.status", "unknown");
@@ -421,7 +421,7 @@ pub enum RuleCondition {
     /// # Example
     ///
     /// ```
-    /// use relay_sampling::condition::RuleCondition;
+    /// use relay_protocol::RuleCondition;
     ///
     /// let condition = RuleCondition::eq("obj.status", "invalid")
     ///     & RuleCondition::gte("obj.length", 10);
@@ -433,7 +433,7 @@ pub enum RuleCondition {
     /// # Example
     ///
     /// ```
-    /// use relay_sampling::condition::RuleCondition;
+    /// use relay_protocol::RuleCondition;
     ///
     /// let condition = !RuleCondition::eq("obj.status", "invalid");
     /// ```
@@ -465,7 +465,7 @@ impl RuleCondition {
     /// # Examples
     ///
     /// ```
-    /// use relay_sampling::condition::RuleCondition;
+    /// use relay_protocol::RuleCondition;
     ///
     /// // Matches if the value is identical to the given string:
     /// let condition = RuleCondition::eq("obj.status", "invalid");
@@ -485,7 +485,7 @@ impl RuleCondition {
     /// # Examples
     ///
     /// ```
-    /// use relay_sampling::condition::RuleCondition;
+    /// use relay_protocol::RuleCondition;
     ///
     /// // Matches if the value is identical to the given string:
     /// let condition = RuleCondition::eq_ignore_case("obj.status", "invalid");
@@ -502,7 +502,7 @@ impl RuleCondition {
     /// # Example
     ///
     /// ```
-    /// use relay_sampling::condition::RuleCondition;
+    /// use relay_protocol::RuleCondition;
     ///
     /// // Match a single pattern:
     /// let condition = RuleCondition::glob("obj.name", "error: *");
@@ -519,7 +519,7 @@ impl RuleCondition {
     /// # Example
     ///
     /// ```
-    /// use relay_sampling::condition::RuleCondition;
+    /// use relay_protocol::RuleCondition;
     ///
     /// let condition = RuleCondition::gt("obj.length", 10);
     /// ```
@@ -532,7 +532,7 @@ impl RuleCondition {
     /// # Example
     ///
     /// ```
-    /// use relay_sampling::condition::RuleCondition;
+    /// use relay_protocol::RuleCondition;
     ///
     /// let condition = RuleCondition::gte("obj.length", 10);
     /// ```
@@ -545,7 +545,7 @@ impl RuleCondition {
     /// # Example
     ///
     /// ```
-    /// use relay_sampling::condition::RuleCondition;
+    /// use relay_protocol::RuleCondition;
     ///
     /// let condition = RuleCondition::lt("obj.length", 10);
     /// ```
@@ -558,7 +558,7 @@ impl RuleCondition {
     /// # Example
     ///
     /// ```
-    /// use relay_sampling::condition::RuleCondition;
+    /// use relay_protocol::RuleCondition;
     ///
     /// let condition = RuleCondition::lte("obj.length", 10);
     /// ```
@@ -573,7 +573,7 @@ impl RuleCondition {
     /// # Example
     ///
     /// ```
-    /// use relay_sampling::condition::RuleCondition;
+    /// use relay_protocol::RuleCondition;
     ///
     /// let condition = RuleCondition::eq("obj.status", "invalid")
     ///     & RuleCondition::gte("obj.length", 10);
@@ -596,7 +596,7 @@ impl RuleCondition {
     /// # Example
     ///
     /// ```
-    /// use relay_sampling::condition::RuleCondition;
+    /// use relay_protocol::RuleCondition;
     ///
     /// let condition = RuleCondition::eq("obj.status", "invalid")
     ///     | RuleCondition::eq("obj.status", "unknown");
@@ -619,7 +619,7 @@ impl RuleCondition {
     /// # Example
     ///
     /// ```
-    /// use relay_sampling::condition::RuleCondition;
+    /// use relay_protocol::RuleCondition;
     ///
     /// let condition = !RuleCondition::eq("obj.status", "invalid");
     /// ```
@@ -698,31 +698,35 @@ impl std::ops::Not for RuleCondition {
 
 #[cfg(test)]
 mod tests {
-    use std::collections::BTreeMap;
-
-    use relay_base_schema::project::ProjectKey;
-    use uuid::Uuid;
+    use super::*;
 
-    use crate::dsc::TraceUserContext;
-    use crate::DynamicSamplingContext;
+    struct MockDSC {
+        transaction: String,
+        release: String,
+        environment: String,
+        user_segment: String,
+    }
 
-    use super::*;
+    impl Getter for MockDSC {
+        fn get_value(&self, path: &str) -> Option<Val<'_>> {
+            Some(match path.strip_prefix("trace.")? {
+                "transaction" => self.transaction.as_str().into(),
+                "release" => self.release.as_str().into(),
+                "environment" => self.environment.as_str().into(),
+                "user.segment" => self.user_segment.as_str().into(),
+                _ => {
+                    return None;
+                }
+            })
+        }
+    }
 
-    fn dsc_dummy() -> DynamicSamplingContext {
-        DynamicSamplingContext {
-            trace_id: Uuid::new_v4(),
-            public_key: ProjectKey::parse("abd0f232775f45feab79864e580d160b").unwrap(),
-            release: Some("1.1.1".to_string()),
-            user: TraceUserContext {
-                user_segment: "vip".to_owned(),
-                user_id: "user-id".to_owned(),
-            },
-            replay_id: Some(Uuid::new_v4()),
-            environment: Some("debug".to_string()),
-            transaction: Some("transaction1".into()),
-            sample_rate: None,
-            sampled: None,
-            other: BTreeMap::new(),
+    fn mock_dsc() -> MockDSC {
+        MockDSC {
+            transaction: "transaction1".to_string(),
+            release: "1.1.1".to_string(),
+            environment: "debug".to_string(),
+            user_segment: "vip".to_string(),
         }
     }
 
@@ -928,7 +932,7 @@ mod tests {
             ("match no conditions", RuleCondition::all()),
         ];
 
-        let dsc = dsc_dummy();
+        let dsc = mock_dsc();
 
         for (rule_test_name, condition) in conditions.iter() {
             let failure_name = format!("Failed on test: '{rule_test_name}'!!!");
@@ -971,7 +975,7 @@ mod tests {
             ("never", false, RuleCondition::never()),
         ];
 
-        let dsc = dsc_dummy();
+        let dsc = mock_dsc();
 
         for (rule_test_name, expected, condition) in conditions.iter() {
             let failure_name = format!("Failed on test: '{rule_test_name}'!!!");
@@ -1014,7 +1018,7 @@ mod tests {
             ("all", true, RuleCondition::all()),
         ];
 
-        let dsc = dsc_dummy();
+        let dsc = mock_dsc();
 
         for (rule_test_name, expected, condition) in conditions.iter() {
             let failure_name = format!("Failed on test: '{rule_test_name}'!!!");
@@ -1037,7 +1041,7 @@ mod tests {
             ),
         ];
 
-        let dsc = dsc_dummy();
+        let dsc = mock_dsc();
 
         for (rule_test_name, expected, condition) in conditions.iter() {
             let failure_name = format!("Failed on test: '{rule_test_name}'!!!");
@@ -1075,7 +1079,7 @@ mod tests {
             ),
         ];
 
-        let dsc = dsc_dummy();
+        let dsc = mock_dsc();
 
         for (rule_test_name, condition) in conditions.iter() {
             let failure_name = format!("Failed on test: '{rule_test_name}'!!!");