Merge branch 'main' into marc/v3

Author: mgravell

Directory.Build.props

@@ -10,7 +10,7 @@
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
     <CodeAnalysisRuleset>$(MSBuildThisFileDirectory)Shared.ruleset</CodeAnalysisRuleset>
     <MSBuildWarningsAsMessages>NETSDK1069</MSBuildWarningsAsMessages>
-    <NoWarn>$(NoWarn);NU5105;NU1507;SER001;SER002;SER003;SER004;SER005</NoWarn>
+    <NoWarn>$(NoWarn);NU5105;NU1507;SER001;SER002;SER003;SER004;SER005;SER006</NoWarn>
     <PackageReleaseNotes>https://stackexchange.github.io/StackExchange.Redis/ReleaseNotes</PackageReleaseNotes>
     <PackageProjectUrl>https://stackexchange.github.io/StackExchange.Redis/</PackageProjectUrl>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>

docs/ReleaseNotes.md

@@ -8,7 +8,14 @@ Current package versions:
 
 ## Unreleased
 
-- (none)
+- none
+
+## 2.12.8
+
+- Add [`GCRA`](https://en.wikipedia.org/wiki/Generic_cell_rate_algorithm) support (and remove experimental flag on `VSIM`) ([#3041 by @mgravell](https://github.com/StackExchange/StackExchange.Redis/pull/3041))
+- Add `IServer.GetProductVariant` to detect the product variant and version of the connected server, and use that internally
+  to enable multi-DB operations on Valkey clusters ([#3040 by @mgravell](https://github.com/StackExchange/StackExchange.Redis/pull/3040))
+- Ignore cluster nodes with the `handshake` flag ([#3043 by @TimLovellSmith](https://github.com/StackExchange/StackExchange.Redis/pull/3043))
 
 ## 2.12.4
 

docs/exp/SER006.md

@@ -0,0 +1,24 @@
+Redis 8.8 is currently in preview and may be subject to change.
+
+New features in Redis 8.8:
+
+- `GCRA` for rate-limiting  
+
+The corresponding library feature must also be considered subject to change:
+
+1. Existing bindings may cease working correctly if the underlying server API changes.
+2. Changes to the server API may require changes to the library API, manifesting in either/both of build-time
+   or run-time breaks. 
+
+While this seems *unlikely*, it must be considered a possibility. If you acknowledge this, you can suppress
+this warning by adding the following to your `csproj` file:
+
+```xml
+<NoWarn>$(NoWarn);SER006</NoWarn>
+```
+
+or more granularly / locally in C#:
+
+``` c#
+#pragma warning disable SER006
+```

src/RESPite/Messages/RespReader.cs

@@ -1852,30 +1852,54 @@ public readonly decimal ReadDecimal()
     }
 
     /// <summary>
-    /// Read the current element as a <see cref="bool"/> value.
+    /// Try to read the current element as a <see cref="bool"/> value.
     /// </summary>
-    public readonly bool ReadBoolean()
+    /// <param name="value">The parsed boolean value if successful.</param>
+    /// <returns>True if the value was successfully parsed; false otherwise.</returns>
+    public readonly bool TryReadBoolean(out bool value)
     {
         var span = Buffer(stackalloc byte[2]);
         switch (span.Length)
         {
             case 1:
                 switch (span[0])
                 {
-                    case (byte)'0' when Prefix == RespPrefix.Integer: return false;
-                    case (byte)'1' when Prefix == RespPrefix.Integer: return true;
-                    case (byte)'f' when Prefix == RespPrefix.Boolean: return false;
-                    case (byte)'t' when Prefix == RespPrefix.Boolean: return true;
+                    case (byte)'0' when Prefix == RespPrefix.Integer:
+                        value = false;
+                        return true;
+                    case (byte)'1' when Prefix == RespPrefix.Integer:
+                        value = true;
+                        return true;
+                    case (byte)'f' when Prefix == RespPrefix.Boolean:
+                        value = false;
+                        return true;
+                    case (byte)'t' when Prefix == RespPrefix.Boolean:
+                        value = true;
+                        return true;
                 }
 
                 break;
-            case 2 when Prefix == RespPrefix.SimpleString && IsOK(): return true;
+            case 2 when Prefix == RespPrefix.SimpleString && IsOK():
+                value = true;
+                return true;
         }
 
-        ThrowFormatException();
+        value = false;
         return false;
     }
 
+    /// <summary>
+    /// Read the current element as a <see cref="bool"/> value.
+    /// </summary>
+    public readonly bool ReadBoolean()
+    {
+        if (!TryReadBoolean(out var value))
+        {
+            ThrowFormatException();
+        }
+        return value;
+    }
+
     /// <summary>
     /// Parse a scalar value as an enum of type <typeparamref name="T"/>.
     /// </summary>

src/RESPite/PublicAPI/PublicAPI.Unshipped.txt

@@ -155,6 +155,7 @@
 [SER004]RESPite.Messages.RespReader.ProtocolBytesRemaining.get -> long
 [SER004]RESPite.Messages.RespReader.ReadArray<TResult>(RESPite.Messages.RespReader.Projection<TResult>! projection, bool scalar = false) -> TResult[]?
 [SER004]RESPite.Messages.RespReader.ReadBoolean() -> bool
+[SER004]RESPite.Messages.RespReader.TryReadBoolean(out bool value) -> bool
 [SER004]RESPite.Messages.RespReader.ReadByteArray() -> byte[]?
 [SER004]RESPite.Messages.RespReader.ReadDecimal() -> decimal
 [SER004]RESPite.Messages.RespReader.ReadDouble() -> double

src/RESPite/Shared/Experiments.cs

@@ -8,11 +8,11 @@ internal static class Experiments
         public const string UrlFormat = "https://stackexchange.github.io/StackExchange.Redis/exp/";
 
         // ReSharper disable InconsistentNaming
-        public const string VectorSets = "SER001";
         public const string Server_8_4 = "SER002";
         public const string Server_8_6 = "SER003";
         public const string Respite = "SER004";
         public const string UnitTesting = "SER005";
+        public const string Server_8_8 = "SER006";
         // ReSharper restore InconsistentNaming
     }
 }

src/StackExchange.Redis/AutoConfigureInfoField.cs

@@ -0,0 +1,49 @@
+using System;
+using RESPite;
+
+namespace StackExchange.Redis;
+
+/// <summary>
+/// Fields that can appear in INFO output during auto-configuration.
+/// </summary>
+internal enum AutoConfigureInfoField
+{
+    /// <summary>
+    /// Unknown or unrecognized field.
+    /// </summary>
+    [AsciiHash("")]
+    Unknown = 0,
+
+    [AsciiHash("role")]
+    Role,
+
+    [AsciiHash("master_host")]
+    MasterHost,
+
+    [AsciiHash("master_port")]
+    MasterPort,
+
+    [AsciiHash("redis_version")]
+    RedisVersion,
+
+    [AsciiHash("redis_mode")]
+    RedisMode,
+
+    [AsciiHash("run_id")]
+    RunId,
+
+    [AsciiHash("garnet_version")]
+    GarnetVersion,
+
+    [AsciiHash("valkey_version")]
+    ValkeyVersion,
+}
+
+/// <summary>
+/// Metadata and parsing methods for <see cref="AutoConfigureInfoField"/>.
+/// </summary>
+internal static partial class AutoConfigureInfoFieldMetadata
+{
+    [AsciiHash]
+    internal static partial bool TryParse(ReadOnlySpan<char> value, out AutoConfigureInfoField field);
+}

src/StackExchange.Redis/ClusterConfiguration.cs

@@ -308,6 +308,7 @@ internal ClusterNode(ClusterConfiguration configuration, string raw, EndPoint or
             }
 
             NodeId = parts[0];
+            IsHandshake = flags.Contains("handshake");
             IsFail = flags.Contains("fail");
             IsPossiblyFail = flags.Contains("fail?");
             IsReplica = flags.Contains("slave") || flags.Contains("replica");
@@ -377,6 +378,12 @@ public IList<ClusterNode> Children
         [Browsable(false), EditorBrowsable(EditorBrowsableState.Never)]
         public bool IsSlave => IsReplica;
 
+        /// <summary>
+        /// The handshake flag is set for nodes which are currently in the process of joining the cluster.
+        /// They might not be fully configured, node IDs and slot ranges are placeholder information, and endpoint details 'best guess'.
+        /// </summary>
+        public bool IsHandshake { get; }
+
         /// <summary>
         /// Gets whether this node is a replica.
         /// </summary>
@@ -417,6 +424,10 @@ public IList<ClusterNode> Children
         /// </summary>
         public IList<SlotRange> Slots { get; }
 
+        // Be resilient to "handshake" nodes, which are nodes that are in the process of joining the cluster and hence might not have all information available yet.
+        // These nodes will be included in the configuration once they finish the handshake process and are fully part of the cluster, so we can safely ignore them for now.
+        internal bool IgnoreFromClient => IsHandshake; // possibly also noaddr?
+
         /// <summary>
         /// Compares the current instance with another object of the same type and returns an integer that indicates
         /// whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

src/StackExchange.Redis/ConnectionMultiplexer.cs

@@ -1759,7 +1759,7 @@ public EndPoint[] GetEndPoints(bool configuredOnly = false) =>
                 {
                     return null;
                 }
-                var clusterEndpoints = new EndPointCollection(clusterConfig.Nodes.Where(node => node.EndPoint is not null).Select(node => node.EndPoint!).ToList());
+                var clusterEndpoints = new EndPointCollection(clusterConfig.Nodes.Where(node => node.EndPoint is not null && !node.IgnoreFromClient).Select(node => node.EndPoint!).ToList());
                 // Loop through nodes in the cluster and update nodes relations to other nodes
                 ServerEndPoint? serverEndpoint = null;
                 foreach (EndPoint endpoint in clusterEndpoints)
@@ -1932,7 +1932,7 @@ internal void UpdateClusterRange(ClusterConfiguration configuration)
             }
             foreach (var node in configuration.Nodes)
             {
-                if (node.IsReplica || node.Slots.Count == 0) continue;
+                if (node.IgnoreFromClient || node.IsReplica || node.Slots.Count == 0) continue;
                 foreach (var slot in node.Slots)
                 {
                     if (GetServerEndPoint(node.EndPoint) is ServerEndPoint server)

src/StackExchange.Redis/Enums/ProductVariant.cs

@@ -0,0 +1,28 @@
+// ReSharper disable once CheckNamespace
+namespace StackExchange.Redis;
+
+/// <summary>
+/// Indicates the flavor of RESP-server being used, if known. Unknown variants will be reported as <see cref="Redis"/>.
+/// Inclusion (or omission) in this list does not imply support for any given variant; nor does it indicate any specific
+/// relationship with the vendor or rights to use the name. It is provided solely for informational purposes. Identification
+/// is not guaranteed, and is based on the server's self-reporting (typically via `INFO`), which may be incomplete or misleading.
+/// </summary>
+public enum ProductVariant
+{
+    /// <summary>
+    /// The original Redis server. This is also the default value if the variant is unknown.
+    /// </summary>
+    Redis,
+
+    /// <summary>
+    /// <a href="https://valkey.io/">Valkey</a> is a fork of open-source Redis associated with AWS.
+    /// </summary>
+    Valkey,
+
+    /// <summary>
+    /// <a href="https://microsoft.github.io/garnet/">Garnet</a> is a Redis-compatible server from Microsoft.
+    /// </summary>
+    Garnet,
+
+    // if you want to add another variant here, please open an issue with the details (variant name, INFO output, etc.)
+}