TypeScript WebSocket: Real-time Communicatie Verbeteren met Typeveiligheid

            
// types.ts

// Interface voor het verzenden van een tekstbericht
export interface SendMessagePayload {
  roomId: string;
  message: string;
}

// Interface voor het betreden van een kamer
export interface JoinRoomPayload {
  roomId: string;
  userId: string;
}

// Union type voor alle mogelijke client-naar-server berichten
export type ClientToServerEvent = 
  | { type: 'SEND_MESSAGE', payload: SendMessagePayload }
  | { type: 'JOIN_ROOM', payload: JoinRoomPayload };

            

              
                Copy
              
            
          

            
// types.ts (vervolg)

// Interface voor een ontvangen bericht in een chatkamer
export interface ChatMessage {
  id: string;
  roomId: string;
  senderId: string;
  content: string;
  timestamp: number;
}

// Interface voor een notificatie dat een gebruiker een kamer betreedt
export interface UserJoinedRoomPayload {
  userId: string;
  roomId: string;
  timestamp: number;
}

// Union type voor alle mogelijke server-naar-client berichten
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'; // Aannemende dat types.ts zich in dezelfde map bevindt

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

console.log('WebSocket-server gestart op poort 8080');

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

  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('Onbekend berichttype ontvangen:', parsedMessage);
          sendError(ws, 'Onbekend berichttype');
      }
    } catch (error) {
      console.error('Bericht parsen mislukt:', error);
      sendError(ws, 'Ongeldige JSON ontvangen');
    }
  });

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

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

  // Stuur een welkomstbericht naar de client
  sendServerMessage(ws, { type: 'SYSTEM_INFO', payload: { message: 'Welkom bij de real-time server!' } });
});

// Hulpfunctie om berichten van server naar client te sturen
function sendServerMessage(ws: WebSocket, message: ServerToClientEvent): void {
  ws.send(JSON.stringify(message));
}

// Hulpfunctie om fouten naar de client te sturen
function sendError(ws: WebSocket, errorMessage: string): void {
  sendServerMessage(ws, { type: 'ERROR', payload: { message: errorMessage } });
}

// Specifieke berichtafhandelaars
function handleSendMessage(ws: WebSocket, payload: SendMessagePayload): void {
  console.log(`Bericht ontvangen in kamer ${payload.roomId}: ${payload.message}`);
  // In een echte app zou je dit naar andere gebruikers in de kamer broadcasten
  const newMessage: ChatMessage = {
    id: Date.now().toString(), // Eenvoudige ID-generatie
    roomId: payload.roomId,
    senderId: 'anonymous', // In een echte app zou dit uit authenticatie komen
    content: payload.message,
    timestamp: Date.now()
  };
  // Voorbeeld: Broadcast naar alle clients (vervang door kamerspecifieke broadcast)
  wss.clients.forEach(client => {
    if (client !== ws && client.readyState === WebSocket.OPEN) {
      sendServerMessage(client, { type: 'NEW_MESSAGE', payload: newMessage });
    }
  });
  // Stuur optioneel een bevestiging terug naar de afzender
  sendServerMessage(ws, { type: 'MESSAGE_SENT', payload: { messageId: newMessage.id } });
}

function handleJoinRoom(ws: WebSocket, payload: JoinRoomPayload): void {
  console.log(`Gebruiker ${payload.userId} betreedt kamer ${payload.roomId}`);
  // In een echte app zou je kamerabonnementen beheren en mogelijk naar anderen broadcasten
  const userJoinedNotification: UserJoinedRoomPayload = {
    userId: payload.userId,
    roomId: payload.roomId,
    timestamp: Date.now()
  };
  // Broadcast naar anderen in de kamer (voorbeeld)
  wss.clients.forEach(client => {
    // Dit vereist logica om te weten welke client in welke kamer is
    // Voor de eenvoud sturen we het hier als voorbeeld naar iedereen
    if (client.readyState === WebSocket.OPEN) {
      sendServerMessage(client, { type: 'USER_JOINED', payload: userJoinedNotification });
    }
  });
}

// Voeg een handler toe voor een hypothetisch SYSTEM_INFO-berichttype voor volledigheid
// Dit is een voorbeeld van hoe de server gestructureerde info kan sturen
// Let op: In de bovenstaande `sendServerMessage`-aanroep hebben we al een type 'SYSTEM_INFO' toegevoegd
// We definiëren het hier voor de duidelijkheid, hoewel het geen deel uitmaakt van de oorspronkelijke `ServerToClientEvent`-union
// In een echte app zou je ervoor zorgen dat alle gedefinieerde types deel uitmaken van de union
interface SystemInfoPayload {
  message: string;
}

// Om de bovenstaande code te laten compileren, moeten we SYSTEM_INFO toevoegen aan ServerToClientEvent
// Laten we voor dit voorbeeld aannemen dat het is toegevoegd:
// export type ServerToClientEvent = ... | { type: 'SYSTEM_INFO', payload: SystemInfoPayload };

// Dit toont de noodzaak van consistente typedefinities aan.

            

              
                Copy
              
            
          

            
// client.ts

import { ClientToServerEvent, ServerToClientEvent, ChatMessage, UserJoinedRoomPayload } from './types'; // Aannemende dat types.ts zich in dezelfde map bevindt

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

// Event handlers voor de WebSocket-verbinding

socket.onopen = () => {
  console.log('WebSocket-verbinding tot stand gebracht');
  // Voorbeeld: Betreed een kamer na verbinding
  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('Serverfout:', message.payload.message);
        break;
      case 'SYSTEM_INFO':
        console.log('Systeem:', message.payload.message);
        break;
      case 'MESSAGE_SENT':
        console.log('Bericht succesvol verzonden, ID:', message.payload.messageId);
        break;
      default:
        console.warn('Onbekend serverberichttype ontvangen:', message);
    }
  } catch (error) {
    console.error('Serverbericht parsen mislukt:', error);
  }
};

socket.onclose = (event) => {
  if (event.wasClean) {
    console.log(`Verbinding netjes gesloten, code=${event.code} reden=${event.reason}`);
  } else {
    console.error('Verbinding verbroken');
  }
};

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

// Functie om berichten van client naar server te sturen
function sendMessage(message: ClientToServerEvent): void {
  if (socket.readyState === WebSocket.OPEN) {
    socket.send(JSON.stringify(message));
  } else {
    console.warn('WebSocket is niet open. Kan geen bericht sturen.');
  }
}

// Voorbeeld van het verzenden van een chatbericht na verbinding
function sendChatMessage(room: string, text: string) {
  const message: ClientToServerEvent = {
    type: 'SEND_MESSAGE',
    payload: { roomId: room, message: text }
  };
  sendMessage(message);
}

// Berichtafhandelaars aan de client-zijde
function handleNewMessage(message: ChatMessage): void {
  console.log(`
--- Nieuw Bericht in Kamer ${message.roomId} ---
Van: ${message.senderId}
Tijd: ${new Date(message.timestamp).toLocaleTimeString()}
Inhoud: ${message.content}
---------------------------
`);
  // Update de UI met het nieuwe bericht
}

function handleUserJoined(payload: UserJoinedRoomPayload): void {
  console.log(`Gebruiker ${payload.userId} is kamer ${payload.roomId} binnengekomen om ${new Date(payload.timestamp).toLocaleTimeString()}`);
  // Update de UI om de nieuwe gebruiker in de kamer te tonen
}

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

            

              
                Copy
              
            
          

            
// types.ts (uitgebreid)

// Generieke interface voor elke server-naar-client event
export interface ServerEvent<T = any> {
  type: string;
  payload: T;
}

// Bijgewerkte ServerToClientEvent die impliciet generics gebruikt
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' };

// Voorbeeld van een client-side ontvangerfunctie met generics
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(`Fout bij afhandelen van bericht van type ${expectedType}:`, error);
  }
}

// Gebruik in 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('Serverfout:', payload.message);
//   });
//   // ... enzovoort
// };

            

              
                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('Al verbonden.');
      return;
    }
    if (this.isConnecting) {
        console.log('Verbinding wordt opgezet...');
        return;
    }

    this.isConnecting = true;
    console.log(`Poging om te verbinden met ${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('WebSocket-verbinding tot stand gebracht.');
    this.reconnectAttempts = 0; // Herstel verbindingspogingen na succesvolle verbinding
    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('Bericht parsen mislukt:', error);
      this.emit('error', new Error('Ongeldige JSON ontvangen'));
    }
  };

  private onClose = (event: CloseEvent): void => {
    console.log(`WebSocket-verbinding gesloten. Code: ${event.code}, Reden: ${event.reason}`);
    this.isConnecting = false;
    this.emit('close', event);
    if (event.code !== 1000) { // 1000 is normale sluiting
      this.reconnect();
    }
  };

  private onError = (error: Event): void => {
    console.error('WebSocket-fout:', error);
    this.isConnecting = false;
    this.emit('error', error);
    // Niet automatisch opnieuw verbinden bij alle fouten, hangt af van het fouttype indien mogelijk
  };

  private reconnect(): void {
    if (this.reconnectAttempts >= this.maxReconnectAttempts) {
      console.error('Maximaal aantal herverbindingspogingen bereikt. Ik geef het op.');
      this.emit('maxReconnects');
      return;
    }

    this.reconnectAttempts++;
    console.log(`Poging tot herverbinding (${this.reconnectAttempts}/${this.maxReconnectAttempts}) over ${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 is niet open. Bericht niet verzonden.');
      // Optioneel berichten in de wachtrij plaatsen of een fout afgeven
    }
  }

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

// Voorbeeldgebruik in uw applicatiecomponent/module:
// import { WebSocketService } from './WebSocketService';
// 
// const wsService = new WebSocketService({ url: 'ws://localhost:8080', reconnectInterval: 3000 });
// 
// wsService.on('open', () => {
//   console.log('Verbonden!');
//   wsService.send({ type: 'SEND_MESSAGE', payload: { roomId: 'general', message: 'Hallo vanuit de service!' } });
// });
// 
// wsService.on('message', (message: ServerToClientEvent) => {
//   console.log('Ontvangen via service:', message);
//   if (message.type === 'NEW_MESSAGE') {
//     // handleNewMessage(message.payload);
//   }
// });
// 
// wsService.on('error', (error) => {
//   console.error('Service heeft een fout ondervonden:', error);
// });
// 
// wsService.on('close', () => {
//   console.log('Service losgekoppeld.');
// });
// 
// wsService.connect();

            

              
                Copy
              
            
          

            
// types.ts (uitgebreid)

// Interface voor een generiek bericht
interface GenericMessage {
  type: string;
  payload: any;
}

// Type guard om te controleren of een bericht van een specifiek type is
function isSendMessagePayload(payload: any): payload is SendMessagePayload {
  return (
    payload &&
    typeof payload.roomId === 'string' &&
    typeof payload.message === 'string'
  );
}

// De type guard gebruiken in serverlogica
// ... binnen de wss.on('message') handler ...

// 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, 'Ongeldige payload voor SEND_MESSAGE');
//       }
//       break;
//     // ... andere gevallen
//   }
// } else {
//   sendError(ws, 'Ongeldig berichtformaat');
// }

            

              
                Copy