Merge pull request #122 from tochka-public/feat/clientContext

Feat/client context
tochka-public · Feb 19, 2025 · 9bf233a · 9bf233a
2 parents 42a534d + abc3183
commit 9bf233a
Show file tree

Hide file tree

Showing 76 changed files with 469 additions and 224 deletions.
diff --git a/.github/workflows/package.yml b/.github/workflows/package.yml
@@ -17,7 +17,7 @@ jobs:
       - name: Setup .NET
         uses: actions/setup-dotnet@v3
         with:
-          dotnet-version: 7.0.x
+          dotnet-version: 8.0.x
 
       - name: Checkout
         uses: actions/checkout@v3
@@ -42,7 +42,7 @@ jobs:
       - name: Setup .NET
         uses: actions/setup-dotnet@v3
         with:
-          dotnet-version: 7.0.x
+          dotnet-version: 8.0.x
 
       - name: Checkout
         uses: actions/checkout@v3

diff --git a/src/Tochka.JsonRpc.ApiExplorer/JsonRpcDescriptionProvider.cs b/src/Tochka.JsonRpc.ApiExplorer/JsonRpcDescriptionProvider.cs
@@ -38,7 +38,7 @@ public void OnProvidersExecuting(ApiDescriptionProviderContext context)
     {
         var existingDescriptions = context.Results
             .Where(static x => x.ActionDescriptor.EndpointMetadata.Any(static m => m is JsonRpcControllerAttribute))
-            .ToArray();
+            .ToList();
 
         foreach (var description in existingDescriptions)
         {
@@ -90,7 +90,7 @@ private void WrapRequest(ApiDescription description, ControllerActionDescriptor
         var parametersMetadata = actionDescriptor.EndpointMetadata.Get<JsonRpcActionParametersMetadata>() ?? new JsonRpcActionParametersMetadata();
         var parametersToRemove = description.ParameterDescriptions
             .Where(p => parametersMetadata.Parameters.ContainsKey(p.Name) || p.Source == BindingSource.Body)
-            .ToArray();
+            .ToList();
         foreach (var parameterDescription in parametersToRemove)
         {
             description.ParameterDescriptions.Remove(parameterDescription);

diff --git a/src/Tochka.JsonRpc.Client/JsonRpcClientBase.cs b/src/Tochka.JsonRpc.Client/JsonRpcClientBase.cs
@@ -10,6 +10,7 @@
 using Tochka.JsonRpc.Common;
 using Tochka.JsonRpc.Common.Models.Id;
 using Tochka.JsonRpc.Common.Models.Request;
+using Tochka.JsonRpc.Common.Models.Request.Untyped;
 using Tochka.JsonRpc.Common.Models.Response.Wrappers;
 
 namespace Tochka.JsonRpc.Client;
@@ -336,7 +337,7 @@ internal virtual async Task SendNotificationInternal<TParams>(string? requestUrl
         var data = notification.WithSerializedParams(DataJsonSerializerOptions);
         context.WithSingle(data);
         using var content = CreateHttpContent(data);
-        using var requestMessage = CreateRequestMessage(requestUrl, content, new[] { notification.Method });
+        using var requestMessage = CreateRequestMessage(requestUrl, content, [data]);
         var httpResponseMessage = await Client.SendAsync(requestMessage, cancellationToken);
         context.WithHttpResponse(httpResponseMessage);
     }
@@ -424,19 +425,18 @@ internal virtual async Task<ISingleJsonRpcResult<TResponse>> SendRequestInternal
     {
         var context = CreateContext();
         context.WithRequestUrl(requestUrl);
-        var data = calls.Select(x => x.WithSerializedParams(DataJsonSerializerOptions)).ToArray();
+        var data = calls.Select(x => x.WithSerializedParams(DataJsonSerializerOptions)).ToList();
         context.WithBatch(data);
         using var content = CreateHttpContent(data);
-        var methodNames = data.Select(static x => x.Method).ToArray();
-        using var request = CreateRequestMessage(requestUrl, content, methodNames);
+        using var request = CreateRequestMessage(requestUrl, content, data);
         var httpResponseMessage = await Client.SendAsync(request, cancellationToken);
         context.WithHttpResponse(httpResponseMessage);
         if (context.ExpectedBatchResponseCount == 0)
         {
             // from specification:
             // "If there are no Response objects contained within the Response array as it is to be sent to the client,
             // the server MUST NOT return an empty Array and should return nothing at all."
-            Log.LogTrace("Batch count [{batchCount}] success: no response expected", data.Length);
+            Log.LogTrace("Batch count [{batchCount}] success: no response expected", data.Count);
             return null;
         }
 
@@ -447,18 +447,18 @@ internal virtual async Task<ISingleJsonRpcResult<TResponse>> SendRequestInternal
         {
             case BatchResponseWrapper batchResponseWrapper:
                 context.WithBatchResponse(batchResponseWrapper.Responses);
-                Log.LogTrace("Batch count [{batchCount}] success: response count [{responseCount}]", data.Length, batchResponseWrapper.Responses.Count);
+                Log.LogTrace("Batch count [{batchCount}] success: response count [{responseCount}]", data.Count, batchResponseWrapper.Responses.Count);
                 return new BatchJsonRpcResult(context, HeadersJsonSerializerOptions, DataJsonSerializerOptions);
             case SingleResponseWrapper singleResponseWrapper:
                 // "If the batch rpc call itself fails to be recognized as an valid JSON or as an Array with at least one value,
                 // the response from the Server MUST be a single Response object."
                 context.WithSingleResponse(singleResponseWrapper.Response);
                 var message1 = $"Expected batch response, got single, id [{singleResponseWrapper.Response.Id}]";
-                Log.LogTrace("Batch count [{batchCount}] failed: {errorMessage}", data.Length, message1);
+                Log.LogTrace("Batch count [{batchCount}] failed: {errorMessage}", data.Count, message1);
                 throw new JsonRpcException(message1, context);
             default:
                 var message2 = $"Expected batch response, got [{responseWrapper?.GetType().Name}]";
-                Log.LogTrace("Batch count [{batchCount}] failed: {errorMessage}", data.Length, message2);
+                Log.LogTrace("Batch count [{batchCount}] failed: {errorMessage}", data.Count, message2);
                 throw new JsonRpcException(message2, context);
         }
     }
@@ -468,19 +468,18 @@ internal virtual async Task<ISingleJsonRpcResult<TResponse>> SendRequestInternal
     {
         var context = CreateContext();
         context.WithRequestUrl(requestUrl);
-        var data = calls.Select(x => x.WithSerializedParams(DataJsonSerializerOptions)).ToArray();
+        var data = calls.Select(x => x.WithSerializedParams(DataJsonSerializerOptions)).ToList();
         context.WithBatch(data);
         using var content = CreateHttpContent(data);
-        var methodNames = data.Select(static x => x.Method).ToArray();
-        using var request = CreateRequestMessage(requestUrl, content, methodNames);
+        using var request = CreateRequestMessage(requestUrl, content, data);
         var httpResponseMessage = await Client.SendAsync(request, cancellationToken);
         context.WithHttpResponse(httpResponseMessage);
         if (context.ExpectedBatchResponseCount == 0)
         {
             // from specification:
             // "If there are no Response objects contained within the Response array as it is to be sent to the client,
             // the server MUST NOT return an empty Array and should return nothing at all."
-            Log.LogTrace("Batch count [{batchCount}] success: no response expected", data.Length);
+            Log.LogTrace("Batch count [{batchCount}] success: no response expected", data.Count);
             return null;
         }
 
@@ -491,18 +490,18 @@ internal virtual async Task<ISingleJsonRpcResult<TResponse>> SendRequestInternal
         {
             case BatchResponseWrapper batchResponseWrapper:
                 context.WithBatchResponse(batchResponseWrapper.Responses);
-                Log.LogTrace("Batch count [{batchCount}] success: response count [{responseCount}]", data.Length, batchResponseWrapper.Responses.Count);
+                Log.LogTrace("Batch count [{batchCount}] success: response count [{responseCount}]", data.Count, batchResponseWrapper.Responses.Count);
                 return new BatchJsonRpcResult<TResponse>(context, HeadersJsonSerializerOptions, DataJsonSerializerOptions);
             case SingleResponseWrapper singleResponseWrapper:
                 // "If the batch rpc call itself fails to be recognized as an valid JSON or as an Array with at least one value,
                 // the response from the Server MUST be a single Response object."
                 context.WithSingleResponse(singleResponseWrapper.Response);
                 var message1 = $"Expected batch response, got single, id [{singleResponseWrapper.Response.Id}]";
-                Log.LogTrace("Batch count [{batchCount}] failed: {errorMessage}", data.Length, message1);
+                Log.LogTrace("Batch count [{batchCount}] failed: {errorMessage}", data.Count, message1);
                 throw new JsonRpcException(message1, context);
             default:
                 var message2 = $"Expected batch response, got [{responseWrapper?.GetType().Name}]";
-                Log.LogTrace("Batch count [{batchCount}] failed: {errorMessage}", data.Length, message2);
+                Log.LogTrace("Batch count [{batchCount}] failed: {errorMessage}", data.Count, message2);
                 throw new JsonRpcException(message2, context);
         }
     }
@@ -512,17 +511,16 @@ internal virtual async Task<HttpResponseMessage> SendInternal(string? requestUrl
     {
         var data = call.WithSerializedParams(DataJsonSerializerOptions);
         using var content = CreateHttpContent(data);
-        using var httpRequestMessage = CreateRequestMessage(requestUrl, content, new[] { call.Method });
+        using var httpRequestMessage = CreateRequestMessage(requestUrl, content, [data]);
         return await Client.SendAsync(httpRequestMessage, cancellationToken);
     }
 
     // internal virtual for mocking in tests
     internal virtual async Task<HttpResponseMessage> SendInternal(string? requestUrl, IEnumerable<ICall> calls, CancellationToken cancellationToken)
     {
-        var data = calls.Select(x => x.WithSerializedParams(DataJsonSerializerOptions)).ToArray();
+        var data = calls.Select(x => x.WithSerializedParams(DataJsonSerializerOptions)).ToList();
         using var content = CreateHttpContent(data);
-        var methodNames = data.Select(static x => x.Method).ToArray();
-        using var message = CreateRequestMessage(requestUrl, content, methodNames);
+        using var message = CreateRequestMessage(requestUrl, content, data);
         return await Client.SendAsync(message, cancellationToken);
     }
 
@@ -561,7 +559,7 @@ protected internal virtual async Task<string> GetContent(HttpContent content, Ca
         var data = request.WithSerializedParams(DataJsonSerializerOptions);
         context.WithSingle(data);
         using var content = CreateHttpContent(data);
-        using var requestMessage = CreateRequestMessage(requestUrl, content, new[] { request.Method });
+        using var requestMessage = CreateRequestMessage(requestUrl, content, [data]);
         var httpResponseMessage = await Client.SendAsync(requestMessage, cancellationToken);
         context.WithHttpResponse(httpResponseMessage);
         var contentString = await GetContent(httpResponseMessage.Content, cancellationToken);
@@ -579,14 +577,14 @@ private void InitializeClient(HttpClient client)
         Log.LogTrace("Client initialized: user-agent {userAgent}", client.DefaultRequestHeaders.UserAgent);
     }
 
-    private static HttpRequestMessage CreateRequestMessage(string? requestUrl, HttpContent content, string[] methodNames)
+    private static HttpRequestMessage CreateRequestMessage(string? requestUrl, HttpContent content, IReadOnlyList<IUntypedCall> calls)
     {
         var httpRequestMessage = new HttpRequestMessage(HttpMethod.Post, requestUrl)
         {
             Content = content
         };
 
-        httpRequestMessage.Options.Set(new HttpRequestOptionsKey<string[]>(JsonRpcConstants.OutgoingHttpRequestOptionMethodNameKey), methodNames);
+        httpRequestMessage.Options.Set(JsonRpcConstants.JsonRpcClientCallsKey, calls);
         return httpRequestMessage;
     }
 

diff --git a/src/Tochka.JsonRpc.Client/Models/BatchResult/BatchJsonRpcResult.cs b/src/Tochka.JsonRpc.Client/Models/BatchResult/BatchJsonRpcResult.cs
@@ -9,7 +9,8 @@ namespace Tochka.JsonRpc.Client.Models.BatchResult;
 
 /// <inheritdoc cref="IBatchJsonRpcResult" />
 [PublicAPI]
-public sealed class BatchJsonRpcResult : BatchJsonRpcResult<object>, IBatchJsonRpcResult
+public sealed class BatchJsonRpcResult : BatchJsonRpcResult<object>,
+    IBatchJsonRpcResult
 {
     /// <summary></summary>
     public BatchJsonRpcResult(IJsonRpcCallContext context, JsonSerializerOptions headersJsonSerializerOptions, JsonSerializerOptions dataJsonSerializerOptions)

diff --git a/src/Tochka.JsonRpc.Client/Models/SingleResult/SingleJsonRpcResult.cs b/src/Tochka.JsonRpc.Client/Models/SingleResult/SingleJsonRpcResult.cs
@@ -7,7 +7,8 @@ namespace Tochka.JsonRpc.Client.Models.SingleResult;
 
 /// <inheritdoc cref="ISingleJsonRpcResult" />
 [PublicAPI]
-public sealed class SingleJsonRpcResult : SingleJsonRpcResult<object>, ISingleJsonRpcResult
+public sealed class SingleJsonRpcResult : SingleJsonRpcResult<object>,
+    ISingleJsonRpcResult
 {
     /// <summary></summary>
     public SingleJsonRpcResult(IJsonRpcCallContext context, JsonSerializerOptions headersJsonSerializerOptions, JsonSerializerOptions dataJsonSerializerOptions)

diff --git a/src/Tochka.JsonRpc.Common/Converters/CallConverter.cs b/src/Tochka.JsonRpc.Common/Converters/CallConverter.cs
@@ -64,5 +64,10 @@ private static PropertiesInfo CheckProperties(Utf8JsonReader propertyReader)
         return new PropertiesInfo(hasId, hasMethod, hasVersion);
     }
 
-    private record PropertiesInfo(bool HasId, bool HasMethod, bool HasVersion);
+    private record PropertiesInfo
+    (
+        bool HasId,
+        bool HasMethod,
+        bool HasVersion
+    );
 }
diff --git a/src/Tochka.JsonRpc.Common/Converters/ResponseConverter.cs b/src/Tochka.JsonRpc.Common/Converters/ResponseConverter.cs
@@ -72,5 +72,11 @@ private static PropertiesInfo CheckProperties(Utf8JsonReader propertyReader)
         return new PropertiesInfo(hasId, hasResult, hasError, hasVersion);
     }
 
-    private record PropertiesInfo(bool HasId, bool HasResult, bool HasError, bool HasVersion);
+    private record PropertiesInfo
+    (
+        bool HasId,
+        bool HasResult,
+        bool HasError,
+        bool HasVersion
+    );
 }
diff --git a/src/Tochka.JsonRpc.Common/JsonRpcConstants.cs b/src/Tochka.JsonRpc.Common/JsonRpcConstants.cs
@@ -1,5 +1,6 @@
 using System.Diagnostics.CodeAnalysis;
 using JetBrains.Annotations;
+using Tochka.JsonRpc.Common.Models.Request.Untyped;
 
 namespace Tochka.JsonRpc.Common;
 
@@ -77,7 +78,7 @@ public static class JsonRpcConstants
     public const int LogStringLimit = 5000;
 
     /// <summary>
-    /// HttpRequest.Options item with string[], contains method name to be called. Multiple names for batch requests
+    /// HttpRequest.Options item, contains jsonrpc requests sent by client. Multiple items for batch requests
     /// </summary>
-    public const string OutgoingHttpRequestOptionMethodNameKey = "tochka_outgoing_http_request_method_name";
+    public static readonly HttpRequestOptionsKey<IReadOnlyList<IUntypedCall>> JsonRpcClientCallsKey = new("tochka_jsonrpc_client_calls");
 }
diff --git a/src/Tochka.JsonRpc.Common/Models/Id/FloatNumberRpcId.cs b/src/Tochka.JsonRpc.Common/Models/Id/FloatNumberRpcId.cs
@@ -11,7 +11,10 @@ namespace Tochka.JsonRpc.Common.Models.Id;
 /// <param name="Value">Actual id value</param>
 [PublicAPI]
 [ExcludeFromCodeCoverage]
-public sealed record FloatNumberRpcId(double Value) : IRpcId
+public sealed record FloatNumberRpcId
+(
+    double Value
+) : IRpcId
 {
     /// <inheritdoc />
     public override string ToString() => Value.ToString(CultureInfo.InvariantCulture);

diff --git a/src/Tochka.JsonRpc.Common/Models/Id/NumberRpcId.cs b/src/Tochka.JsonRpc.Common/Models/Id/NumberRpcId.cs
@@ -10,7 +10,10 @@ namespace Tochka.JsonRpc.Common.Models.Id;
 /// <param name="Value">Actual id value</param>
 [PublicAPI]
 [ExcludeFromCodeCoverage]
-public sealed record NumberRpcId(long Value) : IRpcId
+public sealed record NumberRpcId
+(
+    long Value
+) : IRpcId
 {
     /// <inheritdoc />
     public override string ToString() => $"{Value}";

diff --git a/src/Tochka.JsonRpc.Common/Models/Id/StringRpcId.cs b/src/Tochka.JsonRpc.Common/Models/Id/StringRpcId.cs
@@ -10,7 +10,10 @@ namespace Tochka.JsonRpc.Common.Models.Id;
 /// <param name="Value">Actual id value</param>
 [PublicAPI]
 [ExcludeFromCodeCoverage]
-public sealed record StringRpcId(string Value) : IRpcId
+public sealed record StringRpcId
+(
+    string Value
+) : IRpcId
 {
     /// <inheritdoc />
     public override string ToString() => $"\"{Value}\"";

diff --git a/src/Tochka.JsonRpc.Common/Models/Request/Notification.cs b/src/Tochka.JsonRpc.Common/Models/Request/Notification.cs
@@ -14,7 +14,12 @@ namespace Tochka.JsonRpc.Common.Models.Request;
 /// <param name="Jsonrpc">Version of the JSON-RPC protocol</param>
 [PublicAPI]
 [ExcludeFromCodeCoverage]
-public record Notification<TParams>(string Method, TParams? Params, string Jsonrpc = JsonRpcConstants.Version) : ICall<TParams>
+public record Notification<TParams>
+(
+    string Method,
+    TParams? Params,
+    string Jsonrpc = JsonRpcConstants.Version
+) : ICall<TParams>
     where TParams : class
 {
     /// <inheritdoc />

diff --git a/src/Tochka.JsonRpc.Common/Models/Request/Request.cs b/src/Tochka.JsonRpc.Common/Models/Request/Request.cs
@@ -16,7 +16,13 @@ namespace Tochka.JsonRpc.Common.Models.Request;
 /// <param name="Jsonrpc">Version of the JSON-RPC protocol</param>
 [PublicAPI]
 [ExcludeFromCodeCoverage]
-public record Request<TParams>(IRpcId Id, string Method, TParams? Params, string Jsonrpc = JsonRpcConstants.Version) : ICall<TParams>
+public record Request<TParams>
+(
+    IRpcId Id,
+    string Method,
+    TParams? Params,
+    string Jsonrpc = JsonRpcConstants.Version
+) : ICall<TParams>
     where TParams : class
 {
     // required for autodoc metadata generation
@@ -41,16 +47,18 @@ public IUntypedCall WithSerializedParams(JsonSerializerOptions serializerOptions
 /// <param name="Jsonrpc">Version of the JSON-RPC protocol</param>
 [PublicAPI]
 [ExcludeFromCodeCoverage]
-public record Request(IRpcId Id, string Method, string Jsonrpc = JsonRpcConstants.Version) : ICall
+public record Request
+(
+    IRpcId Id,
+    string Method,
+    string Jsonrpc = JsonRpcConstants.Version
+) : ICall
 {
     // required for autodoc metadata generation
     internal Request() : this(null!)
     {
     }
 
     /// <inheritdoc />
-    public IUntypedCall WithSerializedParams(JsonSerializerOptions serializerOptions)
-    {
-        return new UntypedRequest(Id, Method, null);
-    }
+    public IUntypedCall WithSerializedParams(JsonSerializerOptions serializerOptions) => new UntypedRequest(Id, Method, null);
 }
diff --git a/src/Tochka.JsonRpc.Common/Models/Request/Untyped/UntypedNotification.cs b/src/Tochka.JsonRpc.Common/Models/Request/Untyped/UntypedNotification.cs
@@ -10,5 +10,11 @@ namespace Tochka.JsonRpc.Common.Models.Request.Untyped;
 /// </summary>
 [PublicAPI]
 [ExcludeFromCodeCoverage]
-public sealed record UntypedNotification(string Method, JsonDocument? Params, string Jsonrpc = JsonRpcConstants.Version)
-    : Notification<JsonDocument>(Method, Params, Jsonrpc), IUntypedCall;
+public sealed record UntypedNotification
+(
+    string Method,
+    JsonDocument? Params,
+    string Jsonrpc = JsonRpcConstants.Version
+)
+    : Notification<JsonDocument>(Method, Params, Jsonrpc),
+        IUntypedCall;
diff --git a/src/Tochka.JsonRpc.Common/Models/Request/Untyped/UntypedRequest.cs b/src/Tochka.JsonRpc.Common/Models/Request/Untyped/UntypedRequest.cs
@@ -11,5 +11,12 @@ namespace Tochka.JsonRpc.Common.Models.Request.Untyped;
 /// </summary>
 [PublicAPI]
 [ExcludeFromCodeCoverage]
-public sealed record UntypedRequest(IRpcId Id, string Method, JsonDocument? Params, string Jsonrpc = JsonRpcConstants.Version)
-    : Request<JsonDocument>(Id, Method, Params, Jsonrpc), IUntypedCall;
+public sealed record UntypedRequest
+(
+    IRpcId Id,
+    string Method,
+    JsonDocument? Params,
+    string Jsonrpc = JsonRpcConstants.Version
+)
+    : Request<JsonDocument>(Id, Method, Params, Jsonrpc),
+        IUntypedCall;
diff --git a/src/Tochka.JsonRpc.Common/Models/Request/Wrappers/BatchRequestWrapper.cs b/src/Tochka.JsonRpc.Common/Models/Request/Wrappers/BatchRequestWrapper.cs
@@ -11,4 +11,7 @@ namespace Tochka.JsonRpc.Common.Models.Request.Wrappers;
 /// <param name="Calls">List of calls in batch request</param>
 [PublicAPI]
 [ExcludeFromCodeCoverage]
-public sealed record BatchRequestWrapper(List<JsonDocument> Calls) : IRequestWrapper;
+public sealed record BatchRequestWrapper
+(
+    List<JsonDocument> Calls
+) : IRequestWrapper;
diff --git a/src/Tochka.JsonRpc.Common/Models/Request/Wrappers/SingleRequestWrapper.cs b/src/Tochka.JsonRpc.Common/Models/Request/Wrappers/SingleRequestWrapper.cs
@@ -11,4 +11,7 @@ namespace Tochka.JsonRpc.Common.Models.Request.Wrappers;
 /// <param name="Call">Single call from request</param>
 [PublicAPI]
 [ExcludeFromCodeCoverage]
-public sealed record SingleRequestWrapper(JsonDocument Call) : IRequestWrapper;
+public sealed record SingleRequestWrapper
+(
+    JsonDocument Call
+) : IRequestWrapper;
diff --git a/src/Tochka.JsonRpc.Common/Models/Response/ErrorResponse.cs b/src/Tochka.JsonRpc.Common/Models/Response/ErrorResponse.cs
@@ -15,4 +15,9 @@ namespace Tochka.JsonRpc.Common.Models.Response;
 /// <typeparam name="TError">Type of error</typeparam>
 [PublicAPI]
 [ExcludeFromCodeCoverage]
-public record ErrorResponse<TError>(IRpcId Id, Error<TError> Error, string Jsonrpc = JsonRpcConstants.Version) : IResponse;
+public record ErrorResponse<TError>
+(
+    IRpcId Id,
+    Error<TError> Error,
+    string Jsonrpc = JsonRpcConstants.Version
+) : IResponse;