@colyseus/core 0.16.0-preview.35 → 0.16.0-preview.37

package/build/Room.mjs

@@ -6,12 +6,13 @@ import { EventEmitter } from "events";
 import { logger } from "./Logger.mjs";
 import { NoneSerializer } from "./serializer/NoneSerializer.mjs";
 import { SchemaSerializer } from "./serializer/SchemaSerializer.mjs";
-import { ErrorCode, getMessageBytes, Protocol } from "./Protocol.mjs";
-import { Deferred, generateId } from "./utils/Utils.mjs";
+import { ErrorCode, getMessageBytes, Protocol } from "./Protocol";
+import { Deferred, generateId, wrapTryCatch } from "./utils/Utils.mjs";
 import { isDevMode } from "./utils/DevMode.mjs";
-import { debugAndPrintError, debugMessage } from "./Debug.mjs";
+import { debugAndPrintError, debugMatchMaking, debugMessage } from "./Debug.mjs";
 import { ServerError } from "./errors/ServerError.mjs";
-import { ClientArray, ClientState } from "./Transport.mjs";
+import { ClientArray, ClientState } from "./Transport";
+import { OnAuthException, OnCreateException, OnDisposeException, OnJoinException, OnLeaveException, OnMessageException, SimulationIntervalException, TimedEventException } from "./errors/RoomExceptions.mjs";
 var DEFAULT_PATCH_RATE = 1e3 / 20;
 var DEFAULT_SIMULATION_INTERVAL = 1e3 / 60;
 var noneSerializer = new NoneSerializer();
@@ -29,12 +30,15 @@ var Room = class _Room {
      * Intervals and timeouts are cleared when the room is disposed.
      */
     this.clock = new Clock();
+    this.#_onLeaveConcurrent = 0;
+    // number of onLeave calls in progress
     /**
      * Maximum number of clients allowed to connect into the room. When room reaches this limit,
      * it is locked automatically. Unless the room was explicitly locked by you via `lock()` method,
      * the room will be unlocked as soon as a client disconnects from it.
      */
     this.maxClients = Infinity;
+    this.#_maxClientsReached = false;
     /**
      * Automatically dispose the room when last client disconnects.
      *
@@ -77,12 +81,14 @@ var Room = class _Room {
     this._serializer = noneSerializer;
     this._afterNextPatchQueue = [];
     this._internalState = 0 /* CREATING */;
-    this._locked = false;
     this._lockedExplicitly = false;
-    this._maxClientsReached = false;
+    this.#_locked = false;
     this._events.once("dispose", () => {
-      this._dispose().catch((e) => debugAndPrintError(`onDispose error: ${e && e.message || e || "promise rejected"}`)).finally(() => this._events.emit("disconnect"));
+      this._dispose().catch((e) => debugAndPrintError(`onDispose error: ${e && e.stack || e.message || e || "promise rejected"}`)).finally(() => this._events.emit("disconnect"));
     });
+    if (this.onUncaughtException !== void 0) {
+      this.#registerUncaughtExceptionHandlers();
+    }
   }
   /**
    * This property will change on these situations:
@@ -92,23 +98,68 @@ var Room = class _Room {
    * @readonly
    */
   get locked() {
-    return this._locked;
+    return this.#_locked;
   }
   get metadata() {
     return this.listing.metadata;
   }
   #_roomId;
   #_roomName;
+  #_onLeaveConcurrent;
+  #_maxClientsReached;
+  #_maxClients;
   #_autoDispose;
   #_patchRate;
   #_patchInterval;
+  #_state;
+  #_locked;
+  /**
+   * This method is called by the MatchMaker before onCreate()
+   * @internal
+   */
   __init() {
-    if (this.state) {
-      this.setState(this.state);
-    }
+    this.#_state = this.state;
     this.#_autoDispose = this.autoDispose;
     this.#_patchRate = this.patchRate;
+    this.#_maxClients = this.maxClients;
     Object.defineProperties(this, {
+      state: {
+        enumerable: true,
+        get: () => this.#_state,
+        set: (newState) => {
+          if (newState[$changes] !== void 0) {
+            this.setSerializer(new SchemaSerializer());
+          } else if ("_definition" in newState) {
+            throw new Error("@colyseus/schema v2 compatibility currently missing (reach out if you need it)");
+          } else if ($changes === void 0) {
+            throw new Error("Multiple @colyseus/schema versions detected. Please make sure you don't have multiple versions of @colyseus/schema installed.");
+          }
+          this._serializer.reset(newState);
+          this.#_state = newState;
+        }
+      },
+      maxClients: {
+        enumerable: true,
+        get: () => this.#_maxClients,
+        set: (value) => {
+          this.#_maxClients = value;
+          if (this._internalState === 1 /* CREATED */) {
+            const hasReachedMaxClients = this.hasReachedMaxClients();
+            if (!this._lockedExplicitly && this.#_maxClientsReached && !hasReachedMaxClients) {
+              this.#_maxClientsReached = false;
+              this.#_locked = false;
+              this.listing.locked = false;
+            }
+            if (hasReachedMaxClients) {
+              this.#_maxClientsReached = true;
+              this.#_locked = true;
+              this.listing.locked = true;
+            }
+            this.listing.maxClients = value;
+            this.listing.save();
+          }
+        }
+      },
       autoDispose: {
         enumerable: true,
         get: () => this.#_autoDispose,
@@ -135,7 +186,11 @@ var Room = class _Room {
       }
     });
     this.patchRate = this.#_patchRate;
+    if (this.#_state) {
+      this.state = this.#_state;
+    }
     this.resetAutoDisposeTimeout(this.seatReservationTime);
+    this.clock.start();
   }
   /**
    * The name of the room you provided as first argument for `gameServer.define()`.
@@ -177,18 +232,23 @@ var Room = class _Room {
     }
     this.#_roomId = roomId;
   }
-  // TODO: flag as @deprecated on v0.16
-  // TOOD: remove instance level `onAuth` on 1.0
-  /**
-   * onAuth at the instance level will be deprecated in the future.
-   * Please use "static onAuth(token, req) instead
-   */
-  onAuth(client, options, request) {
+  onAuth(client, options, context) {
     return true;
   }
-  static async onAuth(token, req) {
+  static async onAuth(token, options, context) {
     return true;
   }
+  /**
+   * This method is called during graceful shutdown of the server process
+   * You may override this method to dispose the room in your own way.
+   *
+   * Once process reaches room count of 0, the room process will be terminated.
+   */
+  onBeforeShutdown() {
+    this.disconnect(
+      isDevMode ? Protocol.WS_CLOSE_DEVMODE_RESTART : Protocol.WS_CLOSE_CONSENTED
+    );
+  }
   /**
    * Returns whether the sum of connected clients and reserved seats exceeds maximum number of clients.
    *
@@ -248,6 +308,9 @@ var Room = class _Room {
       clearInterval(this._simulationInterval);
     }
     if (onTickCallback) {
+      if (this.onUncaughtException !== void 0) {
+        onTickCallback = wrapTryCatch(onTickCallback, this.onUncaughtException.bind(this), SimulationIntervalException, "setSimulationInterval");
+      }
       this._simulationInterval = setInterval(() => {
         this.clock.tick();
         onTickCallback(this.clock.deltaTime);
@@ -260,14 +323,10 @@ var Room = class _Room {
   setPatchRate(milliseconds) {
     this.patchRate = milliseconds;
   }
+  /**
+   * @deprecated Use `.state =` instead.
+   */
   setState(newState) {
-    this.clock.start();
-    if (newState[$changes] !== void 0) {
-      this.setSerializer(new SchemaSerializer());
-    } else if ($changes === void 0) {
-      throw new Error("@colyseus/schema v2 compatibility currently missing (reach out if you need it)");
-    }
-    this._serializer.reset(newState);
     this.state = newState;
   }
   setSerializer(serializer) {
@@ -304,12 +363,12 @@ var Room = class _Room {
    */
   async lock() {
     this._lockedExplicitly = arguments[0] === void 0;
-    if (this._locked) {
+    if (this.#_locked) {
       return;
     }
-    this._locked = true;
+    this.#_locked = true;
     await this.listing.updateOne({
-      $set: { locked: this._locked }
+      $set: { locked: this.#_locked }
     });
     this._events.emit("lock");
   }
@@ -320,12 +379,12 @@ var Room = class _Room {
     if (arguments[0] === void 0) {
       this._lockedExplicitly = false;
     }
-    if (!this._locked) {
+    if (!this.#_locked) {
       return;
     }
-    this._locked = false;
+    this.#_locked = false;
     await this.listing.updateOne({
-      $set: { locked: this._locked }
+      $set: { locked: this.#_locked }
     });
     this._events.emit("unlock");
   }
@@ -370,7 +429,7 @@ var Room = class _Room {
     return hasChanges;
   }
   onMessage(messageType, callback, validate) {
-    this.onMessageHandlers[messageType] = { callback, validate };
+    this.onMessageHandlers[messageType] = this.onUncaughtException !== void 0 ? { validate, callback: wrapTryCatch(callback, this.onUncaughtException.bind(this), OnMessageException, "onMessage", false, messageType) } : { validate, callback };
     return () => delete this.onMessageHandlers[messageType];
   }
   /**
@@ -390,7 +449,7 @@ var Room = class _Room {
     this.#_autoDispose = true;
     const delayedDisconnection = new Promise((resolve) => this._events.once("disconnect", () => resolve()));
     for (const [_, reconnection] of Object.values(this._reconnections)) {
-      reconnection.reject();
+      reconnection.reject(new Error("disconnecting"));
     }
     let numClients = this.clients.length;
     if (numClients > 0) {
@@ -402,7 +461,7 @@ var Room = class _Room {
     }
     return delayedDisconnection;
   }
-  async ["_onJoin"](client, req) {
+  async ["_onJoin"](client, authContext) {
     const sessionId = client.sessionId;
     client.reconnectionToken = generateId();
     if (this.reservedSeatTimeouts[sessionId]) {
@@ -418,6 +477,7 @@ var Room = class _Room {
       throw new ServerError(ErrorCode.MATCHMAKE_EXPIRED, "already consumed");
     }
     this.reservedSeats[sessionId][2] = true;
+    debugMatchMaking("consuming seat reservation, sessionId: '%s'", client.sessionId);
     client._afterNextPatchQueue = this._afterNextPatchQueue;
     client.ref["onleave"] = (_) => client.state = ClientState.LEAVING;
     client.ref.once("close", client.ref["onleave"]);
@@ -435,9 +495,15 @@ var Room = class _Room {
         if (authData) {
           client.auth = authData;
         } else if (this.onAuth !== _Room.prototype.onAuth) {
-          client.auth = await this.onAuth(client, joinOptions, req);
-          if (!client.auth) {
-            throw new ServerError(ErrorCode.AUTH_FAILED, "onAuth failed");
+          try {
+            client.auth = await this.onAuth(client, joinOptions, authContext);
+            if (!client.auth) {
+              throw new ServerError(ErrorCode.AUTH_FAILED, "onAuth failed");
+            }
+          } catch (e) {
+            delete this.reservedSeats[sessionId];
+            await this._decrementClientCount();
+            throw e;
           }
         }
         if (client.state === ClientState.LEAVING) {
@@ -451,15 +517,15 @@ var Room = class _Room {
         if (this.onJoin) {
           await this.onJoin(client, joinOptions, client.auth);
         }
-        this._events.emit("join", client);
-        delete this.reservedSeats[sessionId];
         if (client.state === ClientState.LEAVING) {
-          await this._onLeave(client, Protocol.WS_CLOSE_GOING_AWAY);
+          throw new Error("early_leave");
+        } else {
+          delete this.reservedSeats[sessionId];
+          this._events.emit("join", client);
         }
       } catch (e) {
-        this.clients.delete(client);
+        await this._onLeave(client, Protocol.WS_CLOSE_GOING_AWAY);
         delete this.reservedSeats[sessionId];
-        this._decrementClientCount();
         if (!e.code) {
           e.code = ErrorCode.APPLICATION_ERROR;
         }
@@ -490,7 +556,7 @@ var Room = class _Room {
    */
   allowReconnection(previousClient, seconds) {
     if (previousClient._enqueuedMessages !== void 0) {
-      return Deferred.reject("client not joined");
+      return Promise.reject(new Error("not joined"));
     }
     if (seconds === void 0) {
       console.warn('DEPRECATED: allowReconnection() requires a second argument. Using "manual" mode.');
@@ -500,8 +566,7 @@ var Room = class _Room {
       seconds = Infinity;
     }
     if (this._internalState === 2 /* DISPOSING */) {
-      this._disposeIfEmpty();
-      return Deferred.reject("disconnecting");
+      return Promise.reject(new Error("disposing"));
     }
     const sessionId = previousClient.sessionId;
     const reconnectionToken = previousClient.reconnectionToken;
@@ -589,7 +654,8 @@ var Room = class _Room {
     return true;
   }
   _disposeIfEmpty() {
-    const willDispose = this.#_autoDispose && this._autoDisposeTimeout === void 0 && this.clients.length === 0 && Object.keys(this.reservedSeats).length === 0;
+    const willDispose = this.#_onLeaveConcurrent === 0 && // no "onLeave" calls in progress
+    this.#_autoDispose && this._autoDisposeTimeout === void 0 && this.clients.length === 0 && Object.keys(this.reservedSeats).length === 0;
     if (willDispose) {
       this._events.emit("dispose");
     }
@@ -681,15 +747,19 @@ var Room = class _Room {
     this._onLeave(client, closeCode).then(() => client.leave(closeCode));
   }
   async _onLeave(client, code) {
-    const success = this.clients.delete(client);
-    if (success) {
-      client.state = ClientState.LEAVING;
-      if (this.onLeave) {
-        try {
-          await this.onLeave(client, code === Protocol.WS_CLOSE_CONSENTED);
-        } catch (e) {
-          debugAndPrintError(`onLeave error: ${e && e.message || e || "promise rejected"}`);
-        }
+    debugMatchMaking("onLeave, sessionId: '%s'", client.sessionId);
+    client.state = ClientState.LEAVING;
+    if (!this.clients.delete(client)) {
+      return;
+    }
+    if (this.onLeave) {
+      try {
+        this.#_onLeaveConcurrent++;
+        await this.onLeave(client, code === Protocol.WS_CLOSE_CONSENTED);
+      } catch (e) {
+        debugAndPrintError(`onLeave error: ${e && e.message || e || "promise rejected"}`);
+      } finally {
+        this.#_onLeaveConcurrent--;
       }
     }
     if (this._reconnections[client.reconnectionToken]) {
@@ -707,13 +777,13 @@ var Room = class _Room {
     }
   }
   async _incrementClientCount() {
-    if (!this._locked && this.hasReachedMaxClients()) {
-      this._maxClientsReached = true;
+    if (!this.#_locked && this.hasReachedMaxClients()) {
+      this.#_maxClientsReached = true;
       this.lock.call(this, true);
     }
     await this.listing.updateOne({
       $inc: { clients: 1 },
-      $set: { locked: this._locked }
+      $set: { locked: this.#_locked }
     });
   }
   async _decrementClientCount() {
@@ -722,17 +792,43 @@ var Room = class _Room {
       return true;
     }
     if (!willDispose) {
-      if (this._maxClientsReached && !this._lockedExplicitly) {
-        this._maxClientsReached = false;
+      if (this.#_maxClientsReached && !this._lockedExplicitly) {
+        this.#_maxClientsReached = false;
         this.unlock.call(this, true);
       }
       await this.listing.updateOne({
         $inc: { clients: -1 },
-        $set: { locked: this._locked }
+        $set: { locked: this.#_locked }
       });
     }
     return willDispose;
   }
+  #registerUncaughtExceptionHandlers() {
+    const onUncaughtException = this.onUncaughtException.bind(this);
+    const originalSetTimeout = this.clock.setTimeout;
+    this.clock.setTimeout = (cb, timeout, ...args) => {
+      return originalSetTimeout.call(this.clock, wrapTryCatch(cb, onUncaughtException, TimedEventException, "setTimeout"), timeout, ...args);
+    };
+    const originalSetInterval = this.clock.setInterval;
+    this.clock.setInterval = (cb, timeout, ...args) => {
+      return originalSetInterval.call(this.clock, wrapTryCatch(cb, onUncaughtException, TimedEventException, "setInterval"), timeout, ...args);
+    };
+    if (this.onCreate !== void 0) {
+      this.onCreate = wrapTryCatch(this.onCreate.bind(this), onUncaughtException, OnCreateException, "onCreate", true);
+    }
+    if (this.onAuth !== void 0) {
+      this.onAuth = wrapTryCatch(this.onAuth.bind(this), onUncaughtException, OnAuthException, "onAuth", true);
+    }
+    if (this.onJoin !== void 0) {
+      this.onJoin = wrapTryCatch(this.onJoin.bind(this), onUncaughtException, OnJoinException, "onJoin", true);
+    }
+    if (this.onLeave !== void 0) {
+      this.onLeave = wrapTryCatch(this.onLeave.bind(this), onUncaughtException, OnLeaveException, "onLeave", true);
+    }
+    if (this.onDispose !== void 0) {
+      this.onDispose = wrapTryCatch(this.onDispose.bind(this), onUncaughtException, OnDisposeException, "onDispose");
+    }
+  }
 };
 export {
   DEFAULT_SEAT_RESERVATION_TIME,