wsmini/src/websocket/WSClientRoom.js

Minimalist WebSocket client and server for real-time applications with RPC, PubSub, Rooms and Game state synchronization.

import WSClient from './WSClient.js';

export default class WSClientRoom extends WSClient {
  prefix = '__room-';
  unregisterCmdListener = new Map();

  roomCreateOrJoin(name = null, data = {}, timeout = this.defaultTimeout) {
    return this._roomAction('createOrJoin', name, data, timeout);
  }

  roomCreate(name = null, data = {}, timeout = this.defaultTimeout) {
    return this._roomAction('create', name, data, timeout);
  }

  roomJoin(name, data = {}, timeout = this.defaultTimeout) {
    return this._roomAction('join', name, data, timeout);
  }

  _roomAction(action, name, data = {}, timeout = this.defaultTimeout) {
    const room = new Room(name, {}, this);
    return this.rpc(this.prefix + action, { name, msg: data }, timeout)
      .then(resp => {
        room.meta = resp.meta;
        room.name = resp.name;
        if (resp?.clients) room.clients = resp.clients;
        this.roomOnClients(room.name, clients => room.clients = clients);
        return room;
      })
  }

  roomLeave(name, timeout = this.defaultTimeout) {
    this._roomOff(name);
    return this.rpc(this.prefix + 'leave', { name }, timeout);
  }

  _roomOff(name) {
    this.clear(`ws:chan:${this.prefix + name}`);
    this.clear(`ws:chan:${this.prefix + name}-clients`);
    // Clean up command listeners for this room
    if (!this.unregisterCmdListener.has(name)) return;
    for (const removeListener of this.unregisterCmdListener.get(name)) removeListener();
    this.unregisterCmdListener.delete(name);
  }

  roomSend(name, data = {}) {
    this.wsClient.send(JSON.stringify({action: 'pub-room', room: name, msg: data}));
  }

  roomSendCmd(name, cmd, data = {}) {
    this.wsClient.send(JSON.stringify({action: 'pub-room-cmd', cmd, room: name, msg: data}));
  }

  roomOnMessage(name, callback) {
    return this.on(`ws:chan:${this.prefix + name}`, callback);
  }

  roomOnCmd(name, cmd, callback) {
    const eventName = `ws:chan-cmd:${cmd}:${this.prefix + name}`;
    const removeListener = this.on(eventName, callback);

    if (!this.unregisterCmdListener.has(name)) this.unregisterCmdListener.set(name, []);
    this.unregisterCmdListener.get(name).push(removeListener);

    return removeListener;
  }

  roomOnRooms(callback) {
    this.rpc(this.prefix + 'list').then(callback);
    return this.sub(this.prefix + 'list', callback);
  }

  roomOnClients(name, callback) {
    return this.on(`ws:chan:${this.prefix + name}-clients`, callback);
  }

}

class Room {

  constructor(name, meta, wsClient) {
    this.name = name;
    this.wsClient = wsClient;
    this.wsClient.on('close', () => this.wsClient._roomOff(this.name));
    this.meta = meta;
    this.clients = [];
  }

  send(data) {
    this.wsClient.roomSend(this.name, data);
  }

  sendCmd(cmd, data = {}) {
    this.wsClient.roomSendCmd(this.name, cmd, data);
  }

  leave() {
    this.wsClient.roomLeave(this.name);
  }

  onMessage(callback) {
    return this.wsClient.roomOnMessage(this.name, callback);
  }

  onCmd(cmd, callback) {
    return this.wsClient.roomOnCmd(this.name, cmd, callback);
  }

  onClients(callback) {
    callback(this.clients);
    return this.wsClient.roomOnClients(this.name, callback);
  }

}