Add support for JsonPropertyNameAttribute from System.Text.Json

[juaal12]

Hi,

Is it planned to add support for System.Text.Json?

I have seen several closed issues regarding this topic (#766 and #305 for example).

In my case I have to use Newtonsoft just to apply a property renaming on my server call. I think we must support System.Text.Json since it is faster, lighter and for sure it will the be standard way for future applications since .NET 6 introduced it.

Thanks in advance!

[AArnott]

#908 in fact has already merged with System.Text.Json support coming in 2.16.

[taooceros]

Hi, when shall 2.16 be released?

[AArnott]

@taooceros It was today.

[juaal12]

Good morning!

@AArnott

I think the last package release does not solve the support issue. With version 2.16.36 using JsonPropertyName is not behaving like JsonProperty provided by Newtonsoft.

[JsonProperty("clientId")]
public string ClientId { get; set; }

works fine since on generated json ClientId will be clientId. This is not happening when:

[JsonPropertyName("clientId")]
public string ClientId { get; set; }

since ClientId will still be ClientId.

Using System.Text.Json results in having a RemoteException by my side due to this behavior. Should we reopen the issue or should we create a new one?

[juaal12]

Hi,

You can notice it does not work fine just upgrading within the test application streamjson package and adding this lines in WebSocketClient Program.cs:

var stringResult = await jsonRpc.InvokeWithParameterObjectAsync<string>("TestMethod", 
                              new TestDto { TestA = "Client", TestB = "Secret" }, cancellationToken);

    public class TestDto
    {
        [JsonPropertyName("clientId")]
        public string TestA { get; set; }
        [JsonPropertyName("clientSecret")]
        public string TestB { get; set; }
    }

And then these others in JsonRpcServer.cs on in Web project:

        public string TestMethod(string clientId, string clientSecret)
        {
            return string.Concat(clientId, clientSecret);
        }

[AArnott]

I'll take a look.

[AArnott]

It's funny, because we have a test that suggests the attribute works:

vs-streamjsonrpc/test/StreamJsonRpc.Tests/SystemTextJsonFormatterTests.cs

Lines 39 to 54 in 1feb491

	[Fact]
	public void STJAttributesWinOverDataContractAttributesByDefault()
	{
	IJsonRpcMessageFactory messageFactory = this.Formatter;
	JsonRpcRequest requestMessage = messageFactory.CreateRequestMessage();
	requestMessage.Method = "test";
	requestMessage.Arguments = new[] { new DCSClass { C = 1 } };
	using Sequence<byte> sequence = new();
	this.Formatter.Serialize(sequence, requestMessage);
	using JsonDocument doc = JsonDocument.Parse(sequence);
	this.Logger.WriteLine(doc.RootElement.ToString());
	Assert.Equal(1, doc.RootElement.GetProperty("params")[0].GetProperty("B").GetInt32());
	}

(look further down in the file to see use of the attribute).

We also have this test:

vs-streamjsonrpc/test/StreamJsonRpc.Tests/JsonRpcTests.cs

Lines 2906 to 2912 in 1feb491

	[Fact]
	public async Task InvokeWithParameterObject_WithRenamingAttributes()
	{
	var param = new ParamsObjectWithCustomNames { TheArgument = "hello" };
	string result = await this.clientRpc.InvokeWithParameterObjectAsync<string>(nameof(Server.ServerMethod), param, this.TimeoutToken);
	Assert.Equal(param.TheArgument + "!", result);
	}

Which demonstrates it works for custom named argument objects.

So I tried your repro. It behaves for me. Can you send me a repro project that I can execute?

[juaal12]

Sure!

I have forked your StreamJsonRpc.Sample repo and I have implemented the modifications in my previous message. Find here the repo: https://github.com/juaal12/StreamJsonRpc.Sample.

Thanks in advance!

[AArnott]

Thanks, @juaal12. But your sample doesn't use the formatter for System.Text.Json at all. It's using Newtonsoft.Json. That would be why your attributes are being ignored.
If you want to use the System.Text.Json attributes, change your sample to use SystemTextJsonFormatter from this library.
Relevant docs here.

[juaal12]

Thanks, @juaal12. But your sample doesn't use the formatter for System.Text.Json at all. It's using Newtonsoft.Json. That would be why your attributes are being ignored. If you want to use the System.Text.Json attributes, change your sample to use SystemTextJsonFormatter from this library. Relevant docs here.

Hi @AArnott ,

I have updated the repository with your proposals in the last message. You can take a look if you want but by my side, after applying the changes, it works like a charm, so maybe this is not an issue anymore and we can close the thread.

Nevertheless, if you want to try it, my repo has been updated!

Thanks a lot and sorry for the inconvenience!