UserAgent: Removes direct version (#3173)

Remove direct version from user agent to as it is unnecessary. The direct version dll is copied into the nuget folder rather than being referenced as a nuget so customers can not change it.
Azure · May 5, 2022 · b04468c · b04468c
1 parent 28830c6
commit b04468c
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 23 deletions.
diff --git a/Microsoft.Azure.Cosmos/src/EnvironmentInformation.cs b/Microsoft.Azure.Cosmos/src/EnvironmentInformation.cs
@@ -10,7 +10,6 @@ namespace Microsoft.Azure.Cosmos
     internal sealed class EnvironmentInformation
     {
         private static readonly string clientSDKVersion;
-        private static readonly string directPackageVersion;
         private static readonly string framework;
         private static readonly string architecture;
         private static readonly string os;
@@ -19,8 +18,6 @@ static EnvironmentInformation()
         {
             Version sdkVersion = Assembly.GetAssembly(typeof(CosmosClient)).GetName().Version;
             EnvironmentInformation.clientSDKVersion = $"{sdkVersion.Major}.{sdkVersion.Minor}.{sdkVersion.Build}";
-            Version directVersion = Assembly.GetAssembly(typeof(Documents.UserAgentContainer)).GetName().Version;
-            EnvironmentInformation.directPackageVersion = $"{directVersion.Major}.{directVersion.Minor}.{directVersion.Build}";
             EnvironmentInformation.framework = RuntimeInformation.FrameworkDescription;
             EnvironmentInformation.architecture = RuntimeInformation.ProcessArchitecture.ToString();
             EnvironmentInformation.os = RuntimeInformation.OSDescription;
@@ -30,11 +27,6 @@ public EnvironmentInformation()
         {
         }
 
-        /// <summary>
-        /// Version of the current direct package.
-        /// </summary>
-        public string DirectVersion => EnvironmentInformation.directPackageVersion;
-
         /// <summary>
         /// Version of the current client.
         /// </summary>

diff --git a/Microsoft.Azure.Cosmos/src/UserAgentContainer.cs b/Microsoft.Azure.Cosmos/src/UserAgentContainer.cs
@@ -33,14 +33,12 @@ public UserAgentContainer(
 
         protected virtual void GetEnvironmentInformation(
             out string clientVersion,
-            out string directVersion,
             out string processArchitecture,
             out string operatingSystem,
             out string runtimeFramework)
         {
             EnvironmentInformation environmentInformation = new EnvironmentInformation();
             clientVersion = environmentInformation.ClientVersion;
-            directVersion = environmentInformation.DirectVersion;
             processArchitecture = environmentInformation.ProcessArchitecture;
             operatingSystem = environmentInformation.OperatingSystem;
             runtimeFramework = environmentInformation.RuntimeFramework;
@@ -52,7 +50,6 @@ private string CreateBaseUserAgentString(
         {
             this.GetEnvironmentInformation(
                 out string clientVersion,
-                out string directVersion,
                 out string processArchitecture,
                 out string operatingSystem,
                 out string runtimeFramework);
@@ -68,7 +65,7 @@ private string CreateBaseUserAgentString(
 #if PREVIEW
             previewFlag = "P";
 #endif
-            string baseUserAgent = $"cosmos-netstandard-sdk/{clientVersion}" + previewFlag + Regex.Replace($"|{directVersion}|{this.clientId}|{processArchitecture}|{operatingSystem}|{runtimeFramework}|", @"[^0-9a-zA-Z\.\|\-]+", " ");
+            string baseUserAgent = $"cosmos-netstandard-sdk/{clientVersion}" + previewFlag + Regex.Replace($"|{this.clientId}|{processArchitecture}|{operatingSystem}|{runtimeFramework}|", @"[^0-9a-zA-Z\.\|\-]+", " ");
             if (!string.IsNullOrEmpty(regionConfiguration))
             {
                 baseUserAgent += $"{regionConfiguration}|";

diff --git a/Microsoft.Azure.Cosmos/tests/Microsoft.Azure.Cosmos.EmulatorTests/UserAgentTests.cs b/Microsoft.Azure.Cosmos/tests/Microsoft.Azure.Cosmos.EmulatorTests/UserAgentTests.cs
@@ -93,11 +93,10 @@ public void VerifyUserAgentContent()
             previewFlag = "P";
 #endif
             Assert.AreEqual($"cosmos-netstandard-sdk/{envInfo.ClientVersion}" + previewFlag, values[0]);
-            Assert.AreEqual(envInfo.DirectVersion, values[1]);
-            Assert.AreEqual("0", values[2]);
-            Assert.AreEqual(envInfo.ProcessArchitecture, values[3]);
-            Assert.AreEqual(envInfo.OperatingSystem, values[4]);
-            Assert.AreEqual(envInfo.RuntimeFramework, values[5]);
+            Assert.AreEqual("0", values[1]);
+            Assert.AreEqual(envInfo.ProcessArchitecture, values[2]);
+            Assert.AreEqual(envInfo.OperatingSystem, values[3]);
+            Assert.AreEqual(envInfo.RuntimeFramework, values[4]);
         }
 
         [TestMethod]
@@ -193,11 +192,11 @@ public void VerifyClientIDForUserAgentString()
                     string userAgentString = client.DocumentClient.ConnectionPolicy.UserAgentContainer.UserAgent;
                     if (i <= max)
                     {
-                        Assert.AreEqual(userAgentString.Split('|')[2], i.ToString());
+                        Assert.AreEqual(userAgentString.Split('|')[1], i.ToString());
                     }
                     else
                     {
-                        Assert.AreEqual(userAgentString.Split('|')[2], max.ToString());
+                        Assert.AreEqual(userAgentString.Split('|')[1], max.ToString());
                     }
                 }
             }
@@ -222,7 +221,7 @@ public async Task VerifyClientIDIncrements_Concurrent()
 
             await Task.WhenAll(tasks);
             List<int> actual = tasks.Select(r => 
-                        int.Parse(r.Result.DocumentClient.ConnectionPolicy.UserAgentContainer.UserAgent.Split('|')[2])).ToList();
+                        int.Parse(r.Result.DocumentClient.ConnectionPolicy.UserAgentContainer.UserAgent.Split('|')[1])).ToList();
             actual.Sort();
             CollectionAssert.AreEqual(expected, actual);
         }
@@ -377,7 +376,6 @@ public MacOsUserAgentContainer(int clientId,
 
             protected override void GetEnvironmentInformation(
                 out string clientVersion,
-                out string directVersion,
                 out string processArchitecture,
                 out string operatingSystem,
                 out string runtimeFramework)
@@ -387,7 +385,6 @@ protected override void GetEnvironmentInformation(
 
                 base.GetEnvironmentInformation(
                     clientVersion: out clientVersion,
-                    directVersion: out directVersion,
                     processArchitecture: out processArchitecture,
                     operatingSystem: out _,
                     runtimeFramework: out runtimeFramework);
@@ -408,7 +405,7 @@ private string GetClientIdFromCosmosClient(CosmosClient client)
         {
             Cosmos.UserAgentContainer userAgentContainer = client.ClientOptions.GetConnectionPolicy(client.ClientId).UserAgentContainer;
             string userAgentString = userAgentContainer.UserAgent;
-            string clientId = userAgentString.Split('|')[2];
+            string clientId = userAgentString.Split('|')[1];
             return clientId;
         }
     }