[Internal] Category: Refactors Cosmos benchmark operations (#3961)

* Refactoring: base classes for operations. * Updating comments. * Adding new line at the end of the file. * Fixing code review points. * Restore PrepareAsync to be virtual.
Azure · Jul 14, 2023 · 8d2691b · 8d2691b
1 parent d7fc282
commit 8d2691b
Show file tree

Hide file tree

Showing 17 changed files with 73 additions and 17 deletions.
diff --git a/Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/BenchmarkOperationType.cs b/Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/BenchmarkOperationType.cs
@@ -0,0 +1,16 @@
+//------------------------------------------------------------
+// Copyright (c) Microsoft Corporation. All rights reserved.
+//------------------------------------------------------------
+
+namespace CosmosBenchmark
+{
+ /// <summary>
+ /// Benchmark operation type.
+ /// </summary>
+ public enum BenchmarkOperationType
+ {
+ Read,
+ Insert,
+ Query
+ }
+}
diff --git a/Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/Fx/CosmosDiagnosticsLogger.cs b/Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/Fx/CosmosDiagnosticsLogger.cs
@@ -6,11 +6,8 @@ namespace CosmosBenchmark
 {
  using System;
  using System.Collections.Concurrent;
- using System.Collections.Generic;
  using System.Diagnostics;
  using System.Linq;
- using System.Runtime.CompilerServices;
- using System.Text;
  using Microsoft.Azure.Cosmos;
  using Newtonsoft.Json.Linq;
 

diff --git a/Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/IBenchmarkOperation.cs b/Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/IBenchmarkOperation.cs
@@ -6,10 +6,26 @@ namespace CosmosBenchmark
 {
  using System.Threading.Tasks;
 
+ /// <summary>
+ /// Represents the Benchmark operation.
+ /// </summary>
  internal interface IBenchmarkOperation
  {
- Task PrepareAsync();
+ /// <summary>
+ /// Benchmark operation type.
+ /// </summary>
+ BenchmarkOperationType OperationType { get; }
 
+ /// <summary>
+ /// Executes Benchmark operation once asynchronously.
+ /// </summary>
+ /// <returns>The operation result wrapped by task.</returns>
  Task<OperationResult> ExecuteOnceAsync();
+
+ /// <summary>
+ /// Prepares Benchmark operation asynchronously.
+ /// </summary>
+ /// <returns>The task related to method's work.</returns>
+ Task PrepareAsync();
  }
 }
diff --git a/Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/v2/InsertV2BenchmarkOperation.cs b/Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/v2/InsertV2BenchmarkOperation.cs
@@ -38,6 +38,8 @@ public InsertV2BenchmarkOperation(
  this.sampleJObject = JsonHelper.Deserialize<Dictionary<string, object>>(sampleJson);
  }
 
+ public BenchmarkOperationType OperationType => BenchmarkOperationType.Insert;
+
  public async Task<OperationResult> ExecuteOnceAsync()
  {
  ResourceResponse<Document> itemResponse = await this.documentClient.CreateDocumentAsync(

diff --git a/Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/v2/QueryStreamSinglePkV2BenchmarkOperation.cs b/Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/v2/QueryStreamSinglePkV2BenchmarkOperation.cs
@@ -47,6 +47,8 @@ public QueryStreamSinglePkV2BenchmarkOperation(
  this.containerUri = UriFactory.CreateDocumentCollectionUri(this.databsaeName, this.containerName);
  }
 
+ public BenchmarkOperationType OperationType => BenchmarkOperationType.Query;
+
  public async Task<OperationResult> ExecuteOnceAsync()
  {
  IDocumentQuery<dynamic> query = this.documentClient.CreateDocumentQuery<dynamic>(

diff --git a/Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/v2/QueryTSinglePkV2BenchmarkOperation.cs b/Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/v2/QueryTSinglePkV2BenchmarkOperation.cs
@@ -46,6 +46,8 @@ public QueryTSinglePkV2BenchmarkOperation(
  this.sampleJObject[this.partitionKeyPath] = this.executionItemPartitionKey;
  }
 
+ public BenchmarkOperationType OperationType => BenchmarkOperationType.Query;
+
  public async Task<OperationResult> ExecuteOnceAsync()
  {
  IDocumentQuery<Dictionary<string, object>> query = this.documentClient.CreateDocumentQuery<Dictionary<string, object>>(
@@ -107,7 +109,7 @@ public async Task PrepareAsync()
  new RequestOptions() { PartitionKey = new PartitionKey(this.executionItemPartitionKey) });
  if (itemResponse.StatusCode != HttpStatusCode.Created)
  {
- throw new Exception($"Create failed with statuscode: {itemResponse.StatusCode}");
+ throw new Exception($"Create failed with status code: {itemResponse.StatusCode}");
  }
 
  this.initialized = true;

diff --git a/Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/v2/ReadFeedStreamV2BenchmarkOperation.cs b/Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/v2/ReadFeedStreamV2BenchmarkOperation.cs
@@ -40,6 +40,8 @@ public ReadFeedStreamV2BenchmarkOperation(
  this.sampleJObject = JsonHelper.Deserialize<Dictionary<string, object>>(sampleJson);
  }
 
+ public BenchmarkOperationType OperationType => BenchmarkOperationType.Read;
+
  public async Task<OperationResult> ExecuteOnceAsync()
  {
  Uri containerUri = UriFactory.CreateDocumentCollectionUri(this.databsaeName, this.containerName);
@@ -75,7 +77,7 @@ public async Task PrepareAsync()
  new RequestOptions() { PartitionKey = new PartitionKey(this.nextExecutionItemPartitionKey) });
  if (itemResponse.StatusCode != HttpStatusCode.Created)
  {
- throw new Exception($"Create failed with statuscode: {itemResponse.StatusCode}");
+ throw new Exception($"Create failed with status code: {itemResponse.StatusCode}");
  }
  }
  }

diff --git a/Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/v2/ReadNotExistsV2BenchmarkOperation.cs b/Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/v2/ReadNotExistsV2BenchmarkOperation.cs
@@ -22,6 +22,8 @@ internal class ReadNotExistsV2BenchmarkOperation : IBenchmarkOperation
 
  private readonly DocumentClient documentClient;
 
+ public BenchmarkOperationType OperationType => BenchmarkOperationType.Read;
+
  public ReadNotExistsV2BenchmarkOperation(
  DocumentClient documentClient,
  string dbName,
@@ -52,7 +54,7 @@ public async Task<OperationResult> ExecuteOnceAsync()
  {
  if (dce.StatusCode != HttpStatusCode.NotFound)
  {
- throw new Exception($"ReadItem failed wth {dce?.StatusCode} {dce?.ToString()}");
+ throw new Exception($"ReadItem failed with {dce?.StatusCode} {dce?.ToString()}");
  }
 
  return new OperationResult()

diff --git a/Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/v2/ReadStreamExistsV2BenchmarkOperation.cs b/Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/v2/ReadStreamExistsV2BenchmarkOperation.cs
@@ -25,6 +25,8 @@ internal class ReadStreamExistsV2BenchmarkOperation : IBenchmarkOperation
 
  private readonly DocumentClient documentClient;
 
+ public BenchmarkOperationType OperationType => BenchmarkOperationType.Read;
+
  public ReadStreamExistsV2BenchmarkOperation(
  DocumentClient documentClient,
  string dbName,
@@ -84,7 +86,7 @@ public async Task PrepareAsync()
 
  if (itemResponse.StatusCode != HttpStatusCode.Created)
  {
- throw new Exception($"Create failed with statuscode: {itemResponse.StatusCode}");
+ throw new Exception($"Create failed with status code: {itemResponse.StatusCode}");
  }
  }
  }

diff --git a/Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/v2/ReadTExistsV2BenchmarkOperation.cs b/Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/v2/ReadTExistsV2BenchmarkOperation.cs
@@ -26,6 +26,8 @@ internal class ReadTExistsV2BenchmarkOperation : IBenchmarkOperation
 
  private readonly DocumentClient documentClient;
 
+ public BenchmarkOperationType OperationType => BenchmarkOperationType.Read;
+
  public ReadTExistsV2BenchmarkOperation(
  DocumentClient documentClient,
  string dbName,
@@ -85,7 +87,7 @@ public async Task PrepareAsync()
 
  if (itemResponse.StatusCode != HttpStatusCode.Created)
  {
- throw new Exception($"Create failed with statuscode: {itemResponse.StatusCode}");
+ throw new Exception($"Create failed with status code: {itemResponse.StatusCode}");
  }
  }
  }

diff --git a/Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/v3/InsertV3BenchmarkOperation.cs b/Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/v3/InsertV3BenchmarkOperation.cs
@@ -37,6 +37,8 @@ public InsertV3BenchmarkOperation(
  this.sampleJObject = JsonHelper.Deserialize<Dictionary<string, object>>(sampleJson);
  }
 
+ public BenchmarkOperationType OperationType => BenchmarkOperationType.Insert;
+
  public async Task<OperationResult> ExecuteOnceAsync()
  {
  using (MemoryStream input = JsonHelper.ToStream(this.sampleJObject))

diff --git a/Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/v3/QueryTV3BenchmarkOperation.cs b/Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/v3/QueryTV3BenchmarkOperation.cs
@@ -31,6 +31,8 @@ internal abstract class QueryTV3BenchmarkOperation : IBenchmarkOperation
  public abstract bool IsPaginationEnabled { get; }
  public abstract bool IsQueryStream { get; }
 
+ public BenchmarkOperationType OperationType => BenchmarkOperationType.Query;
+
  protected string executionItemId = null;
  protected string executionPartitionKey = null;
 
@@ -291,7 +293,7 @@ public virtual async Task PrepareAsync()
 
  if (itemResponse.StatusCode != HttpStatusCode.Created)
  {
- throw new Exception($"Create failed with statuscode: {itemResponse.StatusCode}");
+ throw new Exception($"Create failed with status code: {itemResponse.StatusCode}");
  }
  }
  }

diff --git a/Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/v3/ReadFeedStreamV3BenchmarkOperation.cs b/Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/v3/ReadFeedStreamV3BenchmarkOperation.cs
@@ -39,6 +39,8 @@ public ReadFeedStreamV3BenchmarkOperation(
  this.sampleJObject = JsonHelper.Deserialize<Dictionary<string, object>>(sampleJson);
  }
 
+ public BenchmarkOperationType OperationType => BenchmarkOperationType.Read;
+
  public async Task<OperationResult> ExecuteOnceAsync()
  {
  FeedIterator feedIterator = this.container
@@ -50,7 +52,7 @@ public async Task<OperationResult> ExecuteOnceAsync()
  ResponseMessage feedResponse = await feedIterator.ReadNextAsync();
  if (feedResponse.StatusCode != HttpStatusCode.OK)
  {
- throw new Exception($"ReadItem failed wth {feedResponse.StatusCode}");
+ throw new Exception($"ReadItem failed with {feedResponse.StatusCode}");
  }
 
  return new OperationResult()
@@ -84,7 +86,7 @@ public async Task PrepareAsync()
 
  if (itemResponse.StatusCode != HttpStatusCode.Created)
  {
- throw new Exception($"Create failed with statuscode: {itemResponse.StatusCode}");
+ throw new Exception($"Create failed with status code: {itemResponse.StatusCode}");
  }
  }
  }

diff --git a/Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/v3/ReadNotExistsV3BenchmarkOperation.cs b/Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/v3/ReadNotExistsV3BenchmarkOperation.cs
@@ -32,6 +32,8 @@ public ReadNotExistsV3BenchmarkOperation(
  this.container = cosmosClient.GetContainer(this.databsaeName, this.containerName);
  }
 
+ public BenchmarkOperationType OperationType => BenchmarkOperationType.Read;
+
  public async Task<OperationResult> ExecuteOnceAsync()
  {
  using (ResponseMessage itemResponse = await this.container.ReadItemStreamAsync(
@@ -40,7 +42,7 @@ public async Task<OperationResult> ExecuteOnceAsync()
  {
  if (itemResponse.StatusCode != HttpStatusCode.NotFound)
  {
- throw new Exception($"ReadItem failed wth {itemResponse.StatusCode}");
+ throw new Exception($"ReadItem failed with {itemResponse.StatusCode}");
  }
 
  return new OperationResult()

diff --git a/Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/v3/ReadStreamExistsV3BenchmarkOperation.cs b/Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/v3/ReadStreamExistsV3BenchmarkOperation.cs
@@ -39,6 +39,8 @@ public ReadStreamExistsV3BenchmarkOperation(
  this.sampleJObject = JsonHelper.Deserialize<Dictionary<string, object>>(sampleJson);
  }
 
+ public BenchmarkOperationType OperationType => BenchmarkOperationType.Read;
+
  public async Task<OperationResult> ExecuteOnceAsync()
  {
  using (ResponseMessage itemResponse = await this.container.ReadItemStreamAsync(

diff --git a/....Cosmos.Samples/Tools/Benchmark/v3/ReadStreamExistsWithDiagnosticsV3BenchmarkOperation.cs b/....Cosmos.Samples/Tools/Benchmark/v3/ReadStreamExistsWithDiagnosticsV3BenchmarkOperation.cs
@@ -39,6 +39,8 @@ public ReadStreamExistsWithDiagnosticsV3BenchmarkOperation(
  this.sampleJObject = JsonHelper.Deserialize<Dictionary<string, object>>(sampleJson);
  }
 
+ public BenchmarkOperationType OperationType => BenchmarkOperationType.Read;
+
  public async Task<OperationResult> ExecuteOnceAsync()
  {
  using (ResponseMessage itemResponse = await this.container.ReadItemStreamAsync(
@@ -47,7 +49,7 @@ public async Task<OperationResult> ExecuteOnceAsync()
  {
  if (itemResponse.StatusCode != HttpStatusCode.OK)
  {
- throw new Exception($"ReadItem failed wth {itemResponse.StatusCode}");
+ throw new Exception($"ReadItem failed with {itemResponse.StatusCode}");
  }
 
  string diagnostics = itemResponse.Diagnostics.ToString();

diff --git a/Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/v3/ReadTExistsV3BenchmarkOperation.cs b/Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/v3/ReadTExistsV3BenchmarkOperation.cs
@@ -10,7 +10,6 @@ namespace CosmosBenchmark
  using System.Net;
  using System.Threading.Tasks;
  using Microsoft.Azure.Cosmos;
- using Newtonsoft.Json.Linq;
 
  internal class ReadTExistsV3BenchmarkOperation : IBenchmarkOperation
  {
@@ -40,14 +39,16 @@ public ReadTExistsV3BenchmarkOperation(
  this.sampleJObject = JsonHelper.Deserialize<Dictionary<string, object>>(sampleJson);
  }
 
+ public BenchmarkOperationType OperationType => BenchmarkOperationType.Read;
+
  public async Task<OperationResult> ExecuteOnceAsync()
  {
  ItemResponse<Dictionary<string, object>> itemResponse = await this.container.ReadItemAsync<Dictionary<string, object>>(
  this.nextExecutionItemId,
  new PartitionKey(this.nextExecutionItemPartitionKey));
  if (itemResponse.StatusCode != HttpStatusCode.OK)
  {
- throw new Exception($"ReadItem failed wth {itemResponse.StatusCode}");
+ throw new Exception($"ReadItem failed with {itemResponse.StatusCode}");
  }
 
  return new OperationResult()
@@ -81,7 +82,7 @@ public async Task PrepareAsync()
 
  if (itemResponse.StatusCode != HttpStatusCode.Created)
  {
- throw new Exception($"Create failed with statuscode: {itemResponse.StatusCode}");
+ throw new Exception($"Create failed with status code: {itemResponse.StatusCode}");
  }
  }
  }