Fixes format exception thrown when user agent header value is incorrect

CloudinaryDotNet.Tests/Asset/UrlBuilderTest.cs

@@ -475,23 +475,57 @@ public void TestExcludeEmptyTransformation()
             Assert.AreEqual(TestConstants.DefaultImageUpPath + "c_fill,x_100,y_100/test", uri);
         }
 
-        [Test]
-        public void TestAgentPlatformHeaders()
+        private HttpRequestMessage CreateRequest(string userPlatform)
         {
             var request = new HttpRequestMessage { RequestUri = new Uri("http://dummy.com") };
-            m_api.UserPlatform = "Test/1.0";
+            m_api.UserPlatform = userPlatform;
 
             m_api.PrepareRequestBody(
                 request,
                 HttpMethod.GET,
                 new SortedDictionary<string, object>(),
                 new FileDescription(""));
+            return request;
+        }
+
+        [Test]
+        public void TestAgentPlatformHeaders()
+        {
+            var httpRequestMessage = CreateRequest("UserPlatform/2.3");
 
             //Can't test the result, so we just verify the UserAgent parameter is sent to the server
-            StringAssert.AreEqualIgnoringCase($"{m_api.UserPlatform} {ApiShared.USER_AGENT}",
-                request.Headers.UserAgent.ToString());
-            StringAssert.IsMatch(@"Test\/1\.0 CloudinaryDotNet\/(\d+)\.(\d+)\.(\d+) \(.*\)",
-                request.Headers.UserAgent.ToString());
+            StringAssert.IsMatch(@"CloudinaryDotNet\/(\d+)\.(\d+)\.(\d+) \(" + ApiShared.USER_AGENT.Replace("(", "").Replace(")", "") + @"\) UserPlatform/2\.3",
+                httpRequestMessage.Headers.UserAgent.ToString());
+        }
+
+        [Test]
+        [TestCase(null)]
+        [TestCase("")]
+        [TestCase(" ")]
+        [TestCase("UserPlatform/")]
+        [TestCase("UserPlatform/ ")]
+        [TestCase("UserPlatform / 1.2")]
+        public void UnexpectedUserPlatformShouldNotThrow(string userPlatorm)
+        {
+            Assert.DoesNotThrow(() => CreateRequest(userPlatorm));
+        }
+
+        [Test]
+        [TestCase("Mono 5.11.0 ((HEAD/768f1b247c6)")]
+        [TestCase("(")]
+        [TestCase(")")]
+        public void MalformedUserAgentShouldNotThrow(string userAgent)
+        {
+            var prevAgent = ApiShared.USER_AGENT;
+            ApiShared.USER_AGENT = userAgent;
+            try
+            {
+                Assert.DoesNotThrow(() => CreateRequest("UserPlatform"));
+            }
+            finally
+            {
+                ApiShared.USER_AGENT = prevAgent;
+            }
         }
 
         [Test]

CloudinaryDotNet/ApiShared.Internal.cs

@@ -248,6 +248,26 @@ protected void HandleUnsignedParameters(IDictionary<string, object> parameters)
             }
         }
 
+        private static void AddCommentToUserAgent(
+                HttpHeaderValueCollection<ProductInfoHeaderValue> userAgentHeader,
+                string comment)
+        {
+            if (string.IsNullOrEmpty(comment))
+            {
+                return;
+            }
+
+            var normalizedComment = RemoveBracketsFrom(comment);
+            userAgentHeader.Add(new ProductInfoHeaderValue($"({normalizedComment})"));
+        }
+
+        private static string RemoveBracketsFrom(string comment)
+        {
+            return comment
+                       .Replace(")", string.Empty)
+                       .Replace("(", string.Empty);
+        }
+
         private static SortedDictionary<string, object> GetCallParams(HttpMethod method, BaseParams parameters)
         {
             parameters?.Check();
@@ -455,10 +475,11 @@ private void PrePrepareRequestBody(
 
             // Add platform information to the USER_AGENT header
             // This is intended for platform information and not individual applications!
-            var userPlatform = string.IsNullOrEmpty(UserPlatform)
-                ? USER_AGENT
-                : string.Format(CultureInfo.InvariantCulture, "{0} {1}", UserPlatform, USER_AGENT);
-            request.Headers.Add("User-Agent", userPlatform);
+            var userAgentHeader = request.Headers.UserAgent;
+            userAgentHeader.Add(new ProductInfoHeaderValue("CloudinaryDotNet", CloudinaryVersion.Full));
+
+            AddCommentToUserAgent(userAgentHeader, USER_AGENT);
+            SetUserPlatform(userAgentHeader);
 
             byte[] authBytes = Encoding.ASCII.GetBytes(GetApiCredentials());
             request.Headers.Add("Authorization", string.Format(CultureInfo.InvariantCulture, "Basic {0}", Convert.ToBase64String(authBytes)));
@@ -478,6 +499,36 @@ private void PrePrepareRequestBody(
             }
         }
 
+        private void SetUserPlatform(HttpHeaderValueCollection<ProductInfoHeaderValue> userAgentHeader)
+        {
+            Console.WriteLine($"UserPlatform: [{UserPlatform}] ======");
+            var up = UserPlatform?.Trim();
+            if (string.IsNullOrEmpty(up))
+            {
+                return;
+            }
+
+            var upp = up.Split('/');
+            var productName = GetElement(0);
+            if (string.IsNullOrEmpty(productName))
+            {
+                return;
+            }
+
+            var productVersion = GetElement(1);
+            if (string.IsNullOrEmpty(productVersion))
+            {
+                productVersion = "0.1";
+            }
+
+            userAgentHeader.Add(new ProductInfoHeaderValue(productName, productVersion));
+
+            string GetElement(int index)
+            {
+                return upp.ElementAtOrDefault(index)?.Trim();
+            }
+        }
+
         private async Task PrepareRequestContentAsync(
             HttpRequestMessage request,
             SortedDictionary<string, object> parameters,

CloudinaryDotNet/ApiShared.cs

@@ -71,7 +71,7 @@ public partial class ApiShared : ISignProvider
         /// <summary>
         /// User agent for cloudinary API requests.
         /// </summary>
-        public static string USER_AGENT = BuildUserAgent();
+        public static string USER_AGENT = RuntimeInformation.FrameworkDescription;
 
         /// <summary>
         /// Sends HTTP requests and receives HTTP responses.
@@ -803,10 +803,5 @@ public string BuildUploadFormShared(string field, string resourceType, SortedDic
 
             return builder.ToString();
         }
-
-        private static string BuildUserAgent()
-        {
-            return $"CloudinaryDotNet/{CloudinaryVersion.Full} ({RuntimeInformation.FrameworkDescription})";
-        }
     }
 }