@pluv/io 0.3.6 → 0.3.8

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @pluv/io@0.3.6 build /home/runner/work/pluv/pluv/packages/io
+> @pluv/io@0.3.8 build /home/runner/work/pluv/pluv/packages/io
 > tsup src/index.ts --format esm,cjs --dts
 
 CLI Building entry: src/index.ts
@@ -8,10 +8,10 @@
 CLI Target: es6
 ESM Build start
 CJS Build start
-ESM dist/index.mjs 27.19 KB
-ESM ⚡️ Build success in 112ms
-CJS dist/index.js 29.25 KB
-CJS ⚡️ Build success in 113ms
+CJS dist/index.js 29.51 KB
+CJS ⚡️ Build success in 109ms
+ESM dist/index.mjs 27.45 KB
+ESM ⚡️ Build success in 118ms
 DTS Build start
-DTS ⚡️ Build success in 2971ms
-DTS dist/index.d.ts 12.73 KB
+DTS ⚡️ Build success in 2905ms
+DTS dist/index.d.ts 12.84 KB

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @pluv/io
 
+## 0.3.8
+
+### Patch Changes
+
+- bcf1c3e: purge empty rooms before joining a new room
+
+## 0.3.7
+
+### Patch Changes
+
+- ecc4040: added ability to set debug when room is created
+
 ## 0.3.6
 
 ### Patch Changes

package/dist/index.d.ts

@@ -204,6 +204,7 @@ declare class IORoom<TPlatform extends AbstractPlatform<any> = AbstractPlatform<
     readonly id: string;
     constructor(id: string, config: IORoomConfig<TPlatform, TAuthorize, TContext, TInput, TOutput>);
     broadcast<TEvent extends keyof InferIOInput<this>>(event: TEvent, data: Id<InferIOInput<this>[TEvent]>): Promise<void>;
+    getSize(): number;
     register(webSocket: InferWebSocketType<TPlatform>, options?: WebsocketRegisterOptions): Promise<void>;
     private _broadcast;
     private _emitQuitters;
@@ -211,7 +212,6 @@ declare class IORoom<TPlatform extends AbstractPlatform<any> = AbstractPlatform<
     private _emitStorageReceived;
     private _emitUserJoined;
     private _getAuthorizedUser;
-    private _getSessionsSize;
     private _getEventConfig;
     private _initialize;
     private _logDebug;
@@ -238,6 +238,9 @@ type PluvIOConfig<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any
     initialStorage?: (room: string) => MaybePromise<Maybe<string>>;
     platform: TPlatform;
 };
+interface GetRoomOptions {
+    debug?: boolean;
+}
 declare class PluvIO<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TAuthorize extends IOAuthorize<any, any> = BaseIOAuthorize, TContext extends JsonObject = {}, TInput extends EventRecord<string, any> = {}, TOutput extends EventRecord<string, any> = {}> implements IOLike<TAuthorize, TInput, TOutput> {
     private _context;
     private _initialStorage;
@@ -250,9 +253,10 @@ declare class PluvIO<TPlatform extends AbstractPlatform<any> = AbstractPlatform<
     constructor(options: PluvIOConfig<TPlatform, TAuthorize, TContext, TInput, TOutput>);
     createToken(params: JWTEncodeParams<InferIOAuthorizeUser<InferIOAuthorize<this>>>): Promise<string>;
     event<TEvent extends string, TData extends JsonObject = {}, TResult extends EventRecord<string, any> = {}>(event: TEvent, config: EventConfig<TContext, TData, TResult>): PluvIO<TPlatform, TAuthorize, TContext, Spread<[TInput, EventRecord<TEvent, TData>]>, Spread<[TOutput, TResult]>>;
-    getRoom(room: string): IORoom<TPlatform, TAuthorize, TContext, TInput, TOutput>;
+    getRoom(room: string, options?: GetRoomOptions): IORoom<TPlatform, TAuthorize, TContext, TInput, TOutput>;
     static merge<TIO1 extends PluvIO, TIO2 extends PluvIO>(first: TIO1, second: TIO2): PluvIO<InferIOPlatform<TIO1>, InferIOAuthorize<TIO1>, InferIOContext<TIO1>, Spread<[InferIOInput<TIO1>, InferIOInput<TIO2>]>, Spread<[InferIOOutput<TIO1>, InferIOOutput<TIO2>]>>;
     private _logDebug;
+    private _purgeEmptyRooms;
 }
 
 type CreateIOParams<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TContext extends JsonObject = {}, TAuthorizeUser extends BaseUser = BaseUser, TAuthorizeRequired extends boolean = false> = Partial<PluvIOListeners> & {
@@ -264,4 +268,4 @@ type CreateIOParams<TPlatform extends AbstractPlatform<any> = AbstractPlatform<a
 };
 declare const createIO: <TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TContext extends JsonObject = {}, TAuthorizeUser extends BaseUser = BaseUser, TAuthorizeRequired extends boolean = false>(params: CreateIOParams<TPlatform, TContext, TAuthorizeUser, TAuthorizeRequired>) => PluvIO<TPlatform, IOAuthorize<TAuthorizeUser, TAuthorizeRequired>, TContext, BaseClientEventRecord, BaseIOEventRecord<IOAuthorize<TAuthorizeUser, TAuthorizeRequired>>>;
 
-export { AbstractCloseEvent, AbstractErrorEvent, AbstractEvent, AbstractEventMap, AbstractListener, AbstractMessageEvent, AbstractPersistance, AbstractPlatform, AbstractPubSub, AbstractWebSocket, AbstractWebSocketConfig, AbstractWebSocketHandleErrorParams, AuthorizeModule, AuthorizeParams, ConvertWebSocketConfig, CreateIOParams, IOPubSubEventMessage, IORoom, InferIORoom, InferWebSocketType, JWT, JWTEncodeParams, PluvIO, createIO };
+export { AbstractCloseEvent, AbstractErrorEvent, AbstractEvent, AbstractEventMap, AbstractListener, AbstractMessageEvent, AbstractPersistance, AbstractPlatform, AbstractPubSub, AbstractWebSocket, AbstractWebSocketConfig, AbstractWebSocketHandleErrorParams, AuthorizeModule, AuthorizeParams, ConvertWebSocketConfig, CreateIOParams, GetRoomOptions, IOPubSubEventMessage, IORoom, InferIORoom, InferWebSocketType, JWT, JWTEncodeParams, PluvIO, createIO };

package/dist/index.js

@@ -334,6 +334,14 @@ var IORoom = class {
     const message = { type: event, data };
     return Promise.resolve(this._broadcast({ message }));
   }
+  getSize() {
+    const currentTime = (/* @__PURE__ */ new Date()).getTime();
+    return Array.from(this._sessions.values()).reduce((count, session) => {
+      if (session.quit)
+        return count;
+      return currentTime - session.timers.ping > PING_TIMEOUT_MS ? count : count + 1;
+    }, 0);
+  }
   register(webSocket, options) {
     return __async(this, null, function* () {
       var _a;
@@ -465,7 +473,7 @@ var IORoom = class {
             senderId: session.id
           });
           uninitializeWs();
-          const size2 = this._getSessionsSize();
+          const size2 = this.getSize();
           this._logDebug(
             `${import_kleur.default.blue(
               `Unregistered connection for room ${this.id}:`
@@ -486,7 +494,7 @@ var IORoom = class {
           `Registered connection for room ${this.id}:`
         )} ${sessionId}`
       );
-      const size = this._getSessionsSize();
+      const size = this.getSize();
       this._logDebug(`${import_kleur.default.blue(`Room ${this.id} size:`)} ${size}`);
     });
   }
@@ -590,14 +598,6 @@ var IORoom = class {
       }
     });
   }
-  _getSessionsSize() {
-    const currentTime = (/* @__PURE__ */ new Date()).getTime();
-    return Array.from(this._sessions.values()).reduce((count, session) => {
-      if (session.quit)
-        return count;
-      return currentTime - session.timers.ping > PING_TIMEOUT_MS ? count : count + 1;
-    }, 0);
-  }
   _getEventConfig(message) {
     var _a;
     return (_a = this._events[message.type]) != null ? _a : null;
@@ -861,8 +861,10 @@ var PluvIO = class {
       })
     );
   }
-  getRoom(room) {
+  getRoom(room, options = {}) {
     var _a;
+    const { debug } = options;
+    this._purgeEmptyRooms();
     if (!/^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$/i.test(room)) {
       throw new Error("Unsupported room name");
     }
@@ -873,7 +875,7 @@ var PluvIO = class {
     const newRoom = new IORoom(room, {
       authorize: (_a = this._authorize) != null ? _a : void 0,
       context: this._context,
-      debug: this._debug,
+      debug: debug != null ? debug : this._debug,
       events: this._events,
       initialStorage: () => {
         var _a2;
@@ -927,6 +929,14 @@ var PluvIO = class {
   _logDebug(...data) {
     this._debug && console.log(...data);
   }
+  _purgeEmptyRooms() {
+    const rooms = Array.from(this._rooms.entries());
+    rooms.forEach(([id, room]) => {
+      if (room.getSize())
+        return;
+      this._rooms.delete(id);
+    });
+  }
 };
 
 // src/createIO.ts

package/dist/index.mjs

@@ -297,6 +297,14 @@ var IORoom = class {
     const message = { type: event, data };
     return Promise.resolve(this._broadcast({ message }));
   }
+  getSize() {
+    const currentTime = (/* @__PURE__ */ new Date()).getTime();
+    return Array.from(this._sessions.values()).reduce((count, session) => {
+      if (session.quit)
+        return count;
+      return currentTime - session.timers.ping > PING_TIMEOUT_MS ? count : count + 1;
+    }, 0);
+  }
   register(webSocket, options) {
     return __async(this, null, function* () {
       var _a;
@@ -428,7 +436,7 @@ var IORoom = class {
             senderId: session.id
           });
           uninitializeWs();
-          const size2 = this._getSessionsSize();
+          const size2 = this.getSize();
           this._logDebug(
             `${colors.blue(
               `Unregistered connection for room ${this.id}:`
@@ -449,7 +457,7 @@ var IORoom = class {
           `Registered connection for room ${this.id}:`
         )} ${sessionId}`
       );
-      const size = this._getSessionsSize();
+      const size = this.getSize();
       this._logDebug(`${colors.blue(`Room ${this.id} size:`)} ${size}`);
     });
   }
@@ -553,14 +561,6 @@ var IORoom = class {
       }
     });
   }
-  _getSessionsSize() {
-    const currentTime = (/* @__PURE__ */ new Date()).getTime();
-    return Array.from(this._sessions.values()).reduce((count, session) => {
-      if (session.quit)
-        return count;
-      return currentTime - session.timers.ping > PING_TIMEOUT_MS ? count : count + 1;
-    }, 0);
-  }
   _getEventConfig(message) {
     var _a;
     return (_a = this._events[message.type]) != null ? _a : null;
@@ -824,8 +824,10 @@ var PluvIO = class {
       })
     );
   }
-  getRoom(room) {
+  getRoom(room, options = {}) {
     var _a;
+    const { debug } = options;
+    this._purgeEmptyRooms();
     if (!/^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$/i.test(room)) {
       throw new Error("Unsupported room name");
     }
@@ -836,7 +838,7 @@ var PluvIO = class {
     const newRoom = new IORoom(room, {
       authorize: (_a = this._authorize) != null ? _a : void 0,
       context: this._context,
-      debug: this._debug,
+      debug: debug != null ? debug : this._debug,
       events: this._events,
       initialStorage: () => {
         var _a2;
@@ -890,6 +892,14 @@ var PluvIO = class {
   _logDebug(...data) {
     this._debug && console.log(...data);
   }
+  _purgeEmptyRooms() {
+    const rooms = Array.from(this._rooms.entries());
+    rooms.forEach(([id, room]) => {
+      if (room.getSize())
+        return;
+      this._rooms.delete(id);
+    });
+  }
 };
 
 // src/createIO.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pluv/io",
-  "version": "0.3.6",
+  "version": "0.3.8",
   "description": "@pluv/io server-side websocket manager",
   "author": "leedavidcs",
   "license": "MIT",

package/src/IORoom.ts

@@ -126,6 +126,24 @@ export class IORoom<
         return Promise.resolve(this._broadcast({ message }));
     }
 
+    public getSize(): number {
+        const currentTime = new Date().getTime();
+
+        /**
+         * @description Doing this instead of .size because some sessions
+         * in the map can be considered as "omitted".
+         * @author leedavidcs
+         * @date December 21, 2022
+         */
+        return Array.from(this._sessions.values()).reduce((count, session) => {
+            if (session.quit) return count;
+
+            return currentTime - session.timers.ping > PING_TIMEOUT_MS
+                ? count
+                : count + 1;
+        }, 0);
+    }
+
     public async register(
         webSocket: InferWebSocketType<TPlatform>,
         options?: WebsocketRegisterOptions
@@ -285,7 +303,7 @@ export class IORoom<
 
                     uninitializeWs();
 
-                    const size = this._getSessionsSize();
+                    const size = this.getSize();
 
                     this._logDebug(
                         `${colors.blue(
@@ -311,7 +329,7 @@ export class IORoom<
             )} ${sessionId}`
         );
 
-        const size = this._getSessionsSize();
+        const size = this.getSize();
 
         this._logDebug(`${colors.blue(`Room ${this.id} size:`)} ${size}`);
     }
@@ -439,24 +457,6 @@ export class IORoom<
         }
     }
 
-    private _getSessionsSize(): number {
-        const currentTime = new Date().getTime();
-
-        /**
-         * @description Doing this instead of .size because some sessions
-         * in the map can be considered as "omitted".
-         * @author leedavidcs
-         * @date December 21, 2022
-         */
-        return Array.from(this._sessions.values()).reduce((count, session) => {
-            if (session.quit) return count;
-
-            return currentTime - session.timers.ping > PING_TIMEOUT_MS
-                ? count
-                : count + 1;
-        }, 0);
-    }
-
     private _getEventConfig(
         message: EventMessage<string, any>
     ): InferEventConfig<TContext, TInput, TOutput>[keyof TInput] | null {

package/src/PluvIO.ts

@@ -60,6 +60,10 @@ export type PluvIOConfig<
     platform: TPlatform;
 };
 
+export interface GetRoomOptions {
+    debug?: boolean;
+}
+
 export class PluvIO<
     TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>,
     TAuthorize extends IOAuthorize<any, any> = BaseIOAuthorize,
@@ -253,8 +257,13 @@ export class PluvIO<
     }
 
     public getRoom(
-        room: string
+        room: string,
+        options: GetRoomOptions = {}
     ): IORoom<TPlatform, TAuthorize, TContext, TInput, TOutput> {
+        const { debug } = options;
+
+        this._purgeEmptyRooms();
+
         if (!/^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$/i.test(room)) {
             throw new Error("Unsupported room name");
         }
@@ -273,7 +282,7 @@ export class PluvIO<
         >(room, {
             authorize: this._authorize ?? undefined,
             context: this._context,
-            debug: this._debug,
+            debug: debug ?? this._debug,
             events: this._events,
             initialStorage: () => this._initialStorage?.(room),
             onDestroy: (encodedState) => {
@@ -346,4 +355,14 @@ export class PluvIO<
     private _logDebug(...data: any[]): void {
         this._debug && console.log(...data);
     }
+
+    private _purgeEmptyRooms(): void {
+        const rooms = Array.from(this._rooms.entries());
+
+        rooms.forEach(([id, room]) => {
+            if (room.getSize()) return;
+
+            this._rooms.delete(id);
+        });
+    }
 }

package/src/index.ts

@@ -32,4 +32,4 @@ export type {
 export type { CreateIOParams } from "./createIO";
 export { createIO } from "./createIO";
 export type { IORoom } from "./IORoom";
-export type { InferIORoom, PluvIO } from "./PluvIO";
+export type { GetRoomOptions, InferIORoom, PluvIO } from "./PluvIO";