Exterminators Week 1 - The 4 Stages of Legacy Code

Reading time ~4 minutes

Last week was my first week on the new team, Exterminators. I got to dive right in and start digging into our code immediately. The transition took me through many emotions, but after the first week I feel optimistic for what comes next.

This is my personal blog and does not represent the views and opinions of my employer. While I do talk about the code and general areas I am working on, the challenges discussed here are my perspective while dealing with a limited part of the whole system.

The difficulties I found while learning about the system are my own and are part of the learning curve. After one week in I feel much better and encourage you to read more for the whole story.

Years ago I read the book Working Effectively with Legacy Code and absolutely loved it. This book changed how I look at code. I now only saw code as black and white, tested and not tested. The techniques in the book show how even the most challenging code can become testable. I began to adopt the book’s definition of Legacy code, Legacy code [is] code without unit tests.

Fast forward to the present and my current rotation where I am learning tons from code I have never seen before. Sadly it has pockets of legacy code. For years I have been privileged to work on newer projects where I could include tests from the start. I always felt safe knowing the tests were there to protect me. Now working on the legacy code my comfortable safety net is gone.

Overwhelmed

At first I was overwhelmed by the code I was going through. Without tests I didn’t have the confidence that my changes would do what I wanted without other side effects.

Typically, I use the tests to get a basic understanding for how code works. Using that knowledge I can start the normal TDD cycle (Red, Green, Refactor) to make small changes until I was done. If there are no tests then I need to reverse engineer what the code should do. Code not designed to be testable is harder to start the normal TDD cycle.

From the outside looking in it is easy to make assumptions about how easy something would be. The extra distance between you and the problem makes it easy to trivialize problems. Techniques for teasing apart code or safely making changes are easy to talk about, but hard to put into practice. Having never worked in these codebases I had an overly optimistic view of how easy it would be.

Despair

In the middle of the week I felt like giving up. The feeling of being overwhelmed by the challenge seemed like too much. I thought I knew what I was getting into, but apparently I had underestimated it. Things that were normally easy in the other codebases I have worked on were now much harder.

Unlike the other developers I don’t have a normal Computer Science degree; this makes me feel like an imposter. I constantly doubt my ability as a developer. Looking at the code made me feel like I had no right to be here. Maybe I don’t. I missed out on many of the “Basics” that my other co-workers take for granted. This has caused me to work harder and try to learn more about the basics, but I always feel like I there are gaps in what I know. The hardest part is not knowing what I don’t know.

Acceptance

Eventually, I realized my feelings were perfectly natural and part of understanding my limits. It is okay to not know all the answers. Learning takes time and I need to be willing to take the time it needs.

It took most of the week to become comfortable and to be able to accept the legacy code for what it is. The code works as intended and is only missing a few tests to be much better. Only pockets of the code are missing tests; knowing where they are can help me deal with them.

Things are the way they are, I can accept that. Getting over my mental blockers will take effort, but is the starting point for improving my ability to work on this code. Accepting reality for what it provides will help me get past my hang-ups and understand what is possible.

Hope

As the week progressed I felt I was beginning to see things more clearly and understand how I could help reduce the legacy code. Coming to the realization that I can help improve the current code and contribute to the team gave me hope.

I spent all of Friday working on something new. The morning was slow at first, but as I got further into what I was doing my ideas took shape. If not enough tests is what’s holding me back from being confident, then the solution is to add more tests. To add unit tests when I need them. To pin down existing functionality with integration tests in order to feel safer before making changes.

With these tests in place I no longer felt overwhelmed. For the first time this week I was filled with hope that I could make a difference. I will share more about what I learned from the new tests I added in later posts. Suffice it to say, I am excited by these early successes on the path to shrinking our legacy code.


I would like to thank the grammatical gal in my life, my lovely lady wife Angela, for helping review this post. She knows when to use a semicolon properly.

The Worst Week of My Life

In January I had the worst week of my life. My wife and I joked we wanted to start 2016 in February. Within a single week I lost my job a...… Continue reading