Readme.md

Websocket

1. Inicialização da Conexão WebSocket

O processo começa com a criação de uma nova instância do objeto WebSocket. O URL para a conexão inclui o caminho para o servidor WebSocket, um parâmetro de evento que especifica o tipo de evento ao qual o cliente está se inscrevendo e um token de autenticação. Este token será usado pelo servidor para verificar se o cliente tem permissão para conectar e receber esses eventos.

const ws = new WebSocket(`${url}?event=${encodeURIComponent(eventName)}&token=${encodeURIComponent(instanceToken)}`);

A URL é construída para incluir:

• event: um parâmetro que especifica o tipo de evento de interesse, facilitando ao servidor rotear ou filtrar as mensagens de acordo com o tipo de dado ou comando desejado.
• token: um parâmetro de segurança que provavelmente é usado pelo servidor para autenticar e autorizar a conexão.

2. Manipuladores de Eventos

onopen:

• Este evento é disparado quando a conexão WebSocket é estabelecida com sucesso.
• No manipulador de onopen, uma mensagem de teste é enviada imediatamente ao servidor. Isso pode ser usado para confirmar que a via de comunicação está funcionando ou para informar ao servidor sobre o estado inicial desejado do cliente.

ws.onopen = () => {
  console.log('Connected to the server');
  ws.send(JSON.stringify({ message: "test data" }));
};

onmessage:

• Este evento é acionado sempre que uma mensagem é recebida do servidor.
• As mensagens recebidas são tratadas convertendo o conteúdo de event.data de uma string JSON para um objeto JavaScript, que é então passado para a função callback fornecida pelo usuário do script.

ws.onmessage = (event) => {
  if (callback) {
    const data = JSON.parse(event.data)
    callback(data, event)
  }
};

onerror:

• Acionado quando ocorre um erro na conexão WebSocket.
• Pode ser usado para logar ou tratar erros de rede, falhas de transmissão, etc.

ws.onerror = (error) => {
  console.log('Error:', error);
};

onclose:

• Este evento é acionado quando a conexão WebSocket é fechada, seja por iniciativa do cliente, do servidor, ou devido a falhas de rede.
• O manipulador de eventos onclose tenta automaticamente reconectar-se ao servidor após um intervalo definido. Importante corrigir aqui, o setTimeout deve chamar socket(eventName, callback) ao invés de socket(event), para garantir que a reconexão seja feita corretamente.

ws.onclose = (event) => {
  console.log(`Connection closed with code ${event.code} and reason ${event.reason}, attempting to reconnect...`);
  setTimeout(() => socket(eventName, callback), reconnectInterval);
};

3. Reconexão Automática

• Após a conexão ser fechada, o cliente tenta se reconectar usando um intervalo de tempo definido (reconnectInterval). Este comportamento garante que o cliente tente manter uma conexão persistente mesmo em face de problemas de rede ou reinícios do servidor.

4. Exemplo completo

const url = "ws://localhost:8084/ws/events";
const token = ""
const reconnectInterval = 5000;

function socket(eventName, callback) {
  const ws = new WebSocket(`${url}?event=${encodeURIComponent(eventName)}&token=${encodeURIComponent(token)}`);

  ws.onopen = () => {
    console.log("Connected to the server");
  };

  ws.onmessage = (event) => {
    if (callback) {
      const data = JSON.parse(event.data)
      callback(data, event)
    }
  };

  ws.onerror = (error) => {
    console.log('Error:', error);
  };

  ws.onclose = (event) => {
    console.log(`Connection closed with code ${event.code} and reason ${event.reason}, attempting to reconnect...`);
    setTimeout(() => socket(event), reconnectInterval);
  };
}

// Será criado uma instância da função para cada evento
// Os eventos são os mesmos disparados pela webhook
// exceto o evento "messaging-history.set"

socket("connection.update", (msg, event) => {
    console.log(msg)
})

socket("messages.upsert", (msg, event) => {
    console.log(msg)
})

socket("qrcode.updated", (msg, event) => {
    console.log(msg)
})