CODEWITHSUNDEEP
asp.net-mvcbundle
user310457
user310457

Reputation: 511

Can the method "Bundle.Include" (in System.Web.Optimization used with ASP.NET MVC) throw an exception instead of silently ignore missing files?

Is it somehow possible to get an exception thrown if a javascript or css file is missing ?

I have tried with the code below but it never throws an exception ...

    public class BundleConfig {
    public static void RegisterBundles(BundleCollection bundles) {  
        ....

        bundles.Add(new ScriptBundle("~/bundles/something").Include("~/Scripts/nonExistingFile.js"));
        // I would like the above usage of Include method with 
        // a non-existing file  to throw an exception to make it 
        // obvious that an expected file is missing ...
        // but since it does not I tried to implement a method as below ...
        ...
        AssertThatAllFilesExist(bundles);
        // but unfortunately an exception is never thrown but when 
        // iterating the files in the method below, 
        // the non-existing file seems to never become retrieved ...
    }   

    private static void AssertThatAllFilesExist(BundleCollection bundles) {
        HttpContext currentHttpContext = HttpContext.Current;
        var httpContext = new HttpContextWrapper(currentHttpContext);
        foreach (var bundle in bundles) {
            var bundleContext = new BundleContext(httpContext, bundles, bundle.Path);
            IEnumerable<FileInfo> files = bundle.EnumerateFiles(bundleContext);
            foreach (var file in files) {
                if (!file.Exists) {
                    // if this problem would occur then it should 
                    // indicate that one of the arguments of the 
                    // method "Bundle.Include" does not 
                    // correspond to an existing file ...
                    throw new ArgumentException("The following file does not exist: " + file.FullName);
                }
            }
        }
    }
}

Upvotes: 19

Views: 2550

Answers (5)

Herman Kan
Herman Kan

Reputation: 2292

Please see my answer here: Asp.Net MVC Bundling, best way to detect missing file. It features support for ASP.NET's wildcards in path.

Upvotes: 1

nrodic
nrodic

Reputation: 3021

I use this class instead of ScriptBundle:

public class ScriptBundleWithException : ScriptBundle
{
    public ScriptBundleWithException( string virtualPath ) : base( virtualPath ) {}
    public ScriptBundleWithException( string virtualPath, string cdnPath ) : base( virtualPath, cdnPath ) {}

    public override Bundle Include( params string[] virtualPaths )
    {
        foreach ( var virtualPath in virtualPaths ) {
            Include( virtualPath );
        }
        return this;
    }

    public override Bundle Include( string virtualPath, params IItemTransform[] transforms )
    {
        var realPath = System.Web.Hosting.HostingEnvironment.MapPath( virtualPath );
        if ( !File.Exists( realPath ) ) {
            throw new FileNotFoundException( "Virtual path not found: " + virtualPath );
        }
        return base.Include( virtualPath, transforms );
    }
}

Then in configuration:

bundles.Add( new ScriptBundleWithException( "~/bundles/something" ) //...

Upvotes: 6

Sam
Sam

Reputation: 976

I came across this and thought I'd submit my solution. As others have mentioned adding files that don't exist to a bundle are silently ignored.

Example code:

string[] jsFiles = { "~/js/file1.js", "~/js/file2.js" };
string[] cssFiles = { "~/css/file1.css", "~/css/file2.css" };
List<string> allFiles = new List<string>();
allFiles.AddRange(jsFiles);
allFiles.AddRange(cssFiles);
var server = HttpContext.Current.Server;
foreach(var file in allFiles) {
    if(!File.Exists(server.MapPath(file))
        throw new FileNotFoundException("File " + file + " was not found.");
}

Then define your bundles as normal, using the arrays for .Include

Upvotes: 2

ovolko
ovolko

Reputation: 2807

If you look at the source of Bundle class, you'll find that .Include just silently doesn't add file if it doesn't exist. Hence your asserts don't work.

I ended up with using an array of script files names and checking them manually before adding to the bundle.

Upvotes: 2

Dmitry Efimenko
Dmitry Efimenko

Reputation: 11178

I use T4MVC:

var bundleJsLayout = new ScriptBundle("~/bundle/js").Include(
    "~" + Links.Scripts.jquery_1_9_0_js,
    "~" + Links.Scripts.modernizr_2_6_2_js,
    "~" + Links.Scripts.jquery_unobtrusive_ajax_min_js
    );

bundleJsLayout.Transforms.Add(new JsMinify());
bundles.Add(bundleJsLayout);

Upvotes: 0

Related Questions