Gabrirf/centrifugo-playground

Centrifugo playground

• Tutorial de despliegue, configuración y conexión

Quick install and use

1. Run npm i
2. Run npm run centrifugo
   1. Enter in container: docker exec -it centrifugo sh
   2. Generate token: centrifugo gentoken -u 123
   3. Copy token in index.js file
3. Run npm start
4. Run curl -X POST http://localhost:3001/publish/publisher1 -H 'Content-Type: application/json' -d '{"channel": "channel1", "data": { "hello": "world!" }}'

Integración básica

Servidor Centrifugo

Se incluye documento docker-compose preparado para ser ejecutado docker-compose up.

Configuración

{
  "token_hmac_secret_key": "bbe7d157-a253-4094-9759-06a8236543f9",
  "admin": true, // Habilitar la interfaz web de administración
  "admin_password": "d0683813-0916-4c49-979f-0e08a686b727",
  "admin_secret": "4e9eafcf-0120-4ddd-b668-8dc40072c78e",
  "api_key": "d7627bb6-2292-4911-82e1-615c0ed3eebb",
  "allowed_origins": ["*"], // Necesario para permitir la conexión ('*' solo para testing local)
  "allow_subscribe_for_client": true // Necesario para la subscripción de los clientes
}

Creación de usuario

Es necesario generar un token con el que el cliente se autentifique, para ello se puede ejecutar el siguiente comando:

centrifugo gentoken -u [CLIENT_ID]

Nota: Aunque permite generar el token sin indicar el ID del cliente, este se generará como usuario anónimo y no permitirá la subscripción a los canales.

Cliente consumidor

• Documentación oficial

Importar SDK oficial

• NodeJS

const { Centrifuge } = require('centrifuge');
const WebSocket = require('ws'); // Necesario para NodeJS ya que no se importa automáticamente como en un navegador

• CDN

<script src="https://unpkg.com/centrifuge@3.0.0/dist/centrifuge.js"></script>

Inicializar el cliente

const centrifuge = new Centrifuge('ws://localhost:8000/connection/websocket', {
  token: 'GENERATED_TOKEN',
  websocket: WebSocket
});
centrifuge.connect();

Eventos de conexión

centrifuge.on('connected', () => {
  console.log('connected');
})

centrifuge.on('connecting', () => {
  console.log('connecting');
})

centrifuge.on('disconnected', () => {
  console.log('disconnected');
})

Subscribirse a un canal

const sub = centrifuge.newSubscription('channel');

sub.on('publication', function(ctx) {
    console.log(ctx.data);
});

sub.subscribe();

Cliente publicador

• Documentación oficial

Como cuenta la documentación, la publicación de mensajes se realiza a través de una API, que se consume a través de peticiones HTTP. La librería cent.js facilita su explotación.

Importar SDK

No es oficial pero está referenciado desde la guía oficial

Módulo que extiende de axios preparado para consumir la API de Centrifugo

const { CentClient } = require('cent.js');

Inicialización del cliente

• token Corresponde al campo api_key de la configuración de Centrifugo

const centrifugeUrl = 'http://localhost:8000/api';
const centrifugeToken = 'd7627bb6-2292-4911-82e1-615c0ed3eebb';

const client = new CentClient({
    url: centrifugeUrl,
    token: centrifugeToken,
})

Publicación de un mensaje

client.publish({
    channel: 'channel',
    data: { message: "Hello World!" }
})

Avanzado

Espacio de nombres (namespaces)

Configuración

• Se puede definir distintas configuraciones (como las establecidas en el apartado anterior) para cada espacio de nombres.

{
  ...
  "namespaces": [
    {
      "name": "notifica",
      "allow_subscribe_for_client": true,
      "allow_user_limited_channels": true
    }
  ]
}

Nomenclatura

El canal es un string, que el servidor interpreta ciertos caracteres reservados. Pero sigue siendo el canal que se indique.

• : Definirá el subespacio de un canal. Puede entenderse como grupos
• # Definirá un canal privado a un usuario o múltiples usuarios separados por comas. El identificador lo recoge Centrifugo del token.
  • canal:subcanal#ID(,ID)*
  • Aplica a un espacio definido, no vale para canal#1

Anotaciones

• Subscribirse a un canal no implica subscripción a los subcanales (:), ni al revés.
• Es necesario subscribirse a un canal completo con todos los modificadores. Es decir:
  • Sólo se recibirá un mensaje privador por canal:namespace#1 si el cliente se ha subscrito a canal:namespace#1.
    • NO recibirá el mensaje si sólo se subscribe a canal:namespace

Autentificación