Enabling serialization customization through CosmosSerializerOptions

Microsoft.Azure.Cosmos/src/CosmosClientOptions.cs

@@ -173,10 +173,7 @@ public Collection<RequestHandler> CustomHandlers
  /// <example>
  /// // An example on how to configure the serializer to ignore null values
  /// CosmosSerializer ignoreNullSerializer = new CosmosJsonDotNetSerializer(
- /// new JsonSerializerSettings()
- /// {
- /// NullValueHandling = NullValueHandling.Ignore
- /// });
+ /// NullValueHandling = NullValueHandling.Ignore);
  /// 
  /// CosmosClientOptions clientOptions = new CosmosClientOptions()
  /// {

Microsoft.Azure.Cosmos/src/CosmosJsonDotNetSerializer.cs → Microsoft.Azure.Cosmos/src/Serializer/CosmosJsonDotNetSerializer.cs

@@ -7,9 +7,10 @@ namespace Microsoft.Azure.Cosmos
  using System.IO;
  using System.Text;
  using Newtonsoft.Json;
+ using Newtonsoft.Json.Serialization;
 
  /// <summary>
- /// The default Cosmos JSON.NET serializer
+ /// The default Cosmos JSON.NET serializer.
  /// </summary>
  public sealed class CosmosJsonDotNetSerializer : CosmosSerializer
  {
@@ -19,17 +20,35 @@ public sealed class CosmosJsonDotNetSerializer : CosmosSerializer
  /// <summary>
  /// Create a serializer that uses the JSON.net serializer
  /// </summary>
- /// <param name="jsonSerializerSettings">Optional serializer settings</param>
- public CosmosJsonDotNetSerializer(JsonSerializerSettings jsonSerializerSettings = null)
+ /// <param name="ignoreNullValues">Ignore null values</param>
+ /// <param name="indented">Indent the JSON</param>
+ /// <param name="propertyNamingPolicy">Support different naming policy like CamelCase</param>
+ public CosmosJsonDotNetSerializer(
+ bool ignoreNullValues = false,
+ bool indented = false,
+ CosmosNamingPolicy propertyNamingPolicy = CosmosNamingPolicy.Default)
  {
- if (jsonSerializerSettings == null)
+ JsonSerializerSettings jsonSerializerSettings = new JsonSerializerSettings()
  {
- jsonSerializerSettings = new JsonSerializerSettings()
- {
- NullValueHandling = NullValueHandling.Include
- };
- }
+ NullValueHandling = ignoreNullValues ? NullValueHandling.Ignore : NullValueHandling.Include,
+ Formatting = indented ? Formatting.Indented : Formatting.None,
+ ContractResolver = propertyNamingPolicy == CosmosNamingPolicy.CamelCase
+ ? new CamelCasePropertyNamesContractResolver() : null,
+ };
+
+ this.Serializer = JsonSerializer.Create(jsonSerializerSettings);
+ }
 
+ /// <summary>
+ /// Create a serializer that uses the JSON.net serializer
+ /// </summary>
+ /// <remarks>
+ /// This is internal to reduce exposure of JSON.net types so
+ /// it is easier to convert to System.Text.Json
+ /// </remarks>
+ internal CosmosJsonDotNetSerializer(
+ JsonSerializerSettings jsonSerializerSettings)
+ {
  this.Serializer = JsonSerializer.Create(jsonSerializerSettings);
  }
 
@@ -45,7 +64,7 @@ public override T FromStream<T>(Stream stream)
  {
  if (typeof(Stream).IsAssignableFrom(typeof(T)))
  {
- return (T)(object)(stream);
+ return (T)(object)stream;
  }
 
  using (StreamReader sr = new StreamReader(stream))

Microsoft.Azure.Cosmos/src/Serializer/CosmosNamingPolicy.cs

@@ -0,0 +1,25 @@
+//------------------------------------------------------------
+// Copyright (c) Microsoft Corporation. All rights reserved.
+//------------------------------------------------------------
+
+namespace Microsoft.Azure.Cosmos
+{
+ using System.IO;
+
+ /// <summary>
+ /// This class provides a way to configure basic
+ /// serializer settings.
+ /// </summary>
+ public enum CosmosNamingPolicy
+ {
+ /// <summary>
+ /// The default naming policy
+ /// </summary>
+ Default = 0,
+
+ /// <summary>
+ /// Naming policy uses Camel Casing
+ /// </summary>
+ CamelCase = 1,
+ }
+}

Microsoft.Azure.Cosmos/src/Serializer/CosmosSerializerSettings.cs

@@ -0,0 +1,29 @@
+//------------------------------------------------------------
+// Copyright (c) Microsoft Corporation. All rights reserved.
+//------------------------------------------------------------
+
+namespace Microsoft.Azure.Cosmos
+{
+ /// <summary>
+ /// This class provides a way to configure basic
+ /// serializer settings.
+ /// </summary>
+ public struct CosmosSerializerSettings
+ {
+ /// <summary>
+ /// Get's if the serializer should ignore null properties
+ /// </summary>
+ public bool IgnoreNullValues { get; set; }
+
+ /// <summary>
+ /// Get's if the serializer should ignore null properties
+ /// </summary>
+ public bool Indented { get; set; }
+
+ /// <summary>
+ /// The naming policy of the serializer. This is used to configure
+ /// camel casing
+ /// </summary>
+ public CosmosNamingPolicy NamingPolicy { get; set; }
+ }
+}

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

@@ -1527,10 +1527,31 @@
  "Attributes": [],
  "MethodInfo": "T FromStream[T](System.IO.Stream)"
  },
- "Void .ctor(Newtonsoft.Json.JsonSerializerSettings)": {
+ "Void .ctor(Boolean, Boolean, Microsoft.Azure.Cosmos.CosmosNamingPolicy)": {
  "Type": "Constructor",
  "Attributes": [],
- "MethodInfo": "Void .ctor(Newtonsoft.Json.JsonSerializerSettings)"
+ "MethodInfo": "Void .ctor(Boolean, Boolean, Microsoft.Azure.Cosmos.CosmosNamingPolicy)"
+ }
+ },
+ "NestedTypes": {}
+ },
+ "CosmosNamingPolicy": {
+ "Subclasses": {},
+ "Members": {
+ "Int32 value__": {
+ "Type": "Field",
+ "Attributes": [],
+ "MethodInfo": null
+ },
+ "Microsoft.Azure.Cosmos.CosmosNamingPolicy CamelCase": {
+ "Type": "Field",
+ "Attributes": [],
+ "MethodInfo": null
+ },
+ "Microsoft.Azure.Cosmos.CosmosNamingPolicy Default": {
+ "Type": "Field",
+ "Attributes": [],
+ "MethodInfo": null
  }
  },
  "NestedTypes": {}
@@ -1550,10 +1571,10 @@
  "Attributes": [],
  "MethodInfo": "T FromStream[T](System.IO.Stream)"
  },
- "Void .ctor(Newtonsoft.Json.JsonSerializerSettings)": {
+ "Void .ctor(Boolean, Boolean, Microsoft.Azure.Cosmos.CosmosNamingPolicy)": {
  "Type": "Constructor",
  "Attributes": [],
- "MethodInfo": "Void .ctor(Newtonsoft.Json.JsonSerializerSettings)"
+ "MethodInfo": "Void .ctor(Boolean, Boolean, Microsoft.Azure.Cosmos.CosmosNamingPolicy)"
  }
  },
  "NestedTypes": {}
@@ -1573,6 +1594,72 @@
  },
  "NestedTypes": {}
  },
+ "CosmosSerializerSettings": {
+ "Subclasses": {},
+ "Members": {
+ "Boolean get_IgnoreNullValues()[System.Runtime.CompilerServices.IsReadOnlyAttribute()]-[System.Runtime.CompilerServices.CompilerGeneratedAttribute()]": {
+ "Type": "Method",
+ "Attributes": [
+ "CompilerGeneratedAttribute",
+ "IsReadOnlyAttribute"
+ ],
+ "MethodInfo": "Boolean get_IgnoreNullValues()"
+ },
+ "Boolean get_Indented()[System.Runtime.CompilerServices.IsReadOnlyAttribute()]-[System.Runtime.CompilerServices.CompilerGeneratedAttribute()]": {
+ "Type": "Method",
+ "Attributes": [
+ "CompilerGeneratedAttribute",
+ "IsReadOnlyAttribute"
+ ],
+ "MethodInfo": "Boolean get_Indented()"
+ },
+ "Boolean IgnoreNullValues": {
+ "Type": "Property",
+ "Attributes": [],
+ "MethodInfo": null
+ },
+ "Boolean Indented": {
+ "Type": "Property",
+ "Attributes": [],
+ "MethodInfo": null
+ },
+ "Microsoft.Azure.Cosmos.CosmosNamingPolicy get_NamingPolicy()[System.Runtime.CompilerServices.IsReadOnlyAttribute()]-[System.Runtime.CompilerServices.CompilerGeneratedAttribute()]": {
+ "Type": "Method",
+ "Attributes": [
+ "CompilerGeneratedAttribute",
+ "IsReadOnlyAttribute"
+ ],
+ "MethodInfo": "Microsoft.Azure.Cosmos.CosmosNamingPolicy get_NamingPolicy()"
+ },
+ "Microsoft.Azure.Cosmos.CosmosNamingPolicy NamingPolicy": {
+ "Type": "Property",
+ "Attributes": [],
+ "MethodInfo": null
+ },
+ "Void set_IgnoreNullValues(Boolean)[System.Runtime.CompilerServices.CompilerGeneratedAttribute()]": {
+ "Type": "Method",
+ "Attributes": [
+ "CompilerGeneratedAttribute"
+ ],
+ "MethodInfo": "Void set_IgnoreNullValues(Boolean)"
+ },
+ "Void set_Indented(Boolean)[System.Runtime.CompilerServices.CompilerGeneratedAttribute()]": {
+ "Type": "Method",
+ "Attributes": [
+ "CompilerGeneratedAttribute"
+ ],
+ "MethodInfo": "Void set_Indented(Boolean)"
+ },
+ "Void set_NamingPolicy(Microsoft.Azure.Cosmos.CosmosNamingPolicy)[System.Runtime.CompilerServices.CompilerGeneratedAttribute()]": {
+ "Type": "Method",
+ "Attributes": [
+ "CompilerGeneratedAttribute"
+ ],
+ "MethodInfo": "Void set_NamingPolicy(Microsoft.Azure.Cosmos.CosmosNamingPolicy)"
+ }
+ },
+ "NestedTypes": {}
+ },
  "Database": {
  "Subclasses": {},
  "Members": {

changelog.md

@@ -5,6 +5,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+### Changed
+- [#650](https://github.com/Azure/azure-cosmos-dotnet-v3/pull/650) CosmosJsonDotNetSerializer changed constructor to use flags instead of JsonSerializerSettings
 ### Fixed
 
 - [#612](https://github.com/Azure/azure-cosmos-dotnet-v3/pull/612) Bug fix for ReadFeed with partition-key