Add async methods (#7)

* Add Async Version for all bloom commands

* Async tests for TOPK, CF and CMS

* Add Bloom Async Tests

Author: shacharPash

src/NRedisStack.Core/Bloom/BloomCommands.cs

@@ -24,6 +24,19 @@ public bool Add(RedisKey key, RedisValue item)
             return _db.Execute(BF.ADD, key, item).ToString() == "1";
         }
 
+        /// <summary>
+        /// Adds an item to a Bloom Filter.
+        /// </summary>
+        /// <param name="key">The key under which the filter is found.</param>
+        /// <param name="item">The item to add.</param>
+        /// <returns><see langword="true"/> if the item did not exist in the filter, <see langword="false"/> otherwise.</returns>
+        /// <remarks><seealso href="https://redis.io/commands/bf.add"/></remarks>
+        public async Task<bool> AddAsync(RedisKey key, RedisValue item)
+        {
+            var result = await _db.ExecuteAsync(BF.ADD, key, item);
+            return result.ToString() == "1";
+        }
+
         /// <summary>
         /// Checks whether an item exist in the Bloom Filter or not.
         /// </summary>
@@ -37,6 +50,20 @@ public bool Exists(RedisKey key, RedisValue item)
             return _db.Execute(BF.EXISTS, key, item).ToString() == "1";
         }
 
+        /// <summary>
+        /// Checks whether an item exist in the Bloom Filter or not.
+        /// </summary>
+        /// <param name="key">The name of the filter.</param>
+        /// <param name="item">The item to check for.</param>
+        /// <returns><see langword="true"/> means the item may exist in the filter,
+        /// and <see langword="false"/> means it does not exist in the filter.</returns>
+        /// <remarks><seealso href="https://redis.io/commands/bf.exists"/></remarks>
+        public async Task<bool> ExistsAsync(RedisKey key, RedisValue item)
+        {
+            var result = await _db.ExecuteAsync(BF.EXISTS, key, item);
+            return result.ToString() == "1";
+        }
+
         /// <summary>
         /// Return information about a bloom filter.
         /// </summary>
@@ -49,6 +76,18 @@ public bool Exists(RedisKey key, RedisValue item)
             return ResponseParser.ToBloomInfo(info);
         }
 
+        /// <summary>
+        /// Return information about a bloom filter.
+        /// </summary>
+        /// <param name="key">Name of the key to return information about.</param>
+        /// <returns>Information of the filter.</returns>
+        /// <remarks><seealso href="https://redis.io/commands/bf.info"/></remarks>
+        public async Task<BloomInformation?> InfoAsync(RedisKey key)
+        {
+            var info = await _db.ExecuteAsync(BF.INFO, key);
+            return ResponseParser.ToBloomInfo(info);
+        }
+
         /// <summary>
         /// Adds one or more items to a Bloom Filter. A filter will be created if it does not exist.
         /// </summary>
@@ -112,6 +151,70 @@ public bool Exists(RedisKey key, RedisValue item)
             return ResponseParser.ToBooleanArray(_db.Execute(BF.INSERT, args));
         }
 
+        /// <summary>
+        /// Adds one or more items to a Bloom Filter. A filter will be created if it does not exist.
+        /// </summary>
+        /// <param name="key">The name of the filter.</param>
+        /// <param name="items">One or more items to add.</param>
+        /// <param name="capacity">(Optional) Specifies the desired capacity for the filter to be created.</param>
+        /// <param name="error">(Optional) Specifies the error ratio of the newly created filter if it does not yet exist.</param>
+        /// <param name="expansion">(Optional) When capacity is reached, an additional sub-filter is
+        /// created in size of the last sub-filter multiplied by expansion.</param>
+        /// <param name="nocreate">(Optional) <see langword="true"/> to indicates that the
+        /// filter should not be created if it does not already exist.</param>
+        /// <param name="nonscaling">(Optional) <see langword="true"/> toprevent the filter
+        /// from creating additional sub-filters if initial capacity is reached.</param>
+        /// <returns>An array of booleans. Each element is either true or false depending on whether the
+        /// corresponding input element was newly added to the filter or may have previously existed.</returns>
+        /// <remarks><seealso href="https://redis.io/commands/bf.insert"/></remarks>
+        public async Task<bool[]> InsertAsync(RedisKey key, RedisValue[] items, int? capacity = null, //TODO: create enother function that get one item, because right now if the user want to insert one item he needs to insert this as RedisValue[]
+                                  double? error = null, int? expansion = null,
+                                  bool nocreate = false, bool nonscaling = false)
+        {
+            if (items == null)
+                throw new ArgumentNullException(nameof(items));
+
+            List<object> args = new List<object> { key };
+
+            if (capacity != null)
+            {
+                args.Add(BloomArgs.CAPACITY);
+                args.Add(capacity);
+            }
+
+            if (error != null)
+            {
+                args.Add(BloomArgs.ERROR);
+                args.Add(error);
+            }
+
+            if (expansion != null)
+            {
+                args.Add(BloomArgs.EXPANSION);
+                args.Add(expansion);
+            }
+
+            if (nocreate)
+            {
+                args.Add(BloomArgs.NOCREATE);
+
+            }
+
+            if (nonscaling)
+            {
+                args.Add(BloomArgs.NONSCALING);
+            }
+
+            args.Add(BloomArgs.ITEMS);
+            foreach (var item in items)
+            {
+                args.Add(item);
+            }
+
+            var result = await _db.ExecuteAsync(BF.INSERT, args);
+            return ResponseParser.ToBooleanArray(result);
+        }
+
         /// <summary>
         /// Restores a filter previosly saved using SCANDUMP.
         /// </summary>
@@ -125,6 +228,20 @@ public bool LoadChunk(RedisKey key, long iterator, Byte[] data)
             return ResponseParser.ParseOKtoBoolean(_db.Execute(BF.LOADCHUNK, key, iterator, data));
         }
 
+        /// <summary>
+        /// Restores a filter previosly saved using SCANDUMP.
+        /// </summary>
+        /// <param name="key">Name of the key to restore.</param>
+        /// <param name="iterator">Iterator value associated with data (returned by SCANDUMP).</param>
+        /// <param name="data">Current data chunk (returned by SCANDUMP).</param>
+        /// <returns>Array with information of the filter.</returns>
+        /// <remarks><seealso href="https://redis.io/commands/bf.loadchunk"/></remarks>
+        public async Task<bool> LoadChunkAsync(RedisKey key, long iterator, Byte[] data)
+        {
+            var result = await _db.ExecuteAsync(BF.LOADCHUNK, key, iterator, data);
+            return ResponseParser.ParseOKtoBoolean(result);
+        }
+
         /// <summary>
         /// Adds one or more items to the Bloom Filter. A filter will be created if it does not exist yet.
         /// </summary>
@@ -148,6 +265,30 @@ public bool[] MAdd(RedisKey key, RedisValue[] items)
             return ResponseParser.ToBooleanArray(_db.Execute(BF.MADD, args));
         }
 
+        /// <summary>
+        /// Adds one or more items to the Bloom Filter. A filter will be created if it does not exist yet.
+        /// </summary>
+        /// <param name="key">The name of the filter.</param>
+        /// <param name="items">One or more items to add.</param>
+        /// <returns>An array of booleans. Each element is either true or false depending on whether the
+        /// corresponding input element was newly added to the filter or may have previously existed.</returns>
+        /// <remarks><seealso href="https://redis.io/commands/bf.madd"/></remarks>
+        public async Task<bool[]> MAddAsync(RedisKey key, RedisValue[] items)
+        {
+            if (items == null)
+                throw new ArgumentNullException(nameof(items));
+
+            List<object> args = new List<object> { key };
+
+            foreach (var item in items)
+            {
+                args.Add(item);
+            }
+
+            var result = await _db.ExecuteAsync(BF.MADD, args);
+            return ResponseParser.ToBooleanArray(result);
+        }
+
         /// <summary>
         /// Checks whether one or more items may exist in the filter or not.
         /// </summary>
@@ -172,6 +313,31 @@ public bool[] MExists(RedisKey key, RedisValue[] items)
 
         }
 
+        /// <summary>
+        /// Checks whether one or more items may exist in the filter or not.
+        /// </summary>
+        /// <param name="key">The name of the filter.</param>
+        /// <param name="items">One or more items to check.</param>
+        /// <returns>An array of booleans, for each item <see langword="true"/> means the item may exist in the filter,
+        /// and <see langword="false"/> means the item may exist in the filter.</returns>
+        /// <remarks><seealso href="https://redis.io/commands/bf.mexists"/></remarks>
+        public async Task<bool[]> MExistsAsync(RedisKey key, RedisValue[] items)
+        {
+            if (items == null)
+                throw new ArgumentNullException(nameof(items));
+
+            List<object> args = new List<object> { key };
+
+            foreach (var item in items)
+            {
+                args.Add(item);
+            }
+
+            var result = await _db.ExecuteAsync(BF.MEXISTS, args);
+            return ResponseParser.ToBooleanArray(result);
+
+        }
+
         /// <summary>
         /// Creates a new Bloom Filter.
         /// </summary>
@@ -202,6 +368,37 @@ public bool Reserve(RedisKey key, double errorRate, long capacity,
             return ResponseParser.ParseOKtoBoolean(_db.Execute(BF.RESERVE, args));
         }
 
+        /// <summary>
+        /// Creates a new Bloom Filter.
+        /// </summary>
+        /// <param name="key">The key under which the filter is found.</param>
+        /// <param name="errorRate">The desired probability for false positives (value between 0 to 1).</param>
+        /// <param name="capacity">The number of entries intended to be added to the filter.</param>
+        /// <param name="expansion">(Optional) When capacity is reached, an additional sub-filter is
+        /// created in size of the last sub-filter multiplied by expansion.</param>
+        /// <param name="nonscaling">(Optional) <see langword="true"/> toprevent the filter
+        /// from creating additional sub-filters if initial capacity is reached.</param>
+        /// <returns><see langword="true"/> if executed correctly, <see langword="false"/> otherwise.</returns>
+        /// <remarks><seealso href="https://redis.io/commands/bf.reserve"/></remarks>
+        public async Task<bool> ReserveAsync(RedisKey key, double errorRate, long capacity,
+                                   int? expansion = null, bool nonscaling = false)
+        {
+            List<object> args = new List<object> { key, errorRate, capacity };
+
+            if (expansion != null)
+            {
+                args.Add(expansion);
+            }
+
+            if (nonscaling)
+            {
+                args.Add(BloomArgs.NONSCALING);
+            }
+
+            var result = await _db.ExecuteAsync(BF.RESERVE, args);
+            return ResponseParser.ParseOKtoBoolean(result);
+        }
+
         /// <summary>
         /// Restores a filter previosly saved using SCANDUMP.
         /// </summary>
@@ -213,5 +410,18 @@ public bool Reserve(RedisKey key, double errorRate, long capacity,
         {
             return ResponseParser.ToScanDumpTuple(_db.Execute(BF.SCANDUMP, key, iterator));
         }
+
+        /// <summary>
+        /// Restores a filter previosly saved using SCANDUMP.
+        /// </summary>
+        /// <param name="key">Name of the filter.</param>
+        /// <param name="iterator">Iterator value; either 0 or the iterator from a previous invocation of this command.</param>
+        /// <returns>Tuple of iterator and data.</returns>
+        /// <remarks><seealso href="https://redis.io/commands/bf.scandump"/></remarks>
+        public async Task<Tuple<long,Byte[]>?> ScanDumpAsync(RedisKey key, long iterator)
+        {
+            var result = await _db.ExecuteAsync(BF.SCANDUMP, key, iterator);
+            return ResponseParser.ToScanDumpTuple(result);
+        }
     }
 }