Statistics not getting populated correctly on CosmosException (#846)

* Adding ToString * Adding test * Changelog * Changing serialization * Making test more robust * Fix test * Partition key * Using session consistency
Azure · Sep 27, 2019 · a96d32f · a96d32f
1 parent c5cc95a
commit a96d32f
Show file tree

Hide file tree

Showing 3 changed files with 62 additions and 6 deletions.
diff --git a/Microsoft.Azure.Cosmos/src/Resource/Settings/CosmosClientSideRequestStatistics.cs b/Microsoft.Azure.Cosmos/src/Resource/Settings/CosmosClientSideRequestStatistics.cs
@@ -13,22 +13,24 @@ namespace Microsoft.Azure.Cosmos
 
     internal sealed class CosmosClientSideRequestStatistics : IClientSideRequestStatistics
     {
+        private static JsonSerializerSettings SerializerSettings = new JsonSerializerSettings()
+        {
+            NullValueHandling = NullValueHandling.Ignore,
+            Formatting = Formatting.None
+        };
         internal const int MaxSupplementalRequestsForToString = 10;
 
         internal DateTime requestStartTime;
         internal DateTime requestEndTime;
 
         private object lockObject = new object();
 
-        internal List<StoreResponseStatistics> responseStatisticsList;
-        internal List<StoreResponseStatistics> supplementalResponseStatisticsList;
-        internal Dictionary<string, AddressResolutionStatistics> addressResolutionStatistics;
+        public List<StoreResponseStatistics> responseStatisticsList { get; private set; }
+        public List<StoreResponseStatistics> supplementalResponseStatisticsList { get; internal set; }
+        public Dictionary<string, AddressResolutionStatistics> addressResolutionStatistics { get; private set; }
 
-        [JsonIgnoreAttribute]
         public List<Uri> ContactedReplicas { get; set; }
-        [JsonIgnoreAttribute]
         public HashSet<Uri> FailedReplicas { get; private set; }
-        [JsonIgnoreAttribute]
         public HashSet<Uri> RegionsContacted { get; private set; }
 
         public CosmosClientSideRequestStatistics()
@@ -150,6 +152,20 @@ public void RecordAddressResolutionEnd(string identifier)
             }
         }
 
+        public override string ToString()
+        {
+            if (this.supplementalResponseStatisticsList != null)
+            {
+                int supplementalResponseStatisticsListCount = this.supplementalResponseStatisticsList.Count;
+                int countToRemove = Math.Max(supplementalResponseStatisticsListCount - CosmosClientSideRequestStatistics.MaxSupplementalRequestsForToString, 0);
+                if (countToRemove > 0)
+                {
+                    this.supplementalResponseStatisticsList.RemoveRange(0, countToRemove);
+                }
+            }
+            return JsonConvert.SerializeObject(this, CosmosClientSideRequestStatistics.SerializerSettings);
+        }
+
         internal struct StoreResponseStatistics
         {
             public DateTime RequestResponseTime;

diff --git a/Microsoft.Azure.Cosmos/tests/Microsoft.Azure.Cosmos.EmulatorTests/CosmosItemTests.cs b/Microsoft.Azure.Cosmos/tests/Microsoft.Azure.Cosmos.EmulatorTests/CosmosItemTests.cs
@@ -1533,6 +1533,45 @@ public async Task VerifySessionTokenPassThrough()
             Assert.AreEqual(sessionToken, readResponse.Headers.Session);
         }
 
+        [TestMethod]
+        public async Task VerifySessionNotFoundStatistics()
+        {
+            CosmosClient cosmosClient = TestCommon.CreateCosmosClient(new CosmosClientOptions() { ConsistencyLevel = Cosmos.ConsistencyLevel.Session });
+            DatabaseResponse database = await cosmosClient.CreateDatabaseIfNotExistsAsync("NoSession");
+            Container container = await database.Database.CreateContainerIfNotExistsAsync("NoSession", "/status");
+
+            try
+            {
+                ToDoActivity temp = ToDoActivity.CreateRandomToDoActivity("TBD");
+
+                ItemResponse<ToDoActivity> responseAstype = await container.CreateItemAsync<ToDoActivity>(partitionKey: new Cosmos.PartitionKey(temp.status), item: temp);
+
+                string invalidSessionToken = this.GetDifferentLSNToken(responseAstype.Headers.Session, 2000);
+
+                try
+                {
+                    ItemResponse<ToDoActivity> readResponse = await container.ReadItemAsync<ToDoActivity>(temp.id, new Cosmos.PartitionKey(temp.status), new ItemRequestOptions() { SessionToken = invalidSessionToken });
+                    Assert.Fail("Should had thrown ReadSessionNotAvailable");
+                }
+                catch (CosmosException cosmosException)
+                {
+                    Assert.IsTrue(cosmosException.Message.Contains("ContactedReplicas"), cosmosException.Message);
+                }
+            }
+            finally
+            {
+                await database.Database.DeleteAsync();
+            }
+        }
+
+        private string GetDifferentLSNToken(string token, long lsnDifferent)
+        {
+            string[] tokenParts = token.Split(':');
+            ISessionToken sessionToken = SessionTokenHelper.Parse(tokenParts[1]);
+            ISessionToken differentSessionToken = TestCommon.CreateSessionToken(sessionToken, sessionToken.LSN + lsnDifferent);
+            return string.Format(CultureInfo.InvariantCulture, "{0}:{1}", tokenParts[0], differentSessionToken.ConvertToString());
+        }
+
         /// <summary>
         /// Stateless container re-create test. 
         /// Create two client instances and do meta data operations through a single client

diff --git a/changelog.md b/changelog.md
@@ -16,6 +16,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 
 - [#835](https://github.com/Azure/azure-cosmos-dotnet-v3/pull/835) Fixed a bug that caused sortedRanges exceptions
+- [#846](https://github.com/Azure/azure-cosmos-dotnet-v3/pull/846) Statistics not getting populated correctly on CosmosException.
 
 ## <a name="3.2.0"/> [3.2.0](https://www.nuget.org/packages/Microsoft.Azure.Cosmos/3.2.0) - 2019-09-17