Skip to content

jehugaleahsa/QueryableInterceptors

Repository files navigation

QueryableInterceptors

Seemlessly interact with IQueryable instances.

Download using NuGet: QueryableInterceptors ExceptionWrapping

Exception Wrapping Overview

It's common practice to expose an IQueryable to the business layer. The business layer is responsible for applying filters, ording, etc. to the IQueryable to get at the needed data. However, if an error occurs, the business layer has no idea how to handle an exception coming from the underlying data technology stack (Entity Framework, LINQ to SQL, etc.). The developer has little choice but to handle a generic Exception and hope it's a connectivity issue and not a bug.

The ExceptionWrapping project aims at allowing developers to wrap data technology stack exceptions with an exception type that the business layer can handle. The following is an example that wraps exceptions coming from Entity Framework:

using QueryableInterceptors.ExceptionWrapping;

...

public IQueryable<Customer> GetCustomerQuery()
{
    return context.DbSet<Customer>()
                  .WrapExceptions()
                  .OfType<EntityException>()
                  .With<DataLayerException>();
}

The WrapExceptions method can be called as many times as needed for the different types of exceptions that will be handled. The exceptions are handled in the order they appear in the LINQ expression, so make sure to put more generic exception handlers at the end of the query.

Since the interceptor classes are seemless, you can call WrapExceptions anywhere in the LINQ query; however, it is usually better to do it up-front to avoid unhandled exceptions from being thrown by earlier method calls (like Include).

There are various overloads of the With method to allow more control over how the exceptions are wrapped.

QueryableInterceptors Overview

It is really, really hard to work with IQueryables without impacting the final output. This project is an attempt to provide a base class that will allow you to safely interact and extract information from the IQueryable throughout its lifetime. All wrappers will inherit from the InterceptingQueryProvider class. The best way to learn how to use the class is to look at the WrappedQueryProvider class in the ExceptionWrapping library.

License

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to http://unlicense.org

About

Seemlessly interact with IQueryable instances.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published