Socket routing improvements, unit test cleanup (#276)

Updated WebSocket message routing improving performance for scenarios with multiple different subscriptions and topics Added AddCommaSeparated helper for Enum value arrays to ParameterCollection Improved EnumConverter performance and removed string allocation for happy path Fixed CreateParamString extension method for ArrayParametersSerialization.Json Fixed Shared GetOrderBookOptions and GetRecentTradeOptions base validations not being called
2026-08-11 16:32:57 +00:00 · 2026-04-08 13:04:18 +02:00
parent 93034e8af8
commit 4e2dc564dd
63 changed files with 3134 additions and 1498 deletions
@@ -0,0 +1,20 @@
+using CryptoExchange.Net.Authentication;
+using CryptoExchange.Net.Clients;
+using CryptoExchange.Net.Objects;
+using System.Collections.Generic;
+
+namespace CryptoExchange.Net.UnitTests.Implementations
+{
+    internal class TestAuthenticationProvider : AuthenticationProvider<TestCredentials, TestCredentials>
+    {
+        public TestAuthenticationProvider(TestCredentials credentials) : base(credentials, credentials)
+        {
+        }
+
+        public override void ProcessRequest(RestApiClient apiClient, RestRequestConfiguration requestConfig)
+        {
+            requestConfig.Headers ??= new Dictionary<string, string>();
+            requestConfig.Headers["Authorization"] = Credential.Key;
+        }
+    }
+}
@@ -0,0 +1,30 @@
+using CryptoExchange.Net.Authentication;
+using System;
+
+namespace CryptoExchange.Net.UnitTests.Implementations
+{
+    internal class TestCredentials : HMACCredential
+    {
+        public TestCredentials() { }
+
+        public TestCredentials(string key, string secret) : base(key, secret)
+        {
+        }
+
+        public TestCredentials(HMACCredential credential) : base(credential.Key, credential.Secret)
+        {
+        }
+
+        public TestCredentials WithHMAC(string key, string secret)
+        {
+            if (!string.IsNullOrEmpty(Key)) throw new InvalidOperationException("Credentials already set");
+
+            Key = key;
+            Secret = secret;
+            return this;
+        }
+
+        /// <inheritdoc />
+        public override ApiCredentials Copy() => new TestCredentials(this);
+    }
+}
@@ -0,0 +1,64 @@
+using CryptoExchange.Net.Objects;
+
+namespace CryptoExchange.Net.UnitTests.Implementations
+{
+    internal class TestEnvironment : TradeEnvironment
+    {
+        public string RestClientAddress { get; }
+        public string SocketClientAddress { get; }
+
+        internal TestEnvironment(
+            string name,
+            string restAddress,
+            string streamAddress) :
+            base(name)
+        {
+            RestClientAddress = restAddress;
+            SocketClientAddress = streamAddress;
+        }
+
+#pragma warning disable CS8618 // Non-nullable field must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring as nullable.
+        public TestEnvironment() : base(TradeEnvironmentNames.Live)
+#pragma warning restore CS8618 // Non-nullable field must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring as nullable.
+        { }
+
+        /// <summary>
+        /// Get the environment by name
+        /// </summary>
+        public static TestEnvironment? GetEnvironmentByName(string? name)
+         => name switch
+         {
+             TradeEnvironmentNames.Live => Live,
+             "" => Live,
+             null => Live,
+             _ => default
+         };
+
+        /// <summary>
+        /// Available environment names
+        /// </summary>
+        /// <returns></returns>
+        public static string[] All => [Live.Name];
+
+        /// <summary>
+        /// Live environment
+        /// </summary>
+        public static TestEnvironment Live { get; }
+            = new TestEnvironment(TradeEnvironmentNames.Live,
+                                     "https://localhost",
+                                     "wss://localhost");
+
+        /// <summary>
+        /// Create a custom environment
+        /// </summary>
+        /// <param name="name"></param>
+        /// <param name="spotRestAddress"></param>
+        /// <param name="spotSocketStreamsAddress"></param>
+        /// <returns></returns>
+        public static TestEnvironment CreateCustom(
+                        string name,
+                        string spotRestAddress,
+                        string spotSocketStreamsAddress)
+            => new TestEnvironment(name, spotRestAddress, spotSocketStreamsAddress);
+    }
+}
@@ -0,0 +1,14 @@
+using System.Text.Json.Serialization;
+
+namespace CryptoExchange.Net.UnitTests.Implementations
+{
+    public class TestObject
+    {
+        [JsonPropertyName("other")]
+        public string StringData { get; set; } = string.Empty;
+        [JsonPropertyName("intData")]
+        public int IntData { get; set; }
+        [JsonPropertyName("decimalData")]
+        public decimal DecimalData { get; set; }
+    }
+}
@@ -0,0 +1,25 @@
+using CryptoExchange.Net.Objects;
+using CryptoExchange.Net.Objects.Errors;
+using CryptoExchange.Net.Sockets;
+using CryptoExchange.Net.Sockets.Default;
+using CryptoExchange.Net.Sockets.Default.Routing;
+using System;
+
+namespace CryptoExchange.Net.UnitTests.Implementations
+{
+    internal class TestQuery : Query<TestSocketMessage>
+    {
+        public TestQuery(TestSocketMessage request, bool authenticated) : base(request, authenticated, 1)
+        {
+            MessageRouter = MessageRouter.CreateWithoutTopicFilter<TestSocketMessage>(request.Id.ToString(), HandleMessage);
+        }
+
+        private CallResult? HandleMessage(SocketConnection connection, DateTime time, string? arg3, TestSocketMessage message)
+        {
+            if (message.Data != "OK")
+                return new CallResult(new ServerError(ErrorInfo.Unknown with { Message = message.Data }));
+
+            return CallResult.SuccessResult;
+        }
+    }
+}
@@ -0,0 +1,64 @@
+using CryptoExchange.Net.Clients;
+using CryptoExchange.Net.Converters.MessageParsing.DynamicConverters;
+using CryptoExchange.Net.Converters.SystemTextJson;
+using CryptoExchange.Net.Interfaces;
+using CryptoExchange.Net.Objects;
+using CryptoExchange.Net.SharedApis;
+using CryptoExchange.Net.Testing.Implementations;
+using Microsoft.Extensions.Logging;
+using System;
+using System.IO;
+using System.Net;
+using System.Net.Http;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace CryptoExchange.Net.UnitTests.Implementations
+{
+    internal class TestRestApiClient : RestApiClient<TestEnvironment, TestAuthenticationProvider, TestCredentials>
+    {
+        protected override IRestMessageHandler MessageHandler { get; } = new TestRestMessageHandler();
+
+        public TestRestApiClient(ILogger logger, HttpClient? httpClient, TestRestOptions options) 
+            : base(logger, httpClient, options.Environment.RestClientAddress, options, options.ExchangeOptions)
+        {
+        }
+
+
+        public override string FormatSymbol(string baseAsset, string quoteAsset, TradingMode tradingMode, DateTime? deliverDate = null) =>
+            baseAsset + quoteAsset;
+
+        protected override TestAuthenticationProvider CreateAuthenticationProvider(TestCredentials credentials) =>
+            new TestAuthenticationProvider(credentials);
+
+        protected override IMessageSerializer CreateSerializer() => new SystemTextJsonMessageSerializer(SerializerOptions.WithConverters(new TestSerializerContext()));
+
+        internal void SetNextResponse(string data, HttpStatusCode code)
+        {
+            var expectedBytes = Encoding.UTF8.GetBytes(data);
+            var responseStream = new MemoryStream();
+            responseStream.Write(expectedBytes, 0, expectedBytes.Length);
+            responseStream.Seek(0, SeekOrigin.Begin);
+
+            var response = new TestResponse(code, responseStream);
+            var request = new TestRequest(response);
+
+            var factory = new TestRequestFactory(request);
+            RequestFactory = factory;
+        }
+
+        internal async Task<WebCallResult<T>> GetResponseAsync<T>(HttpMethod? httpMethod = null, ParameterCollection? collection = null)
+        {
+            var definition = new RequestDefinition("/path", httpMethod ?? HttpMethod.Get)
+            {
+                Weight = 0
+            };
+            return await SendAsync<T>(BaseAddress, definition, collection ?? new ParameterCollection(), default);
+        }
+
+        internal void SetParameterPosition(HttpMethod httpMethod, HttpMethodParameterPosition pos)
+        {
+            ParameterPositions[httpMethod] = pos;
+        }
+    }
+}
@@ -0,0 +1,27 @@
+using CryptoExchange.Net.Clients;
+using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Options;
+using System;
+using System.Net.Http;
+
+namespace CryptoExchange.Net.UnitTests.Implementations
+{
+    internal class TestRestClient : BaseRestClient<TestEnvironment, TestCredentials>
+    {
+        public TestRestApiClient ApiClient1 { get; set; }
+        public TestRestApiClient ApiClient2 { get; set; }
+
+        public TestRestClient(Action<TestRestOptions>? optionsDelegate = null)
+            : this(null, null, Options.Create(ApplyOptionsDelegate(optionsDelegate)))
+        {
+        }
+
+        public TestRestClient(HttpClient? httpClient, ILoggerFactory? loggerFactory, IOptions<TestRestOptions> options) : base(loggerFactory, "Test")
+        {
+            Initialize(options.Value);
+
+            ApiClient1 = AddApiClient(new TestRestApiClient(_logger, httpClient, options.Value));
+            ApiClient2 = AddApiClient(new TestRestApiClient(_logger, httpClient, options.Value));
+        }
+    }
+}
@@ -0,0 +1,33 @@
+using CryptoExchange.Net.Converters.SystemTextJson;
+using CryptoExchange.Net.Converters.SystemTextJson.MessageHandlers;
+using CryptoExchange.Net.Objects;
+using CryptoExchange.Net.Objects.Errors;
+using System.IO;
+using System.Net.Http.Headers;
+using System.Text.Json;
+using System.Threading.Tasks;
+
+namespace CryptoExchange.Net.UnitTests.Implementations
+{
+    internal class TestRestMessageHandler : JsonRestMessageHandler
+    {
+        public override JsonSerializerOptions Options { get; } = SerializerOptions.WithConverters(new TestSerializerContext());
+
+        public override async ValueTask<Error> ParseErrorResponse(int httpStatusCode, HttpResponseHeaders responseHeaders, Stream responseStream)
+        {
+            var (jsonError, jsonDocument) = await GetJsonDocument(responseStream).ConfigureAwait(false);
+            if (jsonError != null)
+                return jsonError;
+
+            int? code = jsonDocument!.RootElement.TryGetProperty("errorCode", out var codeProp) ? codeProp.GetInt32() : null;
+            var msg = jsonDocument.RootElement.TryGetProperty("errorMessage", out var msgProp) ? msgProp.GetString() : null;
+            if (msg == null)
+                return new ServerError(ErrorInfo.Unknown);
+
+            if (code == null)
+                return new ServerError(ErrorInfo.Unknown with { Message = msg });
+
+            return new ServerError(code.Value, new ErrorInfo(ErrorType.Unknown, false, "Error") with { Message = msg });
+        }
+    }
+}
@@ -0,0 +1,27 @@
+using CryptoExchange.Net.Objects.Options;
+
+namespace CryptoExchange.Net.UnitTests.Implementations
+{
+    internal class TestRestOptions : RestExchangeOptions<TestEnvironment, TestCredentials>
+    {
+        internal static TestRestOptions Default { get; set; } = new TestRestOptions()
+        {
+            Environment = TestEnvironment.Live,
+            AutoTimestamp = true
+        };
+
+        public TestRestOptions()
+        {
+            Default?.Set(this);
+        }
+
+        public RestApiOptions ExchangeOptions { get; private set; } = new RestApiOptions();
+
+        internal TestRestOptions Set(TestRestOptions targetOptions)
+        {
+            targetOptions = base.Set<TestRestOptions>(targetOptions);
+            targetOptions.ExchangeOptions = ExchangeOptions.Set(targetOptions.ExchangeOptions);
+            return targetOptions;
+        }
+    }
+}
@@ -0,0 +1,29 @@
+using CryptoExchange.Net.UnitTests.ConverterTests;
+using CryptoExchange.Net.UnitTests.Implementations;
+using System.Collections.Generic;
+using System.Text.Json.Serialization;
+
+namespace CryptoExchange.Net.UnitTests
+{
+    [JsonSerializable(typeof(string))]
+    [JsonSerializable(typeof(int))]
+    [JsonSerializable(typeof(Dictionary<string, string>))]
+    [JsonSerializable(typeof(IDictionary<string, string>))]
+    [JsonSerializable(typeof(Dictionary<string, object>))]
+    [JsonSerializable(typeof(IDictionary<string, object>))]
+    [JsonSerializable(typeof(TestObject))]
+
+    [JsonSerializable(typeof(TestSocketMessage))]
+    [JsonSerializable(typeof(Test))]
+    [JsonSerializable(typeof(Test2))]
+    [JsonSerializable(typeof(Test3))]
+    [JsonSerializable(typeof(NotNullableSTJBoolObject))]
+    [JsonSerializable(typeof(STJBoolObject))]
+    [JsonSerializable(typeof(NotNullableSTJEnumObject))]
+    [JsonSerializable(typeof(STJEnumObject))]
+    [JsonSerializable(typeof(STJDecimalObject))]
+    [JsonSerializable(typeof(STJTimeObject))]
+    internal partial class TestSerializerContext : JsonSerializerContext
+    {
+    }
+}
@@ -0,0 +1,44 @@
+using CryptoExchange.Net.Clients;
+using CryptoExchange.Net.Converters.MessageParsing.DynamicConverters;
+using CryptoExchange.Net.Converters.SystemTextJson;
+using CryptoExchange.Net.Interfaces;
+using CryptoExchange.Net.Objects;
+using CryptoExchange.Net.Objects.Options;
+using CryptoExchange.Net.Objects.Sockets;
+using CryptoExchange.Net.SharedApis;
+using Microsoft.Extensions.Logging;
+using System;
+using System.Net.Http;
+using System.Net.WebSockets;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace CryptoExchange.Net.UnitTests.Implementations
+{
+    internal class TestSocketApiClient : SocketApiClient<TestEnvironment, TestAuthenticationProvider, TestCredentials>
+    {
+        public TestSocketApiClient(ILogger logger, TestSocketOptions options)
+            : base(logger, options.Environment.SocketClientAddress, options, options.ExchangeOptions)
+        {
+        }
+
+        public TestSocketApiClient(ILogger logger, HttpClient httpClient, string baseAddress, TestSocketOptions options, SocketApiOptions apiOptions)
+            : base(logger, baseAddress, options, apiOptions)
+        {
+        }
+
+        public override ISocketMessageHandler CreateMessageConverter(WebSocketMessageType messageType) => new TestSocketMessageHandler();
+        protected internal override IMessageSerializer CreateSerializer() => new SystemTextJsonMessageSerializer(SerializerOptions.WithConverters(new TestSerializerContext()));
+
+        public override string FormatSymbol(string baseAsset, string quoteAsset, TradingMode tradingMode, DateTime? deliverDate = null) =>
+            baseAsset + quoteAsset;
+
+        protected override TestAuthenticationProvider CreateAuthenticationProvider(TestCredentials credentials) =>
+            new TestAuthenticationProvider(credentials);
+
+        public async Task<CallResult<UpdateSubscription>> SubscribeToUpdatesAsync<T>(Action<DataEvent<T>> handler, bool subQuery, CancellationToken ct)
+        {
+            return await base.SubscribeAsync(new TestSubscription<T>(_logger, handler, subQuery, false), ct);
+        }
+    }
+}
@@ -0,0 +1,26 @@
+using CryptoExchange.Net.Clients;
+using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Options;
+using System;
+
+namespace CryptoExchange.Net.UnitTests.Implementations
+{
+    internal class TestSocketClient : BaseSocketClient<TestEnvironment, TestCredentials>
+    {
+        public TestSocketApiClient ApiClient1 { get; set; }
+        public TestSocketApiClient ApiClient2 { get; set; }
+
+        public TestSocketClient(Action<TestSocketOptions>? optionsDelegate = null)
+            : this(null, Options.Create(ApplyOptionsDelegate(optionsDelegate)))
+        {
+        }
+
+        public TestSocketClient(ILoggerFactory? loggerFactory, IOptions<TestSocketOptions> options) : base(loggerFactory, "Test")
+        {
+            Initialize(options.Value);
+
+            ApiClient1 = AddApiClient(new TestSocketApiClient(_logger, options.Value));
+            ApiClient2 = AddApiClient(new TestSocketApiClient(_logger, options.Value));
+        }
+    }
+}
@@ -0,0 +1,16 @@
+using Newtonsoft.Json;
+using System;
+using System.Collections.Generic;
+using System.Text;
+using System.Text.Json.Serialization;
+
+namespace CryptoExchange.Net.UnitTests.Implementations
+{
+    internal record TestSocketMessage
+    {
+        [JsonPropertyName("id")]
+        public int Id { get; set; }
+        [JsonPropertyName("data")]
+        public string Data { get; set; } = string.Empty;
+    }
+}
@@ -0,0 +1,33 @@
+using CryptoExchange.Net.Converters.MessageParsing.DynamicConverters;
+using CryptoExchange.Net.Converters.SystemTextJson;
+using CryptoExchange.Net.Converters.SystemTextJson.MessageHandlers;
+using System.Text.Json;
+
+namespace CryptoExchange.Net.UnitTests.Implementations
+{
+    internal class TestSocketMessageHandler : JsonSocketMessageHandler
+    {
+        public override JsonSerializerOptions Options { get; } = SerializerOptions.WithConverters(new TestSerializerContext());
+
+        public TestSocketMessageHandler()
+        {
+        }
+
+        protected override MessageTypeDefinition[] TypeEvaluators { get; } = [
+
+             new MessageTypeDefinition {
+                ForceIfFound = true,
+                Fields = [
+                    new PropertyFieldReference("id")
+                ],
+                TypeIdentifierCallback = (doc) => doc.FieldValue("id")!
+            },
+
+            new MessageTypeDefinition {
+                Fields = [
+                ],
+                StaticIdentifier = "test"
+            },
+        ];
+    }
+}
@@ -0,0 +1,27 @@
+using CryptoExchange.Net.Objects.Options;
+
+namespace CryptoExchange.Net.UnitTests.Implementations
+{
+    internal class TestSocketOptions : SocketExchangeOptions<TestEnvironment, TestCredentials>
+    {
+        internal static TestSocketOptions Default { get; set; } = new TestSocketOptions()
+        {
+            Environment = TestEnvironment.Live,
+            AutoTimestamp = true
+        };
+
+        public TestSocketOptions()
+        {
+            Default?.Set(this);
+        }
+
+        public SocketApiOptions ExchangeOptions { get; private set; } = new SocketApiOptions();
+
+        internal TestSocketOptions Set(TestSocketOptions targetOptions)
+        {
+            targetOptions = base.Set<TestSocketOptions>(targetOptions);
+            targetOptions.ExchangeOptions = ExchangeOptions.Set(targetOptions.ExchangeOptions);
+            return targetOptions;
+        }
+    }
+}
@@ -0,0 +1,50 @@
+using CryptoExchange.Net.Objects;
+using CryptoExchange.Net.Objects.Sockets;
+using CryptoExchange.Net.Sockets;
+using CryptoExchange.Net.Sockets.Default;
+using CryptoExchange.Net.Sockets.Default.Routing;
+using Microsoft.Extensions.Logging;
+using System;
+using System.Collections.Generic;
+using System.Reflection.Metadata;
+using System.Text;
+
+namespace CryptoExchange.Net.UnitTests.Implementations
+{
+    internal class TestSubscription<T> : Subscription
+    {
+        private readonly Action<DataEvent<T>> _handler;
+        private bool _subQuery;
+
+        public TestSubscription(ILogger logger, Action<DataEvent<T>> handler, bool subQuery, bool authenticated) : base(logger, authenticated, true)
+        {
+            _handler = handler;
+            _subQuery = subQuery;
+
+            MessageRouter = MessageRouter.CreateWithoutTopicFilter<T>("test", HandleUpdate);
+        }
+
+        protected override Query? GetSubQuery(SocketConnection connection)
+        {
+            if (!_subQuery)
+                return null;
+
+            return new TestQuery(new TestSocketMessage { Id = 1, Data = "Sub" }, false);
+        }
+
+        protected override Query? GetUnsubQuery(SocketConnection connection)
+        {
+            if (!_subQuery)
+                return null;
+
+            return new TestQuery(new TestSocketMessage { Id = 2, Data = "Unsub" }, false);
+        }
+
+
+        private CallResult? HandleUpdate(SocketConnection connection, DateTime time, string? originalData, T data)
+        {
+            _handler(new DataEvent<T>("Test", data, time, originalData));
+            return CallResult.SuccessResult;
+        }
+    }
+}