Thoughts on Internal Complexity

Complexity is something that needs to be managed down and is an eternal battle. Part of the battle is to stay away from the style and cosmetical changes. Can we really get 100% of style discussions? Even removing discussions of 2-4 tabs, there will be some form of style on the discussion because every engineer has a background towards JEE, Spring, or Functional. That's a greater generalization, and there are other "design schools" over there but still quite common to find people within these 3 backgrounds. A Philosophy of Software Design is a great book that explains what complexity means. In the book, complexity is mainly described as "Obscurity," something that is not readable and has a high cognitive load to be understood. IMHO some problem spaces require you to have some background and experience on how some problems are solved; otherwise, it might look the worst they actually are. Complexity discussion often hard since lots of engineers have high EGO and have a hard time decoupling their personal self from their code. That's why it is important to have a culture of Retrospectives and continuum feedbacks. In this battle is straightforward to throw the towel and give up, but you should not give up. 

Obscurity

Obscurity happens because of a lack of continuous improvement culture. Yes, oftentimes, we need to move fast and compromise, but it is possible to keep the code base decently. IMHO a good chunk of the problem is related to the fact that code reviews to shallow and too fast. LGTM happens way too fast, and besides the fact that things can move faster, this might be actually bad in another sense. 

The issue with Github code Reviews

I personally dont like GitHub code reviews. Because code reviews in github focus on DELTAS and the DESIGN is about the WHOLE, not about what changed on the code(DELTAS). Personally, from time to time, go to the whole code repository and look at the code as a whole. IMMO is much better, and I can capture things that when I'm doing smaller reviews. Some trends and patterns can only be stoped by a more complete view with deltas do not offer. 

Obscurity Smells

See, obscurity is not subjective; you will feel it! However, we need to be TEACH to fight it because often we dont fight it. IMHO there are some criteria you can apply(besides the ones in the book), such as:
  • When you read the code, you feel something is wrong! 
  • Number of moving parts - number of classes
  • Same concern in different packages
  • Annotations, Enums, interfaces, and checked exceptions
  • Abstractions that add little or no value
  • Abstractions that are just delegators
Having more classes does not make it better; often, it is the opposite. However, if you hear these ideas the first time, they might sound wrong and even ludicrous. Since we live day and night on "Clean Code Propaganda,." Managing complexity down is a high effort but, at the same time, a high payment exercise. Fixing Obscurity means moving a bit slow, having a humility exercise in code reviews, and sometimes being right and other times being wrong(and it is fine to be wrong).  

Cheers,
Diego Pacheco

Popular posts from this blog

C Unit Testing with Check

Image
When I start on IT, several years ago(+15), C was the first language that I learned. But was not the first language I mastered and deployed in production which was...surprisingly Visual Basic 6.0. However, when I learned C or any language back on that old and arcane time noddy was into testing. However now is impossible to work professionally in any language without tests. C is a low-level language but still kicks ass and has several interesting libs/frameworks. People use to fear C a lot because of lack of syntactical sugar but once you get used to it is not that hard at all. Today I want to show how you can do Unit Testing with C. I will not show how to do Unit Testing with C++ but with C ANSI actually. We will be using Check a unit test lib for C ANSI.
read more »

Having fun with Zig Language

Image
Zig is a general-purpose language created in 2016 by Andrew Kelly .  Zig aims to fix the issues C language has while being pragmatic and simple at the same time. Zig really shines as being simple by not having any hidden control flows, not having hidden memory allocations, no pre-processors, and no macros. Basically, it's one language and one language only. Since pre-processors and macros can get really complex and become their own universe. Sure it's not the Zig Philosophy.  Zig Compiler(Zig cc) also is a C compiler, and the interoperability from C to Zig is very good. Clearly, we can see influence from other languages like Go and Rust; however, Zig is pretty unique and different from Go and Rust.  Zig is fast. Zig is perfect for system programming. I bet we will see a lot of solutions being built in Zig. As a languages aficionado, I like to learn at least one language per year and sometimes more; Zig was my 2021 pick, did not regret it. Even if you dont use all languages in p
Keep reading

HMAC in Java

Image
In 2018 AWS CTO(Vogels) said : "Security is everyone's job". For the last 2 years, there was so many famous and big data leaks and breaks that made that statement be very true more than ever. Security often could mean worst performance and worst user experience so in order to get it right you really need to think about the designs before jumping into to code and consider performance and user experience has main requirements.  I was thinking about writing about how to do HMAC in Java for a while and recently Redis 6.0.0 come out and to my surprise, there was a refactoring on the password part in order to use HMAC.  Security easily could scare engineers often because it is not something well spread yet but I believe this will change soon. It does not matter if you have to deal with PII Data or not, security is super relevant because everybody is running their workloads at the cloud or with IoT and Edge devices which means more distribution, more code, more points of fail
read more »