[refactor] hyperledger-iroha#1981, hyperledger-iroha#4195: Refactor t…

…he event filters (even further)

- Remove the FilterOpt combinator, fuse it with DataEventFilter
- Rename DataEntityFilter to DataEventFilter
- Add `Any` suffix to nested events matchers
- Add doc-comments to event filters & their variants

Signed-off-by: Nikita Strygin <[email protected]>

client/tests/integration/events/data.rs

@@ -138,7 +138,7 @@ fn transaction_execution_should_produce_events(
     let listener = client.clone();
     let (init_sender, init_receiver) = mpsc::channel();
     let (event_sender, event_receiver) = mpsc::channel();
-    let event_filter = DataEventFilter::AcceptAll.into();
+    let event_filter = FilterBox::Data(DataEventFilter::ByAny);
     thread::spawn(move || -> Result<()> {
         let event_iterator = listener.listen_for_events(event_filter)?;
         init_sender.send(())?;
@@ -184,7 +184,7 @@ fn produce_multiple_events() -> Result<()> {
     let listener = client.clone();
     let (init_sender, init_receiver) = mpsc::channel();
     let (event_sender, event_receiver) = mpsc::channel();
-    let event_filter = DataEventFilter::AcceptAll.into();
+    let event_filter = FilterBox::Data(DataEventFilter::ByAny);
     thread::spawn(move || -> Result<()> {
         let event_iterator = listener.listen_for_events(event_filter)?;
         init_sender.send(())?;

client/tests/integration/events/notification.rs

@@ -35,7 +35,7 @@ fn trigger_completion_success_should_produce_event() -> Result<()> {
     let (sender, receiver) = mpsc::channel();
     let _handle = thread::spawn(move || -> Result<()> {
         let mut event_it = thread_client.listen_for_events(
-            NotificationEventFilter::TriggerCompleted(TriggerCompletedEventFilter::new(
+            NotificationEventFilter::ByTriggerCompleted(TriggerCompletedEventFilter::new(
                 Some(trigger_id),
                 Some(TriggerCompletedOutcomeType::Success),
             ))
@@ -84,7 +84,7 @@ fn trigger_completion_failure_should_produce_event() -> Result<()> {
     let (sender, receiver) = mpsc::channel();
     let _handle = thread::spawn(move || -> Result<()> {
         let mut event_it = thread_client.listen_for_events(
-            NotificationEventFilter::TriggerCompleted(TriggerCompletedEventFilter::new(
+            NotificationEventFilter::ByTriggerCompleted(TriggerCompletedEventFilter::new(
                 Some(trigger_id),
                 Some(TriggerCompletedOutcomeType::Failure),
             ))

client/tests/integration/triggers/data_trigger.rs

@@ -20,11 +20,10 @@ fn must_execute_both_triggers() -> Result<()> {
             [instruction.clone()],
             Repeats::Indefinitely,
             account_id.clone(),
-            // FIXME: rewrite the filters using the builder DSL https://github.com/hyperledger/iroha/issues/3068
-            TriggeringFilterBox::Data(BySome(DataEntityFilter::ByAccount(AccountEventFilter {
+            TriggeringFilterBox::Data(DataEventFilter::ByAccount(AccountEventFilter {
                 id_matcher: None,
                 event_matcher: Some(AccountEventMatcher::ByCreated),
-            }))),
+            })),
         ),
     ));
     test_client.submit_blocking(register_trigger)?;
@@ -35,10 +34,10 @@ fn must_execute_both_triggers() -> Result<()> {
             [instruction],
             Repeats::Indefinitely,
             account_id,
-            TriggeringFilterBox::Data(BySome(DataEntityFilter::ByDomain(DomainEventFilter {
+            TriggeringFilterBox::Data(DataEventFilter::ByDomain(DomainEventFilter {
                 id_matcher: None,
                 event_matcher: Some(DomainEventMatcher::ByCreated),
-            }))),
+            })),
         ),
     ));
     test_client.submit_blocking(register_trigger)?;
@@ -89,11 +88,10 @@ fn domain_scoped_trigger_must_be_executed_only_on_events_in_its_domain() -> Resu
             [Mint::asset_quantity(1_u32, asset_id.clone())],
             Repeats::Indefinitely,
             account_id,
-            // FIXME: rewrite the filters using the builder DSL https://github.com/hyperledger/iroha/issues/3068
-            TriggeringFilterBox::Data(BySome(DataEntityFilter::ByAccount(AccountEventFilter {
+            TriggeringFilterBox::Data(DataEventFilter::ByAccount(AccountEventFilter {
                 id_matcher: None,
                 event_matcher: Some(AccountEventMatcher::ByCreated),
-            }))),
+            })),
         ),
     ));
     test_client.submit_blocking(register_trigger)?;

client/tests/integration/triggers/event_trigger.rs

@@ -24,13 +24,12 @@ fn test_mint_asset_when_new_asset_definition_created() -> Result<()> {
             vec![instruction],
             Repeats::Indefinitely,
             account_id,
-            // FIXME: rewrite the filters using the builder DSL https://github.com/hyperledger/iroha/issues/3068
-            TriggeringFilterBox::Data(BySome(DataEntityFilter::ByAssetDefinition(
+            TriggeringFilterBox::Data(DataEventFilter::ByAssetDefinition(
                 AssetDefinitionEventFilter {
                     id_matcher: None,
                     event_matcher: Some(AssetDefinitionEventMatcher::ByCreated),
                 },
-            ))),
+            )),
         ),
     ));
     test_client.submit(register_trigger)?;

client_cli/src/main.rs

@@ -334,8 +334,8 @@ mod events {
         fn run(self, context: &mut dyn RunContext) -> Result<()> {
             let filter = match self {
                 Args::Pipeline => FilterBox::Pipeline(PipelineEventFilter::new()),
-                Args::Data => FilterBox::Data(DataEventFilter::AcceptAll),
-                Args::Notification => FilterBox::Notification(NotificationEventFilter::AcceptAll),
+                Args::Data => FilterBox::Data(DataEventFilter::ByAny),
+                Args::Notification => FilterBox::Notification(NotificationEventFilter::ByAny),
             };
             listen(filter, context)
         }

data_model/Cargo.toml

@@ -54,8 +54,6 @@ strum = { workspace = true, features = ["derive"] }
 base64 = { workspace = true, features = ["alloc"] }
 once_cell = { workspace = true, optional = true }
 
-cfg-if = "1.0.0"
-
 [dev-dependencies]
 trybuild = { workspace = true }
 criterion = { workspace = true }

data_model/src/events/data/events.rs

@@ -31,6 +31,8 @@ macro_rules! data_event {
     };
 }
 
+// NOTE: if adding/editing events here, make sure to update the corresponding event filter in [`super::filter`]
+
 #[model]
 pub mod model {
     use super::*;