Dia : TD1

TD1 du cours de développement et déploiement d'applications distribuées.

L'objectif de ce TD est de développer un serveur TCP minimaliste répondant à des commandes textes en utilisant Node.js.

Installation de node

Télécharger les binaires et les décompresser :

wget https://nodejs.org/dist/v8.12.0/node-v8.12.0-linux-x64.tar.xz
tar -xJvf node-v8.12.0-linux-x64.tar.xz

Mettre à jour votre PATH :

echo "export PATH=$PATH:$(pwd)/node-v8.12.0-linux-x64/bin/" >> ~/.bashrc

Recharger vos variables d'environnement :

. ~/.bashrc

Vérifier que node s'exécute bien :

node --version

Protocole

Le protocole est en texte et il utilise le port 8123 en TCP. C'est un cache mémoire sur un modèle clé / valeur qui propose les commandes suivantes :

KEYS\n : liste les clés, elles sont séparées par un \n;
PUT <key> <data-length> <data>\n : stocke une chaine de caractères <data> de taille <data-length>dans la clé <key>. Renvoie au client ok\n en cas de succès ou ko\n sinon;
GET <key>\n : pour la clé <key> renvoie au client la longueur de la chaine de caractères associé suivie d’un saut de ligne puis la chaine associé. Renvoie 0\n si la clé est inexistante;
DEL <key>\n : supprime la clé / valeur <key>. Renvoie au client ok\n en cas de succès ou ko\n sinon.

Implémentation

Commencer par cloner ce dépôt :

git clone https://github.com/dreimert/dia-td1

Et vous déplacer dedans :

cd dia-td1

En Node.js, la librairie standard net permet de manipuler facilement les sockets : https://nodejs.org/api/net.html. Vous trouverez plusieurs exemples de codes sur cette page.

Vous pouvez implémenter votre serveur dans le fichier server.js.

Pour lancer le server :

npm install nodemon
npm start

Si vous n'avez pas réussi à configurer correctement npm, vous pouvez directement utiliser node :

node server.js

npm install va installer les dépendances listées dans le package.json. Dans notre cas, nodemon qui permet de recharger un fichier quand il est modifié. Votre serveur se relancera automatiquement quand vous sauvegarderez le ficher. Dans le cas où vous lancez directement avec node server.js, il faudra relancer le serveur à chaque modification.

Test

Vous pouvez tester directement via :

netcat localhost 8123

Sur les systèmes plus anciens, vous pouvez remplacer netcat par telnet.

Ou en utilisant des tests déjà écrits par moi-même :

npm test

node client.js

Par où commencer ?

Commencez par implémenter un serveur minimaliste en utilisant les exemples de la documentation. Ensuite, intéressez-vous à l'événement 'data'. Pour afficher une variable, console.log(JSON.stringify(maVariable)) permet de voir exectement ce que contient la variable comme données.

Ce que je dois retenir

Ce que vous venez de coder est une base extrêmement simple pour un serveur web par exemple. Maintenant, on ne s'amuse pas coder ce genre de choses tous les jours. On va utiliser un outil qui va nous simplifier la vie comme Express en Node.js.

Un autre élément à retenir est que l'on ne vous parle pas de multithreading ici car Node.js est mono-thread. Du coup, vous n'avez pas de problèmes de lock de données sur un même processus.

Pour aller plus loin

Les tests que j'ai écrit sont assez basiques. Que ce passe t'il, s'il y a un \n dans la chaine de caractères ? Si vous supprimez une valeur qui n'existe pas ? S'il y a des caractères spéciaux dans vos chaines ?

Étendre les tests pour prendre en compte plus de cas.