long polling con jquery+jsonp+couchdb (cross domain soportado)

Traducción del original en catalán. Léela en: CatalàEnglish

Llevo meses soñando con hacer la prueba de concepto que explico en este artículo, intentaré describir en qué consiste pero ya aviso de que la cosa es un pelín complicadilla.

Funcionalidades requeridas:

  • long polling: el objetivo es recibir los cambios de una base de datos de couchdb en tiempo real sin tener que ir preguntando si hay cambios, sino que estos se envían cada vez que se producen de forma automática.

  • A través de jQuery lo que quiero es actualizar una página web de forma asíncrona, de forma que los nuevos resultados que vayan entrando en la BBDD se vayan mostrando en tiempo real en la pantalla.

  • JSONP, es una técnica que nos permite recibir la salida JSON de CouchDB y después llamar a una función de callback de JavaScript. El problema es que la función jQuery.getJSON() original de jQuery tiene algunas carencias que gracias al plugin jQuery-JSONP podemos solucionar, estas son: (copy/paste de la web del plugin)

  • error recovery en caso de fallo de red o de respuestas JSON mal formadas,

  • un control preciso del nombre del callback y de cómo se transmite en la URL,

  • múltiples peticiones con el mismo nombre de callback ejecutándose de forma concurrente,

  • dos mecanismos de caché (basado en el navegador y basado en la página),

  • la posibilidad de abortar manualmente la petición igual que cualquier otra petición AJAX,

  • un mecanismo de timeout.

  • CouchDB es una base de datos NoSQL basada en documentos que es capaz de emitir una señal (trigger) cada vez que el contenido de una base de datos cambia. Para más información sobre el tema se puede consultar en: CouchDB: The Definitive Guide en el capítulo Change Notifications.

  • Cross-domain: cuando se lanza una petición XmlHttpRequest (la base del AJAX) con JavaScript tenemos la limitación de solo poder hacerlo sobre el dominio que sirve la página web, ningún otro puerto ni subdominio. Obviamente tampoco otro host. Para saltarse esta restricción es cuando hay que recurrir a JSONP.

La prueba de concepto ha sido crear una base de datos llamada: notifcations donde se guardan documentos que son notificaciones a mostrar en la página web.

Después he programado la siguiente web:

<html>
<head>
<script type="text/javascript" src="jquery-1.4.2.min.js"></script>
<script type="text/javascript" src="jquery.jsonp-1.1.4.js"></script>
<script type="text/javascript">
function longpoll(since) {
    var url = "http://IP_COUCHDB_SERVER:5984/notifications/_changes?include_docs=true&feed=longpoll&since="+since+"&callback=?";
    console.log("since="+since);
    $.jsonp({
        "url":url,
        "success":function(data) {
            //console.log(data);
            since=data.last_seq;
            try {
                console.log(data.results[0].doc.msg);
            } catch(err) {
                console.log("error:"+err);
            };
            longpoll(since);
        },
        "error":function(msg) {
            //console.log(msg);
            console.log('capturat error');
        }
    });
};

var url = "http://IP_COUCHDB_SERVER:5984/notifications?callback=?";
$.jsonp({
    "url":url,
    "success":function(data) {
        //console.log(data);
        longpoll(data.update_seq);
    },
    "error":function(msg) {
        console.log(msg);
    }
});
</script>
</head>
<body>
cos
</body>
</html>

El código es bastante simple de seguir, primero de todo se cargan las librerías: jQuery 1.4.2 y jquery-jsonp 1.1.4, ambas necesarias para llamar al método $.jsonp, que es el que realmente hará el trabajo.

A continuación se declara la función longpoll que tiene como parámetro el numeral que indica cuál ha sido el último cambio en la base de datos. Este se utiliza para construir la petición que se hace a CouchDB:

var url = "http://IP_COUCHDB_SERVER:5984/notifications/_changes?include_docs=true&feed=longpoll&since="+since+"&callback=?";

La URL lo que hace es pedir lo siguiente:

  • los cambios (_changes)

  • incluyendo los documentos que han cambiado (include_docs=true)

  • trata la petición como long polling (feed=longpoll)

  • muestra los cambios desde la versión X (since=X)

  • cuando envíes los cambios haz una llamada a la función de callback definida aquí (callback=?)

  • '?' es sustituido por jquery-jsonp por la función llamada 'C', este nombre se puede cambiar usando parámetros en la declaración de $.jsonp() que viene a continuación

Los mensajes del estilo 'console.log()' son para tener un seguimiento de lo que va pasando en la consola de javascript del navegador.

$.jsonp() tiene bastantes parámetros posibles definidos en la API, pero en esta prueba de concepto solo uso 'url', 'success' y 'error'. El primero está claro qué es, los otros dos son las funciones a llamar cuando la acción va bien o mal respectivamente. Dentro de la función ponemos el código referente a las acciones que queremos hacer, por ejemplo, actualizar la página actual. Como esto solo es una prueba de concepto lo que hago es mostrar mensajes por consola y listo. La parte más importante es fijarse en que cuando la cosa ha ido bien se hace una llamada a ella misma de forma que la cosa nunca acabe. De hecho cuando hay un error se podría también hacer una llamada a sí misma para que no pares de intentar lanzar la petición una y otra vez, pero lo que he hecho para probar es que se notifique en la consola de javascript y ya está.

Fuera de la función longpoll lo que se hace es una petición JSONP para saber cuál es el último número de secuencia de la base de datos, parámetro necesario para entrar por primera vez en la función recursiva de longpoll.

Conclusiones

Puede parecer todo un poco enrevesado pero diría que he simplificado el problema muchísimo, ya que hasta ahora había estado teorizando muchísimo sobre el tema. Hasta que ayer y anteayer tuve que ponerme a probarlo en la práctica para saber exactamente cómo se podía implementar. Bajo mi punto de vista ha quedado todo bastante limpio y comprensible.

Para los que sois programadores de webs habitualmente habréis tenido necesidades parecidas, así pues espero que os pueda ser tan útil como a mí; de hecho, hace unas semanas que estoy trabajando con Tiny Core Linux montando un Quiet PC sobre una DOM de 512MB para usarla como sistema de monitorización de mis redes y las de algunos clientes, espero que de aquí unos meses pueda daros más información del proyecto.

2 comentarios

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

  1. Oriol Rius

    He trobat una applicació per CouchDB que intenta solucionar el problema del cross-domain al fer peticions amb JavaScript, malgrat això no implementa el tema del long-polling.

    La solució es basa en la mateixa idea i és força elegant, tot s'ha de dir.

    http://github.com/benvinegar/couchdb-xd

  2. Oriol Rius

    La nova versió de google search també usa JSONP i en aqest document que enllaço ens explica com evitar que les peticions fetes amb JSONP provoquin que una pàgina quedi infinitament en càrrega.

    http://googlecode.blogspot.com/2010/11/instant-previews-under-hood.html?spref=tw