Skip to main content

[Code refactoring] Error Codes

One of my colleges found the following code:
public class BaseFooException : System.Exception
{       
  public int ErrorCode { get; set; }
   
  public string ResourceMessageKey
  {
    get
    {
      return string.Format("error_{0}", ErrorCode);
    }
  }
}

public class CustomFooException : BaseFooException
{
  public CustomFooException()
  {
    ErrorCode = 5;
  }
}
The error code was introduce to manage the resources of UI. For each specific error code we had an “error_[code]” in the resources file. When we look over this for the first time we could say that it is okay and the implementation looks good.
But, if we look more dipper we can observe that we introduce information related to UI in the all the core components. When an exception from a core component is throw, the component don’t needs to know at that level that some resources are mapped to that error.
In this happy case, each exception type has a different exception code. We cannot have two exception references from the same custom exception and have two different error codes. Because of this, we can map the error messages for exception using based on the type of the exception.
Solution:
  • Remove the ErrorCode property and ResourceMessageKey from the base exception class
  • At the UI level, create a resolver, which will resolve the message for each exception from resources file
  • Create/Rename resources items that represent the error message something similar with this “error_[ExceptionType]"
  • Create a Resolver that get the type of exception and extract the string message for the given exception

public class BaseFooClientException : System.Exception
{       
}

public class CustomFooException : BaseFooException
{
  //...
}

What other solutions do you have/imagine?

Comments

  1. Do you need the Base exception then? You can just let the resolver resolve all kinds of exceptions.

    ReplyDelete

Post a Comment

Popular posts from this blog

Windows Docker Containers can make WIN32 API calls, use COM and ASP.NET WebForms

After the last post , I received two interesting questions related to Docker and Windows. People were interested if we do Win32 API calls from a Docker container and if there is support for COM. WIN32 Support To test calls to WIN32 API, let’s try to populate SYSTEM_INFO class. [StructLayout(LayoutKind.Sequential)] public struct SYSTEM_INFO { public uint dwOemId; public uint dwPageSize; public uint lpMinimumApplicationAddress; public uint lpMaximumApplicationAddress; public uint dwActiveProcessorMask; public uint dwNumberOfProcessors; public uint dwProcessorType; public uint dwAllocationGranularity; public uint dwProcessorLevel; public uint dwProcessorRevision; } ... [DllImport("kernel32")] static extern void GetSystemInfo(ref SYSTEM_INFO pSI); ... SYSTEM_INFO pSI = new SYSTEM_INFO(

ADO.NET provider with invariant name 'System.Data.SqlClient' could not be loaded

Today blog post will be started with the following error when running DB tests on the CI machine: threw exception: System.InvalidOperationException: The Entity Framework provider type 'System.Data.Entity.SqlServer.SqlProviderServices, EntityFramework.SqlServer' registered in the application config file for the ADO.NET provider with invariant name 'System.Data.SqlClient' could not be loaded. Make sure that the assembly-qualified name is used and that the assembly is available to the running application. See http://go.microsoft.com/fwlink/?LinkId=260882 for more information. at System.Data.Entity.Infrastructure.DependencyResolution.ProviderServicesFactory.GetInstance(String providerTypeName, String providerInvariantName) This error happened only on the Continuous Integration machine. On the devs machines, everything has fine. The classic problem – on my machine it’s working. The CI has the following configuration: TeamCity .NET 4.51 EF 6.0.2 VS2013 It see

Navigating Cloud Strategy after Azure Central US Region Outage

 Looking back, July 19, 2024, was challenging for customers using Microsoft Azure or Windows machines. Two major outages affected customers using CrowdStrike Falcon or Microsoft Azure computation resources in the Central US. These two outages affected many people and put many businesses on pause for a few hours or even days. The overlap of these two issues was a nightmare for travellers. In addition to blue screens in the airport terminals, they could not get additional information from the airport website, airline personnel, or the support line because they were affected by the outage in the Central US region or the CrowdStrike outage.   But what happened in reality? A faulty CrowdStrike update affected Windows computers globally, from airports and healthcare to small businesses, affecting over 8.5m computers. Even if the Falson Sensor software defect was identified and a fix deployed shortly after, the recovery took longer. In parallel with CrowdStrike, Microsoft provided a too