Notificacions push del servidor al navegador del client sense polling

Traducció de l’original en anglès. Llegeix-lo en: CastellanoEnglish

Avui dia les últimes versions dels navegadors suporten websockets i és una bona idea utilitzar-los per connectar al servidor un canal permanent i rebre notificacions push del servidor. En aquest cas faré servir el servidor Mosquitto (MQTT) darrere de lighttpd amb mod_websocket com a servidor de notificacions. Mosquitto és un servidor MQTT lleuger programat en C i molt fàcil de configurar. El millor avantatge d'utilitzar MQTT és la possibilitat de crear cues de publicació/subscripció i és molt útil quan vols tenir més d'un canal de notificacions. Com és habitual en els serveis pub/sub, podem subscriure el client a un tema ben definit o podem utilitzar un patró per subscriure'ns a més d'un tema. Si no esteu familiaritzats amb MQTT, ara és el millor moment per llegir una mica sobre aquest interessant protocol. No és l'objectiu d'aquest article explicar les bases de MQTT.

Fa unes setmanes vaig muntar la següent arquitectura només per provar aquesta idea:

mqtt_schema

passarel·la weboscket cap al servidor mqtt mosquitto amb client mqtt javascript

El navegador

Ara és el moment d'explicar aquesta prova de concepte. La pàgina HTML contindrà un codi Javascript senzill que crida la biblioteca mqttws31.js de Paho. Aquest codi Javascript es connectarà al servidor utilitzant websockets segurs. No té cap altra mesura de seguretat de moment; potser en propers articles explicaré algunes idees interessants per autenticar el websocket. Al final de l'article podeu descarregar tot el codi font i els fitxers de configuració. Però ara és el moment d'entendre les parts més importants del codi del client.

client = new Messaging.Client("ns.example.tld", 443, "unique_client_id");
client.onConnectionLost = onConnectionLost;
client.onMessageArrived = onMessageArrived;
client.connect({onSuccess:onConnect, onFailure:onFailure, useSSL:true});

L'última part és molt simple: el client es connecta al servidor i enllaça alguns callbacks amb funcions definides. Pareu atenció a l'opció de connexió 'useSSL', que s'utilitza per forçar una connexió SSL amb el servidor.

Hi ha dues funcions especialment interessants enllaçades als callbacks; la primera és:

function onConnect() {
  client.subscribe("/news/+/sport", {qos:1,onSuccess:onSubscribe,onFailure:onSubscribeFailure});
}

Com us podeu imaginar, aquest callback es cridarà quan la connexió estigui establerta; quan això passa, el client se subscriu a tots els canals anomenats '/news/+/sports', per exemple, '/news/europe/sports/' o '/news/usa/sports/', etc. També podem utilitzar una cosa com '/news/#' i això voldrà dir que volem subscriure'ns a tots els canals que comencen per '/news/'. Si només volem subscriure'ns a un canal, poseu el nom complet del canal en aquest paràmetre. El paràmetre següent és un diccionari amb la qualitat de servei que s'utilitzarà i enllaça dos callbacks més.

La segona funció interessant per entendre és:

function onMessageArrived(message) {
  console.log("onMessageArrived:"+message.payloadString);
};

Es crida quan es rep un missatge nou del servidor i, en aquest exemple, el missatge s'imprimeix a la consola amb el mètode log.

El servidor

Vaig utilitzar un servidor Ubuntu 12.04 amb els següents repositoris addicionals:

# lighttpd + mod_webserver
deb http://ppa.launchpad.net/roger.light/ppa/ubuntu precise main
deb-src http://ppa.launchpad.net/roger.light/ppa/ubuntu precise main

# mosquitto
deb http://ppa.launchpad.net/mosquitto-dev/mosquitto-ppa/ubuntu precise main
deb-src http://ppa.launchpad.net/mosquitto-dev/mosquitto-ppa/ubuntu precise main

Amb aquests repositoris nous podeu instal·lar els paquets necessaris:

apt-get install lighttpd lighttpd-mod-websocket mosquitto mosquitto-clients

Després de la instal·lació és molt fàcil executar mosquitto en mode de prova; feu servir una consola per a això i escriviu la comanda: mosquitto; hem de veure una cosa com aquesta:

# mosquitto
1379873664: mosquitto version 1.2.1 (build date 2013-09-19 22:18:02+0000) starting
1379873664: Using default config.
1379873664: Opening ipv4 listen socket on port 1883.
1379873664: Opening ipv6 listen socket on port 1883.

El fitxer de configuració per a lighttpd en proves és:

server.modules = (
        "mod_websocket",
)

websocket.server = (
        "/mqtt" => ( 
                "host" => "127.0.0.1",
                "port" => "1883",
                "type" => "bin",
                "subproto" => "mqttv3.1"
        ),
)

server.document-root        = "/var/www"
server.upload-dirs          = ( "/var/cache/lighttpd/uploads" )
server.errorlog             = "/var/log/lighttpd/error.log"
server.pid-file             = "/var/run/lighttpd.pid"
server.username             = "www-data"
server.groupname            = "www-data"
server.port                 = 80

$SERVER["socket"] == ":443" {
    ssl.engine = "enable" 
    ssl.pemfile = "/etc/lighttpd/certs/sample-certificate.pem" 
    server.name = "ns.example.tld"
}

Recordeu canviar 'ssl.pemfile' pel vostre fitxer de certificat real i 'server.name' pel vostre nom de servidor real. Després reinicieu el lighttpd i valideu la configuració SSL utilitzant una cosa com:

openssl s_client -host ns.example.tld -port 443

Heu de veure la negociació SSL i llavors podeu provar d'enviar comandes HTTP, per exemple: "GET / HTTP/1.0" o una cosa semblant. Ara el servidor està a punt.

La prova

Ara heu de carregar la pàgina HTML de prova al navegador i validar com les connexions arriben al servidor i després com la consola de mosquitto diu com rep la connexió. Per descomptat, podeu modificar el codi Javascript per imprimir més informació de log i seguir com el client es connecta al servidor MQTT i com se subscriu al patró de temes.

Si voleu publicar alguna cosa al servidor MQTT podríem utilitzar la CLI, amb una comanda mosquitto_pub:

mosquitto_pub -h ns.example.tld -t '/news/europe/sport' -m 'this is the message about european sports'

Feu una ullada a la consola Javascript del navegador; hi heu de veure com el client imprimeix el missatge. Si falla, reviseu els passos i depureu-los un a un per resoldre el problema. Si necessiteu ajuda, deixeu-me un missatge. Per descomptat, podeu utilitzar moltes maneres diferents de publicar missatges; per exemple, podríeu utilitzar codi python per publicar missatges al servidor MQTT. De la mateixa manera, podríeu subscriure als temes no només navegadors; per exemple, podríeu subscriure un codi python:

import mosquitto

def on_connect(mosq, obj, rc):
    print("rc: "+str(rc))

def on_message(mosq, obj, msg):
    print(msg.topic+" "+str(msg.qos)+" "+str(msg.payload))

def on_publish(mosq, obj, mid):
    print("mid: "+str(mid))

def on_subscribe(mosq, obj, mid, granted_qos):
    print("Subscribed: "+str(mid)+" "+str(granted_qos))

def on_log(mosq, obj, level, string):
    print(string)

mqttc = mosquitto.Mosquitto("the_client_id")
mqttc.on_message = on_message
mqttc.on_connect = on_connect
mqttc.on_publish = on_publish
mqttc.on_subscribe = on_subscribe

mqttc.connect("ns.example.tld", 1883, 60)
mqttc.subscribe("/news/+/sport", 0)

rc = 0
while rc == 0:
    rc = mqttc.loop()

Pareu atenció al port del servidor: no és el port 'https' (443/tcp) perquè ara el codi utilitza un client MQTT real. La passarel·la websocket no cal.

Els fitxers

  • mqtt.tar.gz - dins d'aquest tar.gz podeu trobar tots els fitxers referenciats

9 comentaris

Els comentaris del blog antic, tal com es van escriure. Els comentaris estan tancats.

  1. Dominik Obermaier

    Awesome blog post which demonstrates how easy it is to set up a working MQTT example! Really enjoyed it.

    If you don't like to set up a separate HTTP server for websockets, you could also try the HiveMQ MQTT broker (http://www.hivemq.com) which supports native (secure) websockets.

    I personally think the ability for real push to browsers with websockets and goodies like Last-Will-and-Testament functionality from MQTT will be HUGE for future web applications.

    I'm really looking forward to the follow-up post about websocket authentication :-)

    1. Oriol Rius

      Of course, you could use HiveMQ which is a very good MQTT broker may be better than Mosquitto but it's licence is to expensive in many cheap projects.

      About auth I can advance I'm using the session cookie string as a token in MQTT negotation then in MQTT broker I have to validate this session as a valid one. I only have to share a password used to cipher session cookie between MQTT broker and Web application. Inside the session cookie I have enough information to validate it. Do you understand the idea?

      Thank you for you comment Dominik.

  2. Zack S.

    I suggest to read this solution: Building mosquitto 1.4 (native websocket support)
    http://goochgooch.wordpress.com/2014/08/01/building-mosquitto-1-4/

    1. Oriol Rius

      Thanks FYI but the post entry has been written one year ago and at that time this feature in Mosquitto didn't exist. I tried websockets with Mosquitto several months ago and it works quite well and it's a very good reason to forget this post entry I'm with you.

  3. Prasanna

    Hello, I have gone through this.
    I want to introduce a new push notification service to you which offers Free plugins like Wordpress and Joomla for different platforms.
    To know more about this just visit www.pushify.com

  4. Priyanka

    Hello,

    Lighttpd + mod_websocket has two options

    1. WebSocket-TCP Proxy ( when "proto" = "tcp" )
    2. WebSocket Proxy ( when "proto" = "websocket" )

    In above configurations WebSocket-TCP Proxy is used between lighttpd and mqtt. I guess, in above configurations mqtt is not using libwebsocket.
    webClient Lighttpd MQTT broker

    Can we use WebSocket Proxy in lighttpd and mqtt(libwebsocket enabled)?
    webClient Lighttpd MQTT broker

    I searched but could not find any configuration for mqtt + websocket.

    Kindly help.

    1. dreamer

      Hi ,

      Did you find solution to your problem ? Can you update us if in case you found the solution ?

      1. Oriol Rius

        Latest versions of mosquitto solve that or using other backends like node.js + mosca + websockets could solve your problem.

        1. dreamer

          What if we have a process is not mosquitto and is written based on libwebsockets ?
          Can you please suggest if there is configuration for lighttpd in such case?