Fix User-Agent when OSDescription has unmatched parenthesis

NuGet · Dec 27, 2022 · 85dc801 · 85dc801
1 parent 743503c
commit 85dc801
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 1 deletion.
diff --git a/src/NuGet.Core/NuGet.Protocol/UserAgentStringBuilder.cs b/src/NuGet.Core/NuGet.Protocol/UserAgentStringBuilder.cs
@@ -36,7 +36,12 @@ public UserAgentStringBuilder(string clientName)
 
         public UserAgentStringBuilder WithOSDescription(string osInfo)
         {
-            _osInfo = osInfo;
+#if NETCOREAPP2_0_OR_GREATER
+            _osInfo = osInfo.Replace("(", @"\(", StringComparison.Ordinal).Replace(")", @"\)", StringComparison.Ordinal);
+#else
+            _osInfo = osInfo.Replace("(", @"\(").Replace(")", @"\)");
+#endif
+
             return this;
         }
 

diff --git a/test/NuGet.Core.Tests/NuGet.Protocol.Tests/UserAgentStringBuilderTests.cs b/test/NuGet.Core.Tests/NuGet.Protocol.Tests/UserAgentStringBuilderTests.cs
@@ -1,6 +1,7 @@
 // Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
+using System.Net.Http;
 using NuGet.Protocol.Core.Types;
 using Xunit;
 using Xunit.Abstractions;
@@ -96,5 +97,18 @@ public void UsesComputedNuGetClientVersion()
             Assert.True(userAgentString3.Contains(builder.NuGetClientVersion));
             Assert.True(userAgentString4.Contains(builder.NuGetClientVersion));
         }
+
+        [Theory]
+        [InlineData("Custom Kernel (123")]
+        [InlineData("Custom Kernel 123)")]
+        public void Build_OsDescriptionWithUnmatchedParenthesis_IsValid(string osDescription)
+        {
+            var target = new UserAgentStringBuilder();
+
+            var result = target.WithOSDescription(osDescription).Build();
+
+            var httpRequest = new HttpRequestMessage();
+            httpRequest.Headers.Add("User-Agent", result);
+        }
     }
 }