JavaScript - des rappels à async / wait

JavaScript est synchrone. Cela signifie qu'il exécutera votre bloc de code par ordre après le levage. Avant que le code ne s'exécute, varet les functiondéclarations sont «hissées» au sommet de leur portée.

Voici un exemple de code synchrone:

console.log('1') console.log('2') console.log('3')

Ce code enregistrera de manière fiable «1 2 3».

Les demandes asynchrones attendront la fin d'un minuteur ou une demande de réponse pendant que le reste du code continue de s'exécuter. Ensuite, lorsque le moment sera venu, un rappel déclenchera ces requêtes asynchrones.

Voici un exemple de code asynchrone:

console.log('1') setTimeout(function afterTwoSeconds() { console.log('2') }, 2000) console.log('3')

Cela enregistrera en fait «1 3 2», puisque le «2» est sur un setTimeoutqui ne s'exécutera, dans cet exemple, qu'après deux secondes. Votre application ne se bloque pas en attendant la fin des deux secondes. Au lieu de cela, il continue d'exécuter le reste du code et lorsque le délai d'expiration est terminé, il revient à afterTwoSeconds.

Vous pouvez demander "Pourquoi est-ce utile?" ou "Comment puis-je synchroniser mon code asynchrone?". J'espère que je pourrai vous montrer les réponses.

"Le problème"

Disons que notre objectif est de rechercher un utilisateur GitHub et d'obtenir tous les référentiels de cet utilisateur. Le problème est que nous ne connaissons pas le nom exact de l'utilisateur. Nous devons donc lister tous les utilisateurs avec un nom similaire et leurs référentiels respectifs.

N'a pas besoin de super fantaisie, quelque chose comme ça

Dans ces exemples, le code de requête utilisera XHR (XMLHttpRequest). Vous pouvez le remplacer par jQuery $.ajaxou par l'approche native plus récente appelée fetch. Les deux vous donneront l'approche des promesses hors de la porte.

Il sera légèrement modifié en fonction de votre approche mais en guise de départ:

// url argument can be something like '//api.github.com/users/daspinola/repos' function request(url) { const xhr = new XMLHttpRequest(); xhr.timeout = 2000; xhr.onreadystatechange = function(e) { if (xhr.readyState === 4) { if (xhr.status === 200) { // Code here for the server answer when successful } else { // Code here for the server answer when not successful } } } xhr.ontimeout = function () { // Well, it took to long do some code here to handle that } xhr.open('get', url, true) xhr.send(); }

N'oubliez pas que dans ces exemples, la partie importante n'est pas le résultat final du code. Au lieu de cela, votre objectif devrait être de comprendre les différences entre les approches et comment vous pouvez les exploiter pour votre développement.

Rappeler

Vous pouvez enregistrer une référence de fonction dans une variable lors de l'utilisation de JavaScript. Ensuite, vous pouvez les utiliser comme arguments d'une autre fonction à exécuter plus tard. Ceci est notre «rappel».

Un exemple serait:

// Execute the function "doThis" with another function as parameter, in this case "andThenThis". doThis will execute whatever code it has and when it finishes it should have "andThenThis" being executed. doThis(andThenThis) // Inside of "doThis" it's referenced as "callback" which is just a variable that is holding the reference to this function function andThenThis() { console.log('and then this') } // You can name it whatever you want, "callback" is common approach function doThis(callback) { console.log('this first') // the '()' is when you are telling your code to execute the function reference else it will just log the reference callback() }

Utiliser le callbackpour résoudre notre problème nous permet de faire quelque chose comme ceci à la requestfonction que nous avons définie précédemment:

function request(url, callback) { const xhr = new XMLHttpRequest(); xhr.timeout = 2000; xhr.onreadystatechange = function(e) { if (xhr.readyState === 4) { if (xhr.status === 200) { callback(null, xhr.response) } else { callback(xhr.status, null) } } } xhr.ontimeout = function () { console.log('Timeout') } xhr.open('get', url, true) xhr.send(); }

Notre fonction pour la requête acceptera maintenant a de callbacksorte que quand a requestest fait, elle sera appelée en cas d'erreur et en cas de succès.

const userGet = `//api.github.com/search/users?page=1&q=daspinola&type=Users` request(userGet, function handleUsersList(error, users) { if (error) throw error const list = JSON.parse(users).items list.forEach(function(user) { request(user.repos_url, function handleReposList(err, repos) { if (err) throw err // Handle the repositories list here }) }) })

Décomposer ceci:

  • Nous faisons une demande pour obtenir les référentiels d'un utilisateur
  • Une fois la demande terminée, nous utilisons le rappel handleUsersList
  • S'il n'y a pas d'erreur, nous analysons la réponse de notre serveur dans un objet en utilisant JSON.parse
  • Ensuite, nous itérons notre liste d'utilisateurs car elle peut avoir plus d'un

    Pour chaque utilisateur, nous demandons leur liste de référentiels.

    Nous utiliserons l'url renvoyée par utilisateur dans notre première réponse

    Nous appelons repos_urlcomme URL pour nos prochaines demandes ou dès la première réponse

  • Lorsque la demande a terminé le rappel, nous appellerons

    Cela gérera soit son erreur, soit la réponse avec la liste des référentiels pour cet utilisateur

Remarque : envoyer d'abord l'erreur en tant que paramètre est une pratique courante, en particulier lors de l'utilisation de Node.js.

Une approche plus «complète» et lisible consisterait à gérer les erreurs. Nous garderions le rappel séparé de l'exécution de la demande.

Quelque chose comme ça:

try { request(userGet, handleUsersList) } catch (e) { console.error('Request boom! ', e) } function handleUsersList(error, users) { if (error) throw error const list = JSON.parse(users).items list.forEach(function(user) { request(user.repos_url, handleReposList) }) } function handleReposList(err, repos) { if (err) throw err // Handle the repositories list here console.log('My very few repos', repos) }

Cela finit par avoir des problèmes tels que des problèmes de course et de gestion des erreurs. La course se produit lorsque vous ne contrôlez pas l'utilisateur que vous obtiendrez en premier. Nous demandons les informations pour chacun d'entre eux au cas où il y en aurait plus d'un. Nous ne prenons pas en compte une commande. Par exemple, l'utilisateur 10 peut venir en premier et l'utilisateur 2 en dernier. Nous avons une solution possible plus loin dans l'article.

Le principal problème avec les rappels est que la maintenance et la lisibilité peuvent devenir pénibles. C'est déjà le cas et le code ne fait pratiquement rien. C'est ce qu'on appelle l' enfer du rappel qui peut être évité avec notre prochaine approche.

Promesses

Vous promet de rendre votre code plus lisible. Un nouveau développeur peut accéder à la base de code et voir un ordre clair d'exécution de votre code.

Pour créer une promesse, vous pouvez utiliser:

const myPromise = new Promise(function(resolve, reject) { // code here if (codeIsFine) { resolve('fine') } else { reject('error') } }) myPromise .then(function whenOk(response) { console.log(response) return response }) .catch(function notOk(err) { console.error(err) })

Décomposons-le:

  • Une promesse est initialisée avec une instruction functionqui a resolveetreject
  • Créez votre code asynchrone dans la Promisefonction

    resolve quand tout se passe comme souhaité

    Autrement reject

  • Quand un resolveest trouvé, la .thenméthode s'exécute pour celaPromise

    Quand un reject est trouvé, le .catch sera déclenché

Choses à garder à l'esprit:

  • resolve and reject only accept one parameter

    resolve(‘yey’, ‘works’) will only send ‘yey’ to the .then callback function

  • If you chain multiple .then

    Add a return if you want the next .then value not to be undefined

  • When a reject is caught with .catch if you have a .then chained to it

    It will still execute that .then

    You can see the .then as an “always executes” and you can check an example in this comment

  • With a chain on .then if an error happens on the first one

    It will skip subsequent .then until it finds a .catch

  • A promise has three states

    pending

  • When waiting for a resolve or reject to happen

    resolved

    rejected

  • Once it’s in a resolved or rejected state

    It cannot be changed

Note: You can create promises without the function at the moment of declarations. The way that I’m showing it is only a common way of doing it.

“Theory, theory, theory…I’m confused” you may say.

Let’s use our request example with a promise to try to clear things up:

function request(url) { return new Promise(function (resolve, reject) { const xhr = new XMLHttpRequest(); xhr.timeout = 2000; xhr.onreadystatechange = function(e) { if (xhr.readyState === 4) { if (xhr.status === 200) { resolve(xhr.response) } else { reject(xhr.status) } } } xhr.ontimeout = function () { reject('timeout') } xhr.open('get', url, true) xhr.send(); }) }

In this scenario when you execute request it will return something like this:

const userGet = `//api.github.com/search/users?page=1&q=daspinola&type=Users` const myPromise = request(userGet) console.log('will be pending when logged', myPromise) myPromise .then(function handleUsersList(users) { console.log('when resolve is found it comes here with the response, in this case users ', users) const list = JSON.parse(users).items return Promise.all(list.map(function(user) { return request(user.repos_url) })) }) .then(function handleReposList(repos) { console.log('All users repos in an array', repos) }) .catch(function handleErrors(error) { console.log('when a reject is executed it will come here ignoring the then statement ', error) })

This is how we solve racing and some of the error handling problems. The code is still a bit convoluted. But its a way to show you that this approach can also create readability problems.

A quick fix would be to separate the callbacks like so:

const userGet = `//api.github.com/search/users?page=1&q=daspinola&type=Users` const userRequest = request(userGet) // Just by reading this part out loud you have a good idea of what the code does userRequest .then(handleUsersList) .then(repoRequest) .then(handleReposList) .catch(handleErrors) function handleUsersList(users) { return JSON.parse(users).items } function repoRequest(users) { return Promise.all(users.map(function(user) { return request(user.repos_url) })) } function handleReposList(repos) { console.log('All users repos in an array', repos) } function handleErrors(error) { console.error('Something went wrong ', error) }

By looking at what userRequest is waiting in order with the .then you can get a sense of what we expect of this code block. Everything is more or less separated by responsibility.

This is “scratching the surface” of what Promises are. To have a great insight on how they work I cannot recommend enough this article.

Generators

Another approach is to use the generators. This is a bit more advance so if you are starting out feel free to jump to the next topic.

One use for generators is that they allow you to have async code looking like sync.

They are represented by a * in a function and look something like:

function* foo() { yield 1 const args = yield 2 console.log(args) } var fooIterator = foo() console.log(fooIterator.next().value) // will log 1 console.log(fooIterator.next().value) // will log 2 fooIterator.next('aParam') // will log the console.log inside the generator 'aParam'

Instead of returning with a return, generators have a yield statement. It stops the function execution until a .next is made for that function iteration. It is similar to .then promise that only executes when resolved comes back.

Our request function would look like this:

function request(url) { return function(callback) { const xhr = new XMLHttpRequest(); xhr.onreadystatechange = function(e) { if (xhr.readyState === 4) { if (xhr.status === 200) { callback(null, xhr.response) } else { callback(xhr.status, null) } } } xhr.ontimeout = function () { console.log('timeout') } xhr.open('get', url, true) xhr.send() } }

We want to have the url as an argument. But instead of executing the request out of the gate we want it only when we have a callback to handle the response.

Our generator would be something like:

function* list() { const userGet = `//api.github.com/search/users?page=1&q=daspinola&type=Users` const users = yield request(userGet) yield for (let i = 0; i<=users.length; i++) { yield request(users[i].repos_url) } }

It will:

  • Wait until the first request is prepared
  • Return a function reference expecting a callback for the first request

    Our request function accepts a url

    and returns a function that expects a callback

  • Expect a users to be sent in the next .next
  • Iterate over users
  • Wait for a .next for each of the users
  • Return their respective callback function

So an execution of this would be:

try { const iterator = list() iterator.next().value(function handleUsersList(err, users) { if (err) throw err const list = JSON.parse(users).items // send the list of users for the iterator iterator.next(list) list.forEach(function(user) { iterator.next().value(function userRepos(error, repos) { if (error) throw repos // Handle each individual user repo here console.log(user, JSON.parse(repos)) }) }) }) } catch (e) { console.error(e) }

We could separate the callback functions like we did previously. You get the deal by now, a takeaway is that we now can handle each individual user repository list individually.

I have mixed felling about generators. On one hand I can get a grasp of what is expected of the code by looking at the generator.

But its execution ends up having similar problems to the callback hell.

Like async/await, a compiler is recommended. This is because it isn’t supported in older browser versions.

Also it isn’t that common in my experience. So it may generate confusing in codebases maintained by various developers.

An awesome insight of how generators work can be found in this article. And here is another great resource.

Async/Await

This method seems like a mix of generators with promises. You just have to tell your code what functions are to be async. And what part of the code will have to await for that promise to finish.

sumTwentyAfterTwoSeconds(10) .then(result => console.log('after 2 seconds', result)) async function sumTwentyAfterTwoSeconds(value) { const remainder = afterTwoSeconds(20) return value + await remainder } function afterTwoSeconds(value) { return new Promise(resolve => { setTimeout(() => { resolve(value) }, 2000); }); }

In this scenario:

  • We have sumTwentyAfterTwoSeconds as being an async function
  • We tell our code to wait for the resolve or reject for our promise function afterTwoSeconds
  • It will only end up in the .then when the await operations finish

    In this case there is only one

Applying this to our request we leave it as a promise as seen earlier:

function request(url) { return new Promise(function(resolve, reject) { const xhr = new XMLHttpRequest(); xhr.onreadystatechange = function(e) { if (xhr.readyState === 4) { if (xhr.status === 200) { resolve(xhr.response) } else { reject(xhr.status) } } } xhr.ontimeout = function () { reject('timeout') } xhr.open('get', url, true) xhr.send() }) }

We create our async function with the needed awaits like so:

async function list() { const userGet = `//api.github.com/search/users?page=1&q=daspinola&type=Users` const users = await request(userGet) const usersList = JSON.parse(users).items usersList.forEach(async function (user) { const repos = await request(user.repos_url) handleRepoList(user, repos) }) } function handleRepoList(user, repos) { const userRepos = JSON.parse(repos) // Handle each individual user repo here console.log(user, userRepos) }

So now we have an async list function that will handle the requests. Another async is needed in the forEach so that we have the list of repos for each user to manipulate.

We call it as:

list() .catch(e => console.error(e))

This and the promises approach are my favorites since the code is easy to read and change. You can read about async/await more in depth here.

A downside of using async/await is that it isn’t supported in the front-end by older browsers or in the back-end. You have to use the Node 8.

You can use a compiler like babel to help solve that.

“Solution”

You can see the end code accomplishing our initial goal using async/await in this snippet.

A good thing to do is to try it yourself in the various forms referenced in this article.

Conclusion

Depending on the scenario you might find yourself using:

  • async/await
  • callbacks
  • mix

It’s up to you what fits your purposes. And what lets you maintain the code so that it is understandable to others and your future self.

Note: Any of the approaches become slightly less verbose when using the alternatives for requests like $.ajax and fetch.

Let me know what you would do different and different ways you found to make each approach more readable.

This is Article 11 of 30. It is part of a project for publishing an article at least once a week, from idle thoughts to tutorials. Leave a comment, follow me on Diogo Spínola and then go back to your brilliant project!