@tldraw/sync-core 5.5.0-next.f9308d324e1c → 5.6.0-canary.5bfc37740468

package/dist-esm/lib/TLSyncRoom.mjs

@@ -37,6 +37,23 @@ import {
 } from "./TLSyncStorage.mjs";
 const DATA_MESSAGE_DEBOUNCE_INTERVAL = 1e3 / 60;
 const timeSince = (time) => Date.now() - time;
+const MAX_CLOSE_REASON_BYTES = 123;
+const closeReasonEncoder = new TextEncoder();
+const truncatedSuffix = (droppedBytes) => `... (+${droppedBytes} bytes)`;
+function truncateCloseReason(reason) {
+  const totalBytes = closeReasonEncoder.encode(reason).length;
+  if (totalBytes <= MAX_CLOSE_REASON_BYTES) return reason;
+  const budget = MAX_CLOSE_REASON_BYTES - truncatedSuffix(totalBytes).length;
+  let out = "";
+  let outBytes = 0;
+  for (const char of reason) {
+    const charBytes = closeReasonEncoder.encode(char).length;
+    if (outBytes + charBytes > budget) break;
+    out += char;
+    outBytes += charBytes;
+  }
+  return out + truncatedSuffix(totalBytes - outBytes);
+}
 class TLSyncRoom {
   // A table of connected clients
   sessions = /* @__PURE__ */ new Map();
@@ -81,7 +98,7 @@ class TLSyncRoom {
     }
   }, 1e3);
   scheduleFollowUpPrune() {
-    if (this.pruneTimer) return;
+    if (this._isClosed || this.pruneTimer) return;
     this.pruneTimer = setTimeout(this.pruneSessions, SESSION_REMOVAL_WAIT_TIME + 100);
   }
   presenceStore = new PresenceStore();
@@ -92,11 +109,23 @@ class TLSyncRoom {
    * and stops background processes.
    */
   close() {
+    this._isClosed = true;
     this.disposables.forEach((d) => d());
     this.sessions.forEach((session) => {
-      session.socket.close();
+      this.clearDebounceTimer(session);
+      try {
+        session.socket.close();
+      } catch {
+      }
     });
-    this._isClosed = true;
+    this.sessions.clear();
+  }
+  clearDebounceTimer(session) {
+    if (session.state === RoomSessionState.Connected && session.debounceTimer !== null) {
+      clearTimeout(session.debounceTimer);
+      session.debounceTimer = null;
+      session.outstandingDataMessages = [];
+    }
   }
   /**
    * Check if the room has been closed and is no longer accepting connections.
@@ -257,6 +286,10 @@ class TLSyncRoom {
     if (session.outstandingDataMessages.length > 0) {
       const data = session.outstandingDataMessages;
       session.outstandingDataMessages = [];
+      if (!session.socket.isOpen) {
+        this.cancelSession(sessionId);
+        return;
+      }
       session.socket.sendMessage({ type: "data", data });
     }
   }
@@ -268,9 +301,10 @@ class TLSyncRoom {
       return;
     }
     this.sessions.delete(sessionId);
+    this.clearDebounceTimer(session);
     try {
       if (fatalReason) {
-        session.socket.close(TLSyncErrorCloseEventCode, fatalReason);
+        session.socket.close(TLSyncErrorCloseEventCode, truncateCloseReason(fatalReason));
       } else {
         session.socket.close();
       }
@@ -298,6 +332,7 @@ class TLSyncRoom {
       this.log?.warn?.("Tried to cancel session that is already awaiting removal");
       return;
     }
+    this.clearDebounceTimer(session);
     this.sessions.set(sessionId, {
       state: RoomSessionState.AwaitingRemoval,
       sessionId,
@@ -326,8 +361,8 @@ class TLSyncRoom {
    * @param sourceSessionId - Optional session ID to exclude from the broadcast
    */
   broadcastPatch(diff, networkDiff, sourceSessionId) {
-    const unmigrated = networkDiff ?? toNetworkDiff(diff);
-    if (!unmigrated) return this;
+    const legacyAppendMode = !this.getCanEmitStringAppend();
+    const unmigrated = networkDiff ?? toNetworkDiff(diff, legacyAppendMode);
     this.sessions.forEach((session) => {
       if (session.state !== RoomSessionState.Connected) return;
       if (sourceSessionId === session.sessionId) return;
@@ -339,7 +374,9 @@ class TLSyncRoom {
         session.sessionId,
         session.serializedSchema,
         session.requiresDownMigrations,
-        diff
+        diff,
+        unmigrated,
+        legacyAppendMode
       );
       if (!diffResult.ok) return;
       this._unsafe_sendMessage(session.sessionId, {
@@ -399,7 +436,12 @@ class TLSyncRoom {
    */
   handleNewSession(opts) {
     const { sessionId, socket, meta, isReadonly, objectAccess } = opts;
+    if (this._isClosed) {
+      socket.close();
+      return this;
+    }
     const existing = this.sessions.get(sessionId);
+    if (existing) this.clearDebounceTimer(existing);
     this.sessions.set(sessionId, {
       state: RoomSessionState.AwaitingConnectMessage,
       sessionId,
@@ -435,6 +477,10 @@ class TLSyncRoom {
       requiresLegacyRejection,
       supportsStringAppend
     } = opts;
+    if (this._isClosed) {
+      socket.close();
+      return;
+    }
     const migrations = this.schema.getMigrationsSince(serializedSchema);
     const requiresDownMigrations = migrations.ok ? migrations.value.length > 0 : false;
     this.sessions.set(sessionId, {
@@ -456,6 +502,14 @@ class TLSyncRoom {
     if (presenceRecord && presenceId) {
       this.presenceStore.set(presenceId, presenceRecord);
     }
+    if (!migrations.ok) {
+      this.rejectSession(sessionId, this.getVersionMismatchReason(serializedSchema));
+      return;
+    }
+    if (migrations.value.some((m) => m.scope !== "record" || !m.down)) {
+      this.rejectSession(sessionId, TLSyncErrorCloseEventReason.CLIENT_TOO_OLD);
+      return;
+    }
   }
   /**
    * Checks if all connected sessions support string append operations (protocol version 8+).
@@ -488,11 +542,12 @@ class TLSyncRoom {
    * @param requiresDownMigrations - Whether the client needs down migrations
    * @param diff - The TLSyncForwardDiff containing full records to migrate
    * @param unmigrated - Optional pre-computed NetworkDiff for when no migration is needed
+   * @param legacyAppendMode - Emit string appends as puts (SES5); defaults to the room-wide state
    * @returns A NetworkDiff with migrated records, or a migration failure
    */
-  migrateDiffOrRejectSession(sessionId, serializedSchema, requiresDownMigrations, diff, unmigrated) {
+  migrateDiffOrRejectSession(sessionId, serializedSchema, requiresDownMigrations, diff, unmigrated, legacyAppendMode = !this.getCanEmitStringAppend()) {
     if (!requiresDownMigrations) {
-      return Result.ok(unmigrated ?? toNetworkDiff(diff) ?? {});
+      return Result.ok(unmigrated ?? toNetworkDiff(diff, legacyAppendMode));
     }
     const result = {};
     for (const [id, put] of objectMapEntriesIterable(diff.puts)) {
@@ -508,7 +563,7 @@ class TLSyncRoom {
           this.rejectSession(sessionId, TLSyncErrorCloseEventReason.CLIENT_TOO_OLD);
           return Result.err(toResult.reason);
         }
-        const patch = diffRecord(fromResult.value, toResult.value);
+        const patch = diffRecord(fromResult.value, toResult.value, legacyAppendMode);
         if (patch) {
           result[id] = [RecordOpType.Patch, patch];
         }
@@ -578,7 +633,8 @@ class TLSyncRoom {
    * Sends appropriate error messages before closing the connection.
    *
    * @param sessionId - The session to reject
-   * @param fatalReason - The reason for rejection (optional)
+   * @param fatalReason - The reason for rejection (optional). WebSocket close reasons are capped
+   * at 123 UTF-8 bytes, so a longer reason is truncated and ends with `... (+N bytes)`.
    * @example
    * ```ts
    * // Reject due to version mismatch
@@ -628,6 +684,7 @@ class TLSyncRoom {
   }
   forceAllReconnect() {
     for (const session of this.sessions.values()) {
+      if (session.state !== RoomSessionState.Connected) continue;
       this.removeSession(session.sessionId);
     }
   }
@@ -651,7 +708,8 @@ class TLSyncRoom {
     if (theirSchema.schemaVersion > ourSchema.schemaVersion) {
       return TLSyncErrorCloseEventReason.SERVER_TOO_OLD;
     }
-    if (theirSchema.schemaVersion === 2 && ourSchema.schemaVersion === 2) {
+    if (theirSchema.schemaVersion === 2 && ourSchema.schemaVersion === 2 && // a malformed client schema must reject the session, not throw
+    typeof theirSchema.sequences === "object" && theirSchema.sequences !== null) {
       for (const [sequenceId, theirVersion] of Object.entries(theirSchema.sequences)) {
         const ourVersion = ourSchema.sequences[sequenceId];
         if (ourVersion === void 0 || theirVersion > ourVersion) {
@@ -696,7 +754,7 @@ class TLSyncRoom {
     }
     const sessionSchema = isEqual(message.schema, this.serializedSchema) ? this.serializedSchema : message.schema;
     const requiresDownMigrations = migrations.value.length > 0;
-    const connect = async (msg) => {
+    const connect = (msg) => {
       this.sessions.set(session.sessionId, {
         state: RoomSessionState.Connected,
         sessionId: session.sessionId,
@@ -804,7 +862,7 @@ class TLSyncRoom {
       }
       if (doc) {
         const recordType = assertExists(getOwnProperty(this.schema.types, doc.typeName));
-        const diff = diffAndValidateRecord(doc, state, recordType);
+        const diff = diffAndValidateRecord(doc, state, recordType, legacyAppendMode);
         if (diff) {
           storage.set(id, state);
           propagateOp(changes2, id, [RecordOpType.Patch, diff], doc, state);
@@ -876,6 +934,7 @@ class TLSyncRoom {
           }
         }
         const canWrite = (typeName) => !session || (this.objectTypes.has(typeName) ? session.objectAccess !== "read" : !session.isReadonly);
+        const authSession = session ? { sessionId: session.sessionId, isReadonly: session.isReadonly, meta: session.meta } : null;
         if (message.diff) {
           for (const [id, op] of objectMapEntriesIterable(message.diff)) {
             switch (op[0]) {
@@ -905,25 +964,7 @@ class TLSyncRoom {
                   if (authorizePut) {
                     authorize = (prevRec, next) => {
                       const result2 = authorizePut(
-                        prevRec ? {
-                          session: {
-                            sessionId: session.sessionId,
-                            isReadonly: session.isReadonly,
-                            meta: session.meta
-                          },
-                          type: "update",
-                          prev: prevRec,
-                          next
-                        } : {
-                          session: {
-                            sessionId: session.sessionId,
-                            isReadonly: session.isReadonly,
-                            meta: session.meta
-                          },
-                          type: "create",
-                          prev: null,
-                          next
-                        }
+                        prevRec ? { session: authSession, type: "update", prev: prevRec, next } : { session: authSession, type: "create", prev: null, next }
                       );
                       if (!result2) {
                         this.log?.warn?.(
@@ -949,11 +990,7 @@ class TLSyncRoom {
                 const authorizePatch = session && this.authorizerFor(doc.typeName);
                 const authorize = authorizePatch ? (prev, next) => {
                   const result2 = authorizePatch({
-                    session: {
-                      sessionId: session.sessionId,
-                      isReadonly: session.isReadonly,
-                      meta: session.meta
-                    },
+                    session: authSession,
                     type: "update",
                     prev,
                     next
@@ -979,16 +1016,7 @@ class TLSyncRoom {
                 }
                 if (!canWrite(doc.typeName)) continue;
                 const authorizeRemove = session && this.authorizerFor(doc.typeName);
-                if (authorizeRemove && !authorizeRemove({
-                  session: {
-                    sessionId: session.sessionId,
-                    isReadonly: session.isReadonly,
-                    meta: session.meta
-                  },
-                  type: "delete",
-                  prev: doc,
-                  next: null
-                })) {
+                if (authorizeRemove && !authorizeRemove({ session: authSession, type: "delete", prev: doc, next: null })) {
                   this.log?.warn?.(
                     "authorizer vetoed delete",
                     doc.typeName,
@@ -1012,7 +1040,10 @@ class TLSyncRoom {
     this.lastDocumentClock = documentClock;
     let pushResult;
     if (changes && session) {
-      result.docChanges.diffs = { networkDiff: toNetworkDiff(changes) ?? {}, diff: changes };
+      result.docChanges.diffs = {
+        networkDiff: toNetworkDiff(changes, legacyAppendMode),
+        diff: changes
+      };
     }
     if (isEqual(result.docChanges.diffs?.networkDiff, message.diff)) {
       pushResult = {
@@ -1034,7 +1065,8 @@ class TLSyncRoom {
         session.serializedSchema,
         session.requiresDownMigrations,
         result.docChanges.diffs.diff,
-        result.docChanges.diffs.networkDiff
+        result.docChanges.diffs.networkDiff,
+        legacyAppendMode
       );
       if (diff.ok) {
         pushResult = {