When the police logic precedes critical signals
TL; DR: Skiping status reports in police branches leads to silent delay and race conditions.
Problems ๐
- Delay the user
- Bad experience
- Unpredictable deadline
- Incalimated preparation
- Hidden dependencies
- Policy mismanagement
- Silent failures
- The backward compatibility breaks
Solutions ๐
- Check all the code tracks
- Use virtual reporting mechanisms
- Edge test cases accurately
- Refactor policy is realized early
- Performance tests
- Transfer reports outside police
Context ๐ฌ
When adding conditional logic (for example, the groupโs policies) to the preparation code, bypassing important steps such as willingness reports leads to delay at the system level.
Edge cases are exceptional conditions that occur outside regular operating parameters.
When you donโt properly deal with these edge cases, your symbol can act unexpectedly.
The Microsoft Blog post highlights a classic example, as the process of the lost edge condition causes the Windows 7 operating system to have a slower login times when users choose a solid colored background instead of a background image.
The code responsible for downloading the desktop wallpapers โreadyโ was reported only when successfully downloading a wallpaper image.
But when users choose a solid colored background (edge โโcase), this code path did not raise the โreadyโ notification.
As a result, the regime waited a 30 -second period before follow -up with a login sequence.
This problem explains how the loss of the small edge condition apparently affects the user experience significantly.
What should have been a 5 -second login, it became a 30 -second frustrating delay for users who chose a simple composition option.
Hit this innocent delay for 30 seconds by each user who has the version. What a waste of human time!
Good software design requires you to look at all possible tracks through your code, not just common paths.
When you go beyond the processing of edge cases, you can create technical debts that are manifested in mysterious performance problems, lymphs, and poor user experiences.
Code ๐
Error โ
public static class WallpaperInitializer
{
private static bool wallpaperWasDefined = false;
public static void InitializeWallpaper()
{
if (wallpaperWasDefined)
// Assume this was defined previously
// and PLEASE DON'T use NULLs in case you hadn't
{
LoadWallpaperBitmap();
Report(WallpaperReady); // Missed if wallpaper is undefined
}
// No default report, causing delays
}
private static void LoadWallpaperBitmap()
{
}
private static void Report(string status)
{
// The Asynchronous loading keeps on
}
}
Right ๐
public static class WallpaperInitializer
{
private static bool wallpaperWasDefined = false;
public static void InitializeWallpaper()
{
if (wallpaperWasDefined)
{
LoadWallpaperBitmap();
}
Report(WallpaperReady);
// Always report, regardless of condition
}
private static void LoadWallpaperBitmap()
{
}
}
Detection ๐
Use fixed analysis tools to inform the policewoman who guard the critical reports calls.
The code of code should be fulfilled that all the preparation paths complete a signal.
Level ๐
Why the objection is important ๐บ
The behavior of the real world (for example, the speed of login) depends on the exact modeling of preparation.
The software must maintain individual correspondence between real states and program cases.
When users define a solid color background in Windows, this choice is a valid real case.
(My personal choice is also at the time)
The program should properly designing this choice with the corresponding status of the program that behaves properly.
When this vital objection is broken by failing to deal with edge cases, you offer the interruption of user expectations and system behavior. In this example, users expect to choose a natural color background naturally, but instead, they have suffered from a mysterious delay.
The lost vital objection creates a perceptual incompatibility: โI have chosen a simple option, why does my computer behave strange?โ This is the separation of user and satisfactionโs confidence.
All broken compensation provides a rift in the system reliable system, making it increasingly unexpected over time.
Breaking this link leads to an incompatibility between user expectations and the implementation of programs, which leads to an unpredictable delay and Mapper to the real world violations.
Amnesty International Generation ๐ค
Artificial intelligence generators can create this smell by wrapping naivety in the old code in the conditions without verifying the authenticity of all paths.
Discover artificial intelligence ๐ฅ
Claiming AI to โensuring the implementation of the status reports in all branchesโ, and it will be suspended or repaired by transferring the report () outside the police.
Try them! ๐
Remember: Artificial Intelligence Assistants make many mistakes
A proposal wave: find other missing reports
Conclusion ๐
Always the completion signal without registration or condition in the preparation code.
The conditional logic should be amend behavior, not to silence the steps of critical reports.
Relationships ๐ฉโโค
https://haackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-xxxii
https://haackernoon.com/how-to-find-the-stinky-parts-of-your-code-bart-xxxx
https://haackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-xvii
More information ๐
Leave responsibility ๐
The smell of the code is my opinion.
The test leads to failure, and failure leads to understanding.
Bert Rotan
This article is part of the Codesmell series.
