💾 Archived View for taoetc.org › changing_old_code_is_risky › index.gmi captured on 2022-07-16 at 15:21:48. Gemini links have been rewritten to link to archived content

View Raw

More Information

⬅️ Previous capture (2021-11-30)

➡️ Next capture (2023-04-19)

-=-=-=-=-=-=-

Changing old code is risky

I was talking to a colleague today who's a junior engineer. He was refactoring some code that my team wrote in the last few weeks, trying to improve type conversion when passing objects between the frontend and the backend. On the frontend, an object is being serialized to a string via JSON.stringify. The resulting string is then appended to another object, which also gets serialized to a JSON string in the request payload.

My recommendation was to remove the call to JSON.stringy in the frontend, remove the probable call to json.loads on the backend, reducing the amount of code and simplifying the mental load. He started doing that, but then realized that we are doing the same double-serialization before our changes, in parts of the API that already existed. I said:

Don't change it, then. The older the code is the more risky it is to change it.

I was surprised by what I said. Almost every engineer loves refactoring code, rewriting projects from scratch and getting rid of old code. I know I do. Old code doesn't follow the latest best practices. It doesn't use the new testing libraries. It doesn't leverage new features from the programming language — no async, no TypedDict. It's easy to dismiss it as inelegant and stale.

But old code has a history. It survived bugs, fixed them, worked around them. It's also harder to understand. When you revisit old code it's harder to understand the context, the subtleties, the reasoning — even with good comments left behind. Dismissing the old code is both disrespectful and unwise.

Tags

programming

Categories

STEM

About

Published on 2021-09-14 16:39:00-07:00 by Beto Dealmeida <roberto@dealmeida.net>.

Go back to the main index