Add support for the BLMOVE and BRPOPLPUSH commands

Issues #235 and #251

Author: Gabriel Erzse

src/NRedisStack/CoreCommands/CoreCommandBuilder.cs

@@ -87,6 +87,28 @@ public static SerializedCommand BRPop(RedisKey[] keys, double timeout)
             return BlockingCommandWithKeysAndTimeout(RedisCoreCommands.BRPOP, keys, timeout);
         }
 
+        public static SerializedCommand BLMove(RedisKey source, RedisKey destination, ListSide sourceSide, ListSide destinationSide, double timeout)
+        {
+            List<object> args = new List<object>();
+            args.Add(source);
+            args.Add(destination);
+            args.Add(sourceSide == ListSide.Left ? CoreArgs.LEFT : CoreArgs.RIGHT);
+            args.Add(destinationSide == ListSide.Left ? CoreArgs.LEFT : CoreArgs.RIGHT);
+            args.Add(timeout);
+
+            return new SerializedCommand(RedisCoreCommands.BLMOVE, args);
+        }
+
+        public static SerializedCommand BRPopLPush(RedisKey source, RedisKey destination, double timeout)
+        {
+            List<object> args = new List<object>();
+            args.Add(source);
+            args.Add(destination);
+            args.Add(timeout);
+
+            return new SerializedCommand(RedisCoreCommands.BRPOPLPUSH, args);
+        }
+
         private static SerializedCommand BlockingCommandWithKeysAndTimeout(String command, RedisKey[] keys, double timeout)
         {
             if (keys.Length == 0)

src/NRedisStack/CoreCommands/CoreCommands.cs

@@ -326,5 +326,49 @@ public static bool ClientSetInfo(this IDatabase db, SetInfoAttr attr, string val
         {
             return BRPop(db, new[] { key }, timeout);
         }
+
+        /// <summary>
+        /// The BLMOVE command.
+        /// <p/>
+        /// Atomically returns and removes the first or last element of the list stored at <paramref name="source"/>
+        /// (depending on the value of <paramref name="sourceSide"/>), and pushes the element as the first or last
+        /// element of the list stored at <paramref name="destination"/> (depending on the value of
+        /// <paramref name="destinationSide"/>).
+        /// <p/>
+        /// This is an extension method added to the <see cref="IDatabase"/> class, for convenience.
+        /// </summary>
+        /// <param name="db">The <see cref="IDatabase"/> class where this extension method is applied.</param>
+        /// <param name="source">The key of the source list.</param>
+        /// <param name="destination">The key of the destination list.</param>
+        /// <param name="sourceSide">What side of the <paramref name="source"/> list to remove from.</param>
+        /// <param name="destinationSide">What side of the <paramref name="destination"/> list to move to.</param>
+        /// <param name="timeout">Server-side timeout for the wait. A value of <c>0</c> means to wait indefinitely.</param>
+        /// <returns>The element being popped and pushed, or <c>null</c> if the server timeout expires.</returns>
+        /// <remarks><seealso href="https://redis.io/commands/blmove"/></remarks>
+        public static RedisValue? BLMove(this IDatabase db, RedisKey source, RedisKey destination, ListSide sourceSide, ListSide destinationSide, double timeout)
+        {
+            var command = CoreCommandBuilder.BLMove(source, destination, sourceSide, destinationSide, timeout);
+            return db.Execute(command).ToRedisValue();
+        }
+
+        /// <summary>
+        /// The BRPOPLPUSH command.
+        /// <p/>
+        /// Atomically returns and removes the last element (tail) of the list stored at source, and pushes the element
+        /// at the first element (head) of the list stored at destination.
+        /// <p/>
+        /// This is an extension method added to the <see cref="IDatabase"/> class, for convenience.
+        /// </summary>
+        /// <param name="db">The <see cref="IDatabase"/> class where this extension method is applied.</param>
+        /// <param name="source">The key of the source list.</param>
+        /// <param name="destination">The key of the destination list.</param>
+        /// <param name="timeout">Server-side timeout for the wait. A value of <c>0</c> means to wait indefinitely.</param>
+        /// <returns>The element being popped and pushed, or <c>null</c> if the server timeout expires.</returns>
+        /// <remarks><seealso href="https://redis.io/commands/rpoplpush"/></remarks>
+        public static RedisValue? BRPopLPush(this IDatabase db, RedisKey source, RedisKey destination, double timeout)
+        {
+            var command = CoreCommandBuilder.BRPopLPush(source, destination, timeout);
+            return db.Execute(command).ToRedisValue();
+        }
     }
 }

src/NRedisStack/CoreCommands/Literals/Commands.cs

@@ -5,9 +5,11 @@ namespace NRedisStack.Core.Literals
     /// </summary>
     internal static class RedisCoreCommands
     {
+        public const string BLMOVE = "BLMOVE";
         public const string BLMPOP = "BLMPOP";
         public const string BLPOP = "BLPOP";
         public const string BRPOP = "BRPOP";
+        public const string BRPOPLPUSH = "BRPOPLPUSH";
         public const string BZMPOP = "BZMPOP";
         public const string BZPOPMAX = "BZPOPMAX";
         public const string BZPOPMIN = "BZPOPMIN";

tests/NRedisStack.Tests/Core Commands/CoreTests.cs

@@ -620,4 +620,86 @@ public void TestBRPopMultipleLists()
         Assert.Equal("list-one", result!.Item1);
         Assert.Equal("b", result.Item2.ToString());
     }
+
+    [SkipIfRedis(Is.OSSCluster, Comparison.LessThan, "6.2.0")]
+    public void TestBLMove()
+    {
+        var redis = ConnectionMultiplexer.Connect("localhost");
+
+        var db = redis.GetDatabase(null);
+        db.Execute("FLUSHALL");
+
+        db.ListRightPush("list-one", "a");
+        db.ListRightPush("list-one", "b");
+
+        db.ListRightPush("list-two", "c");
+        db.ListRightPush("list-two", "d");
+
+        var result = db.BLMove("list-one", "list-two", ListSide.Right, ListSide.Left, 0);
+        Assert.NotNull(result);
+        Assert.Equal("b", result!);
+
+        Assert.Equal(1, db.ListLength("list-one"));
+        Assert.Equal("a", db.ListGetByIndex("list-one", 0));
+        Assert.Equal(3, db.ListLength("list-two"));
+        Assert.Equal("b", db.ListGetByIndex("list-two", 0));
+        Assert.Equal("c", db.ListGetByIndex("list-two", 1));
+        Assert.Equal("d", db.ListGetByIndex("list-two", 2));
+
+        result = db.BLMove("list-two", "list-one", ListSide.Left, ListSide.Right, 0);
+        Assert.NotNull(result);
+        Assert.Equal("b", result!);
+
+        Assert.Equal(2, db.ListLength("list-one"));
+        Assert.Equal("a", db.ListGetByIndex("list-one", 0));
+        Assert.Equal("b", db.ListGetByIndex("list-one", 1));
+        Assert.Equal(2, db.ListLength("list-two"));
+        Assert.Equal("c", db.ListGetByIndex("list-two", 0));
+        Assert.Equal("d", db.ListGetByIndex("list-two", 1));
+
+        result = db.BLMove("list-one", "list-two", ListSide.Left, ListSide.Left, 0);
+        Assert.NotNull(result);
+        Assert.Equal("a", result!);
+
+        Assert.Equal(1, db.ListLength("list-one"));
+        Assert.Equal("b", db.ListGetByIndex("list-one", 0));
+        Assert.Equal(3, db.ListLength("list-two"));
+        Assert.Equal("a", db.ListGetByIndex("list-two", 0));
+        Assert.Equal("c", db.ListGetByIndex("list-two", 1));
+        Assert.Equal("d", db.ListGetByIndex("list-two", 2));
+
+        result = db.BLMove("list-two", "list-one", ListSide.Right, ListSide.Right, 0);
+        Assert.NotNull(result);
+        Assert.Equal("d", result!);
+
+        Assert.Equal(2, db.ListLength("list-one"));
+        Assert.Equal("b", db.ListGetByIndex("list-one", 0));
+        Assert.Equal("d", db.ListGetByIndex("list-one", 1));
+        Assert.Equal(2, db.ListLength("list-two"));
+        Assert.Equal("a", db.ListGetByIndex("list-two", 0));
+        Assert.Equal("c", db.ListGetByIndex("list-two", 1));
+    }
+
+    [SkipIfRedis(Is.OSSCluster, Comparison.LessThan, "2.2.0")]
+    public void TestBRPopLPush()
+    {
+        var redis = ConnectionMultiplexer.Connect("localhost");
+
+        var db = redis.GetDatabase(null);
+        db.Execute("FLUSHALL");
+
+        db.ListRightPush("list-one", "a");
+        db.ListRightPush("list-one", "b");
+
+        db.ListRightPush("list-two", "c");
+        db.ListRightPush("list-two", "d");
+
+        var result = db.BRPopLPush("list-one", "list-two", 0);
+        Assert.NotNull(result);
+        Assert.Equal("b", result!);
+
+        Assert.Equal(1, db.ListLength("list-one"));
+        Assert.Equal(3, db.ListLength("list-two"));
+        Assert.Equal("b", db.ListLeftPop("list-two"));
+    }
 }