//! Subscription and filter parsing use crate::error::Result; use crate::event::Event; use serde::{Deserialize, Deserializer, Serialize}; use std::collections::HashSet; /// Subscription identifier and set of request filters #[derive(Serialize, PartialEq, Debug, Clone)] pub struct Subscription { pub id: String, pub filters: Vec, } /// Filter for requests /// /// Corresponds to client-provided subscription request elements. Any /// element can be present if it should be used in filtering, or /// absent ([`None`]) if it should be ignored. #[derive(Serialize, Deserialize, PartialEq, Debug, Clone)] pub struct ReqFilter { /// Event hashes pub ids: Option>, /// Event kinds pub kinds: Option>, /// Referenced event hash #[serde(rename = "#e")] pub events: Option>, /// Referenced public key for a petname #[serde(rename = "#p")] pub pubkeys: Option>, /// Events published after this time pub since: Option, /// Events published before this time pub until: Option, /// List of author public keys pub authors: Option>, /// Set of event tags, for quick indexing #[serde(skip)] event_tag_set: Option>, /// Set of pubkey tags, for quick indexing #[serde(skip)] pubkey_tag_set: Option>, } impl<'de> Deserialize<'de> for Subscription { /// Custom deserializer for subscriptions, which have a more /// complex structure than the other message types. fn deserialize(deserializer: D) -> Result where D: Deserializer<'de>, { let mut v: serde_json::Value = Deserialize::deserialize(deserializer)?; // this shoud be a 3-or-more element array. // verify the first element is a String, REQ // get the subscription from the second element. // convert each of the remaining objects into filters // check for array let va = v .as_array_mut() .ok_or_else(|| serde::de::Error::custom("not array"))?; // check length if va.len() < 3 { return Err(serde::de::Error::custom("not enough fields")); } let mut i = va.iter_mut(); // get command ("REQ") and ensure it is a string let req_cmd_str: serde_json::Value = i.next().unwrap().take(); let req = req_cmd_str .as_str() .ok_or_else(|| serde::de::Error::custom("first element of request was not a string"))?; if req != "REQ" { return Err(serde::de::Error::custom("missing REQ command")); } // ensure sub id is a string let sub_id_str: serde_json::Value = i.next().unwrap().take(); let sub_id = sub_id_str .as_str() .ok_or_else(|| serde::de::Error::custom("missing subscription id"))?; let mut filters = vec![]; for fv in i { let mut f: ReqFilter = serde_json::from_value(fv.take()) .map_err(|_| serde::de::Error::custom("could not parse filter"))?; // create indexes f.update_tag_indexes(); filters.push(f); } Ok(Subscription { id: sub_id.to_owned(), filters, }) } } impl Subscription { /// Get a copy of the subscription identifier. pub fn get_id(&self) -> String { self.id.clone() } /// Determine if this subscription matches a given [`Event`]. Any /// individual filter match is sufficient. pub fn interested_in_event(&self, event: &Event) -> bool { for f in self.filters.iter() { if f.interested_in_event(event) { return true; } } false } } impl ReqFilter { /// Update pubkey and event indexes fn update_tag_indexes(&mut self) { if let Some(event_vec) = &self.events { self.event_tag_set = Some(HashSet::from_iter(event_vec.iter().cloned())); } if let Some(pubkey_vec) = &self.pubkeys { self.pubkey_tag_set = Some(HashSet::from_iter(pubkey_vec.iter().cloned())); } } /// Check for a match within the authors list. fn ids_match(&self, event: &Event) -> bool { self.ids .as_ref() .map(|vs| vs.contains(&event.id.to_owned())) .unwrap_or(true) } fn authors_match(&self, event: &Event) -> bool { self.authors .as_ref() .map(|vs| vs.contains(&event.pubkey.to_owned())) .unwrap_or(true) } /// Check if this filter either matches, or does not care about the event tags. fn event_match(&self, event: &Event) -> bool { // an event match is performed by looking at the ReqFilter events field, and sending a hashset to the event to intersect with. if let Some(es) = &self.event_tag_set { // if there exists event tags in this filter, find if any intersect. event.generic_tag_val_intersect("e", es) } else { // if no event tags were requested in a filter, we do match true } } /// Check if this filter either matches, or does not care about the event tags. fn pubkey_match(&self, event: &Event) -> bool { // an event match is performed by looking at the ReqFilter events field, and sending a hashset to the event to intersect with. if let Some(ps) = &self.pubkey_tag_set { // if there exists event tags in this filter, find if any intersect. event.generic_tag_val_intersect("p", ps) } else { // if no event tags were requested in a filter, we do match true } } /// Check if this filter either matches, or does not care about the kind. fn kind_match(&self, kind: u64) -> bool { self.kinds .as_ref() .map(|ks| ks.contains(&kind)) .unwrap_or(true) } /// Determine if all populated fields in this filter match the provided event. pub fn interested_in_event(&self, event: &Event) -> bool { // self.id.as_ref().map(|v| v == &event.id).unwrap_or(true) self.ids_match(event) && self.since.map(|t| event.created_at > t).unwrap_or(true) && self.kind_match(event.kind) && self.authors_match(event) && self.pubkey_match(event) && self.event_match(event) } } #[cfg(test)] mod tests { use super::*; #[test] fn empty_request_parse() -> Result<()> { let raw_json = "[\"REQ\",\"some-id\",{}]"; let s: Subscription = serde_json::from_str(raw_json)?; assert_eq!(s.id, "some-id"); assert_eq!(s.filters.len(), 1); assert_eq!(s.filters.get(0).unwrap().authors, None); Ok(()) } #[test] fn incorrect_header() { let raw_json = "[\"REQUEST\",\"some-id\",\"{}\"]"; assert!(serde_json::from_str::(raw_json).is_err()); } #[test] fn req_missing_filters() { let raw_json = "[\"REQ\",\"some-id\"]"; assert!(serde_json::from_str::(raw_json).is_err()); } #[test] fn invalid_filter() { // unrecognized field in filter let raw_json = "[\"REQ\",\"some-id\",{\"foo\": 3}]"; assert!(serde_json::from_str::(raw_json).is_err()); } #[test] fn author_filter() -> Result<()> { let raw_json = "[\"REQ\",\"some-id\",{\"author\": \"test-author-id\"}]"; let s: Subscription = serde_json::from_str(raw_json)?; assert_eq!(s.id, "some-id"); assert_eq!(s.filters.len(), 1); let first_filter = s.filters.get(0).unwrap(); assert_eq!(first_filter.author, Some("test-author-id".to_owned())); Ok(()) } #[test] fn interest_id_nomatch() -> Result<()> { // subscription with a filter for ID let s: Subscription = serde_json::from_str(r#"["REQ","xyz",{"id":"abc"}]"#)?; let e = Event { id: "abcde".to_owned(), pubkey: "".to_owned(), created_at: 0, kind: 0, tags: Vec::new(), content: "".to_owned(), sig: "".to_owned(), }; assert_eq!(s.interested_in_event(&e), false); Ok(()) } #[test] fn interest_time_and_id() -> Result<()> { // subscription with a filter for ID and time let s: Subscription = serde_json::from_str(r#"["REQ","xyz",{"id":"abc", "since": 1000}]"#)?; let e = Event { id: "abc".to_owned(), pubkey: "".to_owned(), created_at: 50, kind: 0, tags: Vec::new(), content: "".to_owned(), sig: "".to_owned(), }; assert_eq!(s.interested_in_event(&e), false); Ok(()) } #[test] fn interest_time_and_id2() -> Result<()> { // subscription with a filter for ID and time let s: Subscription = serde_json::from_str(r#"["REQ","xyz",{"id":"abc", "since": 1000}]"#)?; let e = Event { id: "abc".to_owned(), pubkey: "".to_owned(), created_at: 1001, kind: 0, tags: Vec::new(), content: "".to_owned(), sig: "".to_owned(), }; assert_eq!(s.interested_in_event(&e), true); Ok(()) } #[test] fn interest_id() -> Result<()> { // subscription with a filter for ID let s: Subscription = serde_json::from_str(r#"["REQ","xyz",{"id":"abc"}]"#)?; let e = Event { id: "abc".to_owned(), pubkey: "".to_owned(), created_at: 0, kind: 0, tags: Vec::new(), content: "".to_owned(), sig: "".to_owned(), }; assert_eq!(s.interested_in_event(&e), true); Ok(()) } #[test] fn authors_single() -> Result<()> { // subscription with a filter for ID let s: Subscription = serde_json::from_str(r#"["REQ","xyz",{"authors":["abc"]}]"#)?; let e = Event { id: "123".to_owned(), pubkey: "abc".to_owned(), created_at: 0, kind: 0, tags: Vec::new(), content: "".to_owned(), sig: "".to_owned(), }; assert_eq!(s.interested_in_event(&e), true); Ok(()) } #[test] fn authors_multi_pubkey() -> Result<()> { // check for any of a set of authors, against the pubkey let s: Subscription = serde_json::from_str(r#"["REQ","xyz",{"authors":["abc", "bcd"]}]"#)?; let e = Event { id: "123".to_owned(), pubkey: "bcd".to_owned(), created_at: 0, kind: 0, tags: Vec::new(), content: "".to_owned(), sig: "".to_owned(), }; assert_eq!(s.interested_in_event(&e), true); Ok(()) } #[test] fn authors_multi_no_match() -> Result<()> { // check for any of a set of authors, against the pubkey let s: Subscription = serde_json::from_str(r#"["REQ","xyz",{"authors":["abc", "bcd"]}]"#)?; let e = Event { id: "123".to_owned(), pubkey: "xyz".to_owned(), created_at: 0, kind: 0, tags: Vec::new(), content: "".to_owned(), sig: "".to_owned(), }; assert_eq!(s.interested_in_event(&e), false); Ok(()) } }