James Hickey's Blog

My Thoughts About .NET, C#, Web Technologies And The Like :)

Menu Close

Buy Me A Coffee

Refactoring Legacy Monoliths – Part 1: First Steps

Where do you even begin when considering “fixing” or refactoring legacy monoliths? I’ve been thinking about this lately – as I’ve been doing it for the last month or so.

What Is A Legacy Monolith?

In the book Working Effectively with Legacy Code, “legacy” software is merely defined as “code without tests.” A few notes are made which include the idea that software with poor design or unmaintainable code is a large piece of what “legacy” means.

“Refactoring legacy software” means refactoring your system to allow for code testing, and then implementing those tests.

A “monolith” is “all your code is one place.” In other words, you have not separated different logical areas of your product into actual isolated areas. If you are working on a .NET based web application (for example) and all your code is in one project (the web project) – then you most definitely have a monolith. Even with multiple projects, if your business logic is inside your web project (which should be a project that just displays what your business logic outputs) then you have a monolith.

Realistic Goals

Before we being changing existing code, the idea that “legacy” code exists is an indication that the software process for this product is not working well. We need to consider a higher level question: “How do we even create software?”

Problems that you may experience in legacy projects, I think, boil down to one core issue:

Software is not designed using known current industry standards.

What are some of these standards?

  • Testing code
  • Separating business logic from presentation logic
  • Not re-inventing the wheel when reliable libraries exist to do the thing you need
  • Avoiding depreciated third-party software (whether deemed so by vendor or development community)

Can you think of any more? I’d love to hear from you in the comments. 🙂

Nip It In The Bud

So then, our first steps need to begin addressing these issues. But even before that, we need to realize that all future software creation is still following whatever process currently exists!

Having gone through this recently and creating a foundation for future development to – at the very least – allow for these standards to be followed, I think I have some insight. And so our first step is just that:

Make the system at least allow future development to follow industry standards.

Practical Steps

The most important point, which goes back to the definition of “legacy” software – is that you need code tests. Why?

  • A clearer definition of system requirements (since tests correspond to individual business requirement)
  • Forces your system to be modular (i.e. code that can be tested well is generally designed well)
  • Early safety net when you code something wrong

But, to be able to test properly, you need to have your business code (i.e. “business logic”) separate from your (for example) web project. You can’t test business rules unless you can test business logic on its own. Splitting your code into (at least) 2 different layers (business logic and presentation logic) is necessary for web projects (using it as an example) because:

Your business code can rely on database access abstractions rather than database access implementations.

What? Let me ask you a question: “Can you test your code without having an active database available?” In true “legacy” projects, that’s answered 99% of the time with “no”.

What we need is a way to make our code rely on an interface which exposes methods that provide database access. Then, we can create our production code against that interface. Our system needs to somehow automatically “pass in” a concrete implementation of that interface to our business code.

Our tests, on the other hand, can use a stub or mock object which implement that interface. Our business code will still do what it does and not crash because there’s no database connection.

We’re Thinking…

So we’re thinking about the core issues and what we need to do to solve them. The next step I would like to look at is how to create a separate area for your business code (in .NET) in a more specific way.

Let me know what you think about the topic in the comments! Thanks for reading!

© 2018 James Hickey's Blog. All rights reserved.

Theme by Anders Norén.