@liveblocks/server 1.0.4 → 1.0.5

package/dist/index.cjs

@@ -850,9 +850,11 @@ var InMemoryDriver = class {
     __publicField(this, "_nodes");
     __publicField(this, "_metadb");
     __publicField(this, "_ydb");
+    __publicField(this, "_leasedSessions");
     this._nodes = /* @__PURE__ */ new Map();
     this._metadb = /* @__PURE__ */ new Map();
     this._ydb = /* @__PURE__ */ new Map();
+    this._leasedSessions = /* @__PURE__ */ new Map();
     this._nextActor = _nullishCoalesce(_optionalChain([options, 'optionalAccess', _35 => _35.initialActor]), () => ( -1));
     for (const [key, value] of _nullishCoalesce(_optionalChain([options, 'optionalAccess', _36 => _36.initialNodes]), () => ( []))) {
       this._nodes.set(key, value);
@@ -877,6 +879,18 @@ var InMemoryDriver = class {
   async delete_meta(key) {
     this._metadb.delete(key);
   }
+  async list_leased_sessions() {
+    return this._leasedSessions.entries();
+  }
+  async get_leased_session(sessionId) {
+    return this._leasedSessions.get(sessionId);
+  }
+  async put_leased_session(session) {
+    this._leasedSessions.set(session.sessionId, session);
+  }
+  async delete_leased_session(sessionId) {
+    this._leasedSessions.delete(sessionId);
+  }
   next_actor() {
     return ++this._nextActor;
   }
@@ -1681,6 +1695,10 @@ function makeRoomStateMsg(actor, nonce, scopes, users, publicMeta) {
     meta: _nullishCoalesce(publicMeta, () => ( {}))
   };
 }
+function isLeasedSessionExpired(leasedSession) {
+  const now = Date.now();
+  return now >= leasedSession.updatedAt + leasedSession.ttl;
+}
 
 // src/Room.ts
 var messagesDecoder = _decoders.array.call(void 0, clientMsgDecoder);
@@ -1993,6 +2011,50 @@ var Room = class {
       newSession.markActive(lastActivity);
     }
   }
+  async sendSessionStartMessages(newSession, ticket, ctx, defer = () => {
+    throw new Error(
+      "One of your hook handlers returned a promise, but no side effect collector was provided. Pass a `defer` callback to sendSessionStartMessages() to collect async side effects."
+    );
+  }) {
+    const users = {};
+    for (const session of this.otherSessions(ticket.sessionKey)) {
+      users[session.actor] = {
+        id: session.user.id,
+        info: session.user.info,
+        scopes: session.scopes
+      };
+    }
+    const leasedSessions = await this.listLeasedSessions(
+      ctx,
+      defer
+    );
+    for (const leasedSession of leasedSessions) {
+      users[leasedSession.actorId] = {
+        id: leasedSession.sessionId,
+        info: leasedSession.info,
+        scopes: []
+      };
+    }
+    newSession.send(
+      makeRoomStateMsg(
+        newSession.actor,
+        ticket.sessionKey,
+        // called "nonce" in the protocol
+        newSession.scopes,
+        users,
+        ticket.publicMeta
+      )
+    );
+    for (const leasedSession of leasedSessions) {
+      newSession.send({
+        type: _core.ServerMsgCode.UPDATE_PRESENCE,
+        actor: leasedSession.actorId,
+        targetActor: newSession.actor,
+        // full presence to new user
+        data: leasedSession.presence
+      });
+    }
+  }
   /**
    * Registers a new BrowserSession into the Room server's session list, along with
    * the socket connection to use for that BrowserSession, now that it is known.
@@ -2001,7 +2063,7 @@ var Room = class {
    * - Sends a ROOM_STATE message to the socket.
    * - Broadcasts a USER_JOINED message to all other sessions in the room.
    */
-  startBrowserSession(ticket, socket, ctx, defer = () => {
+  async startBrowserSession(ticket, socket, ctx, defer = () => {
     throw new Error(
       "One of your hook handlers returned a promise, but no side effect collector was provided. Pass a `defer` callback to startBrowserSession() to collect async side effects."
     );
@@ -2021,24 +2083,7 @@ var Room = class {
     }
     const newSession = new BrowserSession(ticket, socket, __privateGet(this, __debug2));
     this.sessions.set(ticket.sessionKey, newSession);
-    const users = {};
-    for (const session of this.otherSessions(ticket.sessionKey)) {
-      users[session.actor] = {
-        id: session.user.id,
-        info: session.user.info,
-        scopes: session.scopes
-      };
-    }
-    newSession.send(
-      makeRoomStateMsg(
-        newSession.actor,
-        ticket.sessionKey,
-        // called "nonce" in the protocol
-        newSession.scopes,
-        users,
-        ticket.publicMeta
-      )
-    );
+    await this.sendSessionStartMessages(newSession, ticket, ctx, defer);
     this.sendToOthers(
       ticket.sessionKey,
       {
@@ -2191,7 +2236,136 @@ var Room = class {
     return Array.from(this.sessions.values());
   }
   /**
-   * Will send the given ServerMsg to all Sessions, except the Session
+   * Upsert a leased session. Creates a new session if it doesn't exist (or is expired),
+   * or updates an existing session with merged presence.
+   */
+  async upsertLeasedSession(sessionId, presence, ttl, info, ctx, defer = () => {
+    throw new Error(
+      "One of your hook handlers returned a promise, but no side effect collector was provided. Pass a `defer` callback to upsertLeasedSession() to collect async side effects."
+    );
+  }) {
+    const existingSession = await this.driver.get_leased_session(sessionId);
+    const isExpired = existingSession !== void 0 && isLeasedSessionExpired(existingSession);
+    if (isExpired) {
+      await this.deleteLeasedSession(existingSession, ctx, defer);
+    }
+    if (existingSession === void 0 || isExpired) {
+      const actorId = await this.getNextActor();
+      const now = Date.now();
+      const session = {
+        sessionId,
+        presence,
+        updatedAt: now,
+        info,
+        ttl,
+        actorId
+      };
+      await this.driver.put_leased_session(session);
+      this.sendToAll(
+        {
+          type: _core.ServerMsgCode.USER_JOINED,
+          actor: actorId,
+          id: sessionId,
+          info,
+          scopes: []
+        },
+        ctx,
+        defer
+      );
+      this.sendToAll(
+        {
+          type: _core.ServerMsgCode.UPDATE_PRESENCE,
+          actor: actorId,
+          data: presence,
+          targetActor: 1
+        },
+        ctx,
+        defer
+      );
+    } else {
+      const mergedPresence = {
+        ...existingSession.presence,
+        ...presence
+      };
+      const updatedSession = {
+        ...existingSession,
+        //info, UserInfo is immutable after creation
+        presence: mergedPresence,
+        updatedAt: Date.now(),
+        ttl
+      };
+      await this.driver.put_leased_session(updatedSession);
+      this.sendToAll(
+        {
+          type: _core.ServerMsgCode.UPDATE_PRESENCE,
+          actor: existingSession.actorId,
+          data: presence
+          // Send only the patch, not the full merged presence
+          // NO targetActor - this makes it a partial presence patch
+        },
+        ctx,
+        defer
+      );
+    }
+  }
+  /**
+   * List all server sessions. As a side effect, it will delete expired sessions.
+   */
+  async listLeasedSessions(ctx, defer = () => {
+    throw new Error(
+      "One of your hook handlers returned a promise, but no side effect collector was provided. Pass a `defer` callback to listLeasedSessions() to collect async side effects."
+    );
+  }) {
+    await this.load(ctx);
+    const sessions = await this.driver.list_leased_sessions();
+    const validSessions = [];
+    const toDelete = [];
+    for (const [_, session] of sessions) {
+      if (isLeasedSessionExpired(session)) {
+        toDelete.push(session);
+      } else {
+        validSessions.push(session);
+      }
+    }
+    for (const session of toDelete) {
+      await this.deleteLeasedSession(session, ctx, defer);
+    }
+    return validSessions;
+  }
+  /**
+   * Delete a server session and broadcast USER_LEFT to all sessions.
+   */
+  async deleteLeasedSession(session, ctx, defer = () => {
+    throw new Error(
+      "One of your hook handlers returned a promise, but no side effect collector was provided. Pass a `defer` callback to deleteLeasedSession() to collect async side effects."
+    );
+  }) {
+    this.sendToAll(
+      {
+        type: _core.ServerMsgCode.USER_LEFT,
+        actor: session.actorId
+      },
+      ctx,
+      defer
+    );
+    await this.driver.delete_leased_session(session.sessionId);
+  }
+  /**
+   * Delete all server sessions and broadcast USER_LEFT to all sessions.
+   */
+  async deleteAllLeasedSessions(ctx, defer = () => {
+    throw new Error(
+      "One of your hook handlers returned a promise, but no side effect collector was provided. Pass a `defer` callback to deleteAllLeasedSessions() to collect async side effects."
+    );
+  }) {
+    await this.load(ctx);
+    const sessions = await this.driver.list_leased_sessions();
+    for (const [_, session] of sessions) {
+      await this.deleteLeasedSession(session, ctx, defer);
+    }
+  }
+  /**
+   * Will send the given ServerMsg through all Session, except the Session
    * where the message originates from.
    */
   sendToOthers(sender, serverMsg, ctx, defer = () => {
@@ -2572,5 +2746,6 @@ __allowStreaming = new WeakMap();
 
 
 
-exports.BackendSession = BackendSession; exports.BrowserSession = BrowserSession; exports.ConsoleTarget = ConsoleTarget; exports.DefaultMap = DefaultMap; exports.InMemoryDriver = InMemoryDriver; exports.LogLevel = LogLevel; exports.LogTarget = LogTarget; exports.Logger = Logger; exports.NestedMap = NestedMap; exports.ProtocolVersion = ProtocolVersion; exports.ROOT_YDOC_ID = ROOT_YDOC_ID; exports.Room = Room; exports.UniqueMap = UniqueMap; exports.ackIgnoredOp = ackIgnoredOp; exports.clientMsgDecoder = clientMsgDecoder; exports.concatUint8Arrays = concatUint8Arrays; exports.guidDecoder = guidDecoder; exports.jsonObjectYolo = jsonObjectYolo; exports.jsonYolo = jsonYolo; exports.makeInMemorySnapshot = makeInMemorySnapshot; exports.makeMetadataDB = makeMetadataDB; exports.plainLsonToNodeStream = plainLsonToNodeStream; exports.protocolVersionDecoder = protocolVersionDecoder; exports.quote = quote; exports.serializeServerMsg = serialize; exports.snapshotToLossyJson_eager = snapshotToLossyJson_eager; exports.snapshotToLossyJson_lazy = snapshotToLossyJson_lazy; exports.snapshotToNodeStream = snapshotToNodeStream; exports.snapshotToPlainLson_eager = snapshotToPlainLson_eager; exports.snapshotToPlainLson_lazy = snapshotToPlainLson_lazy; exports.test_only__Storage = Storage; exports.test_only__YjsStorage = YjsStorage; exports.transientClientMsgDecoder = transientClientMsgDecoder; exports.tryCatch = tryCatch;
+
+exports.BackendSession = BackendSession; exports.BrowserSession = BrowserSession; exports.ConsoleTarget = ConsoleTarget; exports.DefaultMap = DefaultMap; exports.InMemoryDriver = InMemoryDriver; exports.LogLevel = LogLevel; exports.LogTarget = LogTarget; exports.Logger = Logger; exports.NestedMap = NestedMap; exports.ProtocolVersion = ProtocolVersion; exports.ROOT_YDOC_ID = ROOT_YDOC_ID; exports.Room = Room; exports.UniqueMap = UniqueMap; exports.ackIgnoredOp = ackIgnoredOp; exports.clientMsgDecoder = clientMsgDecoder; exports.concatUint8Arrays = concatUint8Arrays; exports.guidDecoder = guidDecoder; exports.isLeasedSessionExpired = isLeasedSessionExpired; exports.jsonObjectYolo = jsonObjectYolo; exports.jsonYolo = jsonYolo; exports.makeInMemorySnapshot = makeInMemorySnapshot; exports.makeMetadataDB = makeMetadataDB; exports.plainLsonToNodeStream = plainLsonToNodeStream; exports.protocolVersionDecoder = protocolVersionDecoder; exports.quote = quote; exports.serializeServerMsg = serialize; exports.snapshotToLossyJson_eager = snapshotToLossyJson_eager; exports.snapshotToLossyJson_lazy = snapshotToLossyJson_lazy; exports.snapshotToNodeStream = snapshotToNodeStream; exports.snapshotToPlainLson_eager = snapshotToPlainLson_eager; exports.snapshotToPlainLson_lazy = snapshotToPlainLson_lazy; exports.test_only__Storage = Storage; exports.test_only__YjsStorage = YjsStorage; exports.transientClientMsgDecoder = transientClientMsgDecoder; exports.tryCatch = tryCatch;
 //# sourceMappingURL=index.cjs.map