improved logging (#227)

Author: msohailhussain

OptimizelySDK.Tests/ConfigTest/HttpProjectConfigManagerTest.cs

@@ -22,6 +22,7 @@
 using OptimizelySDK.Tests.Utils;
 using System;
 using System.Diagnostics;
+using System.Net;
 using System.Net.Http;
 using System.Threading;
 using System.Threading.Tasks;
@@ -70,6 +71,24 @@ public void TestHttpConfigManagerRetreiveProjectConfigByURL()
             httpManager.Dispose();
         }
 
+        [Test]
+        public void TestHttpConfigManagerWithInvalidStatus()
+        {
+            var t = MockSendAsync(statusCode: HttpStatusCode.Forbidden);
+
+            HttpProjectConfigManager httpManager = new HttpProjectConfigManager.Builder()
+                .WithUrl("https://cdn.optimizely.com/datafiles/QBw9gFM8oTn7ogY9ANCC1z.json")
+                .WithLogger(LoggerMock.Object)
+                .WithPollingInterval(TimeSpan.FromMilliseconds(1000))
+                .WithBlockingTimeoutPeriod(TimeSpan.FromMilliseconds(500))
+                .WithStartByDefault()
+                .Build();
+
+            LoggerMock.Verify(_ => _.Log(LogLevel.ERROR, $"Error fetching datafile \"{HttpStatusCode.Forbidden}\""), Times.AtLeastOnce);
+
+            httpManager.Dispose();
+        }
+
         [Test]
         public void TestHttpClientHandler()
         {
@@ -143,6 +162,7 @@ public void TestHttpConfigManagerRetreiveProjectConfigByFormat()
                 requestMessage.RequestUri.ToString() == "https://cdn.optimizely.com/json/10192104166.json"
                 )));
             Assert.IsNotNull(httpManager.GetConfig());
+            LoggerMock.Verify(_ => _.Log(LogLevel.DEBUG, "Making datafile request to url \"https://cdn.optimizely.com/json/10192104166.json\""));
             httpManager.Dispose();
         }
 
@@ -459,9 +479,9 @@ public void TestFormatUrlHigherPriorityThanDefaultUrl()
 
         }
 
-        public Task MockSendAsync(string datafile = null, TimeSpan? delay = null)
+        public Task MockSendAsync(string datafile = null, TimeSpan? delay = null, HttpStatusCode statusCode = HttpStatusCode.OK)
         {
-            return TestHttpProjectConfigManagerUtil.MockSendAsync(HttpClientMock, datafile, delay);
+            return TestHttpProjectConfigManagerUtil.MockSendAsync(HttpClientMock, datafile, delay, statusCode);
         }
 
         #endregion

OptimizelySDK.Tests/Utils/TestHttpProjectConfigManagerUtil.cs

@@ -16,6 +16,7 @@
  */
 
 using System;
+using System.Net;
 using System.Net.Http;
 using System.Threading.Tasks;
 using Moq;
@@ -28,7 +29,7 @@ namespace OptimizelySDK.Tests.Utils
     /// </summary>
     public static class TestHttpProjectConfigManagerUtil
     {
-        public static Task MockSendAsync(Mock<HttpProjectConfigManager.HttpClient> HttpClientMock, string datafile = null, TimeSpan? delay=null)
+        public static Task MockSendAsync(Mock<HttpProjectConfigManager.HttpClient> HttpClientMock, string datafile = null, TimeSpan? delay=null, HttpStatusCode statusCode = HttpStatusCode.OK)
         {
             var t = new System.Threading.Tasks.TaskCompletionSource<bool>();
 
@@ -39,7 +40,7 @@ public static Task MockSendAsync(Mock<HttpProjectConfigManager.HttpClient> HttpC
                         Task.Delay(delay.Value).Wait();
                     }
 
-                    return System.Threading.Tasks.Task.FromResult<HttpResponseMessage>(new HttpResponseMessage { StatusCode = System.Net.HttpStatusCode.OK, Content = new StringContent(datafile ?? string.Empty) });
+                    return System.Threading.Tasks.Task.FromResult<HttpResponseMessage>(new HttpResponseMessage { StatusCode = statusCode, Content = new StringContent(datafile ?? string.Empty) });
                 })
                 .Callback(()
                 => {

OptimizelySDK/Config/HttpProjectConfigManager.cs

@@ -88,6 +88,7 @@ static HttpProjectConfigManager()
 
         private string GetRemoteDatafileResponse()
         {
+            Logger.Log(LogLevel.DEBUG, $"Making datafile request to url \"{Url}\"");
             var request = new System.Net.Http.HttpRequestMessage {
                 RequestUri = new Uri(Url),
                 Method = System.Net.Http.HttpMethod.Get,
@@ -107,7 +108,7 @@ private string GetRemoteDatafileResponse()
             // Return from here if datafile is not modified.
             var result = httpResponse.Result;
             if (!result.IsSuccessStatusCode) {
-                Logger.Log(LogLevel.ERROR, "Unexpected response from event endpoint, status: " + result.StatusCode);
+                Logger.Log(LogLevel.ERROR, $"Error fetching datafile \"{result.StatusCode}\"");
                 return null;
             }
 
@@ -134,7 +135,7 @@ private string GetRemoteDatafileResponse()
             var result = (System.Net.HttpWebResponse)request.GetResponse();
 
             if (result.StatusCode != System.Net.HttpStatusCode.OK) {
-                Logger.Log(LogLevel.ERROR, "Unexpected response from event endpoint, status: " + result.StatusCode);
+                Logger.Log(LogLevel.ERROR, $"Error fetching datafile \"{result.StatusCode}\"");
             }
             var lastModified = result.Headers.GetValues("Last-Modified");
             if(!string.IsNullOrEmpty(lastModified.First()))