Merge pull request #12 from Flagsmith/release/v1.1.0

Release/v1.1.0

Author: gagantrivedi

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "flagsmith"
-version = "1.0.1"
+version = "1.1.0"
 authors = ["Gagan Trivedi <[email protected]>"]
 edition = "2021"
 license = "BSD-3-Clause"
@@ -20,6 +20,7 @@ reqwest = { version = "0.11", features = ["json", "blocking"] }
 url = "2.1"
 chrono = { version = "0.4"}
 log = "0.4"
+flume = "0.10.14"
 
 flagsmith-flag-engine = "0.1.1"
 

example/readme.md

@@ -1,21 +1,21 @@
 # Flagsmith Basic Rust Example
 
-This directory contains a basic Rocket application which utilises Flagsmith. To run the example application, you'll 
+This directory contains a basic Rocket application which utilises Flagsmith. To run the example application, you'll
 need to go through the following steps:
 
 1. Create an account, organisation and project on [Flagsmith](https://flagsmith.com)
 2. Create a feature in the project called "secret_button"
-3. Give the feature a value using the json editor as follows: 
+3. Give the feature a value using the json editor as follows:
 
 ```json
 {"colour": "#ababab"}
 ```
 
-4. Set the environment variable `FLAGSMITH_ENVIRONMENT_KEY` with the environment key of one of the environments 
+4. Set the environment variable `FLAGSMITH_ENVIRONMENT_KEY` with the environment key of one of the environments
 in flagsmith (This can be found on the 'settings' page accessed from the menu on the left under the chosen environment.)
 5. Run the app using `cargo run`
 6. Browse to http://localhost:5000
 
 Now you can play around with the 'secret_button' feature in flagsmith, turn it on to show it and edit the colour in the
 json value to edit the colour of the button. You can also identify as a given user and then update the settings for the
-secret button feature for that user in the flagsmith interface to see the affect that has too. 
+secret button feature for that user in the flagsmith interface to see the affect that has too.

src/flagsmith/analytics.rs

@@ -1,16 +1,15 @@
 use log::{debug, warn};
 use reqwest::header::HeaderMap;
 use serde_json;
-use std::sync::mpsc;
-use std::sync::mpsc::{Sender, TryRecvError};
+use flume;
 use std::{collections::HashMap, thread};
 
 use std::sync::{Arc,  RwLock};
 static ANALYTICS_TIMER_IN_MILLI: u64 = 10 * 1000;
 
 #[derive(Clone, Debug)]
 pub struct AnalyticsProcessor {
-    pub tx: Sender<String>,
+    pub tx: flume::Sender<String>,
     _analytics_data: Arc<RwLock<HashMap<String, u32>>>,
 }
 
@@ -21,7 +20,7 @@ impl AnalyticsProcessor {
         timeout: std::time::Duration,
         timer: Option<u64>,
     ) -> Self {
-        let (tx, rx) = mpsc::channel::<String>();
+        let (tx, rx) = flume::unbounded();
         let client = reqwest::blocking::Client::builder()
             .default_headers(headers)
             .timeout(timeout)
@@ -49,8 +48,8 @@ impl AnalyticsProcessor {
                                 .and_modify(|e| *e += 1)
                                 .or_insert(1);
                         }
-                        Err(TryRecvError::Empty) => {}
-                        Err(TryRecvError::Disconnected) => {
+                        Err(flume::TryRecvError::Empty) => {}
+                        Err(flume::TryRecvError::Disconnected) => {
                             debug!("Shutting down analytics thread ");
                             break;
                         }

src/flagsmith/mod.rs

@@ -14,7 +14,7 @@ pub mod models;
 use self::analytics::AnalyticsProcessor;
 use self::models::{Flag, Flags};
 use super::error;
-use std::sync::mpsc::{self, Sender, TryRecvError};
+use std::sync::mpsc::{self, SyncSender, TryRecvError};
 
 const DEFAULT_API_URL: &str = "https://edge.api.flagsmith.com/api/v1/";
 
@@ -50,7 +50,7 @@ pub struct Flagsmith {
     options: FlagsmithOptions,
     datastore: Arc<Mutex<DataStore>>,
     analytics_processor: Option<AnalyticsProcessor>,
-    _polling_thead_tx: Sender<u32>, // used for shutting down polling manager
+    _polling_thread_tx: SyncSender<u32>, // to trigger polling manager shutdown
 }
 
 struct DataStore {
@@ -88,7 +88,7 @@ impl Flagsmith {
         // Put the environment model behind mutex to
         // to share it safely between threads
         let ds = Arc::new(Mutex::new(DataStore { environment: None }));
-        let (tx, rx) = mpsc::channel::<u32>();
+        let (tx, rx) = mpsc::sync_channel::<u32>(1);
         let flagsmith = Flagsmith {
             client: client.clone(),
             environment_flags_url,
@@ -97,7 +97,7 @@ impl Flagsmith {
             options: flagsmith_options,
             datastore: Arc::clone(&ds),
             analytics_processor,
-            _polling_thead_tx: tx,
+            _polling_thread_tx: tx,
         };
 
         // Create a thread to update environment document
@@ -368,6 +368,14 @@ mod tests {
             "feature_states": []
     }"#;
 
+    #[test]
+    fn client_implements_send_and_sync(){
+        // Given
+        fn implements_send_and_sync<T: Send + Sync>() {}
+        // Then
+        implements_send_and_sync::<Flagsmith>();
+    }
+
     #[test]
     fn polling_thread_updates_environment_on_start() {
         // Given
@@ -391,6 +399,7 @@ mod tests {
         };
         // When
         let _flagsmith = Flagsmith::new(environment_key.to_string(), flagsmith_options);
+
         // let's wait for the thread to make the request
         thread::sleep(std::time::Duration::from_millis(50));
         // Then