Why a clear error message matters
Miguel Rentes May 1 '17
This post was originally posted on my blog
Last month I was getting an error while uploading several files to a Linux server at work.
For some reason, the upload was always stopping at the same byte count. Not only that but the error message was saying that the upload failed but the next line stated it was successful. This is confusing to the end user in my opinion. Apart from that, the error message didn't say much else.
I was thinking of a few causes for this error, namely:
- A filesystem limit was set that prevented uploads greater in size than the zip file I was trying to upload (~ 4GiB);
- A bug in my FTP client (FileZilla)... this seemed to me really far-fetched, but it could happen;
- A network problem seemed the natural cause;
- A user disk quota exceeded on the Linux server;
- A control group configuration limiting disk I/O resources on the Linux server.
The next thing I did was to divide my zip file into smaller ones (700MiB each) to check if my first hypothesis was correct.
Hum... no luck FTP'ing all zip files to the Linux server. At this point I tried option number 2), downloaded WinSCP (I was working from a Windows machine) and tried again.
No luck again, but this time the error message was clear and to me a lot better, because:
- it states there is an error (and doesn't say the upload was successful at the next line);
- it lists several possible causes for the problem I was facing.
And there it was: after reading the possible causes I first checked if the
partition was full because it seemed the most probable error cause, and indeed it was. Problem solved! <img src="https://thepracticaldev.s3.amazonaws.com/i/p8px69h2c6zowt81ryon.jpg" alt="The real cause of a problem is not always the obvious one" title="The real cause of a problem is not always the obvious one" width="750px"/> This simple error message saved me precious work time, and it showed me how important a clear error message can be (and even better if it contains a list of possible error causes). Sometimes the "natural cause" is not the real cause for a problem, and if we have a great error message to help us out, we can avoid wasting a lot of time. Always code your error messages to provide this kind of feedback to your end users, as it is better to loose 5 minutes coding a good error message then having your end user wasting half an hour (or even more time) trying to figure out what is wrong. Until next time, have an awesome coding fun!