tochka-public / tochka.jsonrpc

JSON RPC 2.0 integration into ASP.NET Core MVC

Tochka.JsonRpc

JSON RPC 2.0 integration into ASP.NET Core MVC

Docs

tochka.jsonrpc's Issues

PropertyNamingPolicy null walue

I think, we should support unsetted value for JsonRpcServerOptions.DefaultDataJsonSerializerOptions.PropertyNamingPolicy

Today, i use this policy

class UnsetNamingPolicy : JsonNamingPolicy
{
    public override string ConvertName(string name) => name;
}

For example System.Text.Json support null value for policy
https://github.com/dotnet/corefx/blob/e667c29636a622eb4f9493f75232b44e0ae90b29/src/System.Text.Json/src/System/Text/Json/Serialization/JsonPropertyInfo.cs#L106-L119

[OpenRPC] ApiExplorerSettingsAttribute.GroupName is ignored

Setting GroupName with ApiExplorerSettingsAttribute on controller has no effect on OpenRPC result.
JsonRpcDescriptionProvider overrides the value of ApiDescription.GroupName with constant "jsonrpc".

GroupName is used when application has several independed APIs.
Ex:

[ApiExplorerSettings(GroupName = "admin")]
[ApiController]
[Route("/admin/api")]
AdminApiControllerBase : JsonRpcControllerBase
{
}

[ApiExplorerSettings(GroupName = "user")]
[ApiController]
[Route("/user/api")]
UserApiControllerBase : JsonRpcControllerBase
{
}

And in Startup.cs

services.AddOpenRpc(Assembly.GetExecutingAssembly(), options =>
{
options.Docs.Add("jadmin_v1", new OpenRpcInfo("Admin API", "1"));
options.Docs.Add("user_v1", new OpenRpcInfo("User API", "1"));
});

In this case /openrpc/admin_v1.json should return details for Admin API but it returns no methods because JsonRpcDescriptionProvider replaces specified GroupName.

JsonRpcDescriptionProvider should not change GroupName if it was determined by DefaultApiDescriptionProvider

header json serializer in client for IRpcId

fails, need to add support for serialization. currently only deserialization works.

Add explicit check for generated xmldoc on startup

Currently app starts but returns 500 if XML docs are not generated. Add check for this file and throw exception with sane description to help users configure their project (should add GenerateDocumentationFile to csproj)

Tochka.JsonRpc/src/Tochka.JsonRpc.Swagger/Extensions.cs

Line 65 in f639891

options.IncludeXmlComments(xmlPath);

Changelog always conflicts in beta

Remove changelog from beta branch to avoid conflicts with master

Ошибка при генерации автодоки для void методов

Если api содержит методы, возвращающие void (или Task), то при генерации автодоки происходит ошибка:
The type 'System.Void' may not be used as a type argument

Client exception should serialize errors

• add serialized error to context
• limit size to about 5kb

Pass serializer here:

Tochka.JsonRpc/src/Tochka.JsonRpc.Client/Models/SingleJsonRpcResult.cs

Line 42 in 24d8ee0

context.WithError(untypedErrorResponse.Error);

Do something like ErrorInfo = JToken.FromObject(data, serializer.Serializer); and limit its length

Use this in ToString instead of Error property

fix by feedback

• document UseMvc() In Configure method
• check controller_name.action_name and action_name in docs
• add examples for different configurations in quickstart

Client exception should serialize request and response

Similar to #34. See context ToString method. Request is currently serialized.

• limit size to around 5kb
• serialize response too

Batch requests lead to warnings about error codes

if response is batch, JToken Value actual type is JArray and it throws on access by string key here:

Tochka.JsonRpc/src/Tochka.JsonRpc.Server/Models/Response/JsonServerResponseWrapper.cs

Line 86 in 24d8ee0

var errorCode = Value[JsonRpcConstants.ErrorProperty]?[JsonRpcConstants.ErrorCodeProperty]?.Value<string>();

do something like HasKey/HasProperty or type-check for JArray there

Client should wrap all exceptions (http, json, ...)

Wrap all logic into try/catch and throw custom exception with context and nested original exception.This is useful because context has detailed information about request and response

app.UseHttpsRedirection() is broken

probably works when AllowRawResponses is true. need to allow this response regardless of allow raw setting.

add services for logging and metrics

at least as example. maybe add Events class to middleware?

Некорректная (де)сериализация datetime

Задача: задать определенный формат datetime при сериализации/десериализации тела реквестов/респонсов.

Решаться должна тем что имплементим интерфейс IJsonRpcSerializer, в котором в settings добавляем вот эту строку DateFormatString = "yyyy-MM-ddTHH:mm:ssK" //мой кастомный формат
Но оно не работает.

НО, если пойти и в исходниках либы вот это задать для
DateFormatString = "yyyy-MM-ddTHH:mm:ssK" //мой кастомный формат
для HeaderJsonRpcSerializer, то респонсы сериализуются по данному формату.
То есть получается настройки берутся из HeaderJsonRpcSerializer, что есть неверно

Доработки для jsonrpc client

• сделать флаг HasError для jsonrpcresult

• сделать метод GetAnyError для jsonrpcresult

• метод AsError<> сейчас падает если в ответе нет поля data
  Пример - как хотим использовать:
  if (rpcResult.HasError) { var error = rpcResult.GetAnyError(); log.LogError(error); return null; }

• когда ловим JsonRpcException и делаем ToString(), некорректно отображается Json Rpc Error, полученный от сервиса, к которому обращались.
  Пример:
  JSON Rpc error: Tochka.JsonRpc.Common.Models.Response.Errors.Error 1[Newtonsoft.Json.Linq.JToken]
  Как хотим:
  JSON Rpc error: { code: some-code, message: some-message, data: some-data }

• когда делаю моки в тестах, не могу сделать что то типа:
  .Throws<JsonRpcException>()
  т.к. must have a public parameterless constructor

add JsonRpcException for error server responses without wrapping it into ErrorData

use case: controller returns some object or throws specific error. user wants to control error response (code/msg/data) without changing method signature to IActionResult.

Client exception should serialize raw http content

not sure how:

• what if http content is valid text? bytes? limit to 5kb?
• passing content reference into context is probably dangerous: we can keep it for a long time
• can we rewind content stream after reading?
• is content stream closed after streamreader+jsonreader? can be reopened?
• can we buffer it while reading?

CORS

Ломается cors. Нет нужных заголовков в респонсах

Serializing into string

Если у метода есть параметр с типом string, но в запросе вместо string передавать допустим int, то он успешно сам конвертится в string и никакой ошибки не выдает.

Метод

public void SomeMethod(string stringParam)
{
   //stringParam has "6277" value
}

Запрос

{
  "id": "1",
  "jsonrpc": "2.0",
  "method": "SomeMethod",
  "params": {
    "stringParam": 6277
  }
}

Remove CancellationToken from autodoc signatures

Types generated from method parameters may contain CancellationTokens. Swagger ignores them by default for REST, we should too.