Merge pull request #83 from KarthikSubbarao/1.0

KarthikSubbarao · web-flow · commit 43b4e704bc8d · 2026-02-23T22:10:32.000-06:00
Merge from unstable into 1.0
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -21,18 +21,18 @@ jobs:
         server_version: ['unstable', '8.0', '8.1']
     steps:
     - uses: actions/checkout@v4
-    - name: Set the server verison for python integeration tests
+    - name: Set the server version for python integration tests
       run: echo "SERVER_VERSION=${{ matrix.server_version }}" >> $GITHUB_ENV
     - name: Run cargo and clippy format check
       run: |
         cargo fmt --check
-        cargo clippy --profile release --all-targets -- -D clippy::all
+        cargo clippy --profile release --all-targets
     - name: Release Build
       run: |
         if [ "${{ matrix.server_version }}" = "8.0" ]; then
-          RUSTFLAGS="-D warnings" cargo build --all --all-targets --release --features valkey_8_0
+          cargo build --all --all-targets --release --features valkey_8_0
         else
-          RUSTFLAGS="-D warnings" cargo build --all --all-targets --release
+          cargo build --all --all-targets --release
         fi
     - name: Run unit tests
       run: cargo test --features enable-system-alloc
@@ -72,9 +72,9 @@ jobs:
     - name: Run cargo and clippy format check
       run: |
         cargo fmt --check
-        cargo clippy --profile release --all-targets -- -D clippy::all
+        cargo clippy --profile release --all-targets
     - name: Release Build
-      run: RUSTFLAGS="-D warnings" cargo build --all --all-targets --release
+      run: cargo build --all --all-targets --release
     - name: Run unit tests
       run: cargo test --features enable-system-alloc
 
@@ -86,18 +86,18 @@ jobs:
         server_version: ['unstable', '8.0', '8.1']
     steps:
     - uses: actions/checkout@v4
-    - name: Set the server verison for python integeration tests
+    - name: Set the server version for python integration tests
       run: echo "SERVER_VERSION=${{ matrix.server_version }}" >> $GITHUB_ENV
     - name: Run cargo and clippy format check
       run: |
         cargo fmt --check
-        cargo clippy --profile release --all-targets -- -D clippy::all
+        cargo clippy --profile release --all-targets
     - name: Release Build
       run: |
         if [ "${{ matrix.server_version }}" = "8.0" ]; then
-          RUSTFLAGS="-D warnings" cargo build --all --all-targets --release --features valkey_8_0
+          cargo build --all --all-targets --release --features valkey_8_0
         else
-          RUSTFLAGS="-D warnings" cargo build --all --all-targets --release
+          cargo build --all --all-targets --release
         fi
     - name: Run unit tests
       run: cargo test --features enable-system-alloc
diff --git a/.github/workflows/trigger-bloom-release.yml b/.github/workflows/trigger-bloom-release.yml
@@ -0,0 +1,40 @@
+name: Trigger Extension Update - Bloom
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      version:
+        description: Version of Valkey Bloom module that was released
+        required: true
+
+jobs:
+  trigger:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Determine version
+        id: determine-vars
+        run: |
+          if [[ "${{ github.event_name }}" == "release" ]]; then
+            echo "Triggered by a release event."
+            VERSION=${{ github.event.release.tag_name }}
+          else
+            echo "Triggered by workflow_dispatch."
+            VERSION=${{ inputs.version }}
+          fi
+
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+
+      - name: Trigger extension update
+        uses: peter-evans/repository-dispatch@v3
+        with:
+          token: ${{ secrets.EXTENSION_PAT }}
+          repository: ${{ github.repository_owner }}/valkey-bundle
+          event-type: bloom-release
+          client-payload: >
+            {
+              "version": "${{ steps.determine-vars.outputs.version }}",
+              "component": "bloom"
+            }
+              
diff --git a/00-RELEASENOTES b/00-RELEASENOTES
@@ -1,6 +1,27 @@
-Valkey Bloom 1.0.0 release notes
+Valkey Bloom 1.0 release notes
 ========================
 
+Upgrade urgency levels:
+
+| Level    | Meaning                                                             |
+|----------|---------------------------------------------------------------------|
+| LOW      | No need to upgrade unless there are new features you want to use.   |
+| MODERATE | Program an upgrade of the server, but it's not urgent.              |
+| HIGH     | There is a critical bug that may affect a subset of users. Upgrade! |
+| CRITICAL | There is a critical bug affecting MOST USERS. Upgrade ASAP.         |
+| SECURITY | There are security fixes in the release.                            |
+
+================================================================================
+Valkey Bloom 1.0.1  -  Released Mon 23 February 2026
+================================================================================
+
+Upgrade urgency SECURITY: This release includes security fixes we recommend you
+apply as soon as possible.
+
+### Security fixes
+
+* (CVE-2026-21864) - Remote DoS from malformed RESTORE command. Fixed by: KarthikSubbarao - Set ModuleOptions to Handle IO Errors (#82)
+
 ================================================================================
 Valkey Bloom 1.0.0 GA  -  Released Tue 01 April 2025
 ================================================================================
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "valkey-bloom"
 authors = ["Karthik Subbarao"]
-version = "1.0.0"
+version = "1.0.1"
 edition = "2021"
 license = "BSD-3-Clause"
 repository = "https://github.com/valkey-io/valkey-bloom"
diff --git a/QUICK_START.md b/QUICK_START.md
@@ -4,9 +4,9 @@ Follow these steps to set up, build, and run the Valkey server with the valkey-b
 
 ## Step 1: Install Valkey and valkey-bloom
 
-1. Build Valkey from source by following the instructions [here](https://github.com/valkey-io/valkey?tab=readme-ov-file#building-valkey-using-makefile). Make sure to use Valkey version 8.0 or above.
+1. Follow the [instructions to build Valkey from source](https://github.com/valkey-io/valkey?tab=readme-ov-file#building-valkey-using-makefile). Make sure to use Valkey version 8.0 or above.
 
-2. Build the valkey-bloom module from source by following the instructions [here](https://github.com/valkey-io/valkey-bloom/blob/unstable/README.md#build-instructions).
+2. Follow the [instructions to build the valkey-bloom module from source](https://github.com/valkey-io/valkey-bloom/blob/unstable/README.md#build-instructions).
 
 ## Step 2: Run the Valkey Server with valkey-bloom
 
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # valkey-bloom
 
-Valkey-Bloom (BSD-3-Clause) is a Rust based Valkey-Module which brings a Bloom Filter (Module) data type into Valkey and supports verions >= 8.0. With this, users can create bloom filters (space efficient probabilistic data structures) to add elements, check whether elements exists, auto scale their filters, customize bloom filter properties, perform RDB Save and load operations, etc.
+Valkey-Bloom (BSD-3-Clause) is a Rust based Valkey-Module which brings a Bloom Filter (Module) data type into Valkey and supports versions >= 8.0. With this, users can create bloom filters (space efficient probabilistic data structures) to add elements, check whether elements exists, auto scale their filters, customize bloom filter properties, perform RDB Save and load operations, etc.
 
 Valkey-Bloom is built using `bloomfilter::Bloom` (https://crates.io/crates/bloomfilter which has a BSD-2-Clause license).
 
@@ -37,12 +37,14 @@ valkey-server --loadmodule ./target/release/libvalkey_bloom.so
 # Builds the valkey-server (unstable) for integration testing.
 SERVER_VERSION=unstable
 ./build.sh
-# Same as above, but uses valkey-server (8.0.0) for integration testing.
-SERVER_VERSION=8.0.0
+# Same as above, but uses valkey-server (8.0) for integration testing.
+SERVER_VERSION=8.0
 ./build.sh
 # Build with asan, you may need to remove the old valkey binary if you have used ./build.sh before. You can do this by deleting the `.build` folder in the `tests` folder 
 ASAN_BUILD=true
 ./build.sh
+# Clean build artifacts
+./build.sh clean
 ```
 
 ## Load the Module
@@ -74,4 +76,4 @@ valkey-server --loadmodule /path/to/libvalkey_bloom.so
 cargo build --release --features valkey_8_0
 ```
 
-This can also be done by specifiyng SERVER_VERSION=8.0.0 and then running `./build.sh`
+This can also be done by specifying SERVER_VERSION=8.0 and then running `./build.sh`
diff --git a/build.sh b/build.sh
@@ -8,6 +8,15 @@ set -e
 SCRIPT_DIR=$(pwd)
 echo "Script Directory: $SCRIPT_DIR"
 
+if [ "$1" = "clean" ]; then
+  echo "Cleaning build artifacts"
+  rm -rf target/
+  rm -rf tests/build/
+  rm -rf test-data/
+  echo "Clean completed."
+  exit 0
+fi
+
 echo "Running cargo and clippy format checks..."
 cargo fmt --check
 cargo clippy --profile release --all-targets -- -D clippy::all
@@ -22,7 +31,7 @@ if [ -z "$SERVER_VERSION" ]; then
     export SERVER_VERSION="unstable"
 fi
 
-if [ "$SERVER_VERSION" != "unstable" ] && [ "$SERVER_VERSION" != "8.0" ] && [ "$SERVER_VERSION" != "8.1" ]; then
+if [ "$SERVER_VERSION" != "unstable" ] && [ "$SERVER_VERSION" != "8.0" ] && [ "$SERVER_VERSION" != "8.1" ] && [ "$SERVER_VERSION" != "9.0" ]; then
   echo "ERROR: Unsupported version - $SERVER_VERSION"
   exit 1
 fi
@@ -90,9 +99,9 @@ fi
 
 os_type=$(uname)
 MODULE_EXT=".so"
-if [[ "$os_type" == "Darwin" ]]; then
+if [ "$os_type" = "Darwin" ]; then
   MODULE_EXT=".dylib"
-elif [[ "$os_type" == "Linux" ]]; then
+elif [ "$os_type" = "Linux" ]; then
   MODULE_EXT=".so"
 else
   echo "Unsupported OS type: $os_type"
@@ -103,7 +112,7 @@ export MODULE_PATH="$SCRIPT_DIR/target/release/libvalkey_bloom$MODULE_EXT"
 echo "Running the integration tests..."
 if [ ! -z "${ASAN_BUILD}" ]; then
     # TEST_PATTERN can be used to run specific tests or test patterns.
-    if [[ -n "$TEST_PATTERN" ]]; then
+    if [ -n "$TEST_PATTERN" ]; then
         python3 -m pytest --capture=sys --cache-clear -v "$SCRIPT_DIR/tests/" -k $TEST_PATTERN 2>&1 | tee test_output.tmp
     else
         echo "TEST_PATTERN is not set. Running all integration tests."
@@ -132,7 +141,7 @@ if [ ! -z "${ASAN_BUILD}" ]; then
     rm test_output.tmp
 else 
     # TEST_PATTERN can be used to run specific tests or test patterns.
-    if [[ -n "$TEST_PATTERN" ]]; then
+    if [ -n "$TEST_PATTERN" ]; then
         python3 -m pytest --cache-clear -v "$SCRIPT_DIR/tests/" -k $TEST_PATTERN
     else
         echo "TEST_PATTERN is not set. Running all integration tests."
diff --git a/src/bloom/data_type.rs b/src/bloom/data_type.rs
@@ -57,7 +57,7 @@ impl ValkeyDataType for BloomObject {
     /// Callback to load and parse RDB data of a bloom item and create it.
     fn load_from_rdb(rdb: *mut raw::RedisModuleIO, encver: i32) -> Option<BloomObject> {
         if encver > BLOOM_TYPE_ENCODING_VERSION {
-            logging::log_warning(format!("{}: Cannot load bloomfltr data type of version {} because it is higher than the loaded module's bloomfltr supported version {}", MODULE_NAME, encver, BLOOM_TYPE_ENCODING_VERSION).as_str());
+            logging::log_warning(format!("{}: Cannot load bloomfltr data type of version {} because it is greater than the loaded module's bloomfltr supported version {}", MODULE_NAME, encver, BLOOM_TYPE_ENCODING_VERSION).as_str());
             return None;
         }
         let Ok(num_filters) = raw::load_unsigned(rdb) else {
diff --git a/src/bloom/utils.rs b/src/bloom/utils.rs
@@ -193,7 +193,7 @@ impl BloomObject {
             + (filters_vec_capacity * std::mem::size_of::<Box<BloomFilter>>())
     }
 
-    /// Caculates the number of bytes that the bloom object will require to be allocated.
+    /// Calculates the number of bytes that the bloom object will require to be allocated.
     /// This is used when scaling out a bloom object to check if the new
     /// size will be within the allowed size limit.
     /// Returns whether the bloom object is of a valid size or not.
@@ -202,7 +202,7 @@ impl BloomObject {
         BloomObject::validate_size(bytes)
     }
 
-    /// Caculates the number of bytes that the bloom object will require to be allocated.
+    /// Calculates the number of bytes that the bloom object will require to be allocated.
     /// This is used when creating a new bloom object to check if the size is within the allowed size limit.
     /// Returns whether the bloom object is of a valid size or not.
     fn validate_size_before_create(capacity: i64, fp_rate: f64) -> bool {
@@ -273,7 +273,7 @@ impl BloomObject {
         self.expansion
     }
 
-    /// Return the false postive rate of the bloom object.
+    /// Return the false positive rate of the bloom object.
     pub fn fp_rate(&self) -> f64 {
         self.fp_rate
     }
@@ -490,7 +490,7 @@ impl BloomObject {
     /// * `validate_scale_to` - the capacity we check to see if it can scale to. If this method is called from BF.INFO this is set as -1 as we
     ///   want to check the maximum size we could scale up till
     /// * `tightening_ratio` - The tightening ratio of the object
-    /// * `expansion` - The expanison rate of the object
+    /// * `expansion` - The expansion rate of the object
     ///
     /// # Returns
     /// * i64 - The maximum capacity that can be reached if called from BF.INFO. If called from BF.INSERT the size it reached when it became greater than `validate_scale_to`
@@ -645,12 +645,12 @@ impl BloomFilter {
         self.bloom.seed()
     }
 
-    /// Return the numer of items in the BloomFilter.
+    /// Return the number of items in the BloomFilter.
     pub fn num_items(&self) -> i64 {
         self.num_items
     }
 
-    /// Return the capcity of the BloomFilter - number of items that can be added to it.
+    /// Return the capacity of the BloomFilter - number of items that can be added to it.
     pub fn capacity(&self) -> i64 {
         self.capacity
     }
@@ -761,7 +761,7 @@ mod tests {
                 Ok(1) => {
                     if let Some(err) = expected_error {
                         panic!(
-                            "Expected error on the bloom object during during item add: {:?}",
+                            "Expected error on the bloom object during item add: {:?}",
                             err
                         );
                     }
@@ -1253,7 +1253,7 @@ mod tests {
 
     #[test]
     fn test_vec_capacity_matches_size_calculations() {
-        // This unit test is designed to make sure out calculations with capcity will always match the correct vec capacity
+        // This unit test is designed to make sure out calculations with capacity will always match the correct vec capacity
         let mut test_v = vec![0];
         for i in 0..5000 {
             let x = if i == 0 {
diff --git a/src/commands/bf.info.json b/src/commands/bf.info.json
@@ -49,7 +49,7 @@
                     {
                         "name": "tightening",
                         "type": "pure-token",
-                        "token": "TIGHTENTING"
+                        "token": "TIGHTENING"
                     },
                     {
                         "name": "maxscaledcapacity",
diff --git a/src/configs.rs b/src/configs.rs
@@ -28,7 +28,7 @@ pub const BLOOM_TIGHTENING_RATIO_MAX: f64 = 1.0;
 
 pub const BLOOM_USE_RANDOM_SEED_DEFAULT: bool = true;
 
-pub const BLOOM_DEFRAG_DEAFULT: bool = true;
+pub const BLOOM_DEFRAG_DEFAULT: bool = true;
 
 // Max Memory usage allowed overall within a bloom object (128MB).
 // Beyond this threshold, a bloom object is classified as large.
@@ -43,7 +43,7 @@ lazy_static! {
     pub static ref BLOOM_MEMORY_LIMIT_PER_OBJECT: AtomicI64 =
         AtomicI64::new(BLOOM_MEMORY_LIMIT_PER_OBJECT_DEFAULT);
     pub static ref BLOOM_USE_RANDOM_SEED: AtomicBool = AtomicBool::default();
-    pub static ref BLOOM_DEFRAG: AtomicBool = AtomicBool::new(BLOOM_DEFRAG_DEAFULT);
+    pub static ref BLOOM_DEFRAG: AtomicBool = AtomicBool::new(BLOOM_DEFRAG_DEFAULT);
     pub static ref BLOOM_FP_RATE_F64: Mutex<f64> = Mutex::new(
         BLOOM_FP_RATE_DEFAULT
             .parse::<f64>()
diff --git a/src/lib.rs b/src/lib.rs
@@ -10,17 +10,19 @@ pub mod wrapper;
 use crate::bloom::command_handler;
 use crate::bloom::data_type::BLOOM_TYPE;
 use crate::bloom::utils::valid_server_version;
+use valkey_module::ModuleOptions;
 use valkey_module_macros::info_command_handler;
 
 pub const MODULE_NAME: &str = "bf";
-pub const MODULE_VERSION: i32 = 10000;
+pub const MODULE_VERSION: i32 = 10001;
 // The release stage is used in order to provide release status information.
 // In unstable branch the status is always "dev".
 // During release process the status will be set to rc1,rc2...rcN.
 // When the version is released the status will be "ga".
 pub const MODULE_RELEASE_STAGE: &str = "ga";
 
 fn initialize(ctx: &Context, _args: &[ValkeyString]) -> Status {
+    ctx.set_module_options(ModuleOptions::HANDLE_IO_ERRORS);
     let ver = ctx
         .get_server_version()
         .expect("Unable to get server version!");
@@ -134,7 +136,7 @@ valkey_module! {
         ],
         bool: [
             ["bloom-use-random-seed", &*configs::BLOOM_USE_RANDOM_SEED, configs::BLOOM_USE_RANDOM_SEED_DEFAULT, ConfigurationFlags::DEFAULT, None],
-            ["bloom-defrag-enabled", &*configs::BLOOM_DEFRAG, configs::BLOOM_DEFRAG_DEAFULT,  ConfigurationFlags::DEFAULT, None],
+            ["bloom-defrag-enabled", &*configs::BLOOM_DEFRAG, configs::BLOOM_DEFRAG_DEFAULT,  ConfigurationFlags::DEFAULT, None],
         ],
         enum: [
         ],
diff --git a/src/wrapper/bloom_callback.rs b/src/wrapper/bloom_callback.rs
@@ -187,7 +187,7 @@ fn external_vec_defrag(vec: Vec<u8>) -> Vec<u8> {
 /// contains a vec of BloomFilter structs. Each BloomFilter contains a Bloom structure implemented in an external Rust crate.
 /// Finally, each of these external Bloom structures contains a Vec (bit vector).
 ///
-/// The order of defragmention is as follows (1 to 3 is in a loop for the number of filters):
+/// The order of defragmentation is as follows (1 to 3 is in a loop for the number of filters):
 /// 1. BloomFilter structures within the top level BloomObject structure
 /// 2. External Bloom structures within each BloomFilter
 /// 3. Vec (Bit vector) within each external Bloom structure
diff --git a/src/wrapper/mod.rs b/src/wrapper/mod.rs
@@ -22,7 +22,7 @@ pub fn must_obey_client(ctx: &Context) -> bool {
 
     #[cfg(feature = "valkey_8_0")]
     {
-        // On Valkey 8.0, fallback to checking for replicated flag in the GetContextFlags API as a best effort.
+        // On Valkey 8.0, fall back to checking for replicated flag in the GetContextFlags API as a best effort.
         ctx.get_flags()
             .contains(valkey_module::ContextFlags::REPLICATED)
     }
diff --git a/tests/test_bloom_acl_category.py b/tests/test_bloom_acl_category.py
@@ -19,7 +19,7 @@ def test_bloom_acl_category_permissions(self):
         client = self.server.get_new_client()
         # Get a list of all commands with the acl category bloom
         list_of_bloom_commands = client.execute_command("COMMAND LIST FILTERBY ACLCAT bloom")
-        # Create users with differnt acl permissions
+        # Create users with different acl permissions
         client.execute_command("ACL SETUSER nonbloomuser1 on >bloom_pass -@bloom")
         client.execute_command("ACL SETUSER nonbloomuser2 on >bloom_pass -@all")
         client.execute_command("ACL SETUSER bloomuser1 on >bloom_pass ~* &* +@all ")
diff --git a/tests/test_bloom_basic.py b/tests/test_bloom_basic.py
diff --git a/tests/test_bloom_keyspace.py b/tests/test_bloom_keyspace.py
diff --git a/tests/test_bloom_replication.py b/tests/test_bloom_replication.py
diff --git a/tests/test_bloom_valkeypy_compatibility.py b/tests/test_bloom_valkeypy_compatibility.py
diff --git a/tests/valkey_bloom_test_case.py b/tests/valkey_bloom_test_case.py

Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ impl ValkeyDataType for BloomObject {`
`57`	`57`	`/// Callback to load and parse RDB data of a bloom item and create it.`
`58`	`58`	`fn load_from_rdb(rdb: *mut raw::RedisModuleIO, encver: i32) -> Option<BloomObject> {`
`59`	`59`	`if encver > BLOOM_TYPE_ENCODING_VERSION {`
`60`		`- logging::log_warning(format!("{}: Cannot load bloomfltr data type of version {} because it is higher than the loaded module's bloomfltr supported version {}", MODULE_NAME, encver, BLOOM_TYPE_ENCODING_VERSION).as_str());`
	`60`	`+ logging::log_warning(format!("{}: Cannot load bloomfltr data type of version {} because it is greater than the loaded module's bloomfltr supported version {}", MODULE_NAME, encver, BLOOM_TYPE_ENCODING_VERSION).as_str());`
`61`	`61`	`return None;`
`62`	`62`	`}`
`63`	`63`	`let Ok(num_filters) = raw::load_unsigned(rdb) else {`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@`
`49`	`49`	`{`
`50`	`50`	`"name": "tightening",`
`51`	`51`	`"type": "pure-token",`
`52`		`- "token": "TIGHTENTING"`
	`52`	`+ "token": "TIGHTENING"`
`53`	`53`	`},`
`54`	`54`	`{`
`55`	`55`	`"name": "maxscaledcapacity",`