Adding benchmarks to compare Patch model to Standard model

eng/Packages.Data.props

@@ -175,7 +175,7 @@
   -->
   <ItemGroup>
     <PackageReference Update="Microsoft.Azure.AutoRest.CSharp" Version="3.0.0-beta.20230814.2" PrivateAssets="All" />
-    <PackageReference Update="Azure.ClientSdk.Analyzers" Version="0.1.1-dev.20230131.1" PrivateAssets="All" />
+    <PackageReference Update="Azure.ClientSdk.Analyzers" Version="0.1.1-dev.20230811.4" PrivateAssets="All" />
     <PackageReference Update="coverlet.collector" Version="3.2.0" PrivateAssets="All" />
     <PackageReference Update="Microsoft.CodeAnalysis.NetAnalyzers" Version="7.0.1" PrivateAssets="All" />
     <PackageReference Update="Microsoft.CodeAnalysis.BannedApiAnalyzers" Version="3.3.2" PrivateAssets="All" />

sdk/core/Azure.Core/perf/Serializations/JsonBenchmark.cs

@@ -123,11 +123,23 @@ public void Serialize_PublicInterface()
 
         [Benchmark]
         [BenchmarkCategory("Internal")]
-        public T Deserialize_Internal()
+        public T Deserialize_Internal_JsonElement()
         {
             return Deserialize(_jsonDocument.RootElement);
         }
 
+        protected virtual T Deserialize(BinaryData data)
+        {
+            return Deserialize(JsonDocument.Parse(data).RootElement);
+        }
+
+        [Benchmark]
+        [BenchmarkCategory("Internal")]
+        public T Deserialize_Internal_BinaryData()
+        {
+            return Deserialize(_data);
+        }
+
         [Benchmark]
         [BenchmarkCategory("Cast")]
         public T Deserialize_ExplicitCast()
@@ -189,5 +201,21 @@ public void JsonDocumentFromBinaryData()
         {
             using var doc = JsonDocument.Parse(_data);
         }
+
+        protected virtual void ModifyValues(T model) { }
+
+        [Benchmark]
+        [BenchmarkCategory("Usage")]
+        public void EndToEndUseCase()
+        {
+            // Instantiate an input model
+            T model = ModelSerializer.Deserialize<T>(_data);
+
+            // Set properties on it
+            ModifyValues(model);
+
+            // Send it over the wire - serialize
+            RequestContent content = CastToRequestContent();
+        }
     }
 }

sdk/core/Azure.Core/perf/Serializations/SimplePatchModelBenchmark.cs

@@ -0,0 +1,39 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System;
+using System.IO;
+using System.Text.Json;
+using Azure.Core.Tests.PatchModels;
+
+namespace Azure.Core.Perf.Serializations
+{
+    public class SimplePatchModelBenchmark : JsonBenchmark<SimplePatchModel>
+    {
+        protected override SimplePatchModel CastFromResponse() => (SimplePatchModel)_response;
+
+        protected override RequestContent CastToRequestContent() => _model;
+
+        protected override SimplePatchModel Deserialize(JsonElement jsonElement)
+        {
+            using Stream stream = new MemoryStream();
+            using Utf8JsonWriter writer = new(stream);
+            jsonElement.WriteTo(writer);
+            writer.Flush();
+            stream.Position = 0;
+            return Deserialize(BinaryData.FromStream(stream));
+        }
+
+        protected override SimplePatchModel Deserialize(BinaryData data) => SimplePatchModel.Deserialize(data);
+
+        protected override void Serialize(Utf8JsonWriter writer) => _model.Serialize(writer);
+
+        protected override string JsonFileName => "SimplePatchModel.json";
+
+        protected override void ModifyValues(SimplePatchModel model)
+        {
+            model.Name = "xyz";
+            model.Count = 2;
+        }
+    }
+}

sdk/core/Azure.Core/perf/Serializations/SimpleStandardModelBenchmark.cs

@@ -0,0 +1,30 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System.Text.Json;
+using Azure.Core.Tests.PatchModels;
+
+namespace Azure.Core.Perf.Serializations
+{
+    public class SimpleStandardModelBenchmark : JsonBenchmark<SimpleStandardModel>
+    {
+        protected override SimpleStandardModel CastFromResponse() => (SimpleStandardModel)_response;
+
+        protected override RequestContent CastToRequestContent() => _model;
+
+        protected override SimpleStandardModel Deserialize(JsonElement jsonElement)
+        {
+            return SimpleStandardModel.DeserializeSimpleStandardModel(jsonElement, new("J"));
+        }
+
+        protected override void Serialize(Utf8JsonWriter writer) => _model.Serialize(writer);
+
+        protected override string JsonFileName => "SimpleStandardModel.json";
+
+        protected override void ModifyValues(SimpleStandardModel model)
+        {
+            model.Name = "xyz";
+            model.Count = 2;
+        }
+    }
+}

sdk/core/Azure.Core/src/Azure.Core.csproj

@@ -64,6 +64,15 @@
     <Compile Include="Shared\HttpMessageSanitizer.cs" />
     <Compile Include="Shared\InitializationConstructorAttribute.cs" />
     <Compile Include="Shared\Multipart\MemoryResponse.cs" />
+    <Compile Include="Shared\MutableJsonChange.cs" />
+    <Compile Include="Shared\MutableJsonChangeKind.cs" />
+    <Compile Include="Shared\MutableJsonDocument.ChangeTracker.cs" />
+    <Compile Include="Shared\MutableJsonDocument.cs" />
+    <Compile Include="Shared\MutableJsonElement.ArrayEnumerator.cs" />
+    <Compile Include="Shared\MutableJsonElement.cs" />
+    <Compile Include="Shared\MutableJsonElement.ObjectEnumerator.cs" />
+    <Compile Include="Shared\MutableJsonElement.WriteTo.cs" />
+    <Compile Include="Shared\MutableJsonElement.WriteTo.MergePatch.cs" />
     <Compile Include="Shared\NullableAttributes.cs" />
     <Compile Include="Shared\OperationInternalBase.cs" />
     <Compile Include="Shared\TrimmingAttribute.cs" />

sdk/core/Azure.Core/src/DynamicData/MutableJsonChange.cs → sdk/core/Azure.Core/src/Shared/MutableJsonChange.cs

@@ -5,6 +5,8 @@
 using System.Buffers;
 using System.Text.Json;
 
+#nullable enable
+
 namespace Azure.Core.Json
 {
     internal struct MutableJsonChange

sdk/core/Azure.Core/src/DynamicData/MutableJsonChangeKind.cs → sdk/core/Azure.Core/src/Shared/MutableJsonChangeKind.cs

@@ -1,6 +1,8 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
+#nullable enable
+
 namespace Azure.Core.Json
 {
     internal enum MutableJsonChangeKind

sdk/core/Azure.Core/src/DynamicData/MutableJsonDocument.ChangeTracker.cs → sdk/core/Azure.Core/src/Shared/MutableJsonDocument.ChangeTracker.cs

@@ -6,6 +6,8 @@
 using System.Diagnostics;
 using System.Text.Json;
 
+#nullable enable
+
 namespace Azure.Core.Json
 {
     internal partial class MutableJsonDocument

sdk/core/Azure.Core/src/DynamicData/MutableJsonDocument.cs → sdk/core/Azure.Core/src/Shared/MutableJsonDocument.cs

@@ -8,6 +8,8 @@
 using System.Text.Json;
 using System.Text.Json.Serialization;
 
+#nullable enable
+
 namespace Azure.Core.Json
 {
     /// <summary>
@@ -16,6 +18,9 @@ namespace Azure.Core.Json
     [JsonConverter(typeof(MutableJsonDocumentConverter))]
     internal sealed partial class MutableJsonDocument : IDisposable
     {
+        private static readonly ReadOnlyMemory<byte> _emptyJson = "{}"u8.ToArray();
+        public static ReadOnlyMemory<byte> EmptyJson => _emptyJson;
+
         private readonly ReadOnlyMemory<byte> _original;
         private readonly JsonDocument _originalDocument;
 
@@ -199,11 +204,12 @@ public void Dispose()
             _originalDocument.Dispose();
         }
 
+        private static JsonSerializerOptions DefaultSerializerOptions = new JsonSerializerOptions();
         private MutableJsonDocument(JsonDocument document, ReadOnlyMemory<byte> utf8Json, JsonSerializerOptions? serializerOptions)
         {
             _originalDocument = document;
             _original = utf8Json;
-            _serializerOptions = serializerOptions ?? new JsonSerializerOptions();
+            _serializerOptions = serializerOptions ?? DefaultSerializerOptions;
         }
 
         private class MutableJsonDocumentConverter : JsonConverter<MutableJsonDocument>

sdk/core/Azure.Core/src/DynamicData/MutableJsonElement.ArrayEnumerator.cs → sdk/core/Azure.Core/src/Shared/MutableJsonElement.ArrayEnumerator.cs

@@ -6,6 +6,8 @@
 using System.Diagnostics;
 using System.Text.Json;
 
+#nullable enable
+
 namespace Azure.Core.Json
 {
     internal partial struct MutableJsonElement

sdk/core/Azure.Core/src/DynamicData/MutableJsonElement.ObjectEnumerator.cs → sdk/core/Azure.Core/src/Shared/MutableJsonElement.ObjectEnumerator.cs

@@ -7,6 +7,8 @@
 using System.Diagnostics;
 using System.Text.Json;
 
+#nullable enable
+
 namespace Azure.Core.Json
 {
     /// <summary>

sdk/core/Azure.Core/src/DynamicData/MutableJsonElement.WriteTo.MergePatch.cs → sdk/core/Azure.Core/src/Shared/MutableJsonElement.WriteTo.MergePatch.cs

@@ -5,6 +5,8 @@
 using System.Diagnostics;
 using System.Text.Json;
 
+#nullable enable
+
 namespace Azure.Core.Json
 {
     internal partial struct MutableJsonElement

sdk/core/Azure.Core/src/DynamicData/MutableJsonElement.WriteTo.cs → sdk/core/Azure.Core/src/Shared/MutableJsonElement.WriteTo.cs

@@ -5,6 +5,8 @@
 using System.Collections.Generic;
 using System.Text.Json;
 
+#nullable enable
+
 namespace Azure.Core.Json
 {
     internal partial struct MutableJsonElement

sdk/core/Azure.Core/src/DynamicData/MutableJsonElement.cs → sdk/core/Azure.Core/src/Shared/MutableJsonElement.cs

@@ -9,6 +9,8 @@
 using System.Text.Json;
 using System.Text.Json.Serialization;
 
+#nullable enable
+
 namespace Azure.Core.Json
 {
     /// <summary>

sdk/core/Azure.Core/tests/common/Azure.Core.Tests.Common.csproj

@@ -18,6 +18,12 @@
   </ItemGroup>
 
   <ItemGroup>
+    <None Update="TestData\SimpleStandardModel.json">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
+    <None Update="TestData\SimplePatchModel.json">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
     <None Update="TestData\AvailabilitySetData.json">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>

sdk/core/Azure.Core/tests/common/TestData/SimplePatchModel.json

@@ -0,0 +1,5 @@
+{
+    "name": "abc",
+    "count": 1,
+    "updatedOn": "2023-10-19T10:19:10.0190001Z"
+}

sdk/core/Azure.Core/tests/common/TestData/SimpleStandardModel.json

@@ -0,0 +1,5 @@
+{
+    "name": "abc",
+    "count": 1,
+    "updatedOn": "2023-10-19T10:19:10.0190001Z"
+}

sdk/core/Azure.Core/tests/public/Azure.Core.Tests.Public.csproj

@@ -22,8 +22,16 @@
 
   <!-- Shared source from Azure.Core -->
   <ItemGroup>
-    <Compile Include="$(AzureCoreSharedSources)ArrayBufferWriter.cs" LinkBase="Shared/Core" />
     <Compile Include="$(AzureCoreSharedSources)ModelSerializerHelper.cs" LinkBase="Shared/Core" />
+    <Compile Include="$(AzureCoreSharedSources)MutableJsonChange.cs" LinkBase="Shared" />
+    <Compile Include="$(AzureCoreSharedSources)MutableJsonChangeKind.cs" LinkBase="Shared" />
+    <Compile Include="$(AzureCoreSharedSources)MutableJsonDocument.cs" LinkBase="Shared" />
+    <Compile Include="$(AzureCoreSharedSources)MutableJsonDocument.ChangeTracker.cs" LinkBase="Shared" />
+    <Compile Include="$(AzureCoreSharedSources)MutableJsonElement.ArrayEnumerator.cs" LinkBase="Shared" />
+    <Compile Include="$(AzureCoreSharedSources)MutableJsonElement.cs" LinkBase="Shared" />
+    <Compile Include="$(AzureCoreSharedSources)MutableJsonElement.ObjectEnumerator.cs" LinkBase="Shared" />
+    <Compile Include="$(AzureCoreSharedSources)MutableJsonElement.WriteTo.cs" LinkBase="Shared" />
+    <Compile Include="$(AzureCoreSharedSources)MutableJsonElement.WriteTo.MergePatch.cs" LinkBase="Shared" />
   </ItemGroup>
 
 </Project>

sdk/core/Azure.Core/tests/public/PatchModels/ChildPatchModel.cs

@@ -0,0 +1,64 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using Azure.Core.Json;
+
+namespace Azure.Core.Tests.PatchModels
+{
+    /// <summary>
+    /// This model illustrates a nested child model in a parent model.
+    /// </summary>
+    public partial class ChildPatchModel
+    {
+#pragma warning disable AZC0020 // Avoid using banned types in libraries
+        private readonly MutableJsonElement _element;
+
+        // Note: A child patch model doesn't have a public constructor.
+        //
+        // When a nested model is also an input to a service method, it will
+        // need to have a public constructor.  When this happens, the parent
+        // model it is also part of will not allow it to be set, to ensure the
+        // MutableJsonElements point to the same root MutableJsonDocument when
+        // they are part of the same input, so the Patch JSON will be correct.
+
+        /// <summary> Serialization constructor. </summary>
+        /// <param name="element"></param>
+        internal ChildPatchModel(MutableJsonElement element)
+        {
+            _element = element;
+        }
+
+        /// <summary>
+        /// Optional string property corresponding to JSON """{"a": "aaa"}""".
+        /// </summary>
+        public string A
+        {
+            get
+            {
+                if (_element.TryGetProperty("a", out MutableJsonElement value))
+                {
+                    return value.GetString();
+                }
+                return null;
+            }
+            set => _element.SetProperty("a", value);
+        }
+
+        /// <summary>
+        /// Optional string property corresponding to JSON """{"b": "bbb"}""".
+        /// </summary>
+        public string B
+        {
+            get
+            {
+                if (_element.TryGetProperty("b", out MutableJsonElement value))
+                {
+                    return value.GetString();
+                }
+                return null;
+            }
+            set => _element.SetProperty("b", value);
+        }
+#pragma warning restore AZC0020 // Avoid using banned types in libraries
+    }
+}