Merge remote-tracking branch 'upstream/main' into doc/description-optional

Author: jgsogo

.github/workflows/pre-commit.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v5
-      - uses: actions/setup-python@v5
+      - uses: actions/setup-python@v6
       - name: Run pre-commit
         run: |
           pip install pre-commit

examples/demo.rs

@@ -60,13 +60,11 @@ fn main() -> std::result::Result<(), Box<dyn Error>> {
         city: "Bangalore".to_string(),
         radius: 60,
     };
-
+    thread::sleep(Duration::from_secs(5));
     println!("The information is displayed every 5 seconds.");
     println!("Try changing the configuraiton in the App Configuration instances.");
 
     loop {
-        println!("\n\nFEATURE FLAG OPERATIONS\n");
-
         match client.get_feature_proxy(&feature_id) {
             Ok(feature) => {
                 println!("Feature name: {}", feature.get_name()?);
@@ -78,8 +76,6 @@ fn main() -> std::result::Result<(), Box<dyn Error>> {
                 println!("There was an error getting the Feature Flag. Error {error}",);
             }
         }
-
-        println!("\n\nPROPERTY OPERATIONS\n");
         match client.get_property_proxy(&property_id) {
             Ok(property) => {
                 println!("Property name: {}", property.get_name()?);

src/metering/client_http.rs

@@ -29,7 +29,7 @@ impl MeteringClientHttp {
 impl MeteringClient for MeteringClientHttp {
     fn push_metering_data(&self, guid: &str, data: &MeteringDataJson) -> MeteringResult<()> {
         let url = format!(
-            "{}/apprapp/events/v1/instances/{}/usage",
+            "{}/events/v1/instances/{}/usage",
             self.service_address.base_url(ServiceAddressProtocol::Http),
             guid
         );
@@ -82,7 +82,7 @@ pub(crate) mod tests {
         let server = MockServer::start();
         let mock = server.mock(|when, then| {
             when.method(POST)
-                .path("/apprapp/events/v1/instances/example_guid/usage")
+                .path("/events/v1/instances/example_guid/usage")
                 .header("content-type", "application/json")
                 .header("Authorization", "Bearer mocked_token")
                 .json_body(json!(

src/metering/metering.rs

@@ -12,6 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+use log::debug;
 use log::warn;
 
 use crate::metering::models::{
@@ -46,6 +47,7 @@ pub(crate) fn start_metering<T: MeteringClient>(
     let thread = ThreadHandle::new(move |_terminator: mpsc::Receiver<()>| {
         let mut batcher = MeteringBatcher::new(client, config_id);
         let mut last_flush = std::time::Instant::now();
+        debug!("Starting Metering transmitting thread");
         loop {
             let recv_result = receiver.recv_timeout(std::time::Duration::from_millis(100));
             match recv_result {
@@ -196,9 +198,19 @@ impl<T: MeteringClient> MeteringBatcher<T> {
             json_data.add_usage(evaluation.0, evaluation.1);
         }
 
-        let _ = self
+        debug!(
+            "Sending metering data for {} usages.",
+            json_data.usages.len()
+        );
+        let result = self
             .client
             .push_metering_data(&self.config_id.guid, &json_data);
+        match result {
+            Err(err) => {
+                warn!("Sending metering data failed: {}", err);
+            }
+            _ => {}
+        }
         self.evaluations.clear();
     }
 }

src/models/feature_snapshot.rs

@@ -99,9 +99,14 @@ impl FeatureSnapshot {
         }
     }
 
+    fn normalized_hash(data: &str) -> u32 {
+        let hash = murmur3_32(&mut Cursor::new(data), 0).expect("Cannot hash the value.");
+        (f64::from(hash) / f64::from(u32::MAX) * 100.0) as u32
+    }
+
     fn should_rollout(rollout_percentage: u32, entity: &impl Entity, feature_id: &str) -> bool {
         let tag = format!("{}:{}", entity.get_id(), feature_id);
-        rollout_percentage == 100 || random_value(&tag) < rollout_percentage
+        rollout_percentage == 100 || Self::normalized_hash(&tag) < rollout_percentage
     }
 
     fn use_rollout_percentage_to_get_value_from_feature_directly(
@@ -139,15 +144,6 @@ impl Feature for FeatureSnapshot {
     }
 }
 
-pub(crate) fn random_value(v: &str) -> u32 {
-    let max_hash = u32::MAX;
-    (f64::from(hash(v)) / f64::from(max_hash) * 100.0) as u32
-}
-
-fn hash(v: &str) -> u32 {
-    murmur3_32(&mut Cursor::new(v), 0).expect("Cannot hash the value.")
-}
-
 #[cfg(test)]
 pub mod tests {
 
@@ -213,7 +209,9 @@ pub mod tests {
             attributes: entity_attributes.clone(),
         };
         assert_eq!(
-            random_value(format!("{}:{}", entity.id, feature.feature_id).as_str()),
+            FeatureSnapshot::normalized_hash(
+                format!("{}:{}", entity.id, feature.feature_id).as_str()
+            ),
             68
         );
         let value = feature.get_value(&entity).unwrap();
@@ -225,7 +223,9 @@ pub mod tests {
             attributes: entity_attributes,
         };
         assert_eq!(
-            random_value(format!("{}:{}", entity.id, feature.feature_id).as_str()),
+            FeatureSnapshot::normalized_hash(
+                format!("{}:{}", entity.id, feature.feature_id).as_str()
+            ),
             29
         );
         let value = feature.get_value(&entity).unwrap();
@@ -407,4 +407,12 @@ pub mod tests {
         let value = feature.get_value(&entity).unwrap();
         assert!(matches!(value, Value::Int64(ref v) if v == &2));
     }
+
+    /// This test ensures that the rust client is using the same hashing algorithm as to other clients.
+    /// See same test for Node client:
+    /// https://github.com/IBM/appconfiguration-node-sdk/blob/master/test/unit/configurations/internal/utils.test.js#L25
+    #[test]
+    fn test_normalized_hash() {
+        assert_eq!(FeatureSnapshot::normalized_hash("entityId:featureId"), 41)
+    }
 }