I just released RequestReduce v1.5 on Nuget and on http://www.RequestReduce.com.
If you are currently on v1.4, you will definitely want to upgrade to this new version. There was a misconfiguration in v1.4 causing a Regex to recompile on every call. The impact will vary depending on the number of scripts and css links on your site but is could well be in the 100s of milliseconds.
Enough about that. The key feature that v1.5 adds is a small API allowing you to do the following:
- Log RequestReduce exceptions thrown from its processing thread to your own error logging implementation including very simple support for Elmah logging.
- Plug in a custom minifier to replace the RequestReduce defaulr Microsoft Ajax Minifier. You can also use this if you want to override the settings that RequestReduce uses.
- Filter out certain CSS, Javascript or Image resources from being processed by RequestReduce including entire pages or areas of your site from being processed. The API allows you to evaluate any property in the HttpRequest to decide if a resource should be filtered.
Here are the details on how to use the API:
Logging RequestReduce Errors
Especially if you already have a error logging mechanism, it is advisable that you log any errors encountered by the RequestReduce reduction processing. This will aid in bug reporting and generalk troubleshooting. To do this, you simply need to provide an Action delegate that will take charge of logging the passed Exception. Here is an example of how to use this if you use Elmah for error logging:
RequestReduce.Api.Registry.CaptureError(x => ErrorLog.GetDefault(null).Log(new Error(x)));
Injecting your own CSS or Javascript Minifier
RequestReduce attempts to follow a decoupled architecture which allows developers to swap out certain parts with their own behavior. To override RequestReduce's use of the Micosoft Ajax minifier library, you simply create a class that derrives from IMinifier. There is not much to IMinifier:
public interface IMinifier{ string Minify<T>(string unMinifiedContent) where T : IResourceType;}
Here Is RequestReduce's implementation:
public class Minifier : IMinifier{ private readonly Microsoft.Ajax.Utilities.Minifier minifier = new Microsoft.Ajax.Utilities.Minifier(); private readonly CodeSettings settings = new CodeSettings {EvalTreatment = EvalTreatment.MakeAllSafe};
public string Minify<T>(string unMinifiedContent) where T : IResourceType { if (typeof(T) == typeof(CssResource)) return minifier.MinifyStyleSheet(unMinifiedContent); if (typeof(T) == typeof(JavaScriptResource)) return minifier.MinifyJavaScript(unMinifiedContent, settings);
throw new ArgumentException("Cannot Minify Resources of unknown type", "unMinifiedContent"); }}
It's not difficult to imagine how you would change this implementation to use something like the YUI Compressor for.Net. Lets say you had a YuiMinifier class that you want RequestReduce to use instead of its own minifier. It might look something like this:
public class YuiMinifier : IMinifier{ public string Minify<T>(string unMinifiedContent) where T : IResourceType { if (typeof(T) == typeof(CssResource)) return CssCompressor.Compress(unMinifiedContent); if (typeof(T) == typeof(JavaScriptResource)) return JavaScriptCompressor.Compress(unMinifiedContent);
throw new ArgumentException("Cannot Minify Resources of unknown type", "unMinifiedContent"); }}
You would just need to add the following code to your startup code:
RequestReduce.Api.Registry.RegisterMinifier<YuiMinifier>();
That's it. Now your minification code will be used.
Filtering Resources from the Reduction Processing
If you would like to have certain CSS or javascript resources filtered from the reduction processing or if you would like to exclude certain images or even entire requests from all response transformations, then use the AddFilter method:
public static void AddFilter(IFilter filter)
RequestReduce provides four concrete types deriving from IFilter:
public class CssFilter : Filter<CssJsFilterContext>public class JavascriptFilter : Filter<CssJsFilterContext>public class SpriteFilter : Filter<SpriteFilterContext>public class PageFilter : Filter<PageFilterContext>
All of these derrive from:
public class Filter<T> : IFilter where T : class, IFilterContext
The IFilter implementations really don't do anything on their own other than pass a IFilterContext which exposes various properties of the request. Each of the IFilter implementations provide a single constructor which takes a Predicate where T is an IFilterContext that RequestReduce populates and provides to the predicate delegate.
There are three different implementations of IFilterContext available:
public class CssJsFilterContext : IFilterContext{ public HttpRequestBase HttpRequest { private set; get; } public string FilteredUrl { private set; get; } //The Css or JS url to be processed public string FilteredTag { private set; get; } //The entire HTML tag being processed}
public class PageFilterContext : IFilterContext{ public HttpRequestBase HttpRequest { private set; get; }}
public class SpriteFilterContext : IFilterContext{ //BackgroundImageClass has several properties that include all the CSS background attributes public BackgroundImageClass BackgroundImage { private set; get; } }
Depending on the type of filter (Page, css, javascript or sprite) for each item that RequestReduce processes, it will provide the appropriate IFilterContext to your predicate. If you return true, RequestReduce will eliminate that resource from being processed. Here is an example of how to have RequestReduce ignore any image over 100px X 100px.
RequestReduce.Api.Registry.AddFilter(new SpriteFilter(x => x.Width > 100 && x.Height > 100));
Make sure to add these filters inside your App start or some other pre application, one time execution block.