Failure is fashionable. Making is much easier than thinking and failures are not stigma, let’s take this idea to our code. Failure to program in the 1950s had dire consequences. Machine time was very expensive. Jumping from punch cards to the compiler and then to execution could take hours or even days. Luckily those times are long gone. Are they? A methodological step back In the 1980s, punch cards were no longer used. The code was written in a text editor, then the program was compiled and linked to generate executable code in a typical desktop application. This process was slow and tedious.An error involved generating to a file with parts of the to try to isolate the cause of the defect. logs execution stack Try a fix, recompile, link, etc. and so iteratively.With the arrival of interpreted languages, ​​we began to believe in the magic of editing the code with a where we could access the state.However, in the late 1990s with the rise of web systems, we went back several steps. ‘on the fly’ debugger Except in those cases where we could simulate the system on a local server, we put logs in the code again while debugging our integrated software remotely.On the other hand. Thanks to the misuse of invalid abstractions our software-generated errors far away from the failure and root cause of the problem. The One and Only Software Design Principle This worsened by the use of invalid representations with possible values ​​that generate unpredictable failures when trying to find out the origin of null values many function calls later. Null NULL: The Billion Dollar Mistake Defensive programming The rise of autonomous cars allows us to learn about the behavior of drivers. Initially, the cars worked well following the traffic rules, but this caused accidents with cars driven by human beings. The solution was to train autonomous cars to drive . defensively As in many of our solutions we are going to reverse the burden of proof. Lets suppose that the preconditions are not met and if so, fail quickly. The argument against this type of inline controls is always the same: The code becomes slightly and . As always, in the face of laziness, we will reply that we privilege the code, and in the face of performance, we will request through a benchmark that shows what the true penalty really is. more complex potentially less performant robust concrete evidence As we saw in the article about the of objects if an invalid date is created we must report the problem. immutability immediately Is it Crystal Clear for Everybody That a Date Should Not Mutate? { { (!$aMonth->includes($aMonthDay)) { InvalidDateException($aMonthDay, $aMonth);
        } 
        ...
}$day30 = Day( );
$year2020 = Year( );
$feb2020 = YearMonth( , $year2020);
$invalidDate = Date($day30, $feb2020); final class Date function __construct ($aMonthDay, $aMonth) if throw new new 30 new 2020 new 2 new //will raise an exception. //No, It will not coerce to March,1st or do under the rug magic to cover the programmer contract violation In this way we will fail very close to the place where the fault occurs and we can take actions. Most of the “modern” languages ​​hide the dirt under the carpet and allow “continue (as if nothing happens)” the execution so that we have to debug the cause of the problem with logs in order to carry out a forensic analysis in search of the failure root cause far away. Representation is always important The best way to fail fast is to properly represent objects while being faithful to our only design rule: Bijection with the real world. A misrepresentation of a geographic coordinate using an array with two integers is not going to know how to “defend” itself from possible invalid situations. $coordinate = ( => , => ); array 'latitude' 1000 'longitude' 2000 //Its OK. they are just arrays. a Bunch of raw data For example, we can represent latitude 1000°, longitude 2000° on a map as follows and this will generate errors when we want to calculate distances in some component that uses this coordinate (probably doing some kind of modulus magic and getting very cheap tickets). This is solved with good representations and with small objects that respect the bijection of both valid and invalid behaviors and states. Bijection is straight: a coordinate an array. all arrays coordinates. is not not are { { (! ->isValidLatitude($latitude)) { InvalidLatitudeException($latitude);
        }
        ...
    }
} final class GeographicCoordinate function __construct ($latitude, $langitude) if $this throw new This would be the first iteration. The coordinate should check that the latitude is within a range. But that would the coordinate to latitude violating the A is not an and vice versa. couple bijection rule. latitude integer Let’s be extreme: { { (!degress->between( , )) { InvalidLatitudeException($latitude);
        }
        ...
    }    
} final class Latitude function __construct ($degrees) if -90 90 throw new With this solution, we do not have to do any checks when building geographic coordinates because the latitude is valid per and because it is its reality counterpart. construction invariant correctly modeling As a last iteration, we should think about what a degree is. An integer? A float? It is clear that a degree exists in reality so we have to model it. No chance to escape. By now performance purists are often outraged by the following thought: It is much easier and more readable to create a coordinate as an array than to do all that indirection of creating degrees, latitudes, longitudes, and coordinates. To make this decision we always have to do performance, maintainability, reliability, and root cause analysis of our failures. Based on our desired quality attributes we will privilege one over the other. In my personal experience, the good and precise models survive much better and , but that depends on each particular case. requirements change ripple effect Photo by on Robert Penaloza Unsplash Let’s go back to space As a last example let’s go back to the situation that the Mars Climater Orbiter rocket mentioned in the article exploded: The One and Only Software Design Principle The rocket was developed by two teams from different countries using different metric systems. The example below is a simplified scenario: $distance = ; $supplyRatio = ; $neededSupply = $distance / $supplyRatio; 12.4 //miles 10 //tons each kilometer //since units could not be mixed the should raise an error //but the units were all floats so the engine keep working and exploded Instead of failing early and getting caught up in a this error spread and blew up the rocket. self healing code routine A simple check of measures would have detected the error and, potentially taken some corrective action. The exception is the rule Our code must always be defensive and controlled by its invariants at all times as indicated by It is not enough to turn and . These assertions must always be in productive environments. Once again, when faced with doubts about performance penalties, the forceful response must be certain of significant degradation. Bertrand Meyer. on off software assertions on evidence Exceptions must occur at all levels. If a movement is created with an invalid date the exception must be reported when creating the date. If the date is valid but it is incompatible with some business rule (for example, you cannot settle movements in the past) this must also be controlled. { { ($aDate < Date::today()) { InvalidMovementDateException($aDate);
        } }
} final class Movement function __construct ($aParty, $aCounterParty, $anAmount, $aDate) if throw new //... The solution is robust but it is coupling the movement to a date and a of a . One of the worst possible couplings for a system that could run in multiple time zones. static method global class Coupling: The One and Only Software Designing Problem To solve this problem we have several options: Leave the coupling to the class. Send as a parameter a date validator that can validate the date using . double dispatch Remove date validation responsibility from the movement. When in doubt about our design decisions, we can always go back to our bijection and ask our business expert whose responsibility is this. It is clear that, by taking the third option we could potentially create movements with invalid dates. But the validity (or not) of the date is not a movement’s responsibility and does not belong to its representation invariants. The case would be different if a movement has an , a and a with clear business constraints among them. But then we would be facing a very low cohesive object. agreement date creation date settlement date As always, design decisions involve continuous trade offs. Conclusions Suspecting an invalid situation, we must throw an exception in all cases. When in doubt, it should be done as early as possible. We should never hide errors by coupling ourselves to the decision to mask this problem with the use of it that has to understand the situation. We must strictly follow the bijection rule, creating the necessary abstractions that can defend themselves. Part of the objective of this series of articles is to generate spaces for debate and discussion on software design. We look forward to comments and suggestions on this article.

BUNCH

Routine

Zones

Winner of Noonies 2020 for the award Hacker Noon Contributor of the Year - REFACTORING.

2020 - Hacker Noon Contributor of the Year in REFACTORING

2022 - HackerNoon Contributor of the Year - Clean Code

2022 - HackerNoon Contributor of the Year - Debugging

2022 - HackerNoon Contributor of the Year - Github

2022 - HackerNoon Contributor of the Year - Machine Learning

2022 - HackerNoon Contributor of the Year - Quality Assurance

2022 - HackerNoon Contributor of the Year - Refactoring

2022 - HackerNoon Contributor of the Year - Software Architecture

2022 - the Greatest Storyteller

Share your ideas with me!

Read My Stories

Buy Me a Coffee

Nominated for 2022 - HackerNoon Contributor of the Year - Refactoring

Nominated for 2022 - HackerNoon Contributor of the Year - Quality Assurance

Nominated for 2022 - HackerNoon Contributor of the Year - Github

Nominated for 2022 - HackerNoon Contributor of the Year - Machine Learning

Nominated for 2022 - HackerNoon Contributor of the Year - Clean Code

Nominated for 2022 - HackerNoon Contributor of the Year - Software Architecture

Nominated for 2022 - the Greatest Storyteller

Nominated for 2022 - HackerNoon Contributor of the Year - Debugging

Portfolio

Software Engineer

Too Long; Didn't Read

In your car, at home, or at work — Bosch technology shapes many areas of life.

Fail Fast Philosophy, Explained 

Fail Fast Philosophy, Explained

Too Long; Didn't Read

Companies Mentioned

Maximiliano Contieri

About Author

TOPICS

THIS ARTICLE WAS FEATURED IN...

Fail Fast Philosophy, Explained

Too Long; Didn't Read

Companies Mentioned

Maximiliano Contieri

About Author

TOPICS

THIS ARTICLE WAS FEATURED IN...

RELATED STORIES