- introduce IRedisClient

- add doc url for configuration

Author: atakavci

src/NRedisStack/CoreCommands/CoreCommands.cs

@@ -4,11 +4,15 @@
 
 namespace NRedisStack;
 
+/// <summary>
+/// Class that provides access to some of blocking Redis core commands
+/// </summary>
 public static class CoreCommands
 {
     /// <summary>
     /// Sets information specific to the client or connection.
     /// </summary>
+    /// <param name="db">The <see cref="IDatabase"/> class where this extension method is applied.</param>
     /// <param name="attr">which attribute to set</param>
     /// <param name="value">the attribute value</param>
     /// <returns><see langword="true"/> if the attribute name was successfully set, Error otherwise.</returns>

src/NRedisStack/IRedisClient.cs

@@ -0,0 +1,28 @@
+using StackExchange.Redis;
+
+namespace NRedisStack;
+
+/// <summary>
+/// This class is EXPERIMENTAL!! and may change or removed in future releases.
+/// Represents a Redis client that can connect to a Redis server 
+/// providing access to <see cref="IRedisDatabase"/> instances as well as the underlying multiplexer.
+/// </summary>
+public interface IRedisClient
+{
+    /// <summary>
+    /// Gets a database instance.
+    /// </summary>
+    /// <param name="db">The ID to get a database for.</param>
+    /// <param name="asyncState">The async state to pass into the resulting <see cref="RedisDatabase"/>.</param>
+    /// <returns></returns>
+    public IRedisDatabase GetDatabase(int db = -1, object? asyncState = null);
+
+    /// <summary>
+    /// Gets the underlying <see cref="ConnectionMultiplexer"/> instance.
+    /// </summary>
+    /// <returns></returns>
+    public IConnectionMultiplexer GetMultiplexer();
+}
+
+
+

src/NRedisStack/RedisClient.cs

@@ -7,11 +7,11 @@ namespace NRedisStack;
 /// Represents a Redis client that can connect to a Redis server 
 /// providing access to <see cref="IRedisDatabase"/> instances as well as the underlying multiplexer.
 /// </summary>
-public class RedisClient
+public class RedisClient: IRedisClient
 {
-    private ConnectionMultiplexer _multiplexer;
+    private IConnectionMultiplexer _multiplexer;
 
-    private RedisClient(ConnectionMultiplexer multiplexer)
+    private RedisClient(IConnectionMultiplexer multiplexer)
     {
         _multiplexer = multiplexer;
     }
@@ -21,7 +21,7 @@ private RedisClient(ConnectionMultiplexer multiplexer)
     /// </summary>
     /// <param name="configuration">The string configuration to use for this client.</param>
     /// <param name="log">The <see cref="TextWriter"/> to log to.</param>
-    public static async Task<RedisClient> ConnectAsync(string configuration, TextWriter? log = null) =>
+    public static async Task<IRedisClient> ConnectAsync(string configuration, TextWriter? log = null) =>
         await ConnectAsync(ConfigurationOptions.Parse(configuration), log);
 
     /// <summary>
@@ -30,7 +30,7 @@ public static async Task<RedisClient> ConnectAsync(string configuration, TextWri
     /// <param name="configuration">The string configuration to use for this client.</param>
     /// <param name="configure">Action to further modify the parsed configuration options.</param>
     /// <param name="log">The <see cref="TextWriter"/> to log to.</param>
-    public static async Task<RedisClient> ConnectAsync(string configuration, Action<ConfigurationOptions> configure, TextWriter? log = null)
+    public static async Task<IRedisClient> ConnectAsync(string configuration, Action<ConfigurationOptions> configure, TextWriter? log = null)
     {
         Action<ConfigurationOptions> config = (ConfigurationOptions config) =>
         {
@@ -46,7 +46,7 @@ public static async Task<RedisClient> ConnectAsync(string configuration, Action<
     /// <param name="configuration">The configuration options to use for this client.</param>
     /// <param name="log">The <see cref="TextWriter"/> to log to.</param>
     /// <remarks>Note: For Sentinel, do <b>not</b> specify a <see cref="ConfigurationOptions.CommandMap"/> - this is handled automatically.</remarks>
-    public static async Task<RedisClient> ConnectAsync(ConfigurationOptions configuration, TextWriter? log = null)
+    public static async Task<IRedisClient> ConnectAsync(ConfigurationOptions configuration, TextWriter? log = null)
     {
         SetNames(configuration);
         return new RedisClient(await ConnectionMultiplexer.ConnectAsync(configuration, log));
@@ -55,9 +55,9 @@ public static async Task<RedisClient> ConnectAsync(ConfigurationOptions configur
     /// <summary>
     /// Creates a new <see cref="RedisClient"/> instance.
     /// </summary>
-    /// <param name="configuration">The string configuration to use for this client.</param>
+    /// <param name="configuration">The string configuration to use for this client. See the StackExchange.Redis configuration documentation(https://stackexchange.github.io/StackExchange.Redis/Configuration) for detailed information.</param>
     /// <param name="log">The <see cref="TextWriter"/> to log to.</param>
-    public static RedisClient Connect(string configuration, TextWriter? log = null) =>
+    public static IRedisClient Connect(string configuration, TextWriter? log = null) =>
          Connect(ConfigurationOptions.Parse(configuration), log);
 
     /// <summary>
@@ -66,7 +66,7 @@ public static RedisClient Connect(string configuration, TextWriter? log = null)
     /// <param name="configuration">The string configuration to use for this client.</param>
     /// <param name="configure">Action to further modify the parsed configuration options.</param>
     /// <param name="log">The <see cref="TextWriter"/> to log to.</param>
-    public static RedisClient Connect(string configuration, Action<ConfigurationOptions> configure, TextWriter? log = null)
+    public static IRedisClient Connect(string configuration, Action<ConfigurationOptions> configure, TextWriter? log = null)
     {
         Action<ConfigurationOptions> config = (ConfigurationOptions config) =>
         {
@@ -82,7 +82,7 @@ public static RedisClient Connect(string configuration, Action<ConfigurationOpti
     /// <param name="configuration">The configuration options to use for this client.</param>
     /// <param name="log">The <see cref="TextWriter"/> to log to.</param>
     /// <remarks>Note: For Sentinel, do <b>not</b> specify a <see cref="ConfigurationOptions.CommandMap"/> - this is handled automatically.</remarks>
-    public static RedisClient Connect(ConfigurationOptions configuration, TextWriter? log = null)
+    public static IRedisClient Connect(ConfigurationOptions configuration, TextWriter? log = null)
     {
         SetNames(configuration);
         return new RedisClient(ConnectionMultiplexer.Connect(configuration, log));
@@ -104,7 +104,7 @@ public IRedisDatabase GetDatabase(int db = -1, object? asyncState = null)
     /// Gets the underlying <see cref="ConnectionMultiplexer"/> instance.
     /// </summary>
     /// <returns></returns>
-    public ConnectionMultiplexer GetMultiplexer()
+    public IConnectionMultiplexer GetMultiplexer()
     {
         return _multiplexer;
     }

tests/NRedisStack.Tests/ClientInfoTests.cs

@@ -57,7 +57,7 @@ public void TestRedisClientInfoOnReconnect()
     {
         bool reconnected = false;
         bool hang = false;
-        RedisClient rc = RedisClient.Connect(GetEndpoint());
+        IRedisClient rc = RedisClient.Connect(GetEndpoint());
         IRedisDatabase db = rc.GetDatabase();
         db.Multiplexer.ConnectionRestored += (sender, e) => reconnected = true;
 
@@ -100,7 +100,7 @@ public void TestConnectionMultiplexerConnect()
     [InlineData] // No parameters passed, but still uses Theory
     public void TestRedisClientConnect()
     {
-        RedisClient rc = RedisClient.Connect(GetEndpoint());
+        IRedisClient rc = RedisClient.Connect(GetEndpoint());
         IRedisDatabase db = rc.GetDatabase();
         db.StringSetAsync("key1", "something");
         Assert.Contains("lib-name=NRedisStack", db.Execute("CLIENT", "INFO").ToString());
@@ -116,7 +116,7 @@ public void TestRedisClientConnectWithConfigOptions()
             LibraryName = "TestLib",
         };
 
-        RedisClient rc = RedisClient.Connect(config);
+        IRedisClient rc = RedisClient.Connect(config);
         IRedisDatabase db = rc.GetDatabase();
         db.StringSetAsync("key1", "something");
         Assert.Contains("lib-name=TestLib", db.Execute("CLIENT", "INFO").ToString());