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

Why Database Modernization Matters for AI

  When companies transition to the cloud, they typically begin with applications and virtual machines, which is often the easier part of the process. The actual complexity arises later when databases are moved. To save time and effort, cloud adoption is more of a cloud migration in an IaaS manner, fulfilling current, but not future needs. Even organisations that are already in the cloud find that their databases, although “migrated,” are not genuinely modernised. This disparity becomes particularly evident when they begin to explore AI technologies. Understanding Modernisation Beyond Migration Database modernisation is distinct from merely relocating an outdated database to Azure. It's about making your data layer ready for future needs, like automation, real-time analytics, and AI capabilities. AI needs high throughput, which can be achieved using native DB cloud capabilities. When your database runs in a traditional setup (even hosted in the cloud), in that case, you will enc...

How to audit an Azure Cosmos DB

In this post, we will talk about how we can audit an Azure Cosmos DB database. Before jumping into the problem let us define the business requirement: As an Administrator I want to be able to audit all changes that were done to specific collection inside my Azure Cosmos DB. The requirement is simple, but can be a little tricky to implement fully. First of all when you are using Azure Cosmos DB or any other storage solution there are 99% odds that you’ll have more than one system that writes data to it. This means that you have or not have control on the systems that are doing any create/update/delete operations. Solution 1: Diagnostic Logs Cosmos DB allows us activate diagnostics logs and stream the output a storage account for achieving to other systems like Event Hub or Log Analytics. This would allow us to have information related to who, when, what, response code and how the access operation to our Cosmos DB was done. Beside this there is a field that specifies what was th...

[Post Event] Azure AI Connect, March 2025

On March 13th, I had the opportunity to speak at Azure AI Connect about modern AI architectures.  My session focused on the importance of modernizing cloud systems to efficiently handle the increasing payload generated by AI.