Notificaciones push del servidor al navegador del cliente sin polling

Traducción del original en inglés. Léela en: CatalàEnglish

Hoy en día las últimas versiones de los navegadores soportan websockets y es una buena idea utilizarlos para conectar al servidor un canal permanente y recibir notificaciones push del servidor. En este caso voy a utilizar el servidor Mosquitto (MQTT) detrás de lighttpd con mod_websocket como servidor de notificaciones. Mosquitto es un servidor MQTT ligero programado en C y muy fácil de configurar. La mejor ventaja de utilizar MQTT es la posibilidad de crear colas de publicación/suscripción y es muy útil cuando quieres tener más de un canal de notificaciones. Como es habitual en los servicios pub/sub, podemos suscribir al cliente a un tema bien definido o podemos utilizar un patrón para suscribirnos a más de un tema. Si no estáis familiarizados con MQTT, ahora es el mejor momento para leer un poco sobre ese interesante protocolo. No es el propósito de este artículo explicar las bases de MQTT.

Hace unas semanas monté la siguiente arquitectura solo para probar esa idea:

mqtt_schema

pasarela weboscket hacia el servidor mqtt mosquitto con cliente mqtt javascript

El navegador

Ahora es el momento de explicar esta prueba de concepto. La página HTML contendrá un código Javascript sencillo que llama a la biblioteca mqttws31.js de Paho. Este código Javascript se conectará al servidor utilizando websockets seguros. No tiene ninguna otra medida de seguridad por el momento; quizá en próximos artículos explique algunas ideas interesantes para autenticar el websocket. Al final del artículo podéis descargar todo el código fuente y los ficheros de configuración. Pero ahora es el momento de entender las partes más importantes del código del cliente.

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});

La última parte es muy simple: el cliente se conecta al servidor y enlaza algunos callbacks con funciones definidas. Prestad atención a la opción de conexión 'useSSL', que se utiliza para forzar una conexión SSL con el servidor.

Hay dos funciones especialmente interesantes enlazadas a los callbacks; la primera es:

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

Como os podéis imaginar, este callback se llamará cuando la conexión esté establecida; cuando eso ocurre, el cliente se suscribe a todos los canales llamados '/news/+/sports', por ejemplo, '/news/europe/sports/' o '/news/usa/sports/', etc. También podemos utilizar algo como '/news/#' y eso querrá decir que queremos suscribirnos a todos los canales que empiezan por '/news/'. Si solo queremos suscribirnos a un canal, poned el nombre completo del canal en ese parámetro. El siguiente parámetro es un diccionario con la calidad de servicio que se va a utilizar y enlaza dos callbacks más.

La segunda función interesante que hay que entender es:

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

Se llama cuando se recibe un mensaje nuevo del servidor y, en este ejemplo, el mensaje se imprime en la consola con el método log.

El servidor

Utilicé un servidor Ubuntu 12.04 con los siguientes repositorios adicionales:

# 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

Con estos repositorios nuevos podéis instalar los paquetes necesarios:

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

Después de la instalación es muy fácil ejecutar mosquitto en modo de prueba; utilizad una consola para eso y escribid el comando: mosquitto; tenemos que ver algo como esto:

# 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 fichero de configuración para lighttpd en pruebas es:

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"
}

Recordad cambiar 'ssl.pemfile' por vuestro fichero de certificado real y 'server.name' por vuestro nombre de servidor real. Después reiniciad el lighttpd y validar la configuración SSL utilizando algo como:

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

Tenéis que ver la negociación SSL y entonces podéis intentar enviar comandos HTTP, por ejemplo: "GET / HTTP/1.0" o algo parecido. Ahora el servidor está listo.

La prueba

Ahora tenéis que cargar la página HTML de prueba en el navegador y validar cómo las conexiones van llegando al servidor y después cómo la consola de mosquitto dice cómo recibe la conexión. Por supuesto, podéis modificar el código Javascript para imprimir más información de log y seguir cómo el cliente se conecta al servidor MQTT y cómo se suscribe al patrón de temas.

Si queréis publicar algo en el servidor MQTT podríamos utilizar la CLI, con un comando mosquitto_pub:

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

Echad un vistazo a la consola Javascript del navegador; tenéis que ver cómo el cliente imprime el mensaje en ella. Si falla, revisad los pasos y depuradlos uno a uno para resolver el problema. Si necesitáis ayuda, dejadme un mensaje. Por supuesto, podéis utilizar muchas formas diferentes de publicar mensajes; por ejemplo, podríais utilizar código python para publicar mensajes en el servidor MQTT. De la misma manera, podríais suscribir a los temas no solo navegadores; por ejemplo, podríais suscribir un código 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()

Prestad atención al puerto del servidor: no es el puerto 'https' (443/tcp) porque ahora el código utiliza un cliente MQTT real. La pasarela websocket no es necesaria.

Los ficheros

  • mqtt.tar.gz - dentro de este tar.gz podéis encontrar todos los ficheros referenciados

9 comentarios

Los comentarios del blog antiguo, tal como se escribieron. Los comentarios están cerrados.

  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?