- add explicit connection failure type

- burn the connection on failure - add initial metrics
StackExchange · Jun 20, 2024 · 3a9d8c9 · 3a9d8c9
1 parent 75ae891
commit 3a9d8c9
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 7 deletions.
diff --git a/src/StackExchange.Redis/Enums/ConnectionFailureType.cs b/src/StackExchange.Redis/Enums/ConnectionFailureType.cs
@@ -44,6 +44,10 @@ public enum ConnectionFailureType
         /// <summary>
         /// It has not been possible to create an initial connection to the redis server(s).
         /// </summary>
-        UnableToConnect
+        UnableToConnect,
+        /// <summary>
+        /// High-integrity mode was enabled, and a failure was detected
+        /// </summary>
+        ResponseIntegrityFailure,
     }
 }
diff --git a/src/StackExchange.Redis/PhysicalConnection.cs b/src/StackExchange.Redis/PhysicalConnection.cs
@@ -1705,7 +1705,10 @@ private void MatchResult(in RawResult result)
             if (_awaitingToken is not null && (msg = Interlocked.Exchange(ref _awaitingToken, null)) is not null)
             {
                 _readStatus = ReadStatus.ResponseSequenceCheck;
-                ProcessHighIntegrityResponseToken(msg, in result, BridgeCouldBeNull);
+                if (!ProcessHighIntegrityResponseToken(msg, in result, BridgeCouldBeNull))
+                {
+                    RecordConnectionFailed(ConnectionFailureType.ResponseIntegrityFailure, origin: nameof(ReadStatus.ResponseSequenceCheck));
+                }
                 return;
             }
 
@@ -1745,7 +1748,7 @@ private void MatchResult(in RawResult result)
             _readStatus = ReadStatus.MatchResultComplete;
             _activeMessage = null;
 
-            static void ProcessHighIntegrityResponseToken(Message message, in RawResult result, PhysicalBridge? bridge)
+            static bool ProcessHighIntegrityResponseToken(Message message, in RawResult result, PhysicalBridge? bridge)
             {
                 bool isValid = false;
                 if (result.Resp2TypeBulkString == ResultType.BulkString)
@@ -1762,20 +1765,21 @@ static void ProcessHighIntegrityResponseToken(Message message, in RawResult resu
                         {
                             Span<byte> span = stackalloc byte[4];
                             payload.CopyTo(span);
-                            interpreted = BinaryPrimitives.ReadUInt32LittleEndian(payload.First.Span);
+                            interpreted = BinaryPrimitives.ReadUInt32LittleEndian(span);
                         }
                         isValid = interpreted == message.HighIntegrityToken;
                     }
                 }
                 if (isValid)
                 {
                     message.Complete();
+                    return true;
                 }
                 else
                 {
                     message.SetExceptionAndComplete(new InvalidOperationException("High-integrity mode detected possible protocol de-sync"), bridge);
+                    return false;
                 }
-
             }
 
             static bool TryGetPubSubPayload(in RawResult value, out RedisValue parsed, bool allowArraySingleton = true)

diff --git a/src/StackExchange.Redis/PublicAPI/PublicAPI.Shipped.txt b/src/StackExchange.Redis/PublicAPI/PublicAPI.Shipped.txt
@@ -321,6 +321,7 @@ StackExchange.Redis.ConnectionFailureType.ProtocolFailure = 4 -> StackExchange.R
 StackExchange.Redis.ConnectionFailureType.SocketClosed = 6 -> StackExchange.Redis.ConnectionFailureType
 StackExchange.Redis.ConnectionFailureType.SocketFailure = 2 -> StackExchange.Redis.ConnectionFailureType
 StackExchange.Redis.ConnectionFailureType.UnableToConnect = 9 -> StackExchange.Redis.ConnectionFailureType
+StackExchange.Redis.ConnectionFailureType.ResponseIntegrityFailure = 10 -> StackExchange.Redis.ConnectionFailureType
 StackExchange.Redis.ConnectionFailureType.UnableToResolvePhysicalConnection = 1 -> StackExchange.Redis.ConnectionFailureType
 StackExchange.Redis.ConnectionMultiplexer
 StackExchange.Redis.ConnectionMultiplexer.ClientName.get -> string!

diff --git a/src/StackExchange.Redis/PublicAPI/PublicAPI.Unshipped.txt b/src/StackExchange.Redis/PublicAPI/PublicAPI.Unshipped.txt
@@ -1 +1 @@
-
+#nullable enable
diff --git a/tests/ConsoleTest/Program.cs b/tests/ConsoleTest/Program.cs
@@ -6,13 +6,24 @@
 stopwatch.Start();
 
 var options = ConfigurationOptions.Parse("localhost");
+#if !SEREDIS_BASELINE
+options.HighIntegrity = false; // as needed
+Console.WriteLine($"{nameof(options.HighIntegrity)}: {options.HighIntegrity}");
+#endif
+
 //options.SocketManager = SocketManager.ThreadPool;
 var connection = ConnectionMultiplexer.Connect(options);
+connection.ConnectionFailed += Connection_ConnectionFailed;
+
+void Connection_ConnectionFailed(object? sender, ConnectionFailedEventArgs e)
+{
+    Console.Error.WriteLine($"CONNECTION FAILED: {e.ConnectionType}, {e.FailureType}, {e.Exception}");
+}
 
 var startTime = DateTime.UtcNow;
 var startCpuUsage = Process.GetCurrentProcess().TotalProcessorTime;
 
-var scenario = args?.Length > 0 ? args[0] : "parallel";
+var scenario = args?.Length > 0 ? args[0] : "mass-insert";
 
 switch (scenario)
 {

diff --git a/tests/ConsoleTestBaseline/ConsoleTestBaseline.csproj b/tests/ConsoleTestBaseline/ConsoleTestBaseline.csproj
@@ -5,6 +5,7 @@
     <OutputType>Exe</OutputType>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
+    <DefineConstants>$(DefineConstants);SEREDIS_BASELINE</DefineConstants>
   </PropertyGroup>
 
   <ItemGroup>