Merge pull request #52 from RoushTech/release/0.5.2

Release/0.5.2

Author: StrangeWill

CHANGELOG.md

@@ -1,4 +1,16 @@
-# 0.5.1
+# 0.5.2
+<sup>Released: 2017/4/21</sup>
+
+## Features
+
+ - Updated documentation. #49
+ - Can now disable Rollbar from configuration. #48
+
+## Bug Fixes
+
+ - Fix issue with trying to access Request.Form variables during POSTs that may not actually support form variables. #54
+
+# 0.5.1
 <sup>Released: 2017/3/10</sup>
 
 ## Features

Readme.md

@@ -1,4 +1,9 @@
 # RollbarDotNet
+[![NuGet](https://img.shields.io/nuget/v/RollbarDotNet.svg)]()
+
+[![Build](https://img.shields.io/teamcity/https/teamcity.roushtech.net/s/RollbarDotNet_Build.svg)]()
+[![SonarQube Tech Debt](https://img.shields.io/sonar/https/sonarqube.roushtech.net/RollbarDotNet/tech_debt.svg)]()
+[![SonarQube Coverage](https://img.shields.io/sonar/https/sonarqube.roushtech.net/RollbarDotNet/coverage.svg)]()
 
 Rollbar support for your .NET Core projects, relies on dependency injection and hooks up to your ASP.NET Core pipeline for easy 
 
@@ -99,7 +104,11 @@ var rollbar = new Rollbar(
         new ConfigurationBuilder(rollbarOptions),
         new EnvironmentBuilder(new SystemDateTime()), // SystemDateTime abstracts DateTime for mocking
         new NotifierBuilder()
-    }
+    },
+	new IExceptionBuilder[] {
+		new ExceptionBuilder()
+	},
+	new RollBarClient(rollbarOptions)
 );
 
 try

src/RollbarDotNet/Builder/RequestBuilder.cs

@@ -44,7 +44,8 @@ protected void BuildRequest(Request request)
             {
                 request.Get = this.QueryToDictionary(context.Request.Query);
             }
-            else if (context.Request.Method.Equals("POST", StringComparison.OrdinalIgnoreCase))
+            else if (context.Request.Method.Equals("POST", StringComparison.OrdinalIgnoreCase)
+                && context.Request.HasFormContentType)
             {
                 request.Post = this.FormToDictionary(context.Request.Form);
             }

src/RollbarDotNet/Configuration/RollbarOptions.cs

@@ -4,6 +4,8 @@ public class RollbarOptions
     {
         public string AccessToken { get; set; }
 
+        public bool Disabled { get; set; }
+
         public string Environment { get; set; }
 
         public BlacklistConfiguration Blacklist { get; set; }

src/RollbarDotNet/Core/ServiceExtensions.cs

@@ -12,14 +12,15 @@ public static class ServiceExtensions
         public static IServiceCollection AddRollbar(this IServiceCollection services)
         {
             return services
-                .AddSingleton<IBuilder, Builder.ConfigurationBuilder>()
+                .AddSingleton<IBuilder, ConfigurationBuilder>()
                 .AddSingleton<IBuilder, EnvironmentBuilder>()
                 .AddSingleton<IBuilder, NotifierBuilder>()
                 .AddSingleton<IDateTime, SystemDateTime>()
                 .AddSingleton<IEnvironment, SystemEnvironment>()
                 .AddSingleton<IBlacklister, ConfigurationBlacklister>()
                 .AddSingleton<IBlacklistCollection, BlacklistCollection>()
                 .AddSingleton<IExceptionBuilder, ExceptionBuilder>()
+                .AddSingleton<RollbarClient>()
                 .AddScoped<Rollbar>();
         }
 

src/RollbarDotNet/Rollbar.cs

@@ -8,11 +8,12 @@
     public class Rollbar
     {
         public Rollbar(IEnumerable<IBuilder> builders, 
-                       IEnumerable<IExceptionBuilder> exceptionBuilders)
+                       IEnumerable<IExceptionBuilder> exceptionBuilders,
+                       RollbarClient rollbarClient)
         {
             this.Builders = builders;
             this.ExceptionBuilders = exceptionBuilders;
-            this.RollbarClient = new RollbarClient();
+            this.RollbarClient = rollbarClient;
         }
 
         protected IEnumerable<IBuilder> Builders { get; set; }

src/RollbarDotNet/RollbarClient.cs

@@ -1,27 +1,42 @@
 namespace RollbarDotNet
 {
+    using Configuration;
+    using Microsoft.Extensions.Options;
     using Newtonsoft.Json;
+    using Payloads;
     using System;
-    using System.Threading.Tasks;
     using System.Net.Http;
     using System.Net.Http.Headers;
-    using Payloads;
+    using System.Threading.Tasks;
 
     public class RollbarClient
     {
-        public RollbarClient()
+        public RollbarClient(IOptions<RollbarOptions> rollbarOptions)
         {
             this.Configuration = new Configuration.Configuration();
+            this.RollbarOptions = rollbarOptions.Value;
         }
 
         public Configuration.Configuration Configuration { get; set; }
 
+        protected RollbarOptions RollbarOptions { get; set; }
+
         protected Uri RollbarUri { get { return new Uri("https://api.rollbar.com/api/1/item/"); } }
 
         public async Task<Response> Send(Payload payload)
         {
-            string json = this.Serialize(payload);
+            if (this.RollbarOptions.Disabled)
+            {
+                return new Response
+                {
+                    Result = new Result
+                    {
+                        Uuid = null
+                    }
+                };
+            }
 
+            string json = this.Serialize(payload);
             using (var httpClient = new HttpClient())
             {
                 httpClient.DefaultRequestHeaders.Accept.Clear();

src/RollbarDotNet/project.json

@@ -15,7 +15,7 @@
       "Error"
     ]
   },
-  "version": "0.5.1",
+  "version": "0.5.2",
   "dependencies": {
     "Microsoft.AspNetCore.Hosting.Abstractions": "1.0.0",
     "Microsoft.AspNetCore.Http": "1.0.0",

test/RollbarDotNet.Tests/Builder/RequestBuilderTests.cs

@@ -6,6 +6,7 @@
     using Moq;
     using Payloads;
     using RollbarDotNet.Builder;
+    using System;
     using System.Collections.Generic;
     using System.Net;
     using Xunit;
@@ -113,7 +114,23 @@ public void Blacklists_Payload_QueryString()
             Assert.Equal("?query=test&blacklist=**********", queryString);
         }
 
-        public IHttpContextAccessor CreateIHttpContextAccessor(string method)
+        /// <summary>
+        /// Caused when you POST a JSON payload -- Request.Form is NOT valid and the call will throw, this checks
+        /// and makes sure we're properly checking the HasFormContentType flag.
+        /// https://github.com/RoushTech/RollbarDotNet/issues/54
+        /// </summary>
+        [Fact]
+        public void Bug_ThrowsIncorrectContentType()
+        {
+            var mock = this.CreateIHttpContextAccessor("POST");
+            mock.Setup(h => h.HttpContext.Request.HasFormContentType).Returns(false);
+            mock.Setup(h => h.HttpContext.Request.Form).Throws(new InvalidOperationException("Incorrect Content-Type: application/json; charset=UTF-8"));
+            var requestBuilder = new RequestBuilder(this.GenerateBacklistCollection(), mock.Object);
+            var payload = new Payload();
+            requestBuilder.Execute(payload);
+        }
+
+        public Mock<IHttpContextAccessor> CreateIHttpContextAccessor(string method)
         {
             var httpContextAccessorMock = new Mock<IHttpContextAccessor>();
             httpContextAccessorMock.Setup(h => h.HttpContext.Request.Scheme).Returns("http");
@@ -123,20 +140,24 @@ public IHttpContextAccessor CreateIHttpContextAccessor(string method)
             httpContextAccessorMock.Setup(h => h.HttpContext.Features.Get<IHttpConnectionFeature>().RemoteIpAddress).Returns(IPAddress.Loopback);
             httpContextAccessorMock.Setup(h => h.HttpContext.Request.Headers).Returns(this.GenerateHeaderDictionary);
             httpContextAccessorMock.Setup(h => h.HttpContext.Request.Query).Returns(this.GenerateQueryCollection);
+            httpContextAccessorMock.Setup(h => h.HttpContext.Request.HasFormContentType).Returns(true);
             httpContextAccessorMock.Setup(h => h.HttpContext.Request.Form).Returns(this.GenerateFormCollection);
             httpContextAccessorMock.Setup(h => h.HttpContext.Request.Cookies).Returns(this.GenerateCookieCollection);
             httpContextAccessorMock.Setup(h => h.HttpContext.Request.QueryString).Returns(new QueryString("?query=test&blacklist=here"));
-            return httpContextAccessorMock.Object;
+            return httpContextAccessorMock;
         }
 
-        protected Payload GeneratePayload(bool enableBlacklist = false, string method = "GET")
+        protected IBlacklistCollection GenerateBacklistCollection(bool enableBlacklist = false)
         {
-
             var blacklistCollectionMock = new Mock<IBlacklistCollection>();
             blacklistCollectionMock.Setup(b => b.Check("test")).Returns(false);
             blacklistCollectionMock.Setup(b => b.Check("blacklist")).Returns(enableBlacklist);
+            return blacklistCollectionMock.Object;
+        }
 
-            var requestBuilder = new RequestBuilder(blacklistCollectionMock.Object, this.CreateIHttpContextAccessor(method));
+        protected Payload GeneratePayload(bool enableBlacklist = false, string method = "GET")
+        {
+            var requestBuilder = new RequestBuilder(this.GenerateBacklistCollection(enableBlacklist), this.CreateIHttpContextAccessor(method).Object);
             var payload = new Payload();
             requestBuilder.Execute(payload);
             return payload;

test/RollbarDotNet.Tests/DependencyInjection/WebDependencyInjectionTests.cs

@@ -4,6 +4,7 @@
     using Core;
     using Microsoft.AspNetCore.Hosting;
     using Microsoft.Extensions.DependencyInjection;
+    using Microsoft.Extensions.Options;
     using Moq;
     using System;
     using System.Threading.Tasks;
@@ -44,20 +45,39 @@ public async Task SucessfullyReportError()
             }
             catch(Exception exception)
             {
-                await this.Rollbar.SendException(exception);
+                var response = await this.Rollbar.SendException(exception);
+                Assert.False(string.IsNullOrEmpty(response.Result.Uuid));
             }
         }
 
         [Fact]
         public async Task SuccessfullyReportMessage()
         {
-            await this.Rollbar.SendMessage("Hello");
+            var response = await this.Rollbar.SendMessage("Hello");
+            Assert.False(string.IsNullOrEmpty(response.Result.Uuid));
         }
 
         [Fact]
         public async Task SuccessfullyReportMessageWithLevel()
         {
-            await this.Rollbar.SendMessage(RollbarLevel.Debug, "Hello");
+            var response = await this.Rollbar.SendMessage(RollbarLevel.Debug, "Hello");
+            Assert.False(string.IsNullOrEmpty(response.Result.Uuid));
+        }
+
+        [Fact]
+        public async Task DisabledRollbar()
+        {
+            var options = this.ServiceProvider.GetService<IOptions<RollbarOptions>>().Value;
+            this.Services.Configure<RollbarOptions>(o =>
+            {
+                o.AccessToken = options.AccessToken;
+                o.Disabled = true;
+                o.Environment = options.Environment;
+            });
+            var serviceProvider = this.Services.BuildServiceProvider();
+            var rollbar = serviceProvider.GetService<Rollbar>();
+            var response = await rollbar.SendMessage(RollbarLevel.Debug, "Hello");
+            Assert.Null(response.Result.Uuid);
         }
     }
 }