TerribleDev/CompressR
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

handle exceptions from the application better

Browse Source
This commit is contained in:
Tommy Parnell
2016-09-20 09:49:05 -04:00
parent 31df13215b
commit bac99a3817
11 changed files with 116 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
src/CompressR.MVC/CompressAttribute.cs
View File

@@ -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);
}

15
src/CompressR.MVC/CompressFactory.cs
View File

@@ -9,7 +9,7 @@ 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)
{
var context = filterContext.RequestContext.HttpContext;
var compressionAccepted = context.Request.Headers.Get(Constants.AcceptEncoding)?.Split(',').Trim().Any(a => string.Equals(a, compression, StringComparison.OrdinalIgnoreCase)) ?? false;
@@ -28,8 +28,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 +46,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:

6
src/CompressR.MVC/Constants.cs
View File

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

6
src/CompressR.MVC/DeflateAttribute.cs
View File

@@ -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);
}
}
}

6
src/CompressR.MVC/Extensions.cs
View File

@@ -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();
}

10
src/CompressR.MVC/GzipAttribute.cs
View File

@@ -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);
}
}
}

89
src/CompressR.MVCUnitTests/CompressionFactoryTests.cs
View File

@@ -22,15 +22,15 @@ namespace CompressR.MVCUnitTests
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.ActionExecutingContext()
Assert.Throws(typeof(CompressR.Exceptions.CompressRException), () =>
{
CompressR.MVC.CompressFactory.Compress(new System.Web.Mvc.ResultExecutedContext()
{
HttpContext = httpContext.Object
}, true);
});
}
[Fact]
public void ShouldNotThrowButAlsoNotCompressIfFalse()
{
@@ -41,17 +41,16 @@ namespace CompressR.MVCUnitTests
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.ActionExecutingContext()
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>();
@@ -69,7 +68,7 @@ namespace CompressR.MVCUnitTests
responseContext.Setup(a => a.Response).Returns(response.Object);
requestContextBase.Setup(a => a.Response).Returns(response.Object);
var httpContext = new ActionExecutingContext()
var httpContext = new ResultExecutedContext()
{
RequestContext = new System.Web.Routing.RequestContext()
{
@@ -83,12 +82,77 @@ namespace CompressR.MVCUnitTests
//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>();
@@ -106,7 +170,7 @@ namespace CompressR.MVCUnitTests
responseContext.Setup(a => a.Response).Returns(response.Object);
requestContextBase.Setup(a => a.Response).Returns(response.Object);
var httpContext = new ActionExecutingContext()
var httpContext = new ResultExecutedContext()
{
RequestContext = new System.Web.Routing.RequestContext()
{
@@ -120,7 +184,6 @@ namespace CompressR.MVCUnitTests
//var contextObject = httpContext;
CompressR.MVC.CompressFactory.Compress(httpContext, false);
Assert.IsType<DeflateStream>(httpContext.RequestContext.HttpContext.Response.Filter);
}
}
}
}

6
src/CompressR.WebApi/BaseCompressAttribute.cs
View File

@@ -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;
}

4
src/CompressR.WebApi/CompressAttribute.cs
View File

@@ -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);
}
}

4
src/CompressR.WebApi/DeflateAttribute.cs
View File

@@ -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);
}
}

4
src/CompressR.WebApi/GzipAttribute.cs
View File

@@ -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);
}
}