rnamed lossy to disable_retries

Author: rdeioris

CHANGELOG.md

@@ -11,7 +11,7 @@ and this project adheres to the versioning scheme outlined in the [README.md](RE
 
 - The `BlockProposal` StackerDB message serialization struct now includes a `server_version` string, which represents the version of the node that the miner is using. ([#5803](https://github.com/stacks-network/stacks-core/pull/5803))
 - Add `vrf_seed` to the `/v3/sortitions` rpc endpoint
-- Add `lossy` mode for events_observer disabling automatic retry on error
+- Add `disable_retries` mode for events_observer disabling automatic retry on error
 
 ### Changed
 

stackslib/src/config/mod.rs

@@ -915,7 +915,7 @@ impl Config {
                         endpoint: observer.endpoint,
                         events_keys,
                         timeout_ms: observer.timeout_ms.unwrap_or(1_000),
-                        lossy: observer.lossy.unwrap_or(false),
+                        disable_retries: observer.disable_retries.unwrap_or(false),
                     });
                 }
                 observers
@@ -929,7 +929,7 @@ impl Config {
                 endpoint: val,
                 events_keys: vec![EventKeyType::AnyEvent],
                 timeout_ms: 1_000,
-                lossy: false,
+                disable_retries: false,
             });
         };
 
@@ -2826,15 +2826,15 @@ pub struct EventObserverConfigFile {
     pub endpoint: String,
     pub events_keys: Vec<String>,
     pub timeout_ms: Option<u64>,
-    pub lossy: Option<bool>,
+    pub disable_retries: Option<bool>,
 }
 
 #[derive(Clone, Default, Debug, Hash, PartialEq, Eq, PartialOrd)]
 pub struct EventObserverConfig {
     pub endpoint: String,
     pub events_keys: Vec<EventKeyType>,
     pub timeout_ms: u64,
-    pub lossy: bool,
+    pub disable_retries: bool,
 }
 
 #[derive(Clone, Debug, Hash, PartialEq, Eq, PartialOrd)]

testnet/stacks-node/src/event_dispatcher.rs

@@ -90,8 +90,8 @@ struct EventObserver {
     endpoint: String,
     /// Timeout for sending events to this observer
     timeout: Duration,
-    /// Lossy observers do not retry on error
-    lossy: bool,
+    /// force observers to not retry on error
+    disable_retries: bool,
 }
 
 struct ReceiptPayloadInfo<'a> {
@@ -462,7 +462,7 @@ impl EventObserver {
         payload: &serde_json::Value,
         full_url: &str,
         timeout: Duration,
-        lossy: bool,
+        disable_retries: bool,
     ) {
         debug!(
             "Event dispatcher: Sending payload"; "url" => %full_url, "payload" => ?payload
@@ -513,8 +513,8 @@ impl EventObserver {
                 }
             }
 
-            if lossy {
-                warn!("Observer is configured in lossy mode: skipping retry of payload");
+            if disable_retries {
+                warn!("Observer is configured in disable_retries mode: skipping retry of payload");
                 return;
             }
 
@@ -534,7 +534,12 @@ impl EventObserver {
         }
     }
 
-    fn new(working_dir: Option<PathBuf>, endpoint: String, timeout: Duration, lossy: bool) -> Self {
+    fn new(
+        working_dir: Option<PathBuf>,
+        endpoint: String,
+        timeout: Duration,
+        disable_retries: bool,
+    ) -> Self {
         let db_path = if let Some(mut db_path) = working_dir {
             db_path.push("event_observers.sqlite");
 
@@ -553,7 +558,7 @@ impl EventObserver {
             db_path,
             endpoint,
             timeout,
-            lossy,
+            disable_retries,
         }
     }
 
@@ -568,8 +573,8 @@ impl EventObserver {
         };
         let full_url = format!("http://{url_str}");
 
-        // if the observer is in lossy mode quickly send the payload without checking for the db
-        if self.lossy {
+        // if the observer is in "disable_retries" mode quickly send the payload without checking for the db
+        if self.disable_retries {
             Self::send_payload_directly(payload, &full_url, self.timeout, true);
         } else if let Some(db_path) = &self.db_path {
             let conn =
@@ -1682,7 +1687,7 @@ impl EventDispatcher {
             Some(working_dir),
             conf.endpoint.clone(),
             Duration::from_millis(conf.timeout_ms),
-            conf.lossy,
+            conf.disable_retries,
         );
 
         let observer_index = self.registered_observers.len() as u16;
@@ -2452,7 +2457,7 @@ mod test {
     }
 
     #[test]
-    fn test_event_dispatcher_lossy() {
+    fn test_event_dispatcher_disable_retries() {
         let timeout = Duration::from_secs(5);
         let payload = json!({"key": "value"});
 
@@ -2464,30 +2469,30 @@ mod test {
 
         let observer = EventObserver::new(None, endpoint, timeout, true);
 
-        // in non lossy mode this will run forever
+        // in non "disable_retries" mode this will run forever
         observer.send_payload(&payload, "/test");
 
         // Verify that the payload was sent
         _m.assert();
     }
 
     #[test]
-    fn test_event_dispatcher_lossy_invalid_url() {
+    fn test_event_dispatcher_disable_retries_invalid_url() {
         let timeout = Duration::from_secs(5);
         let payload = json!({"key": "value"});
 
         let endpoint = String::from("255.255.255.255");
 
         let observer = EventObserver::new(None, endpoint, timeout, true);
 
-        // in non lossy mode this will run forever
+        // in non "disable_retries" mode this will run forever
         observer.send_payload(&payload, "/test");
     }
 
     #[test]
     #[ignore]
-    /// This test generates a new block and ensures the lossy events_observer will not block.
-    fn block_event_with_lossy_observer() {
+    /// This test generates a new block and ensures the "disable_retries" events_observer will not block.
+    fn block_event_with_disable_retries_observer() {
         let dir = tempdir().unwrap();
         let working_dir = dir.path().to_path_buf();
 
@@ -2496,7 +2501,7 @@ mod test {
             endpoint: String::from("255.255.255.255"),
             events_keys: vec![EventKeyType::MinedBlocks],
             timeout_ms: 1000,
-            lossy: true,
+            disable_retries: true,
         };
         event_dispatcher.register_observer(&config, working_dir);
 
@@ -2505,7 +2510,7 @@ mod test {
             txs: vec![],
         };
 
-        // this will block forever in non lossy mode
+        // this will block forever in non "disable_retries" mode
         event_dispatcher.process_mined_nakamoto_block_event(
             0,
             &nakamoto_block,

testnet/stacks-node/src/tests/epoch_22.rs

@@ -644,7 +644,7 @@ fn pox_2_unlock_all() {
         endpoint: format!("localhost:{}", test_observer::EVENT_OBSERVER_PORT),
         events_keys: vec![EventKeyType::AnyEvent],
         timeout_ms: 1000,
-        lossy: false,
+        disable_retries: false,
     });
     conf.initial_balances.append(&mut initial_balances);
 

testnet/stacks-node/src/tests/neon_integrations.rs

@@ -657,7 +657,7 @@ pub mod test_observer {
             endpoint: format!("localhost:{EVENT_OBSERVER_PORT}"),
             events_keys: event_keys.to_vec(),
             timeout_ms: 1000,
-            lossy: false,
+            disable_retries: false,
         });
     }
 
@@ -7491,7 +7491,7 @@ fn atlas_integration_test() {
             endpoint: format!("localhost:{}", test_observer::EVENT_OBSERVER_PORT),
             events_keys: vec![EventKeyType::AnyEvent],
             timeout_ms: 1000,
-            lossy: false,
+            disable_retries: false,
         });
 
     conf_follower_node.node.always_use_affirmation_maps = false;
@@ -8025,7 +8025,7 @@ fn antientropy_integration_test() {
             endpoint: format!("localhost:{}", test_observer::EVENT_OBSERVER_PORT),
             events_keys: vec![EventKeyType::AnyEvent],
             timeout_ms: 1000,
-            lossy: false,
+            disable_retries: false,
         });
 
     conf_follower_node.node.mine_microblocks = true;

testnet/stacks-node/src/tests/signer/mod.rs

@@ -736,7 +736,7 @@ fn setup_stx_btc_node<G: FnMut(&mut NeonConfig)>(
                 EventKeyType::BurnchainBlocks,
             ],
             timeout_ms: 1000,
-            lossy: false,
+            disable_retries: false,
         });
     }
 
@@ -752,7 +752,7 @@ fn setup_stx_btc_node<G: FnMut(&mut NeonConfig)>(
             EventKeyType::BurnchainBlocks,
         ],
         timeout_ms: 1000,
-        lossy: false,
+        disable_retries: false,
     });
 
     // The signers need some initial balances in order to pay for epoch 2.5 transaction votes

testnet/stacks-node/src/tests/signer/v0.rs

@@ -4431,7 +4431,7 @@ fn signer_set_rollover() {
                         EventKeyType::BurnchainBlocks,
                     ],
                     timeout_ms: 1000,
-                    lossy: false,
+                    disable_retries: false,
                 });
             }
             naka_conf.node.rpc_bind = rpc_bind.clone();
@@ -8877,7 +8877,7 @@ fn injected_signatures_are_ignored_across_boundaries() {
                     EventKeyType::BurnchainBlocks,
                 ],
                 timeout_ms: 1000,
-                lossy: false,
+                disable_retries: false,
             });
             naka_conf.node.rpc_bind = rpc_bind.clone();
         },