@pluv/io 1.0.0 → 1.0.2

package/src/PluvServer.ts

@@ -1,8 +1,19 @@
 import type { AbstractCrdtDocFactory } from "@pluv/crdt";
 import { noop } from "@pluv/crdt";
-import type { IOLike, Id, InferIOAuthorize, InferIOAuthorizeUser, JsonObject, Maybe } from "@pluv/types";
+import type {
+    IOLike,
+    Id,
+    InferIOAuthorize,
+    InferIOAuthorizeUser,
+    JsonObject,
+    Maybe,
+} from "@pluv/types";
 import colors from "kleur";
-import type { AbstractPlatform, InferInitContextType, InferRoomContextType } from "./AbstractPlatform";
+import type {
+    AbstractPlatform,
+    InferInitContextType,
+    InferRoomContextType,
+} from "./AbstractPlatform";
 import type { IORoomListeners } from "./IORoom";
 import { IORoom } from "./IORoom";
 import type { PluvIO } from "./PluvIO";
@@ -29,7 +40,11 @@ export type InferIORoom<TServer extends PluvServer<any, any, any, any>> =
 
 export type PluvServerConfig<
     TPlatform extends AbstractPlatform<any, any> = AbstractPlatform<any, any>,
-    TAuthorize extends PluvIOAuthorize<TPlatform, any, InferInitContextType<TPlatform>> | null = any,
+    TAuthorize extends PluvIOAuthorize<
+        TPlatform,
+        any,
+        InferInitContextType<TPlatform>
+    > | null = any,
     TContext extends Record<string, any> = {},
     TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext> = {},
 > = Partial<PluvIOListeners<TPlatform, TAuthorize, TContext, TEvents>> & {
@@ -60,11 +75,20 @@ export type CreateRoomOptions<
     TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext>,
 > = keyof InferRoomContextType<TPlatform> extends never
     ? [BaseCreateRoomOptions<TPlatform, TAuthorize, TContext, TEvents>] | []
-    : [Id<BaseCreateRoomOptions<TPlatform, TAuthorize, TContext, TEvents> & InferRoomContextType<TPlatform>>];
+    : [
+          Id<
+              BaseCreateRoomOptions<TPlatform, TAuthorize, TContext, TEvents> &
+                  InferRoomContextType<TPlatform>
+          >,
+      ];
 
 export class PluvServer<
     TPlatform extends AbstractPlatform<any, any> = AbstractPlatform<any, any>,
-    TAuthorize extends PluvIOAuthorize<TPlatform, any, InferInitContextType<TPlatform>> | null = any,
+    TAuthorize extends PluvIOAuthorize<
+        TPlatform,
+        any,
+        InferInitContextType<TPlatform>
+    > | null = any,
     TContext extends Record<string, any> = {},
     TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext> = {},
 > implements IOLike<TAuthorize, TEvents>
@@ -126,17 +150,56 @@ export class PluvServer<
             })
             .self(async (data, { context, doc, room, session }) => {
                 const oldState = await this._platform.persistence.getStorageState(room);
+                /**
+                 * !HACK
+                 * @description This is the frontend's initialStorage. We only want to
+                 * apply this if the server's storage is empty (i.e. no initial storage
+                 * has been applied)
+                 */
                 const update = (data as any)?.update as Maybe<string>;
 
-                const updates: readonly Maybe<string>[] = [
-                    oldState ? null : await this._getInitialStorage?.({ context, room }),
-                    update,
-                ];
+                if (!oldState) {
+                    const loadedState = await this._getInitialStorage?.({ context, room });
+
+                    if (!!loadedState) {
+                        doc.applyEncodedState({ update: loadedState }).getEncodedState();
+                    }
+                }
+
+                /**
+                 * @description Storage was already initialized. Don't overwrite the current
+                 * storage state with the incoming initial storage. Return what the current state
+                 * is without changes.
+                 * @date May 7, 2025
+                 */
+                if (!doc.isEmpty()) {
+                    const encodedState = doc.getEncodedState();
 
-                if (updates.some((_update) => !!_update)) {
-                    const encodedState = doc.batchApplyEncodedState({ updates }).getEncodedState();
+                    return { $storageReceived: { changeKind: "unchanged", state: encodedState } };
+                }
 
-                    await this._platform.persistence.setStorageState(room, encodedState);
+                /**
+                 * @description Storage was never initialized, and there is an incoming
+                 * initialStorage from the client. Apply the initialStorage and persist the state
+                 * as an update.
+                 * @date May 7, 2025
+                 */
+                if (!!update) {
+                    const encodedState = doc.applyEncodedState({ update }).getEncodedState();
+                    const storageSize = new TextEncoder().encode(encodedState).length;
+
+                    if (
+                        !!this._limits.storageMaxSize &&
+                        storageSize > this._limits.storageMaxSize
+                    ) {
+                        throw new Error("Storage has exceeded the size limit");
+                    }
+
+                    await this._platform.persistence
+                        .setStorageState(room, encodedState)
+                        .catch((error) => {
+                            this._logDebug(error);
+                        });
 
                     this._getListeners().onStorageUpdated({
                         context,
@@ -145,16 +208,13 @@ export class PluvServer<
                         user: session?.user,
                         webSocket: session?.webSocket.webSocket,
                     });
-                }
-
-                const encodedState = (await this._platform.persistence.getStorageState(room)) ?? doc.getEncodedState();
-                const storageSize = new TextEncoder().encode(encodedState).length;
 
-                if (!!this._limits.storageMaxSize && storageSize > this._limits.storageMaxSize) {
-                    throw new Error("Storage has exceeded the size limit");
+                    return { $storageReceived: { changeKind: "initialized", state: encodedState } };
                 }
 
-                return { $storageReceived: { state: encodedState } };
+                const encodedState = doc.getEncodedState();
+
+                return { $storageReceived: { changeKind: "empty", state: encodedState } };
             }),
         $ping: this._procedure.self((data, { session }) => {
             if (!session) return {};
@@ -222,7 +282,10 @@ export class PluvServer<
             return { $storageUpdated: { state: encodedState } };
         }),
     });
-    private readonly _context: PluvContext<TPlatform, TContext> = {} as PluvContext<TPlatform, TContext>;
+    private readonly _context: PluvContext<TPlatform, TContext> = {} as PluvContext<
+        TPlatform,
+        TContext
+    >;
     private readonly _crdt: { doc: (value: any) => AbstractCrdtDocFactory<any> };
     private readonly _debug: boolean;
     private readonly _getInitialStorage: GetInitialStorageFn<TContext> | null = null;
@@ -233,7 +296,8 @@ export class PluvServer<
 
     public get fetch(): (...args: any[]) => Promise<any> {
         return ((...args: any[]): Promise<any> => {
-            if (!this._platform._fetch) throw new Error(`\`${this._platform._name}\` does not support \`fetch\``);
+            if (!this._platform._fetch)
+                throw new Error(`\`${this._platform._name}\` does not support \`fetch\``);
 
             return this._platform._fetch(...args);
         }) as NonNullable<typeof this._platform._fetch>;
@@ -275,8 +339,13 @@ export class PluvServer<
             router = new PluvRouter<TPlatform, TAuthorize, TContext, TEvents>({} as TEvents),
         } = options;
 
-        const { onRoomDeleted, onRoomMessage, onStorageUpdated, onUserConnected, onUserDisconnected } =
-            options as Partial<BasePluvIOListeners<TPlatform, TAuthorize, TContext, TEvents>>;
+        const {
+            onRoomDeleted,
+            onRoomMessage,
+            onStorageUpdated,
+            onUserConnected,
+            onUserDisconnected,
+        } = options as Partial<BasePluvIOListeners<TPlatform, TAuthorize, TContext, TEvents>>;
 
         platform.validateConfig(options);
 
@@ -285,12 +354,9 @@ export class PluvServer<
         this._io = io;
         this._limits = limits;
         this._platform = platform;
-        this._router = (router ? PluvRouter.merge(this._baseRouter, router) : this._baseRouter) as PluvRouter<
-            TPlatform,
-            TAuthorize,
-            TContext,
-            TEvents
-        >;
+        this._router = (
+            router ? PluvRouter.merge(this._baseRouter, router) : this._baseRouter
+        ) as PluvRouter<TPlatform, TAuthorize, TContext, TEvents>;
 
         if (authorize) this._authorize = authorize;
         if (context) this._context = context;
@@ -309,21 +375,19 @@ export class PluvServer<
         room: string,
         ...options: CreateRoomOptions<TPlatform, TAuthorize, TContext, TEvents>
     ): IORoom<TPlatform, TAuthorize, TContext, TEvents> {
-        const { _meta, debug, onDestroy, onMessage, ...platformRoomContext } = (options[0] ?? {}) as CreateRoomOptions<
-            TPlatform,
-            TAuthorize,
-            TContext,
-            TEvents
-        >[0] & { _meta?: any };
+        const { _meta, debug, onDestroy, onMessage, ...platformRoomContext } = (options[0] ??
+            {}) as CreateRoomOptions<TPlatform, TAuthorize, TContext, TEvents>[0] & { _meta?: any };
 
         if (this._platform._config.handleMode !== "io") {
             throw new Error(`\`createRoom\` is unsupported for \`${this._platform._name}\``);
         }
 
-        if (!/^[a-z0-9](?:[a-z0-9-_]*[a-z0-9])?$/i.test(room)) throw new Error("Unsupported room name");
+        if (!/^[a-z0-9](?:[a-z0-9-_]*[a-z0-9])?$/i.test(room))
+            throw new Error("Unsupported room name");
 
         const roomContext = platformRoomContext as InferRoomContextType<TPlatform>;
-        const context: TContext = typeof this._context === "function" ? this._context(roomContext) : this._context;
+        const context: TContext =
+            typeof this._context === "function" ? this._context(roomContext) : this._context;
 
         const newRoom = new IORoom<TPlatform, TAuthorize, TContext, TEvents>(room, {
             ...(!!_meta ? { _meta } : {}),

package/src/PubSub.ts

@@ -20,7 +20,10 @@ export class PubSub extends AbstractPubSub {
         Promise.resolve(subject.next(payload));
     }
 
-    public subscribe(roomName: string, onMessage: (message: IOPubSubEventMessage<any>) => void): Promise<number> {
+    public subscribe(
+        roomName: string,
+        onMessage: (message: IOPubSubEventMessage<any>) => void,
+    ): Promise<number> {
         const id = this._currentSubscriptionId++;
         const refs = this._subscriptionsRefs.get(roomName) ?? [];
 

package/src/authorize.ts

@@ -15,7 +15,10 @@ export interface JWT<TUser extends BaseUser> {
     user: TUser;
 }
 
-export type JWTEncodeParams<TUser extends BaseUser | null, TPlatform extends AbstractPlatform<any, any>> = {
+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!";

package/src/createIO.ts

@@ -22,10 +22,18 @@ export const createIO = <
     TUser extends BaseUser | null = null,
 >(
     params: CreateIOParams<TPlatform, TContext, TUser>,
-): PluvIO<TPlatform, PluvIOAuthorize<TPlatform, TUser, InferInitContextType<TPlatform>>, TContext> => {
+): PluvIO<
+    TPlatform,
+    PluvIOAuthorize<TPlatform, TUser, InferInitContextType<TPlatform>>,
+    TContext
+> => {
     const { authorize, context, crdt, debug, limits, platform } = params;
 
-    return new PluvIO<TPlatform, PluvIOAuthorize<TPlatform, TUser, InferInitContextType<TPlatform>>, TContext>({
+    return new PluvIO<
+        TPlatform,
+        PluvIOAuthorize<TPlatform, TUser, InferInitContextType<TPlatform>>,
+        TContext
+    >({
         authorize,
         context,
         crdt,

package/src/types.ts

@@ -57,7 +57,9 @@ export interface EventResolverContext<
     garbageCollect: () => Promise<void>;
     presence: JsonObject | null;
     room: string;
-    session: TKind extends "sync" ? WebSocketSession<TAuthorize> | null : WebSocketSession<TAuthorize>;
+    session: TKind extends "sync"
+        ? WebSocketSession<TAuthorize> | null
+        : WebSocketSession<TAuthorize>;
     sessions: readonly WebSocketSession<TAuthorize>[];
     time: number;
 }
@@ -79,11 +81,12 @@ export interface WebSocketSerializedState {
     timers: WebSocketSessionTimers;
 }
 
-export type WebSocketSession<TAuthorize extends IOAuthorize<any, any> | null = null> = WebSocketSerializedState & {
-    id: string;
-    user: InferIOAuthorizeUser<TAuthorize>;
-    webSocket: AbstractWebSocket;
-};
+export type WebSocketSession<TAuthorize extends IOAuthorize<any, any> | null = null> =
+    WebSocketSerializedState & {
+        id: string;
+        user: InferIOAuthorizeUser<TAuthorize>;
+        webSocket: AbstractWebSocket;
+    };
 
 export type MergeEventRecords<
     TEventRecords extends EventRecord<string, any>[],
@@ -143,7 +146,9 @@ export type PluvIOAuthorize<
     TContext extends Record<string, unknown> = {},
 > =
     | (TUser extends BaseUser ? ResolvedPluvIOAuthorize<TPlatform, TUser> : null)
-    | ((context: TContext) => TUser extends BaseUser ? ResolvedPluvIOAuthorize<TPlatform, TUser> : null);
+    | ((
+          context: TContext,
+      ) => TUser extends BaseUser ? ResolvedPluvIOAuthorize<TPlatform, TUser> : null);
 
 export interface PluvIOLimits {
     /**
@@ -184,7 +189,10 @@ export type PluvIOListeners<
     TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext>,
 > = UndefinedProps<
     BasePluvIOListeners<TPlatform, TAuthorize, TContext, TEvents>,
-    Exclude<keyof BasePluvIOListeners<TPlatform, TAuthorize, TContext, TEvents>, InferPlatformListeners<TPlatform>>
+    Exclude<
+        keyof BasePluvIOListeners<TPlatform, TAuthorize, TContext, TEvents>,
+        InferPlatformListeners<TPlatform>
+    >
 >;
 
 export type PluvIORouter<
@@ -200,14 +208,20 @@ export type PluvIORouter<
 export type InferPlatformConfig<TPlatform extends AbstractPlatform<any, any, any, any>> =
     TPlatform extends AbstractPlatform<any, any, any, infer IConfig> ? IConfig : never;
 
-export type InferPlatformAuthorizeProperties<TPlatform extends AbstractPlatform<any, any, any, any>> = keyof {
-    [P in keyof PlatformConfig["authorize"] as InferPlatformConfig<TPlatform>["authorize"][P] extends true | undefined
+export type InferPlatformAuthorizeProperties<
+    TPlatform extends AbstractPlatform<any, any, any, any>,
+> = keyof {
+    [P in keyof PlatformConfig["authorize"] as InferPlatformConfig<TPlatform>["authorize"][P] extends
+        | true
+        | undefined
         ? P
         : never]: true;
 };
 
 export type InferPlatformListeners<TPlatform extends AbstractPlatform<any, any, any, any>> = keyof {
-    [P in keyof PlatformConfig["listeners"] as InferPlatformConfig<TPlatform>["listeners"][P] extends true | undefined
+    [P in keyof PlatformConfig["listeners"] as InferPlatformConfig<TPlatform>["listeners"][P] extends
+        | true
+        | undefined
         ? P
         : never]: true;
 };

package/src/utils/pickBy.ts

@@ -1,4 +1,7 @@
-export const pickBy = <T extends Record<string, any>>(obj: T, by: (value: T[keyof T]) => boolean): Partial<T> => {
+export const pickBy = <T extends Record<string, any>>(
+    obj: T,
+    by: (value: T[keyof T]) => boolean,
+): Partial<T> => {
     const result: Partial<T> = {};
     const keys: (keyof T)[] = Object.keys(obj);
 

package/src/version.generated.ts

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