Skip to main content

Refactoring in the Maintenance phase

In this blog spot I would like to talk about the maintenance phase of an application, especially from a developer perspective.
Usually a software product has the following life cycle:

  • Requirements definition
  • System and Software Design 
  • Implementation and Unit Testing
  • Integration and System Testing
  • Operation and Maintenance

At the last phase, you already have a working product that was deliver to the client and is used by users. A big problem at this step is the technical depth that not only exist but will increase with every bug that you fix.
When a bug is found, almost all the people recommend to touch only the part of the application where the issues was found and fix the problem with the minim amount of changes. The problem with this approach is related to technical depth and the garbage that you need to pull with you.
What is happening with the dirty fixes that are done at this step? Who and when you will refac. this parts of the application and clean the code.
A non-technical client will say that he don’t care about this, it is your problem to resolve this issues and all the things related to it. In the end he will not pay for additional tasks.
In the same time, a refac. or a clean up would mean changing a part of the code (system) that will required a full test of the application. This may not be possible.
Going back to the original question: When and how we should do this refac?
There are two possible things that can be done.
First one is the refac. that should be done in the moment when a solution for the bug was found. In that moment, before going live and send to the client a notification that the bug was fixed, you should look over the code and refac. the code that was changed for the current issues.
The second thing that can be done when we observe that there is a technical depth that don’t affect the application functionality is to add the refac. task in a queue. All the tasks from this queue should be prioritize, estimate and the risks calculated.
For example let’s suppose that you have in your application an algorithm that is critical for your client (calculate the wining chances in a casino) and is working as expected. But you don’t like the way was written. In this particular case you should not touch it and change because you think that is better in the other way. You could cause a lot of damages on the client side.
Also, don’t forget that all the refac. should be approved by the client, in the end it is his code and not your. We can compare the application code with a garden. You cannot change the location of a tree of cut the grass without the approval of the owner. The same thing is with the code.
In conclusion I would say that even the temptation is high to change and refac. the code, you should make a step back and wait client approval. It is very good to be proactive, to come with new ideas and designs, but in the same time you should wait the green light from the client.

Comments

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

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

Cloud Myths: Cloud is Cheaper (Pill 1 of 5 / Cloud Pills)

Cloud Myths: Cloud is Cheaper (Pill 1 of 5 / Cloud Pills) The idea that moving to the cloud reduces the costs is a common misconception. The cloud infrastructure provides flexibility, scalability, and better CAPEX, but it does not guarantee lower costs without proper optimisation and management of the cloud services and infrastructure. Idle and unused resources, overprovisioning, oversize databases, and unnecessary data transfer can increase running costs. The regional pricing mode, multi-cloud complexity, and cost variety add extra complexity to the cost function. Cloud adoption without a cost governance strategy can result in unexpected expenses. Improper usage, combined with a pay-as-you-go model, can result in a nightmare for business stakeholders who cannot track and manage the monthly costs. Cloud-native services such as AI services, managed databases, and analytics platforms are powerful, provide out-of-the-shelve capabilities, and increase business agility and innovation. H...