matrix-js-sdk 15.5.1 → 15.5.2

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+Changes in [15.5.2](https://github.com/matrix-org/matrix-js-sdk/releases/tag/v15.5.2) (2022-02-17)
+==================================================================================================
+
+## 🐛 Bug Fixes
+ * Fix synthetic read receipt handling
+
 Changes in [15.5.1](https://github.com/matrix-org/matrix-js-sdk/releases/tag/v15.5.1) (2022-02-14)
 ==================================================================================================
 

package/dist/browser-matrix.js

@@ -50841,10 +50841,10 @@ class Room extends events_1.EventEmitter {
     getReadReceiptForUserId(userId, ignoreSynthesized = false) {
         var _a, _b;
         const [realReceipt, syntheticReceipt] = (_b = (_a = this.receipts["m.read"]) === null || _a === void 0 ? void 0 : _a[userId]) !== null && _b !== void 0 ? _b : [];
-        if (ignoreSynthesized || realReceipt) {
+        if (ignoreSynthesized) {
             return realReceipt;
         }
-        return syntheticReceipt;
+        return syntheticReceipt !== null && syntheticReceipt !== void 0 ? syntheticReceipt : realReceipt;
     }
     /**
      * Get the ID of the event that a given user has read up to, or null if we
@@ -50904,10 +50904,10 @@ class Room extends events_1.EventEmitter {
     /**
      * Add a receipt event to the room.
      * @param {MatrixEvent} event The m.receipt event.
-     * @param {Boolean} fake True if this event is implicit.
+     * @param {Boolean} synthetic True if this event is implicit.
      */
-    addReceipt(event, fake = false) {
-        this.addReceiptsToStructure(event, fake);
+    addReceipt(event, synthetic = false) {
+        this.addReceiptsToStructure(event, synthetic);
         // send events after we've regenerated the structure & cache, otherwise things that
         // listened for the event would read stale data.
         this.emit("Room.receipt", event, this);
@@ -50915,14 +50915,14 @@ class Room extends events_1.EventEmitter {
     /**
      * Add a receipt event to the room.
      * @param {MatrixEvent} event The m.receipt event.
-     * @param {Boolean} fake True if this event is implicit.
+     * @param {Boolean} synthetic True if this event is implicit.
      */
-    addReceiptsToStructure(event, fake) {
+    addReceiptsToStructure(event, synthetic) {
         const content = event.getContent();
         Object.keys(content).forEach((eventId) => {
             Object.keys(content[eventId]).forEach((receiptType) => {
                 Object.keys(content[eventId][receiptType]).forEach((userId) => {
-                    var _a;
+                    var _a, _b, _c;
                     const receipt = content[eventId][receiptType][userId];
                     if (!this.receipts[receiptType]) {
                         this.receipts[receiptType] = {};
@@ -50932,8 +50932,8 @@ class Room extends events_1.EventEmitter {
                     }
                     const pair = this.receipts[receiptType][userId];
                     let existingReceipt = pair[ReceiptPairRealIndex];
-                    if (fake && !existingReceipt) {
-                        existingReceipt = pair[ReceiptPairSyntheticIndex];
+                    if (synthetic) {
+                        existingReceipt = (_a = pair[ReceiptPairSyntheticIndex]) !== null && _a !== void 0 ? _a : pair[ReceiptPairRealIndex];
                     }
                     if (existingReceipt) {
                         // we only want to add this receipt if we think it is later than the one we already have.
@@ -50947,8 +50947,28 @@ class Room extends events_1.EventEmitter {
                         eventId,
                         data: receipt,
                     };
+                    const realReceipt = synthetic ? pair[ReceiptPairRealIndex] : wrappedReceipt;
+                    const syntheticReceipt = synthetic ? wrappedReceipt : pair[ReceiptPairSyntheticIndex];
+                    let ordering = null;
+                    if (realReceipt && syntheticReceipt) {
+                        ordering = this.getUnfilteredTimelineSet().compareEventOrdering(realReceipt.eventId, syntheticReceipt.eventId);
+                    }
+                    const preferSynthetic = ordering === null || ordering < 0;
                     // we don't bother caching just real receipts by event ID as there's nothing that would read it.
-                    const cachedReceipt = (_a = pair[ReceiptPairSyntheticIndex]) !== null && _a !== void 0 ? _a : pair[ReceiptPairRealIndex];
+                    // Take the current cached receipt before we overwrite the pair elements.
+                    const cachedReceipt = (_b = pair[ReceiptPairSyntheticIndex]) !== null && _b !== void 0 ? _b : pair[ReceiptPairRealIndex];
+                    if (synthetic && preferSynthetic) {
+                        pair[ReceiptPairSyntheticIndex] = wrappedReceipt;
+                    }
+                    else if (!synthetic) {
+                        pair[ReceiptPairRealIndex] = wrappedReceipt;
+                        if (!preferSynthetic) {
+                            pair[ReceiptPairSyntheticIndex] = null;
+                        }
+                    }
+                    const newCachedReceipt = (_c = pair[ReceiptPairSyntheticIndex]) !== null && _c !== void 0 ? _c : pair[ReceiptPairRealIndex];
+                    if (cachedReceipt === newCachedReceipt)
+                        return;
                     // clean up any previous cache entry
                     if (cachedReceipt && this.receiptCacheByEventId[cachedReceipt.eventId]) {
                         const previousEventId = cachedReceipt.eventId;
@@ -50969,14 +50989,6 @@ class Room extends events_1.EventEmitter {
                         type: receiptType,
                         data: receipt,
                     });
-                    if (fake) {
-                        pair[ReceiptPairSyntheticIndex] = wrappedReceipt;
-                    }
-                    else {
-                        pair[ReceiptPairRealIndex] = wrappedReceipt;
-                        // a real receipt for a receiptType+userId tuple should clobber any synthetic one
-                        pair[ReceiptPairSyntheticIndex] = null;
-                    }
                 });
             });
         });