fix package dependencies

handle exceptions from the application better

gulpfile.js

@@ -5,7 +5,7 @@ var download = require("gulp-download");
 var del = require('del');
 var assemblyInfo = require('gulp-dotnet-assembly-info');
 var xunit = xunit = require('gulp-xunit-runner');
-var version = '1.4.0';
+var version = '1.5.1';
 
 gulp.task('clean', ()=>{
     return del(['src/**/obj/', 'src/**/bin/Release', 'nuget.exe', 'nupkgs'])

src/CompressR.MVC/CompressAttribute.cs

@@ -14,12 +14,7 @@ namespace CompressR.MVC
         {
         }
 
-        /// <summary>
-        /// Override to compress the content that is generated by
-        /// an action method.
-        /// </summary>
-        /// <param name="filterContext"></param>
-        public override void OnActionExecuting(System.Web.Mvc.ActionExecutingContext filterContext)
+        public override void OnResultExecuted(ResultExecutedContext filterContext)
         {
             CompressFactory.Compress(filterContext, RequireCompression, CompressionLevel);
         }

src/CompressR.MVC/CompressFactory.cs

@@ -9,8 +9,12 @@ namespace CompressR.MVC
 {
     public static class CompressFactory
     {
-        public static void Compress(System.Web.Mvc.ActionExecutingContext filterContext, bool requireCompression, string compression, CompressionLevel compressLevel = CompressionLevel.Optimal)
+        public static void Compress(System.Web.Mvc.ResultExecutedContext filterContext, bool requireCompression, string compression, CompressionLevel compressLevel = CompressionLevel.Optimal)
         {
+            if(filterContext.Exception != null && !filterContext.ExceptionHandled)
+            {
+                return;
+            }
             var context = filterContext.RequestContext.HttpContext;
             var compressionAccepted = context.Request.Headers.Get(Constants.AcceptEncoding)?.Split(',').Trim().Any(a => string.Equals(a, compression, StringComparison.OrdinalIgnoreCase)) ?? false;
             if(!compressionAccepted)
@@ -28,8 +32,12 @@ namespace CompressR.MVC
             HandleCompression(compression, filterContext, compressLevel);
         }
 
-        public static void Compress(System.Web.Mvc.ActionExecutingContext filterContext, bool requireCompression, CompressionLevel compressLevel = CompressionLevel.Optimal)
+        public static void Compress(System.Web.Mvc.ResultExecutedContext filterContext, bool requireCompression, CompressionLevel compressLevel = CompressionLevel.Optimal)
         {
+            if(filterContext.Exception != null && !filterContext.ExceptionHandled)
+            {
+                return;
+            }
             var context = filterContext.RequestContext.HttpContext;
             var compressionAlgorithm = context.Request.Headers.Get(Constants.AcceptEncoding)?.Split(',').Trim().Intersect(Constants.Compressors, StringComparer.OrdinalIgnoreCase)?.FirstOrDefault();
             if(!string.IsNullOrWhiteSpace(compressionAlgorithm))
@@ -42,9 +50,14 @@ namespace CompressR.MVC
             }
         }
 
-        private static void HandleCompression(string compression, System.Web.Mvc.ActionExecutingContext filterContext, CompressionLevel compressLevel = CompressionLevel.Optimal)
+        private static void HandleCompression(string compression, System.Web.Mvc.ResultExecutedContext filterContext, CompressionLevel compressLevel = CompressionLevel.Optimal)
         {
             var context = filterContext.RequestContext.HttpContext;
+            HandleCompression(compression, filterContext.RequestContext.HttpContext, compressLevel);
+        }
+
+        private static void HandleCompression(string compression, System.Web.HttpContextBase context, CompressionLevel compressLevel)
+        {
             switch(compression)
             {
                 case Constants.Gzip:

src/CompressR.MVC/Constants.cs

@@ -1,8 +1,4 @@
-using System;
-using System.Collections.Generic;
-using System.Text;
-
-namespace CompressR.MVC
+namespace CompressR.MVC
 {
     public struct Constants
     {

src/CompressR.MVC/DeflateAttribute.cs

@@ -1,6 +1,7 @@
 using System;
 using System.IO.Compression;
 using System.Linq;
+using System.Web.Mvc;
 
 namespace CompressR.MVC
 {
@@ -17,9 +18,10 @@ namespace CompressR.MVC
         /// an action method.
         /// </summary>
         /// <param name="filterContext"></param>
-        public override void OnActionExecuting(System.Web.Mvc.ActionExecutingContext filterContext)
+
+        public override void OnResultExecuted(ResultExecutedContext filterContext)
         {
-            CompressFactory.Compress(filterContext, RequireCompression, Constants.Deflate, CompressionLevel);
+            CompressFactory.Compress(filterContext, RequireCompression, CompressionLevel);
         }
     }
 }

src/CompressR.MVC/Extensions.cs

@@ -1,6 +1,4 @@
-using System;
-using System.Collections.Generic;
-using System.Text;
+using System.Collections.Generic;
 
 namespace CompressR.MVC
 {
@@ -8,7 +6,7 @@ namespace CompressR.MVC
     {
         public static IEnumerable<string> Trim(this IEnumerable<string> arr)
         {
-            foreach (var item in arr)
+            foreach(var item in arr)
             {
                 yield return item.Trim();
             }

src/CompressR.MVC/GzipAttribute.cs

@@ -1,6 +1,7 @@
 using System;
 using System.IO.Compression;
 using System.Linq;
+using System.Web.Mvc;
 
 namespace CompressR.MVC
 {
@@ -11,14 +12,9 @@ namespace CompressR.MVC
         {
         }
 
-        /// <summary>
-        /// Override to compress the content that is generated by
-        /// an action method.
-        /// </summary>
-        /// <param name="filterContext"></param>
-        public override void OnActionExecuting(System.Web.Mvc.ActionExecutingContext filterContext)
+        public override void OnResultExecuted(ResultExecutedContext filterContext)
         {
-            CompressFactory.Compress(filterContext, RequireCompression, Constants.Gzip, CompressionLevel);
+            CompressFactory.Compress(filterContext, RequireCompression, CompressionLevel);
         }
     }
 }

src/CompressR.MVC5/CompressR.MVC5.nuspec

@@ -14,7 +14,7 @@
     <copyright>Copyright 2016</copyright>
     <tags>Compression MVC</tags>
     <dependencies>
-      <dependency id="Microsoft.AspNet.Mvc" version="(5.0.0, 6.0.0]" />
+      <dependency id="Microsoft.AspNet.Mvc" version="[5.0.0, 6.0.0)" />
     </dependencies>
   </metadata>
 </package>

src/CompressR.MVCUnitTests/CompressR.MVCUnitTests.csproj

@@ -33,8 +33,45 @@
     <WarningLevel>4</WarningLevel>
   </PropertyGroup>
   <ItemGroup>
+    <Reference Include="Castle.Core, Version=3.3.0.0, Culture=neutral, PublicKeyToken=407dd0808d44fbdc, processorArchitecture=MSIL">
+      <HintPath>..\..\packages\Castle.Core.3.3.3\lib\net45\Castle.Core.dll</HintPath>
+      <Private>True</Private>
+    </Reference>
+    <Reference Include="Microsoft.Web.Infrastructure, Version=1.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL">
+      <HintPath>..\..\packages\Microsoft.Web.Infrastructure.1.0.0.0\lib\net40\Microsoft.Web.Infrastructure.dll</HintPath>
+      <Private>True</Private>
+    </Reference>
+    <Reference Include="Moq, Version=4.5.10.0, Culture=neutral, PublicKeyToken=69f491c39445e920, processorArchitecture=MSIL">
+      <HintPath>..\..\packages\Moq.4.5.10\lib\net45\Moq.dll</HintPath>
+      <Private>True</Private>
+    </Reference>
     <Reference Include="System" />
     <Reference Include="System.Core" />
+    <Reference Include="System.Web" />
+    <Reference Include="System.Web.Helpers, Version=3.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL">
+      <HintPath>..\..\packages\Microsoft.AspNet.WebPages.3.2.3\lib\net45\System.Web.Helpers.dll</HintPath>
+      <Private>True</Private>
+    </Reference>
+    <Reference Include="System.Web.Mvc, Version=5.2.3.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL">
+      <HintPath>..\..\packages\Microsoft.AspNet.Mvc.5.2.3\lib\net45\System.Web.Mvc.dll</HintPath>
+      <Private>True</Private>
+    </Reference>
+    <Reference Include="System.Web.Razor, Version=3.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL">
+      <HintPath>..\..\packages\Microsoft.AspNet.Razor.3.2.3\lib\net45\System.Web.Razor.dll</HintPath>
+      <Private>True</Private>
+    </Reference>
+    <Reference Include="System.Web.WebPages, Version=3.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL">
+      <HintPath>..\..\packages\Microsoft.AspNet.WebPages.3.2.3\lib\net45\System.Web.WebPages.dll</HintPath>
+      <Private>True</Private>
+    </Reference>
+    <Reference Include="System.Web.WebPages.Deployment, Version=3.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL">
+      <HintPath>..\..\packages\Microsoft.AspNet.WebPages.3.2.3\lib\net45\System.Web.WebPages.Deployment.dll</HintPath>
+      <Private>True</Private>
+    </Reference>
+    <Reference Include="System.Web.WebPages.Razor, Version=3.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL">
+      <HintPath>..\..\packages\Microsoft.AspNet.WebPages.3.2.3\lib\net45\System.Web.WebPages.Razor.dll</HintPath>
+      <Private>True</Private>
+    </Reference>
     <Reference Include="System.Xml.Linq" />
     <Reference Include="System.Data.DataSetExtensions" />
     <Reference Include="Microsoft.CSharp" />
@@ -60,6 +97,7 @@
   </ItemGroup>
   <ItemGroup>
     <Compile Include="Class1.cs" />
+    <Compile Include="CompressionFactoryTests.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
   </ItemGroup>
   <ItemGroup>
@@ -70,6 +108,10 @@
       <Project>{256f0ecd-0310-4de9-8334-31a3d3867925}</Project>
       <Name>CompressR.MVC5</Name>
     </ProjectReference>
+    <ProjectReference Include="..\CompressR\CompressR.csproj">
+      <Project>{c94378c3-4aa8-4f49-8720-77d14b62f72e}</Project>
+      <Name>CompressR</Name>
+    </ProjectReference>
   </ItemGroup>
   <ItemGroup>
     <Service Include="{82A7F48D-3B50-4B1E-B82E-3ADA8210C358}" />

src/CompressR.MVCUnitTests/CompressionFactoryTests.cs

@@ -0,0 +1,189 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.IO.Compression;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using System.Web;
+using System.Web.Mvc;
+using System.Web.Routing;
+using Moq;
+using Xunit;
+
+namespace CompressR.MVCUnitTests
+{
+    public class CompressionFactoryTests
+    {
+        [Fact]
+        public void ShouldThrowWhenRequired()
+        {
+            var request = new Mock<HttpRequestBase>();
+            request.Setup(a => a.Headers).Returns(new System.Collections.Specialized.NameValueCollection() { });
+            var httpContext = new Moq.Mock<HttpContextBase>();
+            httpContext.Setup(a => a.Request).Returns(request.Object);
+            Assert.Throws(typeof(CompressR.Exceptions.CompressRException), () =>
+            {
+                CompressR.MVC.CompressFactory.Compress(new System.Web.Mvc.ResultExecutedContext()
+                {
+                    HttpContext = httpContext.Object
+                }, true);
+            });
+        }
+
+        [Fact]
+        public void ShouldNotThrowButAlsoNotCompressIfFalse()
+        {
+            var request = new Mock<HttpRequestBase>();
+            request.Setup(a => a.Headers).Returns(new System.Collections.Specialized.NameValueCollection() { });
+            var httpContext = new Moq.Mock<HttpContextBase>();
+            httpContext.Setup(a => a.Request).Returns(request.Object);
+            var response = new Mock<HttpResponseBase>();
+            httpContext.Setup(a => a.Response).Returns(response.Object);
+            var contextObject = httpContext.Object;
+            CompressR.MVC.CompressFactory.Compress(new System.Web.Mvc.ResultExecutedContext()
+            {
+                HttpContext = contextObject
+            }, false);
+            Assert.Null(contextObject.Response.Filter);
+        }
+
+        [Fact]
+        public void ShouldGzipWhenRequested()
+        {
+            var request = new Mock<HttpRequestBase>();
+            request.Setup(a => a.Headers).Returns(new System.Collections.Specialized.NameValueCollection() { ["Accept-Encoding"] = "gzip" });
+            var requestContextBase = new Mock<HttpContextBase>();
+            requestContextBase.Setup(a => a.Request).Returns(request.Object);
+            var requestContext = new Mock<RequestContext>();
+            requestContext.Setup(a => a.HttpContext).Returns(requestContextBase.Object);
+            var cachePolicy = new Mock<HttpCachePolicyBase>();
+            cachePolicy.Setup(a => a.VaryByHeaders).Returns(new HttpCacheVaryByHeaders());
+            //var httpContext = new Moq.Mock<ActionExecutingContext>();
+            var response = new Mock<HttpResponseBase>();
+            response.Setup(a => a.Headers).Returns(new System.Collections.Specialized.NameValueCollection());
+            response.SetupProperty(a => a.Filter, new MemoryStream(Encoding.UTF8.GetBytes("awesome")) { });
+            response.Setup(a => a.Cache).Returns(cachePolicy.Object);
+            var responseContext = new Mock<HttpContextBase>();
+            responseContext.Setup(a => a.Response).Returns(response.Object);
+
+            requestContextBase.Setup(a => a.Response).Returns(response.Object);
+            var httpContext = new ResultExecutedContext()
+            {
+                RequestContext = new System.Web.Routing.RequestContext()
+                {
+                    HttpContext = requestContextBase.Object
+                }
+            };
+
+            //httpContext.Setup(a=>a.RequestContext.Filter).Returns(new MemoryStream(Encoding.UTF8.GetBytes("awesome")) { } );
+            //var response = new Mock<HttpResponseBase>();
+            //httpContext.Setup(a => a.Response).Returns(response.Object);
+            //var contextObject = httpContext;
+            CompressR.MVC.CompressFactory.Compress(httpContext, false);
+            Assert.IsType<GZipStream>(httpContext.RequestContext.HttpContext.Response.Filter);
+        }
+
+        [Fact]
+        public void ShouldNotGzipWhenExceptionNotHandled()
+        {
+            var request = new Mock<HttpRequestBase>();
+            request.Setup(a => a.Headers).Returns(new System.Collections.Specialized.NameValueCollection() { ["Accept-Encoding"] = "gzip" });
+            var requestContextBase = new Mock<HttpContextBase>();
+            requestContextBase.Setup(a => a.Request).Returns(request.Object);
+            var requestContext = new Mock<RequestContext>();
+            requestContext.Setup(a => a.HttpContext).Returns(requestContextBase.Object);
+            var cachePolicy = new Mock<HttpCachePolicyBase>();
+            cachePolicy.Setup(a => a.VaryByHeaders).Returns(new HttpCacheVaryByHeaders());
+            //var httpContext = new Moq.Mock<ActionExecutingContext>();
+            var response = new Mock<HttpResponseBase>();
+            response.Setup(a => a.Headers).Returns(new System.Collections.Specialized.NameValueCollection());
+            response.SetupProperty(a => a.Filter, new MemoryStream(Encoding.UTF8.GetBytes("awesome")) { });
+            response.Setup(a => a.Cache).Returns(cachePolicy.Object);
+            var responseContext = new Mock<HttpContextBase>();
+            responseContext.Setup(a => a.Response).Returns(response.Object);
+
+            requestContextBase.Setup(a => a.Response).Returns(response.Object);
+            var httpContext = new ResultExecutedContext()
+            {
+                RequestContext = new System.Web.Routing.RequestContext()
+                {
+                    HttpContext = requestContextBase.Object
+                },
+                Exception = new Exception(),
+                ExceptionHandled = false
+            };
+            CompressR.MVC.CompressFactory.Compress(httpContext, false);
+            Assert.IsNotType<GZipStream>(httpContext.RequestContext.HttpContext.Response.Filter);
+        }
+
+        [Fact]
+        public void ShouldGzipWhenExceptionHandled()
+        {
+            var request = new Mock<HttpRequestBase>();
+            request.Setup(a => a.Headers).Returns(new System.Collections.Specialized.NameValueCollection() { ["Accept-Encoding"] = "gzip" });
+            var requestContextBase = new Mock<HttpContextBase>();
+            requestContextBase.Setup(a => a.Request).Returns(request.Object);
+            var requestContext = new Mock<RequestContext>();
+            requestContext.Setup(a => a.HttpContext).Returns(requestContextBase.Object);
+            var cachePolicy = new Mock<HttpCachePolicyBase>();
+            cachePolicy.Setup(a => a.VaryByHeaders).Returns(new HttpCacheVaryByHeaders());
+            //var httpContext = new Moq.Mock<ActionExecutingContext>();
+            var response = new Mock<HttpResponseBase>();
+            response.Setup(a => a.Headers).Returns(new System.Collections.Specialized.NameValueCollection());
+            response.SetupProperty(a => a.Filter, new MemoryStream(Encoding.UTF8.GetBytes("awesome")) { });
+            response.Setup(a => a.Cache).Returns(cachePolicy.Object);
+            var responseContext = new Mock<HttpContextBase>();
+            responseContext.Setup(a => a.Response).Returns(response.Object);
+
+            requestContextBase.Setup(a => a.Response).Returns(response.Object);
+            var httpContext = new ResultExecutedContext()
+            {
+                RequestContext = new System.Web.Routing.RequestContext()
+                {
+                    HttpContext = requestContextBase.Object
+                },
+                Exception = new Exception(),
+                ExceptionHandled = true
+            };
+            CompressR.MVC.CompressFactory.Compress(httpContext, false);
+            Assert.IsType<GZipStream>(httpContext.RequestContext.HttpContext.Response.Filter);
+        }
+
+        [Fact]
+        public void ShouldDeflateWhenRequested()
+        {
+            var request = new Mock<HttpRequestBase>();
+            request.Setup(a => a.Headers).Returns(new System.Collections.Specialized.NameValueCollection() { ["Accept-Encoding"] = "deflate" });
+            var requestContextBase = new Mock<HttpContextBase>();
+            requestContextBase.Setup(a => a.Request).Returns(request.Object);
+            var requestContext = new Mock<RequestContext>();
+            requestContext.Setup(a => a.HttpContext).Returns(requestContextBase.Object);
+            var cachePolicy = new Mock<HttpCachePolicyBase>();
+            cachePolicy.Setup(a => a.VaryByHeaders).Returns(new HttpCacheVaryByHeaders());
+            //var httpContext = new Moq.Mock<ActionExecutingContext>();
+            var response = new Mock<HttpResponseBase>();
+            response.Setup(a => a.Headers).Returns(new System.Collections.Specialized.NameValueCollection());
+            response.SetupProperty(a => a.Filter, new MemoryStream(Encoding.UTF8.GetBytes("awesome")) { });
+            response.Setup(a => a.Cache).Returns(cachePolicy.Object);
+            var responseContext = new Mock<HttpContextBase>();
+            responseContext.Setup(a => a.Response).Returns(response.Object);
+
+            requestContextBase.Setup(a => a.Response).Returns(response.Object);
+            var httpContext = new ResultExecutedContext()
+            {
+                RequestContext = new System.Web.Routing.RequestContext()
+                {
+                    HttpContext = requestContextBase.Object
+                }
+            };
+
+            //httpContext.Setup(a=>a.RequestContext.Filter).Returns(new MemoryStream(Encoding.UTF8.GetBytes("awesome")) { } );
+            //var response = new Mock<HttpResponseBase>();
+            //httpContext.Setup(a => a.Response).Returns(response.Object);
+            //var contextObject = httpContext;
+            CompressR.MVC.CompressFactory.Compress(httpContext, false);
+            Assert.IsType<DeflateStream>(httpContext.RequestContext.HttpContext.Response.Filter);
+        }
+    }
+}

src/CompressR.MVCUnitTests/packages.config

@@ -1,5 +1,11 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
+  <package id="Castle.Core" version="3.3.3" targetFramework="net452" />
+  <package id="Microsoft.AspNet.Mvc" version="5.2.3" targetFramework="net452" />
+  <package id="Microsoft.AspNet.Razor" version="3.2.3" targetFramework="net452" />
+  <package id="Microsoft.AspNet.WebPages" version="3.2.3" targetFramework="net452" />
+  <package id="Microsoft.Web.Infrastructure" version="1.0.0.0" targetFramework="net452" />
+  <package id="Moq" version="4.5.10" targetFramework="net452" />
   <package id="xunit" version="2.1.0" targetFramework="net452" />
   <package id="xunit.abstractions" version="2.0.0" targetFramework="net452" />
   <package id="xunit.assert" version="2.1.0" targetFramework="net452" />

src/CompressR.WebApi/BaseCompressAttribute.cs

@@ -23,7 +23,11 @@ namespace CompressR.WebApi
 
         protected async Task CompressAction(HttpActionExecutedContext actionExecutedContext, params string[] compressors)
         {
-            if(actionExecutedContext.Response.Content == null)
+            if(actionExecutedContext?.Exception != null)
+            {
+                return;
+            }
+            if(actionExecutedContext?.Response?.Content == null)
             {
                 return;
             }

src/CompressR.WebApi/CompressAttribute.cs

@@ -16,6 +16,10 @@ namespace CompressR.WebApi
 
         public override Task OnActionExecutedAsync(HttpActionExecutedContext actionExecutedContext, CancellationToken cancellationToken)
         {
+            if(cancellationToken.IsCancellationRequested)
+            {
+                return Task.FromResult(0);
+            }
             return base.CompressAction(actionExecutedContext, Constants.Compressors);
         }
     }

src/CompressR.WebApi/DeflateAttribute.cs

@@ -24,6 +24,10 @@ namespace CompressR.WebApi
 
         public override Task OnActionExecutedAsync(HttpActionExecutedContext actionExecutedContext, CancellationToken cancellationToken)
         {
+            if(cancellationToken.IsCancellationRequested)
+            {
+                return Task.FromResult(0);
+            }
             return base.CompressAction(actionExecutedContext, Constants.Deflate);
         }
     }

src/CompressR.WebApi/GzipAttribute.cs

@@ -23,6 +23,10 @@ namespace CompressR.WebApi
 
         public override Task OnActionExecutedAsync(HttpActionExecutedContext actionExecutedContext, CancellationToken cancellationToken)
         {
+            if(cancellationToken.IsCancellationRequested)
+            {
+                return Task.FromResult(0);
+            }
             return base.CompressAction(actionExecutedContext, Constants.Gzip);
         }
     }