TP 2 Web Sockets Master Info 2013-2014

De $1

Introduction

Dans ce TP nous allons étudier les WebSockets faisant partie de ce qu'on appelle WebRTC (Real Time Communication), c'est "à côté de HTML5" et c'est un nouveau protocole (et une API JavaScript que doivent implémenter les navigateurs) synchrone, à faible latence, bi-directionnel.

Pour faire des WebSockets il faut un serveur supportant ce protocole. Aujourd'hui presque tous les serveurs (apache, glassfish, tomcat, jetty, etc.) supportent ce protocole nativement ou à l'aide d'extensions. Comme l'application que nous développons est un jeu multi-participants, nous allons utiliser un micro serveur très à la mode en ce moment: NodeJS. Ce serveur intègre l'interpréteur JavaScript V8 de Google et permet de coder la couche applicative côté serveur en JavaScript. On pourra ainsi échanger entre le serveur et les clients des objets JavaScript, sans devoir systématiquement les transformer dans un autre langage.

Nous commencerons par étudier deux applications de chat synchrones basés sur la librairie socket.io très populaire dans le monde des WebSockets (il existe des clients pour Java, C#, etc. il est par exemple possible d'écrire une application Android qui parle avec un serveur nodeJS via des WebSockets).

Livre gratuit sur NodeJS, en français

Installation de NodeJS et des modules express et socket.io

Quel que soit votre système d'exploitation, allez sur le site http://www.nodejs.org et suivez la procédure d'installation (click sur le bouton "install"). Installez la dernière version.

Une fois nodeJS installé, vérifiez qu'il fonctionne en tapant dans une fenêtre dos/shell la commande "node --version", cela devrait afficher quelque chose comme: "node 0.10.x". Ok, tout va bien.

 

Test d'une première application NodeJS

  • Créez un fichier test.js file avec ce contenu :
  1. var http = require('http');  
  2. http.createServer(function (req, res) {  
  3.   res.writeHead(200, {'Content-Type''text/plain'});  
  4.   res.end('Hello World\n');  
  5. }).listen(8124, "127.0.0.1");  
  6. console.log('Server running at http://127.0.0.1:8124/');  

Sauvez le et exécutez la commande suivante :

node test.js


Vous venez juste de lancer le serveur NodeJS qui répond à cet URL : http://localhost:8124

Snap5.jpg

Ouvrez cet URL dans votre navigateur !

Vous devriez avoir :

Snap6.jpg

Vous venez d'exécuter votre première application NodeJS ;-)

Le fichier test.js contient le code pour un serveur web archi minimal qui n'est même pas capable de lire un fichier html. Il a juste renvoyé des Strings en parlant de protocole HTTP.

Installation de modules complémentaires

NodeJS est extensible grace à un système de "modules", sortes de "packages" à la linux. Lors de l'installation, si vous avez mis le répertoire d'installation dans le PATH, vous devriez avoir accès à la commande "npm" ou Node Package Manager, qui permet d'installer (il faut avoir une connexion qui fonctionne, évidemment...) des modules supplémentaires. Il en existe des centaines aujourd'hui, mais nous allons utiliser deux des plus populaires:

  • express donne la possibilité de servir des pages HTML avec CSS, JavaScript etc. Par défaut NodeJS ne sait pas faire cela. Permet aussi de faire des web services REST mais cela n'est pas étudié pendant ce cours.
  • socket.io : librairie pour les WebSockets. Donne aussi des solutions de fallbacks si le navigateur utilisé ne supporte pas les WebSockets (comet, ajax, flash sockets), permet de gérer des groupes (sortes de "salles" de chat/ sessions de jeux entre amis, etc.)

Travail à faire :

  1. Créer un répertoire "chatWithSocketIO" quelque part sur votre disque dur,
  2. Aller dans ce répertoire (cd...)
  3. Exécuter la commande "npm install express", attendre qu'elle se termine,
  4. Exécuter la commande "npm install socket.io", attendre qu'elle se termine.

ATTENTION SI PROXY NECESSAIRE (parfois le cas en entreprise) : npm config set proxy http://login:password@internetpsa.inetpsa.com:80 et aussi  npm config set https-proxy http://login:password@internetpsa.inetpsa.com:80

SI ERREUR "nodejs/windows Error: ENOENT, stat 'C:\Users\RT\AppData\Roaming\npm' sous windows, comme dans l'image ci-dessous, il faut créer à la main le répertoire manquant et relancer npm install.

 unnamed.png

 

Dans votre répertoire vous devriez avoir un répertoire supplémentaires intitulé "node_modules" qui contient les modules que vous venez d'ajouter à votre projet. En général on ajoute les modules par projet, non pas globalement.

Si vous développez une autre application, vous pourrez simplement copier ce répertoire si vous ne voulez pas re-télécharger les modules express et socket.io, vous pourrez éventuellement en ajouter.

Test d'une application de chat "simple", utilisant express et socket.io

Nous avons repris ici le code d'un tutorial bien connu du web, qui explique comment réaliser un petit chat avec nodeJS, express et socket.io. Le code a été mis à jour pour fonctionner avec les dernières versions de nodeJS et de express (v3), et socket.io.

Récupérez donc cette archive : chatSocketIOFIxedv2.zip 

Désarchivez là et faites en sorte pour qu'on ait dans ce répertoire le répertoire node_modules qui contient socket.io et express. Vous devez avoir ceci dans le répertoire à la fin:

Snap13.jpg

Bon, maintenant, executez la commande "node simpleChatServer.js" et ouvrez dans votre navigateur "http://localhost:8080", si votre port 8080 est occupé, changez le port dans le fichier simpleChatServer.js.

Ouvrez cet URL dans deux tabs, et regardez le résultat. Le chat devrait fonctionner. Ouvrez la console de debug de Chrome (y'a que Chrome qui permet de debugger efficacement les WS aujourd'hui, tab "network" et tout en bas "websocket", puis tab "frames"), chattez et regardez les trames échangées....

Maintenant, étudiez le code de simpleChatServer.js, de simpleChat.html, et lisez le tutorial (en anglais) qui correspond : http://psitsmike.com/2011/09/node-js...chat-tutorial/, la partie installation est inutile, nous avons fait autrement pour prendre des versions plus à jour, et les premières lignes du serveur sont aussi différentes, pour les mêmes raisons.

Principes de base de socket.io (on trouve de nombreux tutoriaux en français et en anglais sur le web, nous résumons ici l'essentiel):

  • socket.on(type d'un événement, callback) : exécute la fonction de callback quand un événement arrive (le type = une chaine quelconque). Quelques événements comme 'connection' ou 'disconnect' sont  prédéfinis.
  • Tout le traitement des messages se fait dans io.sockets.on('connection', function (socket) {...}, sans connexion, on ne peut rien faire!

  • socket.emit(type de l'évenement, data1, data2) : envoie juste au client connecté un événement (une chaine) et deux paramètres pouvant contenir des données
  • io.sockets.emit(type de l'évenement, data1, data2) : envoie à tous les clients connectés un événement (une chaine) et deux paramètres pouvant contenir des données
  • socket.broadcast.emit(type de l'évenement, data1, data2) : envoie à tous les clients connectés sauf au client courant (l'emetteur) un événement (une chaine) et deux paramètres pouvant contenir des données

simpleChatServer.js:

  1. // We need to use the express framework: have a real web server that knows how to send mime types etc.  
  2. var express=require('express');  
  3.   
  4. // Init globals variables for each module required  
  5. var app = express()  
  6.   , http = require('http')  
  7.   , server = http.createServer(app)  
  8.   , io = require('socket.io').listen(server);  
  9.   
  10. // Indicate where static files are located    
  11. app.use(express.static(__dirname + '/'));    
  12.   
  13. // launch the http server on given port  
  14. server.listen(8080);  
  15.   
  16. // routing  
  17. app.get('/'function (req, res) {  
  18.   res.sendfile(__dirname + '/simpleChat.html');  
  19. });  
  20.   
  21. // usernames which are currently connected to the chat  
  22. var usernames = {};  
  23.   
  24. io.sockets.on('connection'function (socket) {  
  25.   
  26.     // when the client emits 'sendchat', this listens and executes  
  27.     socket.on('sendchat'function (data) {  
  28.         // we tell the client to execute 'updatechat' with 2 parameters  
  29.         io.sockets.emit('updatechat', socket.username, data);  
  30.     });  
  31.   
  32.     // when the client emits 'adduser', this listens and executes  
  33.     socket.on('adduser'function(username){  
  34.         // we store the username in the socket session for this client  
  35.         socket.username = username;  
  36.         // add the client's username to the global list  
  37.         usernames[username] = username;  
  38.         // echo to client they've connected  
  39.         socket.emit('updatechat''SERVER''you have connected');  
  40.         // echo globally (all clients) that a person has connected  
  41.         socket.broadcast.emit('updatechat''SERVER', username + ' has connected');  
  42.         // update the list of users in chat, client-side  
  43.         io.sockets.emit('updateusers', usernames);  
  44.     });  
  45.   
  46.     // when the user disconnects.. perform this  
  47.     socket.on('disconnect'function(){  
  48.         // remove the username from global usernames list  
  49.         delete usernames[socket.username];  
  50.         // update list of users in chat, client-side  
  51.         io.sockets.emit('updateusers', usernames);  
  52.         // echo globally that this client has left  
  53.         socket.broadcast.emit('updatechat''SERVER', socket.username + ' has disconnected');  
  54.     });  
  55. });  

Et la page simpleChat.html

  1. <script src="/socket.io/socket.io.js"></script>  
  2. <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.6.4/jquery.min.js"></script>  
  3. <script>  
  4.     var socket = io.connect(); // we might pass the URL of the WS server as parameter here  
  5.   
  6.     // on connection to server, ask for user's name with an anonymous callback  
  7.     socket.on('connect', function(){  
  8.         // call the server-side function 'adduser' and send one parameter (value of prompt)  
  9.         socket.emit('adduser', prompt("What's your name?"));  
  10.     });  
  11.   
  12.     // listener, whenever the server emits 'updatechat', this updates the chat body   
  13.     socket.on('updatechat', function (username, data) {  
  14.         $('#conversation').append('<b>'+username + ':</b> ' + data + '<br>');  
  15.     });  
  16.   
  17.     // listener, whenever the server emits 'updateusers', this updates the username list  
  18.     socket.on('updateusers', function(data) {  
  19.         $('#users').empty();  
  20.         $.each(data, function(key, value) {  
  21.             $('#users').append('<div>' + key + '</div>');  
  22.         });  
  23.     });  
  24.   
  25.     // on load of page  
  26.     $(function(){  
  27.         // when the client clicks SEND  
  28.         $('#datasend').click( function() {  
  29.             var message = $('#data').val();  
  30.             $('#data').val('');  
  31.             // tell server to execute 'sendchat' and send along one parameter  
  32.             socket.emit('sendchat', message);  
  33.         });  
  34.   
  35.         // when the client hits ENTER on their keyboard  
  36.         $('#data').keypress(function(e) {  
  37.             if(e.which == 13) {  
  38.                 $(this).blur();  
  39.                 $('#datasend').focus().click();  
  40.             }  
  41.         });  
  42.     });  
  43.   
  44. </script>  
  45. <div style="float:left;width:100px;border-right:1px solid black;height:300px;padding:10px;overflow:scroll-y;">  
  46.     <b>USERS</b>  
  47.     <div id="users"></div>  
  48. </div>  
  49. <div style="float:left;width:300px;height:250px;overflow:scroll-y;padding:10px;">  
  50.     <div id="conversation"></div>  
  51.     <input id="data" style="width:200px;" />  
  52.     <input type="button" id="datasend" value="send" />  
  53. </div>  

Test d'une version "multi-rooms" permettant de gérer des "salles de chat"

Dans cette version, on commence à se rapprocher d'une véritable plate-forme permettant de gérer des "sessions" permettant à plusieurs groupes d'utilisateur de participer en temps réel à un chat privé, de rejoindre d'autres salles de chat etc. Cet exemple porte en lui les éléments fondamentaux pour réaliser un serveur de jeux en réseau, remplacez "salle de chat" par "session de jeu" et vous avez tout compris. Imaginez qu'au lieu de taper du texte dans un champ de saisie, le code client qui tourne dans le navigateur envoie des objets JavaScript sur le même canal, par exemple {type:'position', player:'1', x:'120', y:'130'} ou {type:'event', value':endOfGame'}, et que le serveur les fasse passer aux autres clients connectés. 

Principes de gestion de "salles":

  • socket.join(nom de la salle) et socket.leave(nom de la salle) pour indiquer que le client actuellement connecté entre dans une salle ou la quitte. Si on entre dans une salle qui n'existe pas on la créée.
  • socket.broadcast.to(nom de la salle).emit(...) idem à socket.broadcast.emit mais que pour les gens connectés à la salle (le client courant est exclu du broadcast comme pour socket.broadcast.emit)
  • io.sockets.in(nom de la salle).emit(...) : envoie à tout les gens de la salle, y compris le client courant.

Il existe de nombreuses autres fonctions propres à la gestion de "salles" comme "connaitre la liste des salles, et qui est dedans, savoir dans quelle salle est un client donné, etc", voir ce tutorial en anglais très complet: https://github.com/LearnBoost/socket.io/wiki/Rooms

multiRoomChatServer.js

  1. // We need to use the express framework: have a real web server that knows how to send mime types etc.  
  2. var express=require('express');  
  3.   
  4. // Init globals variables for each module required  
  5. var app = express()  
  6.   , http = require('http')  
  7.   , server = http.createServer(app)  
  8.   , io = require('socket.io').listen(server);  
  9.   
  10. // Indicate where static files are located. Without this, no external js file, no css...  
  11.     app.use(express.static(__dirname + '/'));    
  12.   
  13. // launch the http server on given port  
  14. server.listen(8080);  
  15.   
  16. // routing with express, mapping for default page  
  17. app.get('/'function (req, res) {  
  18.   res.sendfile(__dirname + '/multiRoomChat.html');  
  19. });  
  20.   
  21. // usernames which are currently connected to the chat  
  22. var usernames = {};  
  23.   
  24. // rooms which are currently available in chat  
  25. var rooms = ['room1','room2','room3'];  
  26.   
  27. io.sockets.on('connection'function (socket) {  
  28.       
  29.     // when the client emits 'adduser', this listens and executes  
  30.     socket.on('adduser'function(username){  
  31.         // store the username in the socket session for this client  
  32.         socket.username = username;  
  33.         // store the room name in the socket session for this client  
  34.         socket.room = 'room1';  
  35.         // add the client's username to the global list  
  36.         usernames[username] = username;  
  37.         // send client to room 1  
  38.         socket.join('room1');  
  39.         // echo to client they've connected  
  40.         socket.emit('updatechat''SERVER''you have connected to room1');  
  41.         // echo to room 1 that a person has connected to their room  
  42.         socket.broadcast.to('room1').emit('updatechat''SERVER', username + ' has connected to this room');  
  43.         socket.emit('updaterooms', rooms, 'room1');  
  44.     });  
  45.       
  46.     // when the client emits 'sendchat', this listens and executes  
  47.     socket.on('sendchat'function (data) {  
  48.         // we tell the client to execute 'updatechat' with 2 parameters  
  49.         io.sockets.in(socket.room).emit('updatechat', socket.username, data);  
  50.     });  
  51.       
  52.     socket.on('switchRoom'function(newroom){  
  53.         socket.leave(socket.room);  
  54.         socket.join(newroom);  
  55.         socket.emit('updatechat''SERVER''you have connected to '+ newroom);  
  56.         // sent message to OLD room  
  57.         socket.broadcast.to(socket.room).emit('updatechat''SERVER', socket.username+' has left this room');  
  58.         // update socket session room title  
  59.         socket.room = newroom;  
  60.         socket.broadcast.to(newroom).emit('updatechat''SERVER', socket.username+' has joined this room');  
  61.         socket.emit('updaterooms', rooms, newroom);  
  62.     });  
  63.       
  64.   
  65.     // when the user disconnects.. perform this  
  66.     socket.on('disconnect'function(){  
  67.         // remove the username from global usernames list  
  68.         delete usernames[socket.username];  
  69.         // update list of users in chat, client-side  
  70.         io.sockets.emit('updateusers', usernames);  
  71.         // echo globally that this client has left  
  72.         socket.broadcast.emit('updatechat''SERVER', socket.username + ' has disconnected');  
  73.         socket.leave(socket.room);  
  74.     });  
  75. });  

multiRoomChat.html

  1. <script src="/socket.io/socket.io.js"></script>  
  2. <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.6.4/jquery.min.js"></script>  
  3. <script>  
  4.         var socket = io.connect();  
  5.       
  6.     // on connection to server, ask for user's name with an anonymous callback  
  7.     socket.on('connect'function(){  
  8.         // call the server-side function 'adduser' and send one parameter (value of prompt)  
  9.         socket.emit('adduser', prompt("What's your name?"));  
  10.     });  
  11.   
  12.     // listener, whenever the server emits 'updatechat', this updates the chat body  
  13.     socket.on('updatechat'function (username, data) {  
  14.         $('#conversation').append('<b>'+username + ':</b> ' + data + '<br>');  
  15.     });  
  16.   
  17.     // listener, whenever the server emits 'updaterooms', this updates the room the client is in  
  18.     socket.on('updaterooms'function(rooms, current_room) {  
  19.         $('#rooms').empty();  
  20.         $.each(rooms, function(key, value) {  
  21.             if(value == current_room){  
  22.                 $('#rooms').append('<div>' + value + '</div>');  
  23.             }  
  24.             else {  
  25.                 $('#rooms').append('<div><a href="#" onclick="switchRoom(\''+value+'\')">' + value + '</a></div>');  
  26.             }  
  27.         });  
  28.     });  
  29.   
  30.     function switchRoom(room){  
  31.         socket.emit('switchRoom', room);  
  32.     }  
  33.       
  34.     // on load of page  
  35.     $(function(){  
  36.         // when the client clicks SEND  
  37.         $('#datasend').click( function() {  
  38.             var message = $('#data').val();  
  39.             $('#data').val('');  
  40.             // tell server to execute 'sendchat' and send along one parameter  
  41.             socket.emit('sendchat', message);  
  42.         });  
  43.   
  44.         // when the client hits ENTER on their keyboard  
  45.         $('#data').keypress(function(e) {  
  46.             if(e.which == 13) {  
  47.                 $(this).blur();  
  48.                 $('#datasend').focus().click();  
  49.             }  
  50.         });  
  51.     });  
  52.   
  53. </script>  
  54. <div style="float:left;width:100px;border-right:1px solid black;height:300px;padding:10px;overflow:scroll-y;">  
  55.     <b>ROOMS</b>  
  56.     <div id="rooms"></div>  
  57. </div>  
  58. <div style="float:left;width:300px;height:250px;overflow:scroll-y;padding:10px;">  
  59.     <div id="conversation"></div>  
  60.     <input id="data" style="width:200px;" />  
  61.     <input type="button" id="datasend" value="send" />  
  62. </div>  

Prenez la peine d'étudier ce code. Les explications détaillées de l'exemple dont nous sommes servi sont ici : http://psitsmike.com/2011/10/node-js-and-socket-io-multiroom-chat-tutorial/ (mais le code a été mis à jour afin de coller aux nouvelles versions de express et socket.io)

 Integration du chat de base (pour commencer) au TP1 (le paint)

Reprenez le fichier HTML du TP1 et intégrez le code du chat. Si vous faites un peu attention, il est possible de faire ça proprement en mettant le code JavaScript dans un fichier chat.js par exemple, ajoutez juste à la page les parties HTML.

Modifiez simplement le code de simpleChatServer.js pour qu'il serve la page HTML avec le bon nom (celle de votre paint).

Testez en lançant "node simpleChatServer.js", normalement si tout va bien votre paint marche et le chat aussi.

Maintenant essayez d'envoyer, lorsqu'on dessine, l'ordre de cdessin par le canal du chat, sous la forme d'une chaine de caractères : "Michel a tracé une ligne de 10, 10 à 20, 20"... Normalement cela doit générer pas mal de trafic dans le chat mais dans les tabs/fenêtres de tous les utilisateurs on doit voir défiler les ordres de dessin des différentes personnes connectées.

Essayez maintenant d'envoyer non pas ces messages sous forme de chaines de caractères, mais directement sous forme d'objets JavaScript. Bamancez directement des objets, la sérialisation/désérialisation JSON est faite en coulisse par socket.io.

Vous pourrez vous inspirez de cet exemple complet et très court qui montre comment partager une position avec NodeJS et socket.io (exemple en bas de la page) : http://stackoverflow.com/questions/9865167/socket-io-and-complex-json-with-node-js-jquery

Testez donc que vous avez bien reçu les objets du côté du récepteur, par exemple en affichant la valeur des attributs dans le chat.

Synchroniser le dessin

Maintenant que vous avez compris le principe, et bien il ne reste plus qu'à dessiner chez l'un ce que l'autre dessine : il faut intepréter les ordres reçus et effectuer les actions correspondantes.

Vous pourrez vous inspirer de la méthode utilisée dans ce tutorial (mais attention, ce tutorial, écrit par M.Buffa utilisait une librairie différente de socket.io, regardez juste le principe d'envoi des objets et de traitement des ordres de dessins reçus) : http://miageprojet2.unice.fr/Intranet_de_Michel_Buffa/HTML5_Tutorial/Tutorial_WWW_2012, section "broadcast and process paint orders".