From c748aebfc50e3b2675b9f588fb08026b87519c8c Mon Sep 17 00:00:00 2001
From: Germain Souquet <germains@element.io>
Date: Wed, 22 Sep 2021 17:36:12 +0100
Subject: [PATCH] Add context to explain why we fetch roomstate in threads

---
 src/models/event-timeline-set.ts | 2 +-
 src/models/thread.ts             | 4 ++++
 2 files changed, 5 insertions(+), 1 deletion(-)

diff --git a/src/models/event-timeline-set.ts b/src/models/event-timeline-set.ts
index dfa974267..b4333e52c 100644
--- a/src/models/event-timeline-set.ts
+++ b/src/models/event-timeline-set.ts
@@ -515,7 +515,7 @@ export class EventTimelineSet extends EventEmitter {
      * @param {MatrixEvent} event Event to be added
      * @param {string?} duplicateStrategy 'ignore' or 'replace'
      * @param {boolean} fromCache whether the sync response came from cache
-     * @param {boolean} fromCache whether the sync response came from cache
+     * @param roomState the state events to reconcile metadata from
      */
     public addLiveEvent(
         event: MatrixEvent,
diff --git a/src/models/thread.ts b/src/models/thread.ts
index 6ae789ee8..cea7b7325 100644
--- a/src/models/thread.ts
+++ b/src/models/thread.ts
@@ -73,6 +73,10 @@ export class Thread extends EventEmitter {
             this.root = event.getId();
         }
 
+        // all the relevant membership info to hydrate events with a sender
+        // is held in the main room timeline
+        // We want to fetch the room state from there and pass it down to this thread
+        // timeline set to let it reconcile an event with its relevant RoomMember
         const roomState = this.room.getLiveTimeline().getState(EventTimeline.FORWARDS);
 
         event.setThread(this);