9 Commits
1.2.2 ... 1.5.1

Author SHA1 Message Date
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
22 changed files with 415 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}" Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{84E10868-C75C-4FDF-8AE1-465F1593A211}"
ProjectSection(SolutionItems) = preProject ProjectSection(SolutionItems) = preProject
appveyor.yml = appveyor.yml appveyor.yml = appveyor.yml
gulpfile.js = gulpfile.js
EndProjectSection EndProjectSection
EndProject EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CompressR.WebApiUnitTests", "src\CompressR.WebApiUnitTests\CompressR.WebApiUnitTests.csproj", "{61D97564-ACF6-4396-AB96-2D29CDCC3814}" 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 del = require('del');
var assemblyInfo = require('gulp-dotnet-assembly-info'); var assemblyInfo = require('gulp-dotnet-assembly-info');
var xunit = xunit = require('gulp-xunit-runner'); var xunit = xunit = require('gulp-xunit-runner');
var version = '1.2.2'; var version = '1.5.1';
gulp.task('clean', ()=>{ gulp.task('clean', ()=>{
return del(['src/**/obj/', 'src/**/bin/Release', 'nuget.exe', 'nupkgs']) return del(['src/**/obj/', 'src/**/bin/Release', 'nuget.exe', 'nupkgs'])

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 namespace CompressR.MVC
{ {
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false, Inherited = false)] [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) 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.Collections.Generic;
using System.IO.Compression; using System.IO.Compression;
using System.Linq; using System.Linq;
using System.Text; using System.Text;
using CompressR.Exceptions;
namespace CompressR.MVC namespace CompressR.MVC
{ {
public static class CompressFactory 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 context = filterContext.RequestContext.HttpContext;
var compressionAccepted = context.Request.Headers.Get(Constants.AcceptEncoding)?.Split(',').Trim().Any(a => string.Equals(a, compression, StringComparison.OrdinalIgnoreCase)) ?? false; 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"); throw new CompressRException("Compression required but client did not send accept header");
} }
@@ -25,18 +29,20 @@ namespace CompressR.MVC
} }
} }
HandleCompression(compression, filterContext, compressLevel);
HandleCompression(compression, filterContext);
} }
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 context = filterContext.RequestContext.HttpContext;
var compressionAlgorithm = context.Request.Headers.Get(Constants.AcceptEncoding)?.Split(',').Trim().Intersect(Constants.Compressors, StringComparer.OrdinalIgnoreCase)?.FirstOrDefault(); 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) 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; 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: 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.AppendHeader(Constants.ContentEncoding, Constants.Gzip);
context.Response.Cache.VaryByHeaders[Constants.AcceptEncoding] = true; context.Response.Cache.VaryByHeaders[Constants.AcceptEncoding] = true;
break; break;
case Constants.Deflate: 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.AppendHeader(Constants.ContentEncoding, Constants.Deflate);
context.Response.Cache.VaryByHeaders[Constants.AcceptEncoding] = true; context.Response.Cache.VaryByHeaders[Constants.AcceptEncoding] = true;
break; break;

View File

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

View File

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

View File

@@ -1,17 +1,16 @@
using System; using System;
using System.IO.Compression; using System.IO.Compression;
using System.Linq; using System.Linq;
using System.Web.Mvc;
namespace CompressR.MVC namespace CompressR.MVC
{ {
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false, Inherited = false)] [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) public DeflateAttribute(bool requireCompression = false)
: base(requireCompression)
{ {
RequireCompression = requireCompression;
} }
/// <summary> /// <summary>
@@ -19,9 +18,10 @@ namespace CompressR.MVC
/// an action method. /// an action method.
/// </summary> /// </summary>
/// <param name="filterContext"></param> /// <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, CompressionLevel);
} }
} }
} }

View File

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

View File

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

View File

@@ -14,7 +14,7 @@
<copyright>Copyright 2016</copyright> <copyright>Copyright 2016</copyright>
<tags>Compression MVC</tags> <tags>Compression MVC</tags>
<dependencies> <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> </dependencies>
</metadata> </metadata>
</package> </package>

View File

@@ -33,8 +33,45 @@
<WarningLevel>4</WarningLevel> <WarningLevel>4</WarningLevel>
</PropertyGroup> </PropertyGroup>
<ItemGroup> <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" />
<Reference Include="System.Core" /> <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.Xml.Linq" />
<Reference Include="System.Data.DataSetExtensions" /> <Reference Include="System.Data.DataSetExtensions" />
<Reference Include="Microsoft.CSharp" /> <Reference Include="Microsoft.CSharp" />
@@ -60,6 +97,7 @@
</ItemGroup> </ItemGroup>
<ItemGroup> <ItemGroup>
<Compile Include="Class1.cs" /> <Compile Include="Class1.cs" />
<Compile Include="CompressionFactoryTests.cs" />
<Compile Include="Properties\AssemblyInfo.cs" /> <Compile Include="Properties\AssemblyInfo.cs" />
</ItemGroup> </ItemGroup>
<ItemGroup> <ItemGroup>
@@ -70,6 +108,10 @@
<Project>{256f0ecd-0310-4de9-8334-31a3d3867925}</Project> <Project>{256f0ecd-0310-4de9-8334-31a3d3867925}</Project>
<Name>CompressR.MVC5</Name> <Name>CompressR.MVC5</Name>
</ProjectReference> </ProjectReference>
<ProjectReference Include="..\CompressR\CompressR.csproj">
<Project>{c94378c3-4aa8-4f49-8720-77d14b62f72e}</Project>
<Name>CompressR</Name>
</ProjectReference>
</ItemGroup> </ItemGroup>
<ItemGroup> <ItemGroup>
<Service Include="{82A7F48D-3B50-4B1E-B82E-3ADA8210C358}" /> <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"?> <?xml version="1.0" encoding="utf-8"?>
<packages> <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" version="2.1.0" targetFramework="net452" />
<package id="xunit.abstractions" version="2.0.0" targetFramework="net452" /> <package id="xunit.abstractions" version="2.0.0" targetFramework="net452" />
<package id="xunit.assert" version="2.1.0" targetFramework="net452" /> <package id="xunit.assert" version="2.1.0" targetFramework="net452" />

View File

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

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.Threading;
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.Tasks; using System.Threading.Tasks;
using System.Web.Http.Controllers;
using System.Web.Http.Filters; using System.Web.Http.Filters;
namespace CompressR.WebApi namespace CompressR.WebApi
{ {
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false, Inherited = false)] public sealed class CompressAttribute : BaseCompressAttribute
public sealed class CompressAttribute : System.Web.Http.Filters.ActionFilterAttribute
{ {
private bool RequireCompression { get; set; }
public CompressAttribute(bool requireCompression = false) public CompressAttribute(bool requireCompression = false)
{ : base(requireCompression) { }
RequireCompression = requireCompression;
}
public override void OnActionExecuted(HttpActionExecutedContext actionExecutedContext) 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 return base.CompressAction(actionExecutedContext, Constants.Compressors);
.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);
} }
} }
} }

View File

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

View File

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

View File

@@ -1,5 +1,4 @@
using CompressR.Exceptions; using System;
using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.IO.Compression; using System.IO.Compression;
using System.Linq; using System.Linq;
@@ -9,49 +8,27 @@ using System.Threading;
using System.Threading.Tasks; using System.Threading.Tasks;
using System.Web.Http.Controllers; using System.Web.Http.Controllers;
using System.Web.Http.Filters; using System.Web.Http.Filters;
using CompressR.Exceptions;
namespace CompressR.WebApi namespace CompressR.WebApi
{ {
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false, Inherited = false)] public sealed class DeflateAttribute : BaseCompressAttribute
public sealed class DeflateAttribute : System.Web.Http.Filters.ActionFilterAttribute
{ {
private bool RequireCompression { get; set; }
public DeflateAttribute(bool requireCompression = false) public DeflateAttribute(bool requireCompression = false)
{ : base(requireCompression) { }
RequireCompression = requireCompression;
}
public override void OnActionExecuted(HttpActionExecutedContext actionExecutedContext) 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 return base.CompressAction(actionExecutedContext, Constants.Deflate);
.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);
} }
} }
} }

View File

@@ -1,5 +1,4 @@
using CompressR.Exceptions; using System;
using System;
using System.IO.Compression; using System.IO.Compression;
using System.Linq; using System.Linq;
using System.Net.Http; using System.Net.Http;
@@ -8,50 +7,27 @@ using System.Threading;
using System.Threading.Tasks; using System.Threading.Tasks;
using System.Web.Http.Controllers; using System.Web.Http.Controllers;
using System.Web.Http.Filters; using System.Web.Http.Filters;
using CompressR.Exceptions;
namespace CompressR.WebApi namespace CompressR.WebApi
{ {
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false, Inherited = false)] public sealed class GzipAttribute : BaseCompressAttribute
public sealed class GzipAttribute : System.Web.Http.Filters.ActionFilterAttribute
{ {
private bool RequireCompression { get; set; }
public GzipAttribute(bool requireCompression = false) public GzipAttribute(bool requireCompression = false)
{ : base(requireCompression) { }
RequireCompression = requireCompression;
}
public override void OnActionExecuted(HttpActionExecutedContext actionExecutedContext) 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 return base.CompressAction(actionExecutedContext, Constants.Gzip);
.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);
} }
} }
} }