Merge branch 'main' into issue-103

.github/workflows/build_and_test.yaml

@@ -51,7 +51,9 @@ jobs:
       # * clippy --all-targets causes clippy to run against tests and examples which it doesnt do by default.
       run: cargo hack --feature-powerset clippy --all-targets --locked ${{ matrix.cargo_flags }} -- -D warnings
     - name: Ensure that tests pass
-      run: cargo test ${{ matrix.cargo_flags }} --all-features --all-targets -- --nocapture
+      run: |
+        cargo test --doc ${{ matrix.cargo_flags }} --all-features -- --show-output --nocapture
+        cargo test ${{ matrix.cargo_flags }} --all-features --all-targets -- --nocapture
     - name: Ensure that tests did not create or modify any files that arent .gitignore'd
       run: |
         if [ -n "$(git status --porcelain)" ]; then

brro-compressor/src/frame/mod.rs

@@ -60,11 +60,7 @@ impl CompressorFrame {
         // We need enough samples to do decent compression, minimum is 128 (2^7)
         let data_sample = COMPRESSION_SPEED[compression_speed] as usize;
         // Eligible compressors for use
-        let compressor_list = [
-            Compressor::Constant,
-            Compressor::FFT,
-            Compressor::Polynomial,
-        ];
+        let compressor_list = [Compressor::FFT, Compressor::Polynomial];
         // Do a statistical analysis of the data, let's see if we can pick a compressor out of this.
         let stats = DataStats::new(data);
         // Checking the statistical analysis and chose, if possible, a compressor
@@ -90,6 +86,7 @@ impl CompressorFrame {
                         compressor,
                     )
                 })
+                .filter(|(result, _)| result.error <= max_error as f64)
                 .min_by_key(|x| x.0.compressed_data.len())
                 .unwrap();
             self.compressor = *chosen_compressor;
@@ -100,19 +97,39 @@ impl CompressorFrame {
                 .compressed_data;
         } else {
             // Run all the eligible compressors and choose smallest
-            let (smallest_result, chosen_compressor) = compressor_list
+            let compressor_results: Vec<_> = compressor_list
                 .iter()
                 .map(|compressor| {
                     (
                         compressor.get_compress_bounded_results(data, max_error as f64),
-                        compressor,
+                        *compressor,
                     )
                 })
-                .min_by_key(|x| x.0.compressed_data.len())
-                .unwrap();
+                .collect();
 
-            self.data = smallest_result.compressed_data;
-            self.compressor = *chosen_compressor;
+            #[allow(
+                clippy::neg_cmp_op_on_partial_ord,
+                reason = "we need to exactly negate `result.error < max_error`, we can't apply de morgans to the expression due to NaN values"
+            )]
+            let best_compressor = if compressor_results
+                .iter()
+                .all(|(result, _)| !(result.error <= max_error as f64))
+            {
+                // To ensure we always have at least one result,
+                // if all results are above the max error just pick the smallest.
+                compressor_results
+                    .into_iter()
+                    .min_by_key(|x| x.0.compressed_data.len())
+            } else {
+                compressor_results
+                    .into_iter()
+                    .filter(|(result, _)| result.error <= max_error as f64)
+                    .min_by_key(|x| x.0.compressed_data.len())
+            };
+
+            let (result, compressor) = best_compressor.unwrap();
+            self.data = result.compressed_data;
+            self.compressor = compressor;
         }
         debug!("Auto Compressor Selection: {:?}", self.compressor);
     }

prometheus-remote/src/lib_vsri.rs

@@ -88,7 +88,7 @@ pub struct Vsri {
 impl Vsri {
     /// Creates the index, it doesn't create the file in the disk
     /// flush needs to be called for that
-    pub fn new(filename: &String) -> Self {
+    pub fn new(filename: &str) -> Self {
         debug!("[INDEX] Creating new index!");
         let segments: Vec<[i32; 4]> = Vec::new();
         Vsri {

rust-toolchain.toml

@@ -1,3 +1,3 @@
 [toolchain]
-channel = "1.80"
+channel = "1.81"
 components = [ "rustfmt", "clippy" ]

vsri/src/lib.rs

@@ -56,18 +56,22 @@ pub fn start_day_ts(dt: DateTime<Utc>) -> i64 {
 /// # Examples
 /// Creating a new index, metric is of expected time 0, but for sure location of X is 0
 /// ```no_run
-/// let vsri = Vsri::new("metric_name", 0, 0);
+/// # use vsri::Vsri;
+/// let vsri = Vsri::new("metric_name");
 /// vsri.flush();
 /// ```
 /// Updating an index, adding point at time 5sec
 /// ```no_run
-/// let vsri = Vsri::load("metric_name").unwrap().update_for_point(5);
+///
+/// # use vsri::Vsri;
+/// let mut vsri = Vsri::load("metric_name").unwrap();
+/// vsri.update_for_point(5).unwrap();
 /// vsri.flush();
 /// ```
 /// Fetch a sample location from the index given a timestamp
 /// ```no_run
-/// let vsri = Vsri::load("metric_name").unwrap();
-/// vsri.get_sample_location("metric_name", 5);
+/// # use vsri::Vsri;
+/// let vsri = Vsri::get_sample_location("metric_name", 5);
 /// ```
 
 /// Index Structure
@@ -90,7 +94,7 @@ pub struct Vsri {
 impl Vsri {
     /// Creates the index, it doesn't create the file in the disk
     /// flush needs to be called for that
-    pub fn new(filename: &String) -> Self {
+    pub fn new(filename: &str) -> Self {
         debug!("[INDEX] Creating new index!");
         Vsri {
             index_file: filename.to_string(),
@@ -102,8 +106,8 @@ impl Vsri {
 
     /// Given a filename and a time location, returns the sample location in the
     /// data file. Or None in case it doesn't exist.
-    pub fn get_sample_location(filename: String, y: i32) -> Option<i32> {
-        let vsri = match Vsri::load(&filename) {
+    pub fn get_sample_location(filename: &str, y: i32) -> Option<i32> {
+        let vsri = match Vsri::load(filename) {
             Ok(vsri) => vsri,
             Err(_err) => return None,
         };