[VNext] System.Text.Json as default serializer

[kirankumarkolli]

CosmosClient supports customizing the serializers #CosmosLinqSerializer.

NOTE: CosmosSerializer will be deprecated in future, prefer CosmosLinqSerializer

CosmosClient library includes two implementations for JSON.net and System.Text.Json (https://learn.microsoft.com/en-us/dotnet/api/system.text.json) with JSON.net being the default serializer.

Applications can change the default to System.Text.Json through CosmosClientOptions

            CosmosClientOptions options = new CosmosClientOptions()
            {
                UseSystemTextJsonSerializerWithOptions = new System.Text.Json.JsonSerializerOptions()
                {
                    PropertyNamingPolicy = System.Text.Json.JsonNamingPolicy.CamelCase,
                }
            };

            CosmosClient client = new(
                ...,
                options
            );

This work item is to change the default to System.Text.json for next major version.

[j82w]

LINQ is still in a design phase so there are not any guarantees, but it should use the System.Text.Json

[benc-uk]

Just lost several hours to "The input content is invalid because the required properties – ‘id; ‘ – are missing” errors
Only to discover that [JsonPropertyName("id")] was being ignored

It's not like the System.Text.Json changes are very new :(

[StefanSchoof]

Did you change your using to System.Text.Json https://docs.microsoft.com/en-us/dotnet/api/system.text.json.serialization.jsonpropertynameattribute?view=net-5.0 or do you used the newtonsoft namespace?

[j82w]

@benc-uk the .NET v3 SDK was released before System.Text.Json was GA. Switching the entire SDK over from newtonsoft to System.Text.Json is a breaking change which would require a v4 SDK. Please look at the following sample on how to make the v3 SDK use the new System.Text.Json: https://github.com/Azure/azure-cosmos-dotnet-v3/tree/master/Microsoft.Azure.Cosmos.Samples/Usage/SystemTextJson

[martinnormark]

@j82w Is there a way to configure the serializer used by the IQueryable implementation you get when calling GetItemLinqQueryable on a container?

I have some dynamic data stored as ExpandoObject in C#. Using System.Text.Json serialize as expected but when expressed in queries it seems to serialize using Newtonsoft.Json.

ExpandoObject serialized with System.Text.Json:

{
	"Name": "John Doe"
}

Using Newtonsoft.Json it produces:

{
	"Name": { "ValueKind": 3 }
}

It seems to be serializing directly using JsonConvert and not base it on configuration of any sort (given that I have found the right spot):

azure-cosmos-dotnet-v3/Microsoft.Azure.Cosmos/src/Linq/CosmosLinqQuery.cs

Line 139 in 56aa533

return JsonConvert.SerializeObject(querySpec);

This problem is outlined in way more detail here: https://josef.codes/custom-dictionary-string-object-jsonconverter-for-system-text-json/

[curia-damiano]

+1

[Robar666]

+1

[Romfos]

+1

[YipingRuan]

Just lost several hours to "The input content is invalid because the required properties – ‘id; ‘ – are missing” errors Only to discover that [JsonPropertyName("id")] was being ignored

It's not like the System.Text.Json changes are very new :(

Maybe
#3282

[AraHaan]

Oh btw any plans to update the Newtonsoft dependency to the latest version to avoid possibly getting a version of that in the v3 that is prone to security issues? I think v10 is prone but v13 is not (that we know of so far).

After that the EFCore cosmos provider in dotnet/efcore would need to be patched to use a version of Microsoft.Azure.Cosmos that upgrades the newtonsoft to v13 as well.

And please look into it before patch Tuesday where they will ship the 6.0.7 servicing release of efcore and the .NET shared frameworks that come with the .NET SDK.

[hkusulja]

Hello, any progress on this? We want to avoid Newtonsoft JSON and move to System.Text.Json ...