How to escape from the async/await hell
async/await freed us from callback hell, but people have started abusing it — leading to the birth of async/await hell.
Link to this headingWhat is async/await hell
While working with Asynchronous JavaScript, people often write multiple statements one after the other and slap an await before a function call. This causes performance issues, as many times one statement doesn’t depend on the previous one — but you still have to wait for the previous one to complete.
Link to this headingAn example of async/await hell
Consider if you wrote a script to order a pizza and a drink. The script might look like this:
(async () => {const pizzaData = await getPizzaData() // async callconst drinkData = await getDrinkData() // async callconst chosenPizza = choosePizza() // sync callconst chosenDrink = chooseDrink() // sync callawait addPizzaToCart(chosenPizza) // async callawait addDrinkToCart(chosenDrink) // async callorderItems() // async call})()
On the surface it looks correct, and it does work. But this is not a good implementation, because it leaves concurrency out of the picture. Let’s understand what its doing so that we can nail down the issue.
Link to this headingExplanation
We have wrapped our code in an async IIFE. The following occurs in this exact order:
- Get the list of pizzas.
- Get the list of drinks.
- Choose one pizza from the list.
- Choose one drink from the list.
- Add the chosen pizza to the cart.
- Add the chosen drink to the cart.
- Order the items in the cart.
Link to this headingSo what’s wrong ?
As I stressed earlier, all these statements execute one by one. There is no concurrency here. Think carefully: why are we waiting to get the list of pizzas before trying to get the list of drinks? We should just try to get both the lists together. However when we need to choose a pizza, we do need to have the list of pizzas beforehand. The same goes for the drinks.
So we can conclude that the pizza related work and drink related work can happen in parallel, but the individual steps involved in pizza related work need to happen sequentially (one by one).
Link to this headingAnother example of bad implementation
This JavaScript snippet will get the items in the cart and place a request to order them.
async function orderItems() {const items = await getCartItems() // async callconst noOfItems = items.lengthfor(var i = 0; i < noOfItems; i++) {await sendRequest(items[i]) // async call}}
In this case, the for loop has to wait for the sendRequest()
function to complete before continuing the next iteration. However, we don’t actually need to wait. We want to send all the requests as quickly as possible and then we can wait for all of them to complete.
I hope that now you are getting closer to understanding what is async/await hell and how severely it affects the performance of your program. Now I want to ask you a question.
Link to this headingWhat if we forget the await keyword ?
If you forget to use await while calling an async function, the function starts executing. This means that await is not required for executing the function. The async function will return a promise, which you can use later.
(async () => {const value = doSomeAsyncTask()console.log(value) // an unresolved promise})()
Another consequence is that the compiler won’t know that you want to wait for the function to execute completely. Thus the compiler will exit the program without finishing the async task. So we do need the await keyword.
(async () => {const promise = doSomeAsyncTask()const value = await promiseconsole.log(value) // the actual value})()
One interesting property of promises is that you can get a promise in one line and wait for it to resolve in another. This is the key to escaping async/await hell.
As you can see, doSomeAsyncTask()
is returning a promise. At this point doSomeAsyncTask()
has started its execution. To get the resolved value of the promise, we use the await keyword and that will tell JavaScript to not execute the next line immediately, but instead wait for the promise to resolve and then execute the next line.
Link to this headingHow to get out of async/await hell ?
You should follow these steps to escape async/await hell.
Link to this headingFind statements which depend on the execution of other statements
In our first example, we were selecting a pizza and a drink. We concluded that, before choosing a pizza, we need to have the list of pizzas. And before adding the pizza to the cart, we’d need to choose a pizza. So we can say that these three steps depend on each other. We cannot do one thing until we have finished the previous thing.
But if we look at it more broadly, we find that selecting a pizza doesn’t depend on selecting a drink, so we can select them in parallel. That is one thing that machines can do better than we can.
Thus we have discovered some statements which depend on the execution of other statements and some which do not.
Link to this headingGroup-dependent statements in async functions
As we saw, selecting pizza involves dependent statements like getting the list of pizzas, choosing one, and then adding the chosen pizza to the cart. We should group these statements in an async function. This way we get two async functions, selectPizza()
and selectDrink()
.
Link to this headingExecute these async functions concurrently
We then take advantage of the event loop to run these async non blocking functions concurrently. Two common patterns of doing this is returning promises early and the Promise.all method.
Link to this headingLet’s fix the examples
Following the three steps, let’s apply them on our examples.
async function selectPizza() {const pizzaData = await getPizzaData() // async callconst chosenPizza = choosePizza() // sync callawait addPizzaToCart(chosenPizza) // async call}async function selectDrink() {const drinkData = await getDrinkData() // async callconst chosenDrink = chooseDrink() // sync callawait addDrinkToCart(chosenDrink) // async call}(async () => {const pizzaPromise = selectPizza()const drinkPromise = selectDrink()await pizzaPromiseawait drinkPromiseorderItems() // async call})()// Although I prefer it this wayPromise.all([selectPizza(),selectDrink(),]).then(orderItems) // async call
Now we have grouped the statements into two functions. Inside the function, each statement depends on the execution of the previous one. Then we concurrently execute both the functions selectPizza()
and selectDrink()
.
In the second example, we need to deal with an unknown number of promises. Dealing with this situation is super easy: we just create an array and push the promises in it. Then using Promise.all()
we concurrently wait for all the promises to resolve.
async function orderItems() {const items = await getCartItems() // async callconst noOfItems = items.lengthconst promises = []for(var i = 0; i < noOfItems; i++) {const orderPromise = sendRequest(items[i]) // async callpromises.push(orderPromise)}await Promise.all(promises) // async call}// Although I prefer it this wayasync function orderItems() {const items = await getCartItems() // async callconst promises = items.map((item) => sendRequest(item))await Promise.all(promises) // async call}
I hope this article helped you see beyond the basics of async/await, and also helped you improve the performance of your application.
If you liked the article, please share it on Twitter and in your network. My DM is open if you need to ask anything.