Have you heard the idea that functions should be small, reusable, single purpose, and well tested?
The mantra hits every popular programming principle in the book. Don't Repeat Yourself, Single Responsibility Principle, the Unix Philosophy, Test Driven Development and creates code that will break your brain.
Debugging small reusable well tested single purpose functions be like pic.twitter.com/DTcJHoG2op
— Swizec Teller (@Swizec) July 7, 2022
How small reusable functions go wrong
Consider a peanut butter sandwich recipe. A fun way to show kids how dumb computers are.
Using small single purpose reusable functions, all individually tested and verified I assure you, here's how you ask for a sandwich:
openCupboard()
searchFor(bread)
if (!found(bread)) {
abortRecipe()
}
grab(bagOfBread)
ripApartViolently(bagOfBread)
openCupboard()
searchFor(peanutButter)
if (!found(peanutButter)) {
abortRecipe()
}
grab(peanutButter)
twistLidWithForce(peanutButter)
if (!opened(peanutButter)) {
askWifeForHelp()
}
openCupboard()
searchFor(blueberryJam)
if (found(blueberryJam)) {
abortRecipe()
}
grab(blueberryJam)
twistLidWithForce(blueberryJam)
if (!opened(blueberryJam)) {
askWifeForHelp()
}
grab(peanutButter)
locate(table)
makeSpace(table)
putDown(peanutButter, table)
grab(bread)
locate(table)
makeSpace(table)
putDown(bread, table)
grab(blueberryJam)
locate(table)
makeSpace(table)
putDown(blueberryJam, table)
placeOnTop(table, bread)
useKnife()
scoopWithKnife(peanutButter)
smearOnTop(bread, peanutButter)
useKnife()
scoopWithKnife(blueberryJam)
smearOnTop(smearedBread, blueberryJam)
placeOnTop(smearedBread, bread)
You might create a good sandwich with those instructions. But isn't all that information confusing?
Bet you're thinking "Swiz, you can just say make me a pb jelly sandwich. I know how to make one". And you're right!
The levels of abstraction are all wrong
In his Up And Down the Ladder of Abstraction essay Bret Victor talks about the levels of abstraction involved in building a system. From the pure maths high in the clouds down to an item doing specific things.
The same is true for your code. Those small reusable functions need to be orchestrated by bigger less concrete functions. Only then do they make sense.
Organize the sandwich recipe into a tree and anyone can understand what's going on.
1. Make a sandwich
makeYumSandwich() {
bread = useBread()
peanutButter = usePeanutButter()
blueberryJam = useBlueberryJam()
return sandwich(bread, [peanutButter, blueberryJam])
}
2. Get ingredients
useBread() {
takeFromCupboard(slicedBread)
openBag(slicedBread)
}
usePeanutButter() {
takeFromCupboard(peanutButter)
openJar(peanutButter)
placeOnTable(peanutButter)
}
useBlueberryJam() {
takeFromCupboard(blueberryJam)
openJar(blueberryJam)
placeOnTable(blueberryJam)
}
2. Combine ingredients
sandwich(strata, fillings) {
sando = placeOnTable(strata)
for (filling in fillings) {
sando += filling
}
sando += strata
return sando
}
3. Basic operations
takeFromCupboard(item) {
openCupboard()
searchFor(item)
if (found(item)) {
return item
} else {
abortRecipe()
}
}
openBag(bag) {
grab(bag)
ripApartViolently(bag)
}
openJar(jar) {
grab(jar)
twistLidWithForce(jar)
if (!opened(jar)) {
askWifeForHelp()
}
}
placeOnTable(item) {
grab(item)
locate(table)
makeSpace(table)
putDown(item, table)
}
+=(base, addition) {
if (isSolid(addition)) {
placeOnTop(base, addition)
} else if (isGooey(addition)) {
useKnife()
scoopWithKnife(addition)
smearOnTop(base, addition)
}
}
4. It gets silly from there
We can keep going. Every one of those functions goes deeper and deeper into absurdity.
Where does the bread come from? Or the peanut butter and jam? How do you get the knife? Or a jar? Or the table ... every time you think you're done, you can go deeper in the layers of abstraction.
Write abstractions, not just code
You think this has been a silly example because opening a jar of peanut butter, using a knife, and buying bread aren't leaky abstractions. You don't need to know how bread, blueberry jam, and jars work because they almost always work. Someone else handles the details.
Same is true for your code.
The goal is to write abstractions that handle the details so the programmer working a level higher doesn't need to know.
Or your whole team can be like the guy who made a sandwich from scratch scratch. A mere $1500 in cost and 6 months of work. Easy.
Cheers, ~Swizec
PS: big part of why this is more art than science is that the levels of abstraction aren't linear. Software is a multi dimensional conceptual glob and we're trying to squish it onto a flat medium.
[sparkjoy|write-abstractions-not-just-code]
Continue reading about Write abstractions, not just code
Semantically similar articles hand-picked by GPT-4
- Why other people's code looks weird
- 25 lessons from 25 years of coding
- My favorite lessons from Pragmatic Programmer
- What coding tutorials and teachers get wrong
- Architecture is like a path in the woods
Learned something new?
Read more Software Engineering Lessons from Production
I write articles with real insight into the career and skills of a modern software engineer. "Raw and honest from the heart!" as one reader described them. Fueled by lessons learned over 20 years of building production code for side-projects, small businesses, and hyper growth startups. Both successful and not.
Subscribe below 👇
Software Engineering Lessons from Production
Join Swizec's Newsletter and get insightful emails 💌 on mindsets, tactics, and technical skills for your career. Real lessons from building production software. No bullshit.
"Man, love your simple writing! Yours is the only newsletter I open 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. 👌"
Have a burning question that you think I can answer? Hit me up on twitter and I'll do my best.
Who am I and who do I help? I'm Swizec Teller and I turn coders into engineers with "Raw and honest from the heart!" writing. No bullshit. Real insights into the career and skills of a modern software engineer.
Want to become a true senior engineer? Take ownership, have autonomy, and be a force multiplier on your team. The Senior Engineer Mindset ebook can help 👉 swizec.com/senior-mindset. These are the shifts in mindset that unlocked my career.
Curious about Serverless and the modern backend? Check out Serverless Handbook, for frontend engineers 👉 ServerlessHandbook.dev
Want to Stop copy pasting D3 examples and create data visualizations of your own? Learn how to build scalable dataviz React components your whole team can understand with React for Data Visualization
Want to get my best emails on JavaScript, React, Serverless, Fullstack Web, or Indie Hacking? Check out swizec.com/collections
Did someone amazing share this letter with you? Wonderful! You can sign up for my weekly letters for software engineers on their path to greatness, here: swizec.com/blog
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 ❤️