@pluv/io 0.40.2 → 0.41.0

package/src/PluvServer.ts

@@ -1,6 +1,6 @@
 import type { AbstractCrdtDocFactory } from "@pluv/crdt";
 import { noop } from "@pluv/crdt";
-import type { IOLike, Id, InferIOAuthorize, InferIOAuthorizeUser, JsonObject, Maybe } from "@pluv/types";
+import type { BaseUser, IOLike, Id, InferIOAuthorize, InferIOAuthorizeUser, JsonObject, Maybe } from "@pluv/types";
 import colors from "kleur";
 import type { AbstractPlatform, InferInitContextType, InferRoomContextType } from "./AbstractPlatform";
 import type { IORoomListeners, WebSocketRegisterConfig } from "./IORoom";
@@ -10,7 +10,7 @@ import type { PluvRouterEventConfig } from "./PluvRouter";
 import { PluvRouter } from "./PluvRouter";
 import type { JWTEncodeParams } from "./authorize";
 import { authorize } from "./authorize";
-import { PING_TIMEOUT_MS } from "./constants";
+import { MAX_PRESENCE_SIZE_BYTES, MAX_USER_SIZE_BYTES, PING_TIMEOUT_MS } from "./constants";
 import type {
     BasePluvIOListeners,
     GetInitialStorageFn,
@@ -27,7 +27,7 @@ export type InferIORoom<TServer extends PluvServer<any, any, any, any>> =
         : never;
 
 export type PluvServerConfig<
-    TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>,
+    TPlatform extends AbstractPlatform<any, any> = AbstractPlatform<any, any>,
     TAuthorize extends PluvIOAuthorize<TPlatform, any, InferInitContextType<TPlatform>> | null = any,
     TContext extends Record<string, any> = {},
     TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext> = {},
@@ -42,7 +42,7 @@ export type PluvServerConfig<
 };
 
 type BaseCreateRoomOptions<
-    TPlatform extends AbstractPlatform<any>,
+    TPlatform extends AbstractPlatform<any, any>,
     TAuthorize extends PluvIOAuthorize<TPlatform, any, InferInitContextType<TPlatform>> | null,
     TContext extends Record<string, any>,
     TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext>,
@@ -51,7 +51,7 @@ type BaseCreateRoomOptions<
 };
 
 export type CreateRoomOptions<
-    TPlatform extends AbstractPlatform<any>,
+    TPlatform extends AbstractPlatform<any, any>,
     TAuthorize extends PluvIOAuthorize<TPlatform, any, InferInitContextType<TPlatform>> | null,
     TContext extends Record<string, any>,
     TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext>,
@@ -60,7 +60,7 @@ export type CreateRoomOptions<
     : [Id<BaseCreateRoomOptions<TPlatform, TAuthorize, TContext, TEvents> & InferRoomContextType<TPlatform>>];
 
 export class PluvServer<
-    TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>,
+    TPlatform extends AbstractPlatform<any, any> = AbstractPlatform<any, any>,
     TAuthorize extends PluvIOAuthorize<TPlatform, any, InferInitContextType<TPlatform>> | null = any,
     TContext extends Record<string, any> = {},
     TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext> = {},
@@ -88,12 +88,13 @@ export class PluvServer<
                         user: JsonObject | null;
                     };
                 }>(
-                    (acc, { id, presence, user }) => ({
+                    (acc, { id, presence, timers, user }) => ({
                         ...acc,
                         [id]: {
                             connectionId: id,
                             presence,
                             room,
+                            timers: { presence: timers.presence },
                             user,
                         },
                     }),
@@ -105,6 +106,7 @@ export class PluvServer<
         $initializeSession: this._procedure
             .broadcast((data, { session }) => {
                 const presence = (data as any)?.presence;
+                const timers = session.timers;
 
                 if (!session) return {};
 
@@ -115,6 +117,7 @@ export class PluvServer<
                         connectionId: session.id,
                         user: session.user,
                         presence,
+                        timers: { presence: timers.presence },
                     },
                 };
             })
@@ -161,16 +164,29 @@ export class PluvServer<
 
             return { $pong: {} };
         }),
-        $updatePresence: this._procedure.broadcast((data, { session }) => {
+        $updatePresence: this._procedure.broadcast((data, context) => {
             const presence = (data as any)?.presence;
+            const { session } = context;
 
             if (!session) return {};
 
             const updated = Object.assign(Object.create(null), session.presence, presence);
+            const bytes = new TextEncoder().encode(JSON.stringify(updated)).length;
 
-            session.webSocket.presence = updated;
+            if (bytes > MAX_PRESENCE_SIZE_BYTES) {
+                throw new Error(
+                    `Large presence. Presence must be at most 512 bytes. Current size: ${bytes.toLocaleString()}`,
+                );
+            }
+
+            context.presence = updated;
 
-            return { $presenceUpdated: { presence: updated } };
+            return {
+                $presenceUpdated: {
+                    presence: updated,
+                    timers: { presence: session.timers.presence },
+                },
+            };
         }),
         $updateStorage: this._procedure.broadcast((data, { context, doc, room }) => {
             const origin = (data as any)?.origin as Maybe<string>;
@@ -331,15 +347,26 @@ export class PluvServer<
             throw new Error("IO does not specify authorize during initialization.");
         }
 
+        const ioAuthorize = this._getIOAuthorize(params);
+        const user = params.user as BaseUser;
+        const parsed = !!ioAuthorize ? ioAuthorize.user.parse(user) : user;
+
+        const bytes = new TextEncoder().encode(JSON.stringify(parsed)).length;
+
+        if (bytes > MAX_USER_SIZE_BYTES) {
+            throw new Error(
+                `createToken called with large payload. User must be at most 512 bytes. Current size: ${bytes.toLocaleString()}`,
+            );
+        }
+
         /**
          * !HACK
          * @description Allow the platform to overwrite this behavior as needed. This is introduced
          * to support platformPluv
          * @date December 15, 2024
          */
-        if (this._platform._createToken) return await this._platform._createToken(params);
+        if (this._platform._createToken) return await this._platform._createToken(params as any);
 
-        const ioAuthorize = this._getIOAuthorize(params);
         const secret = ioAuthorize?.secret ?? null;
 
         if (!secret) throw new Error("`authorize` was specified without a valid secret");

package/src/authorize.ts

@@ -15,20 +15,20 @@ export interface JWT<TUser extends BaseUser> {
     user: TUser;
 }
 
-export type JWTEncodeParams<TUser extends BaseUser | null, TPlatform extends AbstractPlatform> = {
+export type JWTEncodeParams<TUser extends BaseUser | null, TPlatform extends AbstractPlatform<any, any>> = {
     maxAge?: number;
     room: string;
     user: TUser extends BaseUser ? TUser : "Error: Cannot create token without authorization!";
 } & InferInitContextType<TPlatform>;
 
 export interface AuthorizeParams {
-    platform: AbstractPlatform;
+    platform: AbstractPlatform<any, any>;
     secret: string;
 }
 
 export interface AuthorizeModule {
     decode: <TUser extends BaseUser>(jwt: string) => Promise<TUser | null>;
-    encode: <TUser extends BaseUser, TPlatform extends AbstractPlatform>(
+    encode: <TUser extends BaseUser, TPlatform extends AbstractPlatform<any, any>>(
         params: JWTEncodeParams<TUser, TPlatform>,
     ) => Promise<string>;
 }
@@ -38,7 +38,7 @@ const now = () => (Date.now() / 1_000) | 0;
 export const authorize = (params: AuthorizeParams) => {
     const { platform, secret } = params;
 
-    const encode = async <TUser extends BaseUser, TPlatform extends AbstractPlatform>(
+    const encode = async <TUser extends BaseUser, TPlatform extends AbstractPlatform<any, any>>(
         encodeParams: JWTEncodeParams<TUser, TPlatform>,
     ): Promise<string> => {
         const { maxAge = DEFAULT_MAX_AGE_MS, room, user } = encodeParams;

package/src/constants.ts

@@ -1 +1,4 @@
+export const GARBAGE_COLLECT_INTERVAL_MS = 60_000;
+export const MAX_PRESENCE_SIZE_BYTES = 512;
+export const MAX_USER_SIZE_BYTES = 512;
 export const PING_TIMEOUT_MS = 30_000;

package/src/types.ts

@@ -23,14 +23,6 @@ import type {
 import type { AbstractWebSocket } from "./AbstractWebSocket";
 import type { PluvRouter, PluvRouterEventConfig } from "./PluvRouter";
 
-declare global {
-    // eslint-disable-next-line no-var
-    var console: {
-        error: (...data: any[]) => void;
-        log: (...data: any[]) => void;
-    };
-}
-
 export type PluvContext<TPlatform extends AbstractPlatform, TContext extends Record<string, any>> =
     | TContext
     | ((params: InferRoomContextType<TPlatform>) => TContext);
@@ -62,9 +54,12 @@ export interface EventResolverContext<
 > {
     context: TContext;
     doc: AbstractCrdtDoc<any>;
+    garbageCollect: () => Promise<void>;
+    presence: JsonObject | null;
     room: string;
     session: TKind extends "sync" ? WebSocketSession<TAuthorize> | null : WebSocketSession<TAuthorize>;
     sessions: readonly WebSocketSession<TAuthorize>[];
+    time: number;
 }
 
 export type SendMessageOptions =
@@ -74,6 +69,7 @@ export type SendMessageOptions =
 
 export interface WebSocketSessionTimers {
     ping: number;
+    presence: number | null;
 }
 
 export interface WebSocketSerializedState {

package/src/version.generated.ts

@@ -1,2 +1,2 @@
 // Generated by genversion.
-export const version = '0.40.2'
+export const version = '0.41.0'

package/tsconfig.json

@@ -1,5 +1,9 @@
 {
 	"extends": "@pluv/tsconfig/library.json",
 	"include": ["next-env.d.ts", "src/*.ts"],
-	"exclude": ["node_modules"]
+	"exclude": ["node_modules"],
+	"compilerOptions": {
+		"lib": ["esnext", "dom"],
+		"types": [],
+	}
 }