TypeScript WebSocket : Améliorer la Communication en Temps Réel avec la Sûreté des Types

            
// types.ts

// Interface pour l'envoi d'un message texte
export interface SendMessagePayload {
  roomId: string;
  message: string;
}

// Interface pour rejoindre un salon
export interface JoinRoomPayload {
  roomId: string;
  userId: string;
}

// Type union pour tous les messages possibles du client vers le serveur
export type ClientToServerEvent = 
  | { type: 'SEND_MESSAGE', payload: SendMessagePayload }
  | { type: 'JOIN_ROOM', payload: JoinRoomPayload };

            

              
                Copy
              
            
          

            
// types.ts (suite)

// Interface pour un message reçu dans un salon de chat
export interface ChatMessage {
  id: string;
  roomId: string;
  senderId: string;
  content: string;
  timestamp: number;
}

// Interface pour la notification d'un utilisateur rejoignant un salon
export interface UserJoinedRoomPayload {
  userId: string;
  roomId: string;
  timestamp: number;
}

// Type union pour tous les messages possibles du serveur vers le client
export type ServerToClientEvent = 
  | { type: 'NEW_MESSAGE', payload: ChatMessage }
  | { type: 'USER_JOINED', payload: UserJoinedRoomPayload }
  | { type: 'ERROR', payload: { message: string } };

            

              
                Copy
              
            
          

            
// server.ts

import WebSocket, { WebSocketServer } from 'ws';
import { ClientToServerEvent, ServerToClientEvent, ChatMessage, JoinRoomPayload, SendMessagePayload } from './types'; // En supposant que types.ts est dans le même répertoire

const wss = new WebSocketServer({ port: 8080 });

console.log('Serveur WebSocket démarré sur le port 8080');

wss.on('connection', (ws: WebSocket) => {
  console.log('Client connecté');

  ws.on('message', (message: string) => {
    try {
      const parsedMessage: ClientToServerEvent = JSON.parse(message);

      switch (parsedMessage.type) {
        case 'SEND_MESSAGE':
          handleSendMessage(ws, parsedMessage.payload);
          break;
        case 'JOIN_ROOM':
          handleJoinRoom(ws, parsedMessage.payload);
          break;
        default:
          console.warn('Type de message inconnu reçu :', parsedMessage);
          sendError(ws, 'Type de message inconnu');
      }
    } catch (error) {
      console.error('Échec de l\'analyse du message :', error);
      sendError(ws, 'JSON invalide reçu');
    }
  });

  ws.on('close', () => {
    console.log('Client déconnecté');
  });

  ws.on('error', (error) => {
    console.error('Erreur WebSocket :', error);
  });

  // Envoyer un message de bienvenue au client
  sendServerMessage(ws, { type: 'SYSTEM_INFO', payload: { message: 'Bienvenue sur le serveur temps réel !' } });
});

// Fonction d'aide pour envoyer des messages du serveur au client
function sendServerMessage(ws: WebSocket, message: ServerToClientEvent): void {
  ws.send(JSON.stringify(message));
}

// Fonction d'aide pour envoyer des erreurs au client
function sendError(ws: WebSocket, errorMessage: string): void {
  sendServerMessage(ws, { type: 'ERROR', payload: { message: errorMessage } });
}

// Gestionnaires de messages spécifiques
function handleSendMessage(ws: WebSocket, payload: SendMessagePayload): void {
  console.log(`Message reçu dans le salon ${payload.roomId}: ${payload.message}`);
  // Dans une application réelle, vous diffuseriez ceci aux autres utilisateurs du salon
  const newMessage: ChatMessage = {
    id: Date.now().toString(), // Génération d'ID simple
    roomId: payload.roomId,
    senderId: 'anonymous', // Dans une application réelle, cela viendrait de l'authentification
    content: payload.message,
    timestamp: Date.now()
  };
  // Exemple : Diffusion à tous les clients (à remplacer par une diffusion spécifique au salon)
  wss.clients.forEach(client => {
    if (client !== ws && client.readyState === WebSocket.OPEN) {
      sendServerMessage(client, { type: 'NEW_MESSAGE', payload: newMessage });
    }
  });
  // Envoyer optionnellement une confirmation à l'expéditeur
  sendServerMessage(ws, { type: 'MESSAGE_SENT', payload: { messageId: newMessage.id } });
}

function handleJoinRoom(ws: WebSocket, payload: JoinRoomPayload): void {
  console.log(`Utilisateur ${payload.userId} rejoint le salon ${payload.roomId}`);
  // Dans une application réelle, vous géreriez les abonnements aux salons et diffuseriez potentiellement aux autres
  const userJoinedNotification: UserJoinedRoomPayload = {
    userId: payload.userId,
    roomId: payload.roomId,
    timestamp: Date.now()
  };
  // Diffusion aux autres dans le salon (exemple)
  wss.clients.forEach(client => {
    // Cela nécessite une logique pour savoir quel client est dans quel salon
    // Par simplicité, nous enverrons à tout le monde ici à titre d'exemple
    if (client.readyState === WebSocket.OPEN) {
      sendServerMessage(client, { type: 'USER_JOINED', payload: userJoinedNotification });
    }
  });
}

// Ajouter un gestionnaire pour un type de message hypothétique SYSTEM_INFO pour être complet
// C'est un exemple de la façon dont le serveur pourrait envoyer des informations structurées
// Note : Dans l'appel `sendServerMessage` ci-dessus, nous avons déjà ajouté un type 'SYSTEM_INFO'
// Nous le définirons ici pour plus de clarté, bien qu'il ne fasse pas partie de l'union initiale `ServerToClientEvent`
// Dans une application réelle, vous vous assureriez que tous les types définis font partie de l'union
interface SystemInfoPayload {
  message: string;
}

// Pour que le code ci-dessus compile, nous devons ajouter SYSTEM_INFO à ServerToClientEvent
// Pour cet exemple, supposons qu'il ait été ajouté :
// export type ServerToClientEvent = ... | { type: 'SYSTEM_INFO', payload: SystemInfoPayload };

// Cela démontre la nécessité d'avoir des définitions de type cohérentes.

            

              
                Copy
              
            
          

            
// client.ts

import { ClientToServerEvent, ServerToClientEvent, ChatMessage, UserJoinedRoomPayload } from './types'; // En supposant que types.ts est dans le même répertoire

const socket = new WebSocket('ws://localhost:8080');

// Gestionnaires d'événements pour la connexion WebSocket

socket.onopen = () => {
  console.log('Connexion WebSocket établie');
  // Exemple : Rejoindre un salon après la connexion
  const joinRoomMessage: ClientToServerEvent = {
    type: 'JOIN_ROOM',
    payload: { roomId: 'general', userId: 'user123' }
  };
  sendMessage(joinRoomMessage);
};

socket.onmessage = (event) => {
  try {
    const message: ServerToClientEvent = JSON.parse(event.data as string);

    switch (message.type) {
      case 'NEW_MESSAGE':
        handleNewMessage(message.payload);
        break;
      case 'USER_JOINED':
        handleUserJoined(message.payload);
        break;
      case 'ERROR':
        console.error('Erreur du serveur :', message.payload.message);
        break;
      case 'SYSTEM_INFO':
        console.log('Système :', message.payload.message);
        break;
      case 'MESSAGE_SENT':
        console.log('Message envoyé avec succès, ID :', message.payload.messageId);
        break;
      default:
        console.warn('Type de message serveur inconnu reçu :', message);
    }
  } catch (error) {
    console.error('Échec de l\'analyse du message du serveur :', error);
  }
};

socket.onclose = (event) => {
  if (event.wasClean) {
    console.log(`Connexion fermée proprement, code=${event.code} raison=${event.reason}`);
  } else {
    console.error('La connexion est morte');
  }
};

socket.onerror = (error) => {
  console.error('Erreur WebSocket :', error);
};

// Fonction pour envoyer des messages du client au serveur
function sendMessage(message: ClientToServerEvent): void {
  if (socket.readyState === WebSocket.OPEN) {
    socket.send(JSON.stringify(message));
  } else {
    console.warn('WebSocket n\'est pas ouvert. Impossible d\'envoyer le message.');
  }
}

// Exemple d'envoi d'un message de chat après la connexion
function sendChatMessage(room: string, text: string) {
  const message: ClientToServerEvent = {
    type: 'SEND_MESSAGE',
    payload: { roomId: room, message: text }
  };
  sendMessage(message);
}

// Gestionnaires de messages côté client
function handleNewMessage(message: ChatMessage): void {
  console.log(`
--- Nouveau Message dans le Salon ${message.roomId} ---
De : ${message.senderId}
Heure : ${new Date(message.timestamp).toLocaleTimeString()}
Contenu : ${message.content}
---------------------------
`);
  // Mettre à jour l'interface utilisateur avec le nouveau message
}

function handleUserJoined(payload: UserJoinedRoomPayload): void {
  console.log(`L'utilisateur ${payload.userId} a rejoint le salon ${payload.roomId} à ${new Date(payload.timestamp).toLocaleTimeString()}`);
  // Mettre à jour l'interface utilisateur pour montrer le nouvel utilisateur dans le salon
}

// Exemple d'utilisation :
// setTimeout(() => {
//   sendChatMessage('general', 'Hello, world!');
// }, 3000);

            

              
                Copy
              
            
          

            
// types.ts (étendu)

// Interface générique pour tout événement du serveur vers le client
export interface ServerEvent<T = any> {
  type: string;
  payload: T;
}

// ServerToClientEvent mis à jour utilisant implicitement les génériques
export type ServerToClientEvent = 
  | ServerEvent<ChatMessage> & { type: 'NEW_MESSAGE' }
  | ServerEvent<UserJoinedRoomPayload> & { type: 'USER_JOINED' }
  | ServerEvent<{ message: string }> & { type: 'ERROR' }
  | ServerEvent<{ message: string }> & { type: 'SYSTEM_INFO' }
  | ServerEvent<{ messageId: string }> & { type: 'MESSAGE_SENT' };

// Exemple de fonction de réception côté client utilisant les génériques
function handleServerMessage<T>(event: MessageEvent, expectedType: string, handler: (payload: T) => void): void {
  try {
    const rawMessage = JSON.parse(event.data as string) as ServerEvent;
    if (rawMessage.type === expectedType) {
      handler(rawMessage.payload as T);
    }
  } catch (error) {
    console.error(`Erreur lors de la gestion du message de type ${expectedType}:`, error);
  }
}

// Utilisation dans client.ts :
// socket.onmessage = (event) => {
//   handleServerMessage<ChatMessage>(event, 'NEW_MESSAGE', handleNewMessage);
//   handleServerMessage<UserJoinedRoomPayload>(event, 'USER_JOINED', handleUserJoined);
//   handleServerMessage<{ message: string }>(event, 'ERROR', (payload) => {
//     console.error('Erreur du serveur :', payload.message);
//   });
//   // ... et ainsi de suite
// };

            

              
                Copy
              
            
          

            
// WebSocketService.ts

import { EventEmitter } from 'events';
import { ClientToServerEvent, ServerToClientEvent } from './types';

interface WebSocketServiceOptions {
  url: string;
  reconnectInterval?: number;
  maxReconnectAttempts?: number;
}

export class WebSocketService extends EventEmitter {
  private socket: WebSocket | null = null;
  private url: string;
  private reconnectInterval: number;
  private maxReconnectAttempts: number;
  private reconnectAttempts: number = 0;
  private isConnecting: boolean = false;

  constructor(options: WebSocketServiceOptions) {
    super();
    this.url = options.url;
    this.reconnectInterval = options.reconnectInterval || 5000;
    this.maxReconnectAttempts = options.maxReconnectAttempts || 10;
  }

  connect(): void {
    if (this.socket && this.socket.readyState === WebSocket.OPEN) {
      console.log('Déjà connecté.');
      return;
    }
    if (this.isConnecting) {
        console.log('Connexion en cours...');
        return;
    }

    this.isConnecting = true;
    console.log(`Tentative de connexion à ${this.url}...`);
    this.socket = new WebSocket(this.url);

    this.socket.onopen = this.onOpen;
    this.socket.onmessage = this.onMessage;
    this.socket.onclose = this.onClose;
    this.socket.onerror = this.onError;
  }

  private onOpen = (): void => {
    console.log('Connexion WebSocket établie.');
    this.reconnectAttempts = 0; // Réinitialiser les tentatives de reconnexion en cas de succès
    this.isConnecting = false;
    this.emit('open');
  };

  private onMessage = (event: MessageEvent): void => {
    try {
      const message = JSON.parse(event.data as string) as ServerToClientEvent;
      this.emit('message', message);
    } catch (error) {
      console.error('Échec de l\'analyse du message :', error);
      this.emit('error', new Error('JSON invalide reçu'));
    }
  };

  private onClose = (event: CloseEvent): void => {
    console.log(`Connexion WebSocket fermée. Code : ${event.code}, Raison : ${event.reason}`);
    this.isConnecting = false;
    this.emit('close', event);
    if (event.code !== 1000) { // 1000 est une fermeture normale
      this.reconnect();
    }
  };

  private onError = (error: Event): void => {
    console.error('Erreur WebSocket :', error);
    this.isConnecting = false;
    this.emit('error', error);
    // Ne pas se reconnecter automatiquement sur toutes les erreurs, dépend du type d'erreur si possible
  };

  private reconnect(): void {
    if (this.reconnectAttempts >= this.maxReconnectAttempts) {
      console.error('Nombre maximum de tentatives de reconnexion atteint. Abandon.');
      this.emit('maxReconnects');
      return;
    }

    this.reconnectAttempts++;
    console.log(`Tentative de reconnexion (${this.reconnectAttempts}/${this.maxReconnectAttempts}) dans ${this.reconnectInterval}ms...`);
    setTimeout(() => {
      this.connect();
    }, this.reconnectInterval);
  }

  send(message: ClientToServerEvent): void {
    if (this.socket && this.socket.readyState === WebSocket.OPEN) {
      this.socket.send(JSON.stringify(message));
    } else {
      console.warn('WebSocket n\'est pas ouvert. Message non envoyé.');
      // Mettre éventuellement les messages en file d'attente ou émettre une erreur
    }
  }

  close(): void {
    if (this.socket) {
      this.socket.close();
    }
  }
}

// Exemple d'utilisation dans votre composant/module d'application :
// import { WebSocketService } from './WebSocketService';
// 
// const wsService = new WebSocketService({ url: 'ws://localhost:8080', reconnectInterval: 3000 });
// 
// wsService.on('open', () => {
//   console.log('Connecté !');
//   wsService.send({ type: 'SEND_MESSAGE', payload: { roomId: 'general', message: 'Bonjour depuis le service !' } });
// });
// 
// wsService.on('message', (message: ServerToClientEvent) => {
//   console.log('Reçu via le service :', message);
//   if (message.type === 'NEW_MESSAGE') {
//     // handleNewMessage(message.payload);
//   }
// });
// 
// wsService.on('error', (error) => {
//   console.error('Le service a rencontré une erreur :', error);
// });
// 
// wsService.on('close', () => {
//   console.log('Service déconnecté.');
// });
// 
// wsService.connect();

            

              
                Copy
              
            
          

            
// types.ts (étendu)

// Interface pour un message générique
interface GenericMessage {
  type: string;
  payload: any;
}

// "Type guard" pour vérifier si un message est d'un type spécifique
function isSendMessagePayload(payload: any): payload is SendMessagePayload {
  return (
    payload &&
    typeof payload.roomId === 'string' &&
    typeof payload.message === 'string'
  );
}

// Utilisation du "type guard" dans la logique du serveur
// ... à l'intérieur du gestionnaire wss.on('message') ...

// const parsedMessage: any = JSON.parse(message);
// 
// if (parsedMessage && typeof parsedMessage.type === 'string') {
//   switch (parsedMessage.type) {
//     case 'SEND_MESSAGE':
//       if (isSendMessagePayload(parsedMessage.payload)) {
//         handleSendMessage(ws, parsedMessage.payload);
//       } else {
//         sendError(ws, 'Charge utile invalide pour SEND_MESSAGE');
//       }
//       break;
//     // ... autres cas
//   }
// } else {
//   sendError(ws, 'Format de message invalide');
// }

            

              
                Copy