Implement new GetTimeToLive API to return TimeSpan?

Author: mythz

src/ServiceStack.Redis/RedisClient.cs

@@ -15,6 +15,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
+using ServiceStack.Caching;
 using ServiceStack.Redis.Generic;
 using ServiceStack.Redis.Pipeline;
 using ServiceStack.Text;
@@ -357,9 +358,16 @@ public bool ExpireEntryAt(string key, DateTime expireAt)
             }
         }
 
-        public TimeSpan GetTimeToLive(string key)
+        public TimeSpan? GetTimeToLive(string key)
         {
-            return TimeSpan.FromSeconds(Ttl(key));
+            var ttlSecs = Ttl(key);
+            if (ttlSecs == -1)
+                return TimeSpan.MaxValue; //no expiry set
+
+            if (ttlSecs == -2)
+                return null; //key does not exist
+
+            return TimeSpan.FromSeconds(ttlSecs);
         }
 
         public IRedisTypedClient<T> As<T>()

src/ServiceStack.Redis/RedisClientManagerCacheClient.cs

@@ -12,7 +12,7 @@ namespace ServiceStack.Redis
     /// This works well for master-slave replication scenarios where you have 
     /// 1 master that replicates to multiple read slaves.
     /// </summary>
-    public class RedisClientManagerCacheClient : ICacheClient, IRemoveByPattern
+    public class RedisClientManagerCacheClient : ICacheClient, IRemoveByPattern, ICacheClientExtended
     {
         private readonly IRedisClientsManager redisManager;
 
@@ -194,5 +194,18 @@ public void RemoveByRegex(string pattern)
         {
             RemoveByPattern(pattern.Replace(".*", "*").Replace(".+", "?"));
         }
+
+        public TimeSpan? GetTimeToLive(string key)
+        {
+            using (var client = GetClient())
+            {
+                var redisClient = client as RedisClient;
+                if (redisClient != null)
+                {
+                    return redisClient.GetTimeToLive(key);
+                }
+            }
+            return null;
+        }
     }
 }

tests/ServiceStack.Redis.Tests/RedisCacheClientTests.cs

@@ -1,3 +1,4 @@
+using System;
 using NUnit.Framework;
 using ServiceStack.Caching;
 using ServiceStack.Common.Tests.Models;
@@ -7,7 +8,7 @@ namespace ServiceStack.Redis.Tests
 	[TestFixture]
 	public class RedisCacheClientTests
 	{
-		private ICacheClient cacheClient;
+		private ICacheClientExtended cacheClient;
 
 		[SetUp]
 		public void OnBeforeEachTest()
@@ -103,5 +104,25 @@ public void Can_Replace_By_Pattern()
             result2 = cacheClient.Get<string>("string1");
             Assert.That(result2, Is.Null);
         }
+
+	    [Test]
+	    public void Can_GetTimeToLive()
+	    {
+            var model = ModelWithIdAndName.Create(1);
+            string key = "model:" + model.CreateUrn();
+            cacheClient.Add(key, model);
+
+	        var ttl = cacheClient.GetTimeToLive(key);
+            Assert.That(ttl, Is.EqualTo(TimeSpan.MaxValue));
+
+	        cacheClient.Set(key, model, expiresIn: TimeSpan.FromSeconds(10));
+            ttl = cacheClient.GetTimeToLive(key);
+            Assert.That(ttl.Value, Is.GreaterThanOrEqualTo(TimeSpan.FromSeconds(9)));
+            Assert.That(ttl.Value, Is.LessThanOrEqualTo(TimeSpan.FromSeconds(10)));
+
+	        cacheClient.Remove(key);
+            ttl = cacheClient.GetTimeToLive(key);
+            Assert.That(ttl, Is.Null);
+        }
 	}
 }

tests/ServiceStack.Redis.Tests/RedisClientTests.cs

@@ -203,11 +203,11 @@ public void Can_GetTimeToLive()
 			Redis.Expire("key", 10);
 
 			var ttl = Redis.GetTimeToLive("key");
-			Assert.That(ttl.TotalSeconds, Is.GreaterThanOrEqualTo(9));
+			Assert.That(ttl.Value.TotalSeconds, Is.GreaterThanOrEqualTo(9));
 			Thread.Sleep(1700);
 
 			ttl = Redis.GetTimeToLive("key");
-			Assert.That(ttl.TotalSeconds, Is.LessThanOrEqualTo(9));
+            Assert.That(ttl.Value.TotalSeconds, Is.LessThanOrEqualTo(9));
 		}
 
         [Test]

tests/ServiceStack.Redis.Tests/RedisTransactionTests.cs

@@ -288,8 +288,8 @@ public void Can_set_Expiry_on_key_in_transaction()
             Assert.That(Redis.Get<string>(key), Is.EqualTo("Foo"));
             Assert.That(Redis.Get<string>(keyWithTtl), Is.EqualTo("Bar"));
 
-            Assert.That(Redis.GetTimeToLive(key).TotalSeconds, Is.EqualTo(-1));
-            Assert.That(Redis.GetTimeToLive(keyWithTtl).TotalSeconds, Is.GreaterThan(1));
+            Assert.That(Redis.GetTimeToLive(key), Is.EqualTo(TimeSpan.MaxValue));
+            Assert.That(Redis.GetTimeToLive(keyWithTtl).Value.TotalSeconds, Is.GreaterThan(1));
         }
 
         [Test]
@@ -309,7 +309,7 @@ public void Does_not_set_Expiry_on_existing_key_in_transaction()
             }
 
             Assert.That(Redis.Get<string>(key), Is.EqualTo("Foo"));
-            Assert.That(Redis.GetTimeToLive(key).TotalSeconds, Is.EqualTo(-1));
+            Assert.That(Redis.GetTimeToLive(key), Is.EqualTo(TimeSpan.MaxValue));
         }
     }
 }