Add DuplicatePropertyNameChecker to ObjectPool (#2328)

OData · Apr 14, 2022 · 277e17f · 277e17f
1 parent acc2c70
commit 277e17f
Show file tree

Hide file tree

Showing 15 changed files with 211 additions and 50 deletions.
diff --git a/src/Microsoft.OData.Core/IWriterValidator.cs b/src/Microsoft.OData.Core/IWriterValidator.cs
@@ -15,10 +15,15 @@ namespace Microsoft.OData
     internal interface IWriterValidator
     {
         /// <summary>
-        /// Creates a DuplicatePropertyNameChecker instance.
+        /// Get a DuplicatePropertyNameChecker instance from the object pool.
         /// </summary>
-        /// <returns>The created instance.</returns>
-        IDuplicatePropertyNameChecker CreateDuplicatePropertyNameChecker();
+        /// <returns>The instance retrieved from the object pool.</returns>
+        IDuplicatePropertyNameChecker GetDuplicatePropertyNameChecker();
+
+        /// <summary>
+        /// Return a DuplicatePropertyNameChecker instance to the object pool.
+        /// </summary>
+        void ReturnDuplicatePropertyNameChecker(IDuplicatePropertyNameChecker duplicatePropertyNameChecker);
 
         /// <summary>
         /// Validates a resource in an expanded link to make sure that the types match.

diff --git a/src/Microsoft.OData.Core/Json/JsonLightInstanceAnnotationWriter.cs b/src/Microsoft.OData.Core/Json/JsonLightInstanceAnnotationWriter.cs
@@ -201,11 +201,13 @@ internal void WriteInstanceAnnotation(
             ODataResourceValue resourceValue = value as ODataResourceValue;
             if (resourceValue != null)
             {
+                IDuplicatePropertyNameChecker duplicatePropertyNameChecker = this.valueSerializer.GetDuplicatePropertyNameChecker();
                 this.WriteInstanceAnnotationName(propertyName, name);
                 this.valueSerializer.WriteResourceValue(resourceValue,
                     expectedType,
                     treatLikeOpenProperty,
-                    this.valueSerializer.CreateDuplicatePropertyNameChecker());
+                    duplicatePropertyNameChecker);
+                this.valueSerializer.ReturnDuplicatePropertyNameChecker(duplicatePropertyNameChecker);
                 return;
             }
 
@@ -389,12 +391,15 @@ await this.valueSerializer.WriteNullValueAsync()
             ODataResourceValue resourceValue = annotationValue as ODataResourceValue;
             if (resourceValue != null)
             {
+                IDuplicatePropertyNameChecker duplicatePropertyNameChecker = this.valueSerializer.GetDuplicatePropertyNameChecker();
                 await this.WriteInstanceAnnotationNameAsync(propertyName, annotationName)
                     .ConfigureAwait(false);
                 await this.valueSerializer.WriteResourceValueAsync(resourceValue,
                     expectedType,
                     treatLikeOpenProperty,
-                    this.valueSerializer.CreateDuplicatePropertyNameChecker()).ConfigureAwait(false);
+                    duplicatePropertyNameChecker).ConfigureAwait(false);
+                this.valueSerializer.ReturnDuplicatePropertyNameChecker(duplicatePropertyNameChecker);
+
                 return;
             }
 

diff --git a/src/Microsoft.OData.Core/JsonLight/ODataJsonLightCollectionWriter.cs b/src/Microsoft.OData.Core/JsonLight/ODataJsonLightCollectionWriter.cs
@@ -114,6 +114,7 @@ protected override void StartCollection(ODataCollectionStart collectionStart)
         /// </summary>
         protected override void EndCollection()
         {
+            this.jsonLightCollectionSerializer.ReturnDuplicatePropertyNameChecker(this.DuplicatePropertyNameChecker);
             this.jsonLightCollectionSerializer.WriteCollectionEnd();
         }
 
@@ -199,6 +200,8 @@ protected override Task StartCollectionAsync(ODataCollectionStart collectionStar
         /// <returns>A task that represents the asynchronous write operation.</returns>
         protected override Task EndCollectionAsync()
         {
+            this.jsonLightCollectionSerializer.ReturnDuplicatePropertyNameChecker(this.DuplicatePropertyNameChecker);
+
             return this.jsonLightCollectionSerializer.WriteCollectionEndAsync();
         }
 

diff --git a/src/Microsoft.OData.Core/JsonLight/ODataJsonLightParameterWriter.cs b/src/Microsoft.OData.Core/JsonLight/ODataJsonLightParameterWriter.cs
@@ -85,6 +85,7 @@ protected override void StartPayload()
         protected override void EndPayload()
         {
             // NOTE: we are always writing a request payload here.
+            this.jsonLightValueSerializer.ReturnDuplicatePropertyNameChecker(this.DuplicatePropertyNameChecker);
             this.jsonLightOutputContext.JsonWriter.EndObjectScope();
             this.jsonLightValueSerializer.WritePayloadEnd();
         }
@@ -174,6 +175,7 @@ await this.jsonLightOutputContext.AsynchronousJsonWriter.StartObjectScopeAsync()
         protected override async Task EndPayloadAsync()
         {
             // NOTE: we are always writing a request payload here.
+            this.jsonLightValueSerializer.ReturnDuplicatePropertyNameChecker(this.DuplicatePropertyNameChecker);
             await this.jsonLightOutputContext.AsynchronousJsonWriter.EndObjectScopeAsync()
                 .ConfigureAwait(false);
             await this.jsonLightValueSerializer.WritePayloadEndAsync()

diff --git a/src/Microsoft.OData.Core/JsonLight/ODataJsonLightPropertySerializer.cs b/src/Microsoft.OData.Core/JsonLight/ODataJsonLightPropertySerializer.cs
@@ -78,14 +78,17 @@ internal void WriteTopLevelProperty(ODataProperty property)
 
                     // Note we do not allow named stream properties to be written as top level property.
                     this.JsonLightValueSerializer.AssertRecursionDepthIsZero();
+                    IDuplicatePropertyNameChecker duplicatePropertyNameChecker = this.GetDuplicatePropertyNameChecker();
+
                     this.WriteProperty(
                         property,
-                        null /*owningType*/,
-                        true /* isTopLevel */,
-                        this.CreateDuplicatePropertyNameChecker(),
-                        null /* metadataBuilder */);
-                    this.JsonLightValueSerializer.AssertRecursionDepthIsZero();
+                        owningType: null,
+                        isTopLevel: true,
+                        duplicatePropertyNameChecker: duplicatePropertyNameChecker,
+                        metadataBuilder : null);
 
+                    this.JsonLightValueSerializer.AssertRecursionDepthIsZero();
+                    this.ReturnDuplicatePropertyNameChecker(duplicatePropertyNameChecker);
                     this.JsonWriter.EndObjectScope();
                 });
         }
@@ -276,14 +279,17 @@ await this.WriteContextUriPropertyAsync(kind, () => contextInfo)
 
                     // Note we do not allow named stream properties to be written as top level property.
                     this.JsonLightValueSerializer.AssertRecursionDepthIsZero();
+                    IDuplicatePropertyNameChecker duplicatePropertyNameChecker = this.GetDuplicatePropertyNameChecker();
+
                     await this.WritePropertyAsync(
                         property,
-                        null /*owningType*/,
-                        true /* isTopLevel */,
-                        this.CreateDuplicatePropertyNameChecker(),
-                        null /* metadataBuilder */).ConfigureAwait(false);
-                    this.JsonLightValueSerializer.AssertRecursionDepthIsZero();
+                        owningType : null,
+                        isTopLevel : true,
+                        duplicatePropertyNameChecker : duplicatePropertyNameChecker,
+                        metadataBuilder : null).ConfigureAwait(false);
 
+                    this.JsonLightValueSerializer.AssertRecursionDepthIsZero();
+                    this.ReturnDuplicatePropertyNameChecker(duplicatePropertyNameChecker);
                     await this.AsynchronousJsonWriter.EndObjectScopeAsync().ConfigureAwait(false);
                 });
         }
@@ -645,11 +651,15 @@ private void WriteResourceProperty(
             Debug.Assert(!this.currentPropertyInfo.IsTopLevel, "Resource property should not be top level");
             this.JsonWriter.WriteName(property.Name);
 
+            IDuplicatePropertyNameChecker duplicatePropertyNameChecker = this.GetDuplicatePropertyNameChecker();
+
             this.JsonLightValueSerializer.WriteResourceValue(
                 resourceValue,
                 this.currentPropertyInfo.MetadataType.TypeReference,
                 isOpenPropertyType,
-                this.CreateDuplicatePropertyNameChecker());
+                duplicatePropertyNameChecker);
+
+            this.ReturnDuplicatePropertyNameChecker(duplicatePropertyNameChecker);
         }
 
         /// <summary>
@@ -1071,11 +1081,15 @@ private async Task WriteResourcePropertyAsync(
             await this.AsynchronousJsonWriter.WriteNameAsync(property.Name)
                 .ConfigureAwait(false);
 
+            IDuplicatePropertyNameChecker duplicatePropertyNameChecker = this.GetDuplicatePropertyNameChecker();
+
             await this.JsonLightValueSerializer.WriteResourceValueAsync(
                 resourceValue,
                 this.currentPropertyInfo.MetadataType.TypeReference,
                 isOpenPropertyType,
-                this.CreateDuplicatePropertyNameChecker()).ConfigureAwait(false);
+                duplicatePropertyNameChecker).ConfigureAwait(false);
+
+            this.ReturnDuplicatePropertyNameChecker(duplicatePropertyNameChecker);
         }
 
         /// <summary>

diff --git a/src/Microsoft.OData.Core/JsonLight/ODataJsonLightValueSerializer.cs b/src/Microsoft.OData.Core/JsonLight/ODataJsonLightValueSerializer.cs
@@ -245,7 +245,7 @@ public virtual void WriteCollectionValue(
                     {
                         if (duplicatePropertyNamesChecker == null)
                         {
-                            duplicatePropertyNamesChecker = this.CreateDuplicatePropertyNameChecker();
+                            duplicatePropertyNamesChecker = this.GetDuplicatePropertyNameChecker();
                         }
 
                         this.WriteResourceValue(
@@ -286,6 +286,11 @@ public virtual void WriteCollectionValue(
                         }
                     }
                 }
+
+                if (duplicatePropertyNamesChecker != null)
+                {
+                    this.ReturnDuplicatePropertyNameChecker(duplicatePropertyNamesChecker);
+                }
             }
 
             // End the array scope which holds the items
@@ -567,7 +572,7 @@ await this.AsynchronousODataAnnotationWriter.WriteODataTypeInstanceAnnotationAsy
                     {
                         if (duplicatePropertyNamesChecker == null)
                         {
-                            duplicatePropertyNamesChecker = this.CreateDuplicatePropertyNameChecker();
+                            duplicatePropertyNamesChecker = this.GetDuplicatePropertyNameChecker();
                         }
 
                         await this.WriteResourceValueAsync(
@@ -608,6 +613,11 @@ await this.WriteResourceValueAsync(
                         }
                     }
                 }
+
+                if (duplicatePropertyNamesChecker != null)
+                {
+                    this.ReturnDuplicatePropertyNameChecker(duplicatePropertyNamesChecker);
+                }
             }
 
             // End the array scope which holds the items

diff --git a/src/Microsoft.OData.Core/JsonLight/ODataJsonLightWriter.cs b/src/Microsoft.OData.Core/JsonLight/ODataJsonLightWriter.cs
@@ -487,6 +487,9 @@ protected override void EndResource(ODataResource resource)
 
             this.jsonLightResourceSerializer.WriteResourceEndMetadataProperties(resourceScope, resourceScope.DuplicatePropertyNameChecker);
 
+            // Release the DuplicatePropertyNameChecker to the object pool since an instance is removed from the object pool each time we create a ResourceScope.
+            this.jsonLightResourceSerializer.ReturnDuplicatePropertyNameChecker(resourceScope.DuplicatePropertyNameChecker);
+
             // Close the object scope
             this.jsonWriter.EndObjectScope();
         }
@@ -1438,6 +1441,9 @@ await this.jsonLightResourceSerializer.WriteResourceEndMetadataPropertiesAsync(
                 resourceScope,
                 resourceScope.DuplicatePropertyNameChecker).ConfigureAwait(false);
 
+            // Release the DuplicatePropertyNameChecker to the object pool since an instance is removed from the object pool each time we create a ResourceScope.
+            this.jsonLightResourceSerializer.ReturnDuplicatePropertyNameChecker(resourceScope.DuplicatePropertyNameChecker);
+
             // Close the object scope
             await this.asynchronousJsonWriter.EndObjectScopeAsync()
                 .ConfigureAwait(false);

diff --git a/src/Microsoft.OData.Core/Microsoft.OData.Core.csproj b/src/Microsoft.OData.Core/Microsoft.OData.Core.csproj
@@ -95,5 +95,8 @@
     <PackageReference Include="Microsoft.Bcl.AsyncInterfaces">
       <Version>5.0.0</Version>
     </PackageReference>
+    <PackageReference Include="Microsoft.Extensions.ObjectPool">
+      <Version>6.0.3</Version>
+    </PackageReference>
   </ItemGroup>
 </Project>
diff --git a/src/Microsoft.OData.Core/ODataCollectionWriterCore.cs b/src/Microsoft.OData.Core/ODataCollectionWriterCore.cs
@@ -106,7 +106,7 @@ protected IDuplicatePropertyNameChecker DuplicatePropertyNameChecker
             {
                 return duplicatePropertyNameChecker
                        ?? (duplicatePropertyNameChecker
-                           = outputContext.MessageWriterSettings.Validator.CreateDuplicatePropertyNameChecker());
+                           = outputContext.MessageWriterSettings.Validator.GetDuplicatePropertyNameChecker());
             }
         }
 

diff --git a/src/Microsoft.OData.Core/ODataParameterWriterCore.cs b/src/Microsoft.OData.Core/ODataParameterWriterCore.cs
@@ -84,7 +84,7 @@ protected IDuplicatePropertyNameChecker DuplicatePropertyNameChecker
                 return this.duplicatePropertyNameChecker ??
                        (this.duplicatePropertyNameChecker =
                            outputContext.MessageWriterSettings.Validator
-                           .CreateDuplicatePropertyNameChecker());
+                           .GetDuplicatePropertyNameChecker());
             }
         }
 

diff --git a/src/Microsoft.OData.Core/ODataSerializer.cs b/src/Microsoft.OData.Core/ODataSerializer.cs
@@ -81,12 +81,20 @@ internal IEdmModel Model
         }
 
         /// <summary>
-        /// Creates a new instance of a duplicate property names checker.
+        /// Get an instance of a duplicate property names checker from the object pool.
         /// </summary>
-        /// <returns>The newly created instance of duplicate property names checker.</returns>
-        internal IDuplicatePropertyNameChecker CreateDuplicatePropertyNameChecker()
+        /// <returns>The instance retrieved from the object pool.</returns>
+        internal IDuplicatePropertyNameChecker GetDuplicatePropertyNameChecker()
         {
-            return MessageWriterSettings.Validator.CreateDuplicatePropertyNameChecker();
+            return MessageWriterSettings.Validator.GetDuplicatePropertyNameChecker();
+        }
+
+        /// <summary>
+        /// Returns an instance of a duplicate property names checker to the object pool.
+        /// </summary>
+        internal void ReturnDuplicatePropertyNameChecker(IDuplicatePropertyNameChecker duplicatePropertyNameChecker)
+        {
+            MessageWriterSettings.Validator.ReturnDuplicatePropertyNameChecker(duplicatePropertyNameChecker);
         }
     }
 }
diff --git a/src/Microsoft.OData.Core/ODataWriterCore.cs b/src/Microsoft.OData.Core/ODataWriterCore.cs
@@ -4136,7 +4136,7 @@ internal ResourceBaseScope(WriterState state, ODataResourceBase resource, ODataR
 
                 if (resource != null)
                 {
-                    duplicatePropertyNameChecker = writerSettings.Validator.CreateDuplicatePropertyNameChecker();
+                    duplicatePropertyNameChecker = writerSettings.Validator.GetDuplicatePropertyNameChecker();
                 }
 
                 this.serializationInfo = serializationInfo;

diff --git a/src/Microsoft.OData.Core/Uri/ODataUriConversionUtils.cs b/src/Microsoft.OData.Core/Uri/ODataUriConversionUtils.cs
@@ -261,11 +261,11 @@ internal static string ConvertToResourceLiteral(ODataResourceValue resourceValue
                     model,
                     messageWriterSettings,
                     textWriter,
-                    (serializer) => serializer.WriteResourceValue(
-                        resourceValue, /* resourceValue */
-                        null, /* metadataTypeReference */
-                        true, /* isOpenPropertyType */
-                        serializer.CreateDuplicatePropertyNameChecker()));
+                    (serializer, duplicatePropertyNamesChecker) => serializer.WriteResourceValue(
+                        resourceValue,
+                        metadataTypeReference : null,
+                        isOpenPropertyType : true,
+                        duplicatePropertyNamesChecker: duplicatePropertyNamesChecker));
             }
 
             return builder.ToString();
@@ -313,13 +313,14 @@ internal static string ConvertToUriCollectionLiteral(ODataCollectionValue collec
                     model,
                     messageWriterSettings,
                     textWriter,
-                    (serializer) => serializer.WriteCollectionValue(
+                    (serializer, duplicatePropertyNameChecker) => serializer.WriteCollectionValue(
                         collectionValue,
-                        null /*metadataTypeReference*/,
-                        null /*valueTypeReference*/,
-                        false /*isTopLevelProperty*/,
-                        true /*isInUri*/,
-                        false /*isOpenPropertyType*/));
+                        metadataTypeReference : null,
+                        valueTypeReference : null,
+                        isTopLevelProperty: false,
+                        isInUri: true,
+                        isOpenPropertyType: false),
+                        isResourceValue: false);
             }
 
             return builder.ToString();
@@ -554,7 +555,8 @@ private static void WriteStartResource(ODataWriter writer, ODataResourceBase res
         /// <param name="messageWriterSettings">Settings to use when writing.</param>
         /// <param name="textWriter">TextWriter to use as the output for the value.</param>
         /// <param name="writeValue">Delegate to use to actually write the value.</param>
-        private static void WriteJsonLightLiteral(IEdmModel model, ODataMessageWriterSettings messageWriterSettings, TextWriter textWriter, Action<ODataJsonLightValueSerializer> writeValue)
+        /// <param name="isResourceValue">We want to pass the <see cref="IDuplicatePropertyNameChecker"/> instance to the Action delegate when writing Resource value but not Collection value.</param>
+        private static void WriteJsonLightLiteral(IEdmModel model, ODataMessageWriterSettings messageWriterSettings, TextWriter textWriter, Action<ODataJsonLightValueSerializer, IDuplicatePropertyNameChecker> writeValue, bool isResourceValue = true)
         {
             IEnumerable<KeyValuePair<string, string>> parameters = new Dictionary<string, string>
             {
@@ -577,7 +579,18 @@ private static void WriteJsonLightLiteral(IEdmModel model, ODataMessageWriterSet
                 new ODataJsonLightOutputContext(textWriter, messageInfo, messageWriterSettings))
             {
                 ODataJsonLightValueSerializer jsonLightValueSerializer = new ODataJsonLightValueSerializer(jsonOutputContext);
-                writeValue(jsonLightValueSerializer);
+
+                if (!isResourceValue)
+                {
+                    writeValue(jsonLightValueSerializer, null);
+                }
+                else
+                {
+                    IDuplicatePropertyNameChecker duplicatePropertyNameChecker = jsonLightValueSerializer.GetDuplicatePropertyNameChecker();
+                    writeValue(jsonLightValueSerializer, duplicatePropertyNameChecker);
+                    jsonLightValueSerializer.ReturnDuplicatePropertyNameChecker(duplicatePropertyNameChecker);
+                }
+
                 jsonLightValueSerializer.AssertRecursionDepthIsZero();
             }
         }