Skip to main content

Code refactoring - Create base class/interface when is needed

When I made the last code review on a project I found the following lines of code:
Original version
public abstract class FooBase
{
Person _person;
public void string PersonId()
{
if(_person is Student)
{
return ((Student)_person).Id;
}
if(_person is Worker)
{
return ((Worker)_person).Id;
}

return _someDefaultValue;
}
public void string ScreenName()
{
if(_screen is MainScreen)
{
return ((MainScreen)_screen).Name;
}
if(_screen is SettingsScreen)
{
return ((SettingsScreen)_screen).Name;
}

((DefaultScreen)_screen).Name ;
}
}

After some new functionality was added:
public abstract class FooBase
{
Person _person;
public void string PersonId()
{
if(_person is Student)
{
return ((Student)_person).Id;
}
if(_person is Worker)
{
return ((Worker)_person).Id;
}
if(_person is Vampire)
{
return ((Vampire)_person).Id;
}

return _someDefaultValue;
}
public void string ScreenName()
{
if(_screen is MainScreen)
{
return ((MainScreen)_screen).Name;
}
if(_screen is SettingsScreen)
{
return ((SettingsScreen)_screen).Name;
}
if(_screen is TimeScreen)
{
return ((TimeScreen)_screen).Name;
}

((DefaultScreen)_screen).Name;
}
}
If you ask you’re self if the Person class contains the Id property, the response is not. The original team didn’t look over the code and add common items to the base class.
What we can observe in the above code?
First of all, the screens and persons could have a base class or at least a base interface.
The changes are made without trying to improve the code and design. Extracting a base class (interface) is a mandatory think to do before marking a task as done.
There are times when the developer don’t want to make changes to the code because is afraid that he can brake something. Maybe, if the code is covered with strong unit tests than the developer would feel more comfortable to make changes. If you are a developer and see that the code is not covered with test and because of this you cannot improve the design that you should begin to write some test first. After that you should refac. this methods.
After we make the refac our FooBase class should look something similar to this:
public abstract class FooBase
{
// Add the Id property to the base class (Person)
Person _person;
public void string PersonId()
{
if(_person == null)
{
return _someDefaultValue;
}
return _person.Id
}
public void string ScreenName()
{
// Define a base Screen class that contains the Name property
return _screen.Name;
}
}
As a developer, don’t be afraid to improve the code. If the first team that implemented this class would made the refac. we would never had this problem. But in the same time, the second developer that made the changes should look over the code and try to improve it.

Comments

Popular posts from this blog

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...

Can User Technical Profile Influence AI Architecture Decisions?

In the last few days, I ran a small experiment on Devin/Windsurf/Cascade, BMAD, and LLM-based architecture decisions. The initial concern was simple: if an AI coding assistant knows something about the user, for example, that the user is a Java developer or a .NET developer, can this information influence the architecture and technology stack that the AI will propose? This question is important because many companies are starting to use AI tools not only for coding but also for product discovery, architecture, documentation, and technical decision-making. If the AI is influenced by the developer's personal profile, the result may not be fully neutral. It may look like a business or architecture decision, but in reality, it may be partially shaped by the context of the person using the tool. The test was done using BMAD with Devin/Windsurf/Cascade. The scenario was a unified field service operations platform. The task was to let BMAD refine the product, define the architecture and s...

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...