SystemTextJsonSerializer: Adds UseSystemTextJsonSerializerWithOptions in CosmosClientOptions to Set the Default STJ Serializer

Microsoft.Azure.Cosmos/src/CosmosClientOptions.cs

@@ -392,6 +392,15 @@ public ConnectionMode ConnectionMode
         /// <seealso cref="ItemRequestOptions.EnableContentResponseOnWrite"/>
         /// <seealso cref="TransactionalBatchItemRequestOptions.EnableContentResponseOnWrite"/>
         public bool? EnableContentResponseOnWrite { get; set; }
+
+        /// <summary>
+        /// Gets or sets the boolean flag to indicate if the default STJ serializer <see cref="CosmosSystemTextJsonSerializer"/> needed to be
+        /// used for JSON serialization.
+        /// </summary>
+        /// <value>
+        /// The default value is false
+        /// </value>
+        public bool UseSystemTextJsonForSerialization { get; set; } = false;
 
         /// <summary>
         /// Gets or sets the advanced replica selection flag. The advanced replica selection logic keeps track of the replica connection
@@ -583,6 +592,11 @@ public CosmosSerializer Serializer
                     throw new ArgumentException(
                         $"{nameof(this.Serializer)} is not compatible with {nameof(this.SerializerOptions)}. Only one can be set.  ");
                 }
+
+                if (this.UseSystemTextJsonForSerialization)
+                {
+                    throw new ArgumentException($"Cannot set a custom {nameof(this.Serializer)} when {nameof(this.UseSystemTextJsonForSerialization)} is enabled. Either specify a custom or set {nameof(this.UseSystemTextJsonForSerialization)} to the default STJ serializer.");
+                }
 
                 this.serializerInternal = value;
             }
@@ -833,8 +847,11 @@ internal Func<X509Certificate2, X509Chain, SslPolicyErrors, bool> GetServerCerti
         internal void SetSerializerIfNotConfigured(CosmosSerializer serializer)
         {
             if (this.serializerInternal == null)
-            {
-                this.serializerInternal = serializer ?? throw new ArgumentNullException(nameof(serializer));
+            {
+                this.serializerInternal = this.UseSystemTextJsonForSerialization
+                    ? new CosmosSystemTextJsonSerializer(
+                        new System.Text.Json.JsonSerializerOptions())
+                    : serializer ?? throw new ArgumentNullException(nameof(serializer));
             }
         }
 

Microsoft.Azure.Cosmos/src/Fluent/CosmosClientBuilder.cs

@@ -726,6 +726,16 @@ internal CosmosClientBuilder WithPartitionLevelFailoverEnabled()
             this.clientOptions.EnablePartitionLevelFailover = true;
             return this;
         }
+
+        /// <summary>
+        /// Enables the usage of <see cref="CosmosSystemTextJsonSerializer"/> as the default
+        /// serializer.
+        /// </summary>
+        internal CosmosClientBuilder WithSystemTextJsonSerializerEnabled()
+        {
+            this.clientOptions.UseSystemTextJsonForSerialization = true;
+            return this;
+        }
 
         /// <summary>
         /// Enables SDK to inject fault. Used for testing applications.  

Microsoft.Azure.Cosmos/tests/Microsoft.Azure.Cosmos.EmulatorTests/Linq/LinqAggregateCustomSerializationBaseline.cs

@@ -29,7 +29,6 @@ public class LinqAggregateCustomSerializationBaseline : BaselineTests<LinqAggreg
         private static Cosmos.Database testDb;
         private static Container testContainer;
 
-        private static CosmosSerializer stjCosmosSerializer;
         private static CosmosClient stjClient;
         private static Cosmos.Database testDbSTJ;
         private static Container testContainerSTJ;
@@ -64,10 +63,8 @@ public async static Task Initialize(TestContext textContext)
             testDb = await client.CreateDatabaseAsync(dbName);
             testContainer = testDb.CreateContainerAsync(new ContainerProperties(id: Guid.NewGuid().ToString(), partitionKeyPath: "/Pk")).Result;
 
-            stjCosmosSerializer = new CosmosSystemTextJsonSerializer(new JsonSerializerOptions());
-
             stjClient = TestCommon.CreateCosmosClient((cosmosClientBuilder)
-                => cosmosClientBuilder.WithCustomSerializer(stjCosmosSerializer));
+                => cosmosClientBuilder.WithSystemTextJsonSerializerEnabled());
 
             // Set a callback to get the handle of the last executed query to do the verification
             // This is neede because aggregate queries return type is a scalar so it can't be used 

Microsoft.Azure.Cosmos/tests/Microsoft.Azure.Cosmos.EmulatorTests/LinqTranslationWithCustomSerializerBaseline.cs

@@ -57,7 +57,7 @@ public async static Task Initialize(TestContext textContext)
             TestDb = await CosmosClient.CreateDatabaseAsync(dbName);
 
             CosmosDefaultSTJClient = TestCommon.CreateCosmosClient((cosmosClientBuilder)
-                => cosmosClientBuilder.WithCustomSerializer(new CosmosSystemTextJsonSerializer(new JsonSerializerOptions())));
+                => cosmosClientBuilder.WithSystemTextJsonSerializerEnabled());
 
             string dbNameSTJ = $"{nameof(LinqTranslationBaselineTests)}-{Guid.NewGuid():N}";
             TestDbSTJDefault = await CosmosDefaultSTJClient.CreateDatabaseAsync(dbNameSTJ);

Microsoft.Azure.Cosmos/tests/Microsoft.Azure.Cosmos.Tests/Contracts/DotNetSDKAPI.json

@@ -2711,11 +2711,23 @@
           ],
           "MethodInfo": "Boolean get_LimitToEndpoint();IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
         },
+        "Boolean get_UseSystemTextJsonForSerialization()[System.Runtime.CompilerServices.CompilerGeneratedAttribute()]": {
+          "Type": "Method",
+          "Attributes": [
+            "CompilerGeneratedAttribute"
+          ],
+          "MethodInfo": "Boolean get_UseSystemTextJsonForSerialization();IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
+        },
         "Boolean LimitToEndpoint": {
           "Type": "Property",
           "Attributes": [],
           "MethodInfo": "Boolean LimitToEndpoint;CanRead:True;CanWrite:True;Boolean get_LimitToEndpoint();IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;Void set_LimitToEndpoint(Boolean);IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
         },
+        "Boolean UseSystemTextJsonForSerialization": {
+          "Type": "Property",
+          "Attributes": [],
+          "MethodInfo": "Boolean UseSystemTextJsonForSerialization;CanRead:True;CanWrite:True;Boolean get_UseSystemTextJsonForSerialization();IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;Void set_UseSystemTextJsonForSerialization(Boolean);IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
+        },
         "Int32 GatewayModeMaxConnectionLimit": {
           "Type": "Property",
           "Attributes": [],
@@ -3165,6 +3177,13 @@
           ],
           "MethodInfo": "Void set_TokenCredentialBackgroundRefreshInterval(System.Nullable`1[System.TimeSpan]);IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
         },
+        "Void set_UseSystemTextJsonForSerialization(Boolean)[System.Runtime.CompilerServices.CompilerGeneratedAttribute()]": {
+          "Type": "Method",
+          "Attributes": [
+            "CompilerGeneratedAttribute"
+          ],
+          "MethodInfo": "Void set_UseSystemTextJsonForSerialization(Boolean);IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
+        },
         "Void set_WebProxy(System.Net.IWebProxy)": {
           "Type": "Method",
           "Attributes": [],

Microsoft.Azure.Cosmos/tests/Microsoft.Azure.Cosmos.Tests/CosmosClientOptionsUnitTests.cs

@@ -501,6 +501,19 @@ public void ThrowOnCustomSerializerWithSerializerOptions()
 
             options.Serializer = new CosmosJsonDotNetSerializer();
         }
+
+        [TestMethod]
+        [ExpectedException(typeof(ArgumentException))]
+        public void ThrowOnCustomSerializerWithSTJSerializerEnabled()
+        {
+            CosmosClientOptions options = new CosmosClientOptions()
+            {
+                Serializer = new CosmosJsonDotNetSerializer()
+            };
+
+            options.SerializerOptions = new CosmosSerializationOptions();
+            options.UseSystemTextJsonForSerialization = true;
+        }
 
         [TestMethod]
         [ExpectedException(typeof(ArgumentNullException))]