Internals Rename: *Wrapper -> "KeyPrefixed" (#2282)

This renames the various wrappers to IMO more intuitive "KeyPrefixedX" - just couldn't get used to the previous model when touching N files for an API addition, hoping this makes it a little clearer overall, also has the benefit of batching them in UI due to common prefix.

Author: NickCraver

src/StackExchange.Redis/KeyspaceIsolation/BatchWrapper.cs

@@ -54,14 +54,14 @@ public static IDatabase WithKeyPrefix(this IDatabase database, RedisKey keyPrefi
                 return database; // fine - you can keep using the original, then
             }
 
-            if (database is DatabaseWrapper wrapper)
+            if (database is KeyPrefixedDatabase prefixed)
             {
                 // combine the key in advance to minimize indirection
-                keyPrefix = wrapper.ToInner(keyPrefix);
-                database = wrapper.Inner;
+                keyPrefix = prefixed.ToInner(keyPrefix);
+                database = prefixed.Inner;
             }
 
-            return new DatabaseWrapper(database, keyPrefix.AsPrefix()!);
+            return new KeyPrefixedDatabase(database, keyPrefix.AsPrefix()!);
         }
     }
 }

src/StackExchange.Redis/KeyspaceIsolation/DatabaseExtension.cs

@@ -7,9 +7,9 @@
 
 namespace StackExchange.Redis.KeyspaceIsolation
 {
-    internal class WrapperBase<TInner> : IDatabaseAsync where TInner : IDatabaseAsync
+    internal class KeyPrefixed<TInner> : IDatabaseAsync where TInner : IDatabaseAsync
     {
-        internal WrapperBase(TInner inner, byte[] keyPrefix)
+        internal KeyPrefixed(TInner inner, byte[] keyPrefix)
         {
             Inner = inner;
             Prefix = keyPrefix;

src/StackExchange.Redis/KeyspaceIsolation/WrapperBase.cs renamed to src/StackExchange.Redis/KeyspaceIsolation/KeyPrefixed.cs

@@ -0,0 +1,9 @@
+namespace StackExchange.Redis.KeyspaceIsolation
+{
+    internal sealed class KeyPrefixedBatch : KeyPrefixed<IBatch>, IBatch
+    {
+        public KeyPrefixedBatch(IBatch inner, byte[] prefix) : base(inner, prefix) { }
+
+        public void Execute() => Inner.Execute();
+    }
+}

src/StackExchange.Redis/KeyspaceIsolation/KeyPrefixedBatch.cs

@@ -4,17 +4,17 @@
 
 namespace StackExchange.Redis.KeyspaceIsolation
 {
-    internal sealed class DatabaseWrapper : WrapperBase<IDatabase>, IDatabase
+    internal sealed class KeyPrefixedDatabase : KeyPrefixed<IDatabase>, IDatabase
     {
-        public DatabaseWrapper(IDatabase inner, byte[] prefix) : base(inner, prefix)
+        public KeyPrefixedDatabase(IDatabase inner, byte[] prefix) : base(inner, prefix)
         {
         }
 
         public IBatch CreateBatch(object? asyncState = null) =>
-            new BatchWrapper(Inner.CreateBatch(asyncState), Prefix);
+            new KeyPrefixedBatch(Inner.CreateBatch(asyncState), Prefix);
 
         public ITransaction CreateTransaction(object? asyncState = null) =>
-            new TransactionWrapper(Inner.CreateTransaction(asyncState), Prefix);
+            new KeyPrefixedTransaction(Inner.CreateTransaction(asyncState), Prefix);
 
         public int Database => Inner.Database;
 

src/StackExchange.Redis/KeyspaceIsolation/DatabaseWrapper.cs renamed to src/StackExchange.Redis/KeyspaceIsolation/KeyPrefixedDatabase.cs

@@ -2,9 +2,9 @@
 
 namespace StackExchange.Redis.KeyspaceIsolation
 {
-    internal sealed class TransactionWrapper : WrapperBase<ITransaction>, ITransaction
+    internal sealed class KeyPrefixedTransaction : KeyPrefixed<ITransaction>, ITransaction
     {
-        public TransactionWrapper(ITransaction inner, byte[] prefix) : base(inner, prefix) { }
+        public KeyPrefixedTransaction(ITransaction inner, byte[] prefix) : base(inner, prefix) { }
 
         public ConditionResult AddCondition(Condition condition) => Inner.AddCondition(condition.MapKeys(GetMapFunction()));
 

src/StackExchange.Redis/KeyspaceIsolation/TransactionWrapper.cs renamed to src/StackExchange.Redis/KeyspaceIsolation/KeyPrefixedTransaction.cs

@@ -187,19 +187,25 @@ public void TalkToNonsenseServer()
     [Fact]
     public async Task TestManaulHeartbeat()
     {
-        using var conn = Create(keepAlive: 2);
+        var options = ConfigurationOptions.Parse(GetConfiguration());
+        options.HeartbeatInterval = TimeSpan.FromMilliseconds(100);
+        using var conn = await ConnectionMultiplexer.ConnectAsync(options);
+
+        foreach (var ep in conn.GetServerSnapshot().ToArray())
+        {
+            ep.WriteEverySeconds = 1;
+        }
 
         var db = conn.GetDatabase();
         db.Ping();
 
         var before = conn.OperationCount;
 
-        Log("sleeping to test heartbeat...");
-        await Task.Delay(5000).ForAwait();
-
+        Log("Sleeping to test heartbeat...");
+        await UntilConditionAsync(TimeSpan.FromSeconds(5), () => conn.OperationCount > before + 1).ForAwait();
         var after = conn.OperationCount;
 
-        Assert.True(after >= before + 2, $"after: {after}, before: {before}");
+        Assert.True(after >= before + 1, $"after: {after}, before: {before}");
     }
 
     [Theory]

tests/StackExchange.Redis.Tests/ConfigTests.cs

@@ -6,21 +6,21 @@
 namespace StackExchange.Redis.Tests;
 
 [Collection(nameof(MoqDependentCollection))]
-public sealed class BatchWrapperTests
+public sealed class KeyPrefixedBatchTests
 {
     private readonly Mock<IBatch> mock;
-    private readonly BatchWrapper wrapper;
+    private readonly KeyPrefixedBatch prefixed;
 
-    public BatchWrapperTests()
+    public KeyPrefixedBatchTests()
     {
         mock = new Mock<IBatch>();
-        wrapper = new BatchWrapper(mock.Object, Encoding.UTF8.GetBytes("prefix:"));
+        prefixed = new KeyPrefixedBatch(mock.Object, Encoding.UTF8.GetBytes("prefix:"));
     }
 
     [Fact]
     public void Execute()
     {
-        wrapper.Execute();
+        prefixed.Execute();
         mock.Verify(_ => _.Execute(), Times.Once());
     }
 }