hassanhabib / efxceptions

.NET Standard library to convert DbUpdateException into meaningful exceptions

EFxceptions

We have designed and developed this library as a wrapper around the existing EntityFramework DbContext implementation to provide the following values:

1. Meaningful Exceptions for SQL error codes.
2. Simplified integrations
3. Test-friendly implementation.

EFxeptions.Identity

A dedicated EFxeptions port that provides an EFxceptionContext that inherits from Microsoft.AspNetCore.Identity.EntityFrameworkCore.IdentityDbContext to inherit from, to support Microsoft ASP.Core Identity using EF Core. Available in the EFxceptions.Identity package.

Installation

You can get EFxceptions Nuget package by typing:

Install-Package EFxceptions

Integration

Replace your existing DbContext class with EFxceptionsContext (or your IdentityDbContext with EFxeption.EFxceptionIdentityContext) as follows:

Before:

    public partial class StorageBroker : DbContext, IStorageBroker
    {
        public StorageBroker(DbContextOptions<StorageBroker> options)
            : base(options) => this.Database.Migrate();
    }

After:

    public partial class StorageBroker : EFxceptionsContext, IStorageBroker
    {
        public StorageBroker(DbContextOptions<StorageBroker> options)
            : base(options) => this.Database.Migrate();
    }

Supported SQL Error Codes

SQL server supports over 41,000 error codes, here's the codes that this library supports so far:

Code	Meanings	Exception
207	Invalid column name '%.*ls'.	InvalidColumnNameException
208	Invalid object name '%.*ls'.	InvalidObjectNameException
547	The %ls statement conflicted with the %ls constraint "%.*ls". The conflict occurred in database "%.*ls", table "%.*ls"%ls%.*ls%ls.	ForeignKeyConstraintConflictException
2627	Violation of %ls constraint '%.*ls'. Cannot insert duplicate key in object '%.*ls'.	DuplicateKeyException

This library is forever growing as we add more exceptions and codes into it, we appreciate any contributions as there are so many codes we need to cover, so please stay tuned.

If you have any suggestions, comments or questions, please feel free to contact me on:
Twitter: @hassanrezkhabib
LinkedIn: hassanrezkhabib
E-Mail: [email protected]

efxceptions's Issues

Exception handling does not follow C# guideline

In the past we all followed Microsoft's design guideline regarding exception handling. I'm wondering if it still applies to .NET Core / .NET Standard.

If so, you might be hiding information or make it harder to find the root cause.

Let me show you an example:

public override async Task<int> SaveChangesAsync(CancellationToken cancellationToken = default)
{
    try
    {
        return await base.SaveChangesAsync(cancellationToken);
    }
    catch (DbUpdateException dbUpdateException)
    {
        this.eFxceptionService.ThrowMeaningfulException(dbUpdateException);
        throw dbUpdateException; // <-- That's the problem
        throw; // <-- would be better
    }
}

INFRA: Initialize Build Project

CONFIG: Upgrade the entire project to .NET 6 (.NET Standard 2.1)

MAJOR FIX: Serialize Problem Details

Guys i'm working on a source generator using the code from this repo.

The non SQLServer mappings have a bug. The test is failing to detect it as it is testing for a number it itself is throwing but its the wrong number.

On a duplicate for an indexed property reading the wrong property etc..

CONFIG: Update .NET version to 7.0.100-preview.1.22110.4

Exception: Unable to cast object of type 'MySql.Data.MySqlClient.MySqlException' to type 'Microsoft.Data.SqlClient.SqlException'

Hello,
I am using this great library but for a MySql connection, and I can only get this exception:
Unable to cast object of type MySql.Data.MySqlClient.MySqlException to type Microsoft.Data.SqlClient.SqlException

By checken the code, i found this:

       public void ThrowMeaningfulException(DbUpdateException dbUpdateException)
        {
            ValidateInnerException(dbUpdateException);
            SqlException sqlException = GetSqlException(dbUpdateException.InnerException);
            int sqlErrorCode = this.sqlErrorBroker.GetSqlErrorCode(sqlException);
            ConvertAndThrowMeaningfulException(sqlErrorCode, sqlException.Message);

            throw dbUpdateException;
        }

I guess the library should be inhanced to support also MySqlException at least.

I forked the repo and fixed it, should I create a pull request ?

Thanks

Not working in postgre

EFxceptions does not support postgre I get an error like below.

Unable to cast object of type 'Npgsql.PostgresException' to type 'Microsoft.Data.SqlClient.SqlException'.

Constructor provides no EFxceptions functionality

Please see link.
This constructor should be changed to inherit EFxceptionsIdentityContext<TUser, TRole, TKey>.

EFxceptions/EFxceptions.Identity/EFxceptionsIdentityContext.cs

Line 18 in 5cfd2b8

public class EFxceptionsIdentityContext<TUser> : IdentityDbContext<TUser, IdentityRole, string> where TUser : IdentityUser

FEATURE: Cosmos DB Implementations

Consider using other Database Providers for Exceptions

I was thinking somewhere along the lines of using generics or some switch statement that takes in the value and based on that it uses the specific database provider(mssql,mysql,postgres,sqlite etc) with the specific sqlexception handling. Any help would be appreciate it

Using wrong SqlClient

EF Core 3 uses Microsoft.Dats.SqlClient. using System.Data.SqlClient with this package is wrong and will cause confusion for consumers and increase deployment size for no good reason.

DOCUMENTATION: Add Images Folder Future Nuget Pkgs Fixes

Adds an assets folder named images with a set of supporting pre done images, icons, master psd and git header logo for future nuget package uploads and or automation builds.

Readme updated with nuget badges appropriately for downloads and community.

Once committed/merged the current readme.md header html block for rendering the EFxceptions.png file can be replaced with the markdown syntax.
Sample, may need be redefined post: ![}(https://raw.githubusercontent.com/hassanhabib/EFxceptions/master/EFxceptions.Shared/Resources/git_logo.png)

CODE RUB: Clean Up Entire Solution