11 Commits

Author SHA1 Message Date
Tommy Parnell
dc44adc712 gzip, and deflate should only gzip/deflate in mvc 2016-11-24 22:09:35 -05:00
Tommy Parnell
772a11a710 fix package dependencies 2016-09-22 14:32:12 -04:00
Tommy Parnell
be2158f38b Merge branch 'handleExceptions' 2016-09-20 11:23:06 -04:00
Tommy Parnell
efffeafae4 Merge pull request #6 from TerribleDev/handleExceptions
handle exceptions from the application better
2016-09-20 11:22:44 -04:00
Tommy Parnell
86382a36c6 bump version 2016-09-20 11:21:13 -04:00
Tommy Parnell
9c87801818 handle exeptions on both overloads 2016-09-20 10:01:04 -04:00
Tommy Parnell
bac99a3817 handle exceptions from the application better 2016-09-20 09:49:05 -04:00
Tommy Parnell
31df13215b add tests for mvc (#5) 2016-06-29 12:19:08 -07:00
Tommy Parnell
a2f9c5e5d5 update sample, bump version 2016-06-25 08:24:39 -04:00
Tommy Parnell
2bab2c3d1d default to optimal compression, clean up code (#4) 2016-06-24 09:35:52 -04:00
Tommy Parnell
fbcaa3ce4b fix assembly data 2016-06-21 11:15:08 -04:00
23 changed files with 424 additions and 173 deletions

View File

@@ -20,6 +20,7 @@ EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{84E10868-C75C-4FDF-8AE1-465F1593A211}"
ProjectSection(SolutionItems) = preProject
appveyor.yml = appveyor.yml
gulpfile.js = gulpfile.js
EndProjectSection
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CompressR.WebApiUnitTests", "src\CompressR.WebApiUnitTests\CompressR.WebApiUnitTests.csproj", "{61D97564-ACF6-4396-AB96-2D29CDCC3814}"

View File

@@ -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.2.1';
var version = '1.5.1';
gulp.task('clean', ()=>{
return del(['src/**/obj/', 'src/**/bin/Release', 'nuget.exe', 'nupkgs'])
@@ -24,6 +24,8 @@ gulp.task('patchAssemblyInfo', ()=>{
.pipe(assemblyInfo({
version: function(value) { return version; },
fileVersion: function(value) { return version; },
company: 'Tommy Parnell',
copyright: 'Copyright © Tommy Parnell 2016'
}))
.pipe(gulp.dest('.'))
});

View File

@@ -0,0 +1,20 @@
using System;
using System.Collections.Generic;
using System.IO.Compression;
using System.Text;
namespace CompressR.MVC
{
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false, Inherited = true)]
public abstract class BaseCompressAttribute : System.Web.Mvc.ActionFilterAttribute
{
protected bool RequireCompression { get; set; }
public CompressionLevel CompressionLevel { get; set; } = CompressionLevel.Optimal;
protected BaseCompressAttribute(bool requireCompression = false)
{
RequireCompression = requireCompression;
}
}
}

View File

@@ -7,18 +7,16 @@ using System.Web.Mvc;
namespace CompressR.MVC
{
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false, Inherited = false)]
public sealed class CompressAttribute : System.Web.Mvc.ActionFilterAttribute
public sealed class CompressAttribute : BaseCompressAttribute
{
private bool RequireCompression { get; set; }
public CompressAttribute(bool requireCompression = false)
: base(requireCompression)
{
RequireCompression = requireCompression;
}
public override void OnActionExecuting(ActionExecutingContext filterContext)
public override void OnResultExecuted(ResultExecutedContext filterContext)
{
CompressFactory.Compress(filterContext, RequireCompression);
CompressFactory.Compress(filterContext, RequireCompression, CompressionLevel);
}
}
}

View File

@@ -1,21 +1,25 @@
using CompressR.Exceptions;
using System;
using System;
using System.Collections.Generic;
using System.IO.Compression;
using System.Linq;
using System.Text;
using CompressR.Exceptions;
namespace CompressR.MVC
{
public static class CompressFactory
{
public static void Compress(string compression, System.Web.Mvc.ActionExecutingContext filterContext, bool requireCompression)
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)
if(!compressionAccepted)
{
if (requireCompression)
if(requireCompression)
{
throw new CompressRException("Compression required but client did not send accept header");
}
@@ -25,18 +29,20 @@ namespace CompressR.MVC
}
}
HandleCompression(compression, filterContext);
HandleCompression(compression, filterContext, compressLevel);
}
public static void Compress(System.Web.Mvc.ActionExecutingContext filterContext, bool requireCompression)
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))
if(!string.IsNullOrWhiteSpace(compressionAlgorithm))
{
HandleCompression(compressionAlgorithm, filterContext);
HandleCompression(compressionAlgorithm, filterContext, compressLevel);
}
else if(requireCompression)
{
@@ -44,19 +50,24 @@ namespace CompressR.MVC
}
}
private static void HandleCompression(string compression, System.Web.Mvc.ActionExecutingContext filterContext)
private static void HandleCompression(string compression, System.Web.Mvc.ResultExecutedContext filterContext, CompressionLevel compressLevel = CompressionLevel.Optimal)
{
var context = filterContext.RequestContext.HttpContext;
switch (compression)
HandleCompression(compression, filterContext.RequestContext.HttpContext, compressLevel);
}
private static void HandleCompression(string compression, System.Web.HttpContextBase context, CompressionLevel compressLevel)
{
switch(compression)
{
case Constants.Gzip:
context.Response.Filter = new GZipStream(context.Response.Filter, CompressionMode.Compress);
context.Response.Filter = new GZipStream(context.Response.Filter, compressLevel);
context.Response.AppendHeader(Constants.ContentEncoding, Constants.Gzip);
context.Response.Cache.VaryByHeaders[Constants.AcceptEncoding] = true;
break;
case Constants.Deflate:
context.Response.Filter = new DeflateStream(context.Response.Filter, CompressionMode.Compress);
context.Response.Filter = new DeflateStream(context.Response.Filter, compressLevel);
context.Response.AppendHeader(Constants.ContentEncoding, Constants.Deflate);
context.Response.Cache.VaryByHeaders[Constants.AcceptEncoding] = true;
break;

View File

@@ -9,6 +9,7 @@
<Import_RootNamespace>CompressR.MVC</Import_RootNamespace>
</PropertyGroup>
<ItemGroup>
<Compile Include="$(MSBuildThisFileDirectory)BaseCompressAttribute.cs" />
<Compile Include="$(MSBuildThisFileDirectory)CompressAttribute.cs" />
<Compile Include="$(MSBuildThisFileDirectory)CompressFactory.cs" />
<Compile Include="$(MSBuildThisFileDirectory)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
{

View File

@@ -1,17 +1,16 @@
using System;
using System.IO.Compression;
using System.Linq;
using System.Web.Mvc;
namespace CompressR.MVC
{
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false, Inherited = false)]
public sealed class DeflateAttribute : System.Web.Mvc.ActionFilterAttribute
public sealed class DeflateAttribute : BaseCompressAttribute
{
private bool RequireCompression { get; set; }
public DeflateAttribute(bool requireCompression = false)
: base(requireCompression)
{
RequireCompression = requireCompression;
}
/// <summary>
@@ -19,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(Constants.Deflate, filterContext, RequireCompression);
CompressFactory.Compress(filterContext, RequireCompression, Constants.Deflate, CompressionLevel);
}
}
}

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

View File

@@ -1,27 +1,20 @@
using System;
using System.IO.Compression;
using System.Linq;
using System.Web.Mvc;
namespace CompressR.MVC
{
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false, Inherited = false)]
public sealed class GzipAttribute : System.Web.Mvc.ActionFilterAttribute
public sealed class GzipAttribute : BaseCompressAttribute
{
private bool RequireCompression { get; set; }
public GzipAttribute(bool requireCompression = false)
: base(requireCompression)
{
RequireCompression = requireCompression;
}
/// <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(Constants.Gzip, filterContext, RequireCompression);
CompressFactory.Compress(filterContext, RequireCompression, Constants.Gzip, CompressionLevel);
}
}
}

View File

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

View File

@@ -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}" />

View File

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

View File

@@ -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" />

View File

@@ -14,7 +14,27 @@ namespace CompressR.Sample.Controllers
{
ViewBag.Title = "Home Page";
return View();
return View("index");
}
public ActionResult NoZip()
{
ViewBag.Title = "Home Page";
return View("index");
}
[Gzip]
public ActionResult Gzip()
{
ViewBag.Title = "Home Page";
return View("index");
}
[Deflate]
public ActionResult Deflate()
{
ViewBag.Title = "Home Page";
return View("index");
}
}
}

View File

@@ -1,11 +1,11 @@
using CompressR.WebApi;
using System;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Threading.Tasks;
using System.Web.Http;
using CompressR.WebApi;
namespace CompressR.Sample.Controllers
{
@@ -17,6 +17,7 @@ namespace CompressR.Sample.Controllers
{
return new string[] { "value1", "value2" };
}
[Deflate]
// GET api/values/5
public string Get(int id)
@@ -24,7 +25,7 @@ namespace CompressR.Sample.Controllers
return "value";
}
[Compress]
[Gzip]
[HttpGet, Route("TestJsonSerialization")]
public async Task<IHttpActionResult> TestJsonSerialization()
{
@@ -32,7 +33,6 @@ namespace CompressR.Sample.Controllers
{
A = 1,
B = new string[] { "1", "A", "B" }
});
}
@@ -44,9 +44,7 @@ namespace CompressR.Sample.Controllers
{
A = 1,
B = new string[] { "1", "A", "B" }
});
}
}
}

View File

@@ -56,4 +56,5 @@
<remove name="TRACEVerbHandler" />
<add name="ExtensionlessUrlHandler-Integrated-4.0" path="*." verb="*" type="System.Web.Handlers.TransferRequestHandler" preCondition="integratedMode,runtimeVersionv4.0" />
</handlers>
<urlCompression doDynamicCompression="false" dynamicCompressionBeforeCache="false" doStaticCompression="false"/>
</system.webServer></configuration>

View File

@@ -0,0 +1,55 @@
using System;
using System.Collections.Generic;
using System.IO.Compression;
using System.Linq;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using System.Web.Http.Filters;
using CompressR.Exceptions;
namespace CompressR.WebApi
{
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false, Inherited = true)]
public abstract class BaseCompressAttribute : System.Web.Http.Filters.ActionFilterAttribute
{
protected bool RequireCompression { get; set; }
public CompressionLevel CompressionLevel { get; set; } = CompressionLevel.Optimal;
protected BaseCompressAttribute(bool requireCompression = false)
{
RequireCompression = requireCompression;
}
protected async Task CompressAction(HttpActionExecutedContext actionExecutedContext, params string[] compressors)
{
if(actionExecutedContext?.Exception != null)
{
return;
}
if(actionExecutedContext?.Response?.Content == null)
{
return;
}
var acceptedEncoding = actionExecutedContext
.Response
.RequestMessage
.Headers
.AcceptEncoding
.Select(a => a.Value)
.Intersect(compressors, StringComparer.OrdinalIgnoreCase)
.FirstOrDefault();
if(string.IsNullOrWhiteSpace(acceptedEncoding))
{
if(RequireCompression)
{
throw new CompressRException("Compression required but client did not send accept header");
}
return;
}
actionExecutedContext.Response.Content = new CompressedContent(actionExecutedContext.Response.Content, acceptedEncoding, CompressionLevel);
}
}
}

View File

@@ -1,62 +1,26 @@
using CompressR.Exceptions;
using System;
using System.Collections.Generic;
using System.IO.Compression;
using System.Linq;
using System.Net.Http;
using System.Text;
using System.Threading;
using System.Threading;
using System.Threading.Tasks;
using System.Web.Http.Controllers;
using System.Web.Http.Filters;
namespace CompressR.WebApi
{
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false, Inherited = false)]
public sealed class CompressAttribute : System.Web.Http.Filters.ActionFilterAttribute
public sealed class CompressAttribute : BaseCompressAttribute
{
private bool RequireCompression { get; set; }
public CompressAttribute(bool requireCompression = false)
{
RequireCompression = requireCompression;
}
: base(requireCompression) { }
public override void OnActionExecuted(HttpActionExecutedContext actionExecutedContext)
{
OnActionExecutedAsync(actionExecutedContext, CancellationToken.None).Wait();
base.CompressAction(actionExecutedContext, Constants.Compressors).Wait();
}
public override async Task OnActionExecutedAsync(HttpActionExecutedContext actionExecutedContext, CancellationToken cancellationToken)
public override Task OnActionExecutedAsync(HttpActionExecutedContext actionExecutedContext, CancellationToken cancellationToken)
{
if(actionExecutedContext.Response.Content == null)
if(cancellationToken.IsCancellationRequested)
{
return;
return Task.FromResult(0);
}
var acceptedEncoding = actionExecutedContext
.Response
.RequestMessage
.Headers
.AcceptEncoding
.Select(a => a.Value)
.Intersect(Constants.Compressors, StringComparer.OrdinalIgnoreCase)
.FirstOrDefault();
if (string.IsNullOrWhiteSpace(acceptedEncoding))
{
if (RequireCompression)
{
throw new CompressRException("Compression required but client did not send accept header");
}
else
{
return;
}
}
actionExecutedContext.Response.Content = new CompressedContent(actionExecutedContext.Response.Content, acceptedEncoding);
return base.CompressAction(actionExecutedContext, Constants.Compressors);
}
}
}

View File

@@ -53,6 +53,7 @@
<Reference Include="System.Xml" />
</ItemGroup>
<ItemGroup>
<Compile Include="BaseCompressAttribute.cs" />
<Compile Include="CompressedContent.cs" />
<Compile Include="Constants.cs" />
<Compile Include="DeflateAttribute.cs" />

View File

@@ -9,12 +9,13 @@ namespace CompressR.WebApi
{
public class CompressedContent : HttpContent
{
private readonly CompressionLevel compressionLevel;
private readonly string _encodingType;
private readonly HttpContent _originalContent;
public CompressedContent(HttpContent content, string encodingType = "gzip")
public CompressedContent(HttpContent content, string encodingType = "gzip", CompressionLevel compressionLevel = CompressionLevel.Optimal)
{
if (content == null)
if(content == null)
{
throw new ArgumentNullException("content");
}
@@ -22,11 +23,12 @@ namespace CompressR.WebApi
_originalContent = content;
_encodingType = encodingType.ToLowerInvariant();
foreach (var header in _originalContent.Headers)
foreach(var header in _originalContent.Headers)
{
Headers.TryAddWithoutValidation(header.Key, header.Value);
}
Headers.ContentEncoding.Add(encodingType);
this.compressionLevel = compressionLevel;
}
protected override bool TryComputeLength(out long length)
@@ -38,14 +40,14 @@ namespace CompressR.WebApi
protected override Task SerializeToStreamAsync(Stream stream, TransportContext context)
{
Stream compressedStream = null;
switch (_encodingType)
switch(_encodingType)
{
case Constants.Gzip:
compressedStream = new GZipStream(stream, CompressionMode.Compress, true);
compressedStream = new GZipStream(stream, compressionLevel, true);
break;
case Constants.Deflate:
compressedStream = new DeflateStream(stream, CompressionMode.Compress, true);
compressedStream = new DeflateStream(stream, compressionLevel, true);
break;
default:
@@ -55,7 +57,7 @@ namespace CompressR.WebApi
return _originalContent.CopyToAsync(compressedStream).ContinueWith(tsk =>
{
if (compressedStream != null)
if(compressedStream != null)
{
compressedStream.Dispose();
}

View File

@@ -1,5 +1,4 @@
using CompressR.Exceptions;
using System;
using System;
using System.Collections.Generic;
using System.IO.Compression;
using System.Linq;
@@ -9,49 +8,27 @@ using System.Threading;
using System.Threading.Tasks;
using System.Web.Http.Controllers;
using System.Web.Http.Filters;
using CompressR.Exceptions;
namespace CompressR.WebApi
{
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false, Inherited = false)]
public sealed class DeflateAttribute : System.Web.Http.Filters.ActionFilterAttribute
public sealed class DeflateAttribute : BaseCompressAttribute
{
private bool RequireCompression { get; set; }
public DeflateAttribute(bool requireCompression = false)
{
RequireCompression = requireCompression;
}
: base(requireCompression) { }
public override void OnActionExecuted(HttpActionExecutedContext actionExecutedContext)
{
OnActionExecutedAsync(actionExecutedContext, CancellationToken.None).Wait();
base.CompressAction(actionExecutedContext, Constants.Deflate).Wait();
}
public override async Task OnActionExecutedAsync(HttpActionExecutedContext actionExecutedContext, CancellationToken cancellationToken)
public override Task OnActionExecutedAsync(HttpActionExecutedContext actionExecutedContext, CancellationToken cancellationToken)
{
if(actionExecutedContext.Response.Content == null)
if(cancellationToken.IsCancellationRequested)
{
return;
return Task.FromResult(0);
}
var acceptedEncoding = actionExecutedContext
.Response
.RequestMessage
.Headers
.AcceptEncoding
.Select(a => a.Value)
.Any(a => a.Equals(Constants.Deflate, StringComparison.OrdinalIgnoreCase));
if (!acceptedEncoding && RequireCompression)
{
throw new CompressRException("Compression required but client did not send accept header");
}
if (!acceptedEncoding)
{
return;
}
actionExecutedContext.Response.Content = new CompressedContent(actionExecutedContext.Response.Content, Constants.Deflate);
return base.CompressAction(actionExecutedContext, Constants.Deflate);
}
}
}

View File

@@ -1,5 +1,4 @@
using CompressR.Exceptions;
using System;
using System;
using System.IO.Compression;
using System.Linq;
using System.Net.Http;
@@ -8,50 +7,27 @@ using System.Threading;
using System.Threading.Tasks;
using System.Web.Http.Controllers;
using System.Web.Http.Filters;
using CompressR.Exceptions;
namespace CompressR.WebApi
{
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false, Inherited = false)]
public sealed class GzipAttribute : System.Web.Http.Filters.ActionFilterAttribute
public sealed class GzipAttribute : BaseCompressAttribute
{
private bool RequireCompression { get; set; }
public GzipAttribute(bool requireCompression = false)
{
RequireCompression = requireCompression;
}
: base(requireCompression) { }
public override void OnActionExecuted(HttpActionExecutedContext actionExecutedContext)
{
OnActionExecutedAsync(actionExecutedContext, CancellationToken.None).Wait();
base.CompressAction(actionExecutedContext, Constants.Gzip).Wait();
}
public override async Task OnActionExecutedAsync(HttpActionExecutedContext actionExecutedContext, CancellationToken cancellationToken)
public override Task OnActionExecutedAsync(HttpActionExecutedContext actionExecutedContext, CancellationToken cancellationToken)
{
if(actionExecutedContext.Response.Content == null)
if(cancellationToken.IsCancellationRequested)
{
return;
return Task.FromResult(0);
}
var acceptedEncoding = actionExecutedContext
.Response
.RequestMessage
.Headers
.AcceptEncoding
.Select(a => a.Value)
.Any(a => a.Equals(Constants.Gzip, StringComparison.OrdinalIgnoreCase));
if (!acceptedEncoding && RequireCompression)
{
throw new CompressRException("Compression required but client did not send accept header");
}
if (!acceptedEncoding)
{
return;
}
actionExecutedContext.Response.Content = new CompressedContent(actionExecutedContext.Response.Content, Constants.Gzip);
return base.CompressAction(actionExecutedContext, Constants.Gzip);
}
}
}