Skip to content
Swizec Teller - a geek with a hatswizec.com

How tests uncover hidden complexity in simple code

"Hey Bob, we need a function that returns the current environment name so QA can test our apps"

Okay that's easy enough.

You're building a utility method for every project. Something that checks an env= param and lets you run web apps against production, QA, and local environments.

Click through for source
Click through for source

URLSearchParams parses the window.location.search string into a Map and you .get() the env param. If the param isn't there, the value is null.

Your spidey senses were tingling so you made sure window is defined. Lets you run this code in server-side rendering.

Job well done ๐Ÿ‘Œ

"Hey Bob, would be cool if we didn't need to add ?env=development on localhost and ?env=production on production"

Damn, that would be cool.

You add some defaults.

Click through for source
Click through for source

That wasn't so hard. If there's no param, pick a default value based on the current domain. "production" in production and "development" everywhere else.

Going to break in QA environments and that's okay. The QA team knows to add ?env=qa when testing.

"Hey Bob, you know what would be really cool? If we remembered the environment even if someone drops the param by accident"

mind_blown giphy

That's a great idea!

You npm install js-cookie and get to work.

Click through for source
Click through for source

You read the env cookie, check the URL param, and update the cookie when those don't match. Return the environment or default based on domain.

Job well done!

Function's getting a little complicated, but eh it's still simple enough right? Easy to reason about.

Deploy ๐Ÿš€

Hidden complexity in simple code

You get bug reports. Something's fishy.

Works okay on localhost, seems fine enough in production, but QA environments are acting weird. On every 2nd page load, they start hitting production servers.

something_fishy giphy

This function ain't so simple after all. What did you miss?

You have 3 pieces of state. Each can be set or not set. How many states is that?

Bet you it's more than you think ๐Ÿ˜›

Lemme show you a trick from college

zZNVUdJ

You write a binary truth table. Each column is a variable, 0 means empty, 1 means set.

2^3 gives you 8 different states to look at.

Your function has just 4 conditionals, hmm ๐Ÿค”

We can discard some because of precedence rules. ?env= param always wins, so you can drop all but one row where it's set.

K3LySTD

Same is true for cookie. It always wins over the domain.

Ei311cv

We're down to 4 states and 4 conditionals. Should be fine now, right?

Beware of bugs in the above code; I have only proved it correct, not tried it. ~ Donald Knuth

Test the code!

What the heck's still missing? Let's add some tests. More tests than you think.

Click through for source
Click through for source

Yep, 7 tests for just 4 states. And I think that's still missing some helpful tests.

So, what was the bug?

๐Ÿคฆโ€โ™€๏ธ

Bug's right here:

Click through for source
Click through for source

That means we overwrite the cookie with an empty value when there's no URL param. Should look like this:

Click through for source
Click through for source

That simple function took 2 days off my life. All because I was too damn proud to write tests the first time.

Happy coding โค๏ธ

Cheers,
~Swizec

PS: this situation adapted for brevity, IRL there were some other functions involved further obscuring the complexity

Did you enjoy this article?

Published on April 14th, 2020 in Computer Science, Front End, Technical

Learned something new?
Want to become a high value JavaScript expert?

Here's how it works ๐Ÿ‘‡

Leave your email and I'll send you an Interactive Modern JavaScript Cheatsheet ๐Ÿ“–right away. After that you'll get thoughtfully written emails every week about React, JavaScript, and your career. Lessons learned over my 20 years in the industry working with companies ranging from tiny startups to Fortune5 behemoths.

Start with an interactive cheatsheet ๐Ÿ“–

Then get thoughtful letters ๐Ÿ’Œ on mindsets, tactics, and technical skills for your career.

"Man, love your simple writing! Yours is the only email I open from marketers and only blog that I give a fuck to read & scroll till the end. And wow always take away lessons with me. Inspiring! And very relatable. ๐Ÿ‘Œ"

~ Ashish Kumar

Join over 10,000 engineers just like you already improving their JS careers with my letters, workshops, courses, and talks. โœŒ๏ธ

Have a burning question that you think I can answer?ย I don't have all of the answers, but I have some! Hit me up on twitter or book a 30min ama for in-depth help.

Ready to Stop copy pasting D3 examples and create data visualizations of your own? ย Learn how to build scalable dataviz components your whole team can understand with React for Data Visualization

Curious about Serverless and the modern backend? Check out Serverless Handbook, modern backend for the frontend engineer.

Ready to learn how it all fits together and build a modern webapp from scratch? Learn how to launch a webapp and make your first ๐Ÿ’ฐ on the side with ServerlessReact.Dev

Want to brush up on your modern JavaScript syntax?ย Check out my interactive cheatsheet: es6cheatsheet.com

By the way, just in case no one has told you it yet today: I love and appreciate you for who you areย โค๏ธ

Created bySwizecwith โค๏ธswizec.com