Dynamiser le shell avec les tâches asynchrones

— Antoine Lépée

Soyons honnêtes, on passe tous pas mal de temps et d’itérations à rendre nos shells plus efficaces et agréables. Nos workflows y sont très présents et c’est l’un des premiers truc que l’on pense à backup.

L’inconvénient c’est qu’à force de l’enrichir, le prompt devient de plus en plus lent et un shell peut vite prendre plusieurs secondes à démarrer.

Pour ma part, avec l’utilisation de docker-machine, je dois, à chaque démarrage de mon shell, exécuter la commande eval $(docker-machine env) afin de rendre disponible les variables nécessaires à docker. C’est long, c’est lourd et c’est synchrone !

Pré-requis

La solution que j’ai trouvé s’appelle simplement mafredri/zsh-async. Cette lib est utilisée notamment par le thème zsh sindresorhus/pure pour gérer l’affichage du nom de la branche du dossier courant et de son status.

On installe tout ça et go.

Avec antigen ❤️

# on ajoute simplement le bundle dans le fichier .zshrc :
antigen bundle mafredri/zsh-async

Manuellement

git clone https://github.com/mafredri/zsh-async.git $HOME/.zsh-async
echo "source $HOME/.zsh-async/async.zsh && async_init" >> $HOME/.zshrc

Mise en place

zsh-async utilise un principe de workers, de callbacks et de jobs. Étape par étape ça donne :

La petite subtilité, c’est que la tâche exéctutée dans un job appartiendra à un autre contexte et ne pourra donc pas faire d’export dans le shell courant (entre autre).

# on créer un nouveau worker 
async_start_worker docker_machine_init

# on définit notre callback qui aura pour mission d'évaluer le résultat du job dans le shell courant
docker_machine_callback() {
    # $3 correspond à l'output sur stdout
    eval $3
    # on détruit le worker
    async_stop_worker docker_machine_init # 😇
}

# on attache notre callback au worker
async_register_callback docker_machine_init docker_machine_callback

# enfin on lance la tâche que l'on souhaite exécuter
async_job docker_machine_init docker-machine env

Benchmark

En faisant un petit comparatif sur cette seule tâche, on gagne en moyenne 680ms (étant sur macOS j’ai utilisé un script perl qui lui même prend un peu de temps).

time_now() {
    perl -MTime::HiRes -e 'printf("%.0f\n",Time::HiRes::time()*1000)'
}

start=$(time_now)
# did some stuff
end=$(time_now)
echo runtime=$((end-start))

Lorsque j’utilise zsh-async, l’initialisation du job prend en moyenne 20ms. Alors que l’exécution de la tâche docker-machine env elle même prend pratiquement 700ms.

Rendu

Lors du lancement d’un nouveau shell, les variables sont indisponibles, docker ne peut pas se connecter au daemon. Puis, au bout d’une petite seconde, les variables sont exportés par la fonction de callback et la même commande retourne bien les valeurs attendues.

Last login: Mon Mar 12 11:47:33 on ttys009

~
❯ docker info | head
Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running?

~
❯ docker info | head
Containers: 32
 Running: 31
 Paused: 0
 Stopped: 1
Images: 25
Server Version: 17.06.0-ce
Storage Driver: zfs
 Zpool: boot2docker-data
 Zpool Health: ONLINE
 Parent Dataset: boot2docker-data/docker
Back