Performance: Adds query improvement to avoid ImmutableDictionary (#2861)

Changed AdditionalHeaders variable type to IReadOnlyDictionary from ImmutableDictionary in order to avoid the creation on this object on every call unnecessarily.
Azure · Nov 9, 2021 · b1fba88 · b1fba88
1 parent 56c0ce8
commit b1fba88
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 13 deletions.
diff --git a/Microsoft.Azure.Cosmos/src/ChangeFeed/ChangeFeedPage.cs b/Microsoft.Azure.Cosmos/src/ChangeFeed/ChangeFeedPage.cs
@@ -5,6 +5,7 @@
 namespace Microsoft.Azure.Cosmos.ChangeFeed
 {
     using System;
+    using System.Collections.Generic;
     using System.Collections.Immutable;
     using Microsoft.Azure.Cosmos.CosmosElements;
 
@@ -24,7 +25,7 @@ sealed class ChangeFeedPage
             double requestCharge,
             string activityId,
             ChangeFeedCrossFeedRangeState state,
-            ImmutableDictionary<string, string> additionalHeaders)
+            IReadOnlyDictionary<string, string> additionalHeaders)
         {
             this.Documents = documents ?? throw new ArgumentOutOfRangeException(nameof(documents));
             this.NotModified = notModified;
@@ -44,13 +45,13 @@ sealed class ChangeFeedPage
 
         public ChangeFeedCrossFeedRangeState State { get; }
 
-        public ImmutableDictionary<string, string> AdditionalHeaders { get; }
+        public IReadOnlyDictionary<string, string> AdditionalHeaders { get; }
 
         public static ChangeFeedPage CreateNotModifiedPage(
             double requestCharge, 
             string activityId, 
             ChangeFeedCrossFeedRangeState state,
-            ImmutableDictionary<string, string> additionalHeaders)
+            IReadOnlyDictionary<string, string> additionalHeaders)
         {
             return new ChangeFeedPage(CosmosArray.Empty, notModified: true, requestCharge, activityId, state, additionalHeaders);
         }
@@ -59,8 +60,8 @@ sealed class ChangeFeedPage
             CosmosArray documents, 
             double requestCharge,
             string activityId, 
-            ChangeFeedCrossFeedRangeState state, 
-            ImmutableDictionary<string, string> additionalHeaders)
+            ChangeFeedCrossFeedRangeState state,
+            IReadOnlyDictionary<string, string> additionalHeaders)
         {
             return new ChangeFeedPage(documents, notModified: false, requestCharge, activityId, state, additionalHeaders);
         }

diff --git a/Microsoft.Azure.Cosmos/src/Pagination/Page.cs b/Microsoft.Azure.Cosmos/src/Pagination/Page.cs
@@ -17,7 +17,7 @@ internal abstract class Page<TState>
             Microsoft.Azure.Documents.HttpConstants.HttpHeaders.ActivityId,
         }.ToImmutableHashSet();
 
-        private static readonly ImmutableDictionary<string, string> EmptyDictionary = new Dictionary<string, string>().ToImmutableDictionary();
+        private static readonly IReadOnlyDictionary<string, string> EmptyDictionary = new Dictionary<string, string>();
 
         protected Page(
             double requestCharge,
@@ -44,14 +44,14 @@ internal abstract class Page<TState>
             }
 #endif
 
-            this.AdditionalHeaders = additionalHeaders == null ? EmptyDictionary : additionalHeaders.ToImmutableDictionary();
+            this.AdditionalHeaders = additionalHeaders ?? EmptyDictionary;
         }
 
         public double RequestCharge { get; }
 
         public string ActivityId { get; }
 
-        public ImmutableDictionary<string, string> AdditionalHeaders { get; }
+        public IReadOnlyDictionary<string, string> AdditionalHeaders { get; }
 
         public TState State { get; }
 

diff --git a/Microsoft.Azure.Cosmos/src/Query/Core/Pipeline/DCount/DCountQueryPipelineStage.Client.cs b/Microsoft.Azure.Cosmos/src/Query/Core/Pipeline/DCount/DCountQueryPipelineStage.Client.cs
@@ -74,7 +74,7 @@ public override async ValueTask<bool> MoveNextAsync(ITrace trace)
 
                 double requestCharge = 0;
                 long responseLengthBytes = 0;
-                ImmutableDictionary<string, string> additionalHeaders = null;
+                IReadOnlyDictionary<string, string> additionalHeaders = null;
                 while (await this.inputStage.MoveNextAsync(trace))
                 {
                     TryCatch<QueryPage> tryGetPageFromSource = this.inputStage.Current;

diff --git a/Microsoft.Azure.Cosmos/src/Query/Core/Pipeline/GroupBy/GroupByQueryPipelineStage.Client.cs b/Microsoft.Azure.Cosmos/src/Query/Core/Pipeline/GroupBy/GroupByQueryPipelineStage.Client.cs
@@ -83,7 +83,7 @@ public override async ValueTask<bool> MoveNextAsync(ITrace trace)
 
                 double requestCharge = 0.0;
                 long responseLengthInBytes = 0;
-                ImmutableDictionary<string, string> addtionalHeaders = null;
+                IReadOnlyDictionary<string, string> addtionalHeaders = null;
 
                 while (await this.inputStage.MoveNextAsync(trace))
                 {

diff --git a/Microsoft.Azure.Cosmos/src/Query/Core/Pipeline/SkipEmptyPageQueryPipelineStage.cs b/Microsoft.Azure.Cosmos/src/Query/Core/Pipeline/SkipEmptyPageQueryPipelineStage.cs
@@ -21,7 +21,7 @@ internal sealed class SkipEmptyPageQueryPipelineStage : IQueryPipelineStage
         private readonly IQueryPipelineStage inputStage;
         private double cumulativeRequestCharge;
         private long cumulativeResponseLengthInBytes;
-        private ImmutableDictionary<string, string> cumulativeAdditionalHeaders;
+        private IReadOnlyDictionary<string, string> cumulativeAdditionalHeaders;
         private CancellationToken cancellationToken;
         private bool returnedFinalStats;
 

diff --git a/Microsoft.Azure.Cosmos/src/ReadFeed/ReadFeedPage.cs b/Microsoft.Azure.Cosmos/src/ReadFeed/ReadFeedPage.cs
@@ -24,7 +24,7 @@ sealed class ReadFeedPage
             double requestCharge,  
             string activityId, 
             ReadFeedCrossFeedRangeState? state,
-            ImmutableDictionary<string, string> additionalHeaders)
+            IReadOnlyDictionary<string, string> additionalHeaders)
         {
             this.Documents = documents ?? throw new ArgumentNullException(nameof(documents));
             this.RequestCharge = requestCharge < 0 ? throw new ArgumentOutOfRangeException(nameof(requestCharge)) : requestCharge;
@@ -41,6 +41,6 @@ sealed class ReadFeedPage
 
         public ReadFeedCrossFeedRangeState? State { get; }
 
-        public ImmutableDictionary<string, string> AdditionalHeaders { get; }
+        public IReadOnlyDictionary<string, string> AdditionalHeaders { get; }
     }
 }