From b1f232bf862ca9aeedeb20e47c673411ef0bb05f Mon Sep 17 00:00:00 2001
From: Konstantinos Sideris <sideris.konstantin@gmail.com>
Date: Tue, 30 Jan 2018 12:56:01 -0700
Subject: [PATCH] Render messages received by `/messages` on demand

---
 include/timeline/TimelineView.h |  4 ++
 src/timeline/TimelineView.cc    | 95 +++++++++++++++++++++------------
 2 files changed, 66 insertions(+), 33 deletions(-)

diff --git a/include/timeline/TimelineView.h b/include/timeline/TimelineView.h
index 43a23b6..f771a23 100644
--- a/include/timeline/TimelineView.h
+++ b/include/timeline/TimelineView.h
@@ -211,9 +211,13 @@ private:
 
         //! Messages received by sync not added to the timeline.
         std::vector<TimelineEvent> bottomMessages_;
+        //! Messages received by /messages not added to the timeline.
+        std::vector<TimelineEvent> topMessages_;
 
         //! Render the given timeline events to the bottom of the timeline.
         void renderBottomEvents(const std::vector<TimelineEvent> &events);
+        //! Render the given timeline events to the top of the timeline.
+        void renderTopEvents(const std::vector<TimelineEvent> &events);
 
         //! Decide if the given timeline event can be rendered.
         inline bool isViewable(const TimelineEvent &event) const;
diff --git a/src/timeline/TimelineView.cc b/src/timeline/TimelineView.cc
index 2c87d3a..1d5e76b 100644
--- a/src/timeline/TimelineView.cc
+++ b/src/timeline/TimelineView.cc
@@ -163,48 +163,32 @@ TimelineView::addBackwardsEvents(const QString &room_id, const mtx::responses::M
         }
 
         isTimelineFinished = false;
-        QList<TimelineItem *> items;
 
-        // Reset the sender of the first message in the timeline
-        // cause we're about to insert a new one.
-        firstSender_.clear();
-
-        // Parse in reverse order to determine where we should not show sender's
-        // name.
-        auto ii = msgs.chunk.size();
-        while (ii != 0) {
-                --ii;
-
-                TimelineItem *item = parseMessageEvent(msgs.chunk[ii], TimelineDirection::Top);
-
-                if (item != nullptr)
-                        items.push_back(item);
+        // Queue incoming messages to be rendered later.
+        for (auto const &e : msgs.chunk) {
+                if (isViewable(e))
+                        topMessages_.emplace_back(e);
         }
 
-        // Reverse again to render them.
-        std::reverse(items.begin(), items.end());
-
-        oldPosition_ = scroll_area_->verticalScrollBar()->value();
-        oldHeight_   = scroll_widget_->size().height();
+        // The RoomList message preview will be updated only if this
+        // is the first batch of messages received through /messages
+        // i.e there are no other messages currently present.
+        if (!topMessages_.empty() && scroll_layout_->count() == 1)
+                notifyForLastEvent(topMessages_.at(0));
 
-        for (const auto &item : items)
-                addTimelineItem(item, TimelineDirection::Top);
+        if (isVisible()) {
+                renderTopEvents(topMessages_);
 
-        lastMessageDirection_ = TimelineDirection::Top;
+                // Free up space for new messages.
+                topMessages_.clear();
 
-        QApplication::processEvents();
+                // Send a read receipt for the last event.
+                if (isActiveWindow())
+                        readLastEvent();
+        }
 
         prev_batch_token_       = QString::fromStdString(msgs.end);
         isPaginationInProgress_ = false;
-
-        // Exclude the top stretch.
-        if (msgs.chunk.size() != 0 && scroll_layout_->count() > 1)
-                notifyForLastEvent();
-
-        // If this batch is the first being rendered (i.e the first and the last
-        // events originate from this batch), set the last sender.
-        if (lastSender_.isEmpty() && !items.isEmpty())
-                lastSender_ = items.constFirst()->descriptionMessage().userid;
 }
 
 TimelineItem *
@@ -270,6 +254,46 @@ TimelineView::renderBottomEvents(const std::vector<TimelineEvent> &events)
         QApplication::processEvents();
 }
 
+void
+TimelineView::renderTopEvents(const std::vector<TimelineEvent> &events)
+{
+        std::vector<TimelineItem *> items;
+
+        // Reset the sender of the first message in the timeline
+        // cause we're about to insert a new one.
+        firstSender_.clear();
+
+        // Parse in reverse order to determine where we should not show sender's
+        // name.
+        auto ii = events.size();
+        while (ii != 0) {
+                --ii;
+
+                TimelineItem *item = parseMessageEvent(events[ii], TimelineDirection::Top);
+
+                if (item != nullptr)
+                        items.push_back(item);
+        }
+
+        // Reverse again to render them.
+        std::reverse(items.begin(), items.end());
+
+        oldPosition_ = scroll_area_->verticalScrollBar()->value();
+        oldHeight_   = scroll_widget_->size().height();
+
+        for (const auto &item : items)
+                addTimelineItem(item, TimelineDirection::Top);
+
+        lastMessageDirection_ = TimelineDirection::Top;
+
+        QApplication::processEvents();
+
+        // If this batch is the first being rendered (i.e the first and the last
+        // events originate from this batch), set the last sender.
+        if (lastSender_.isEmpty() && !items.empty())
+                lastSender_ = items.at(0)->descriptionMessage().userid;
+}
+
 int
 TimelineView::addEvents(const mtx::responses::Timeline &timeline)
 {
@@ -636,6 +660,11 @@ TimelineView::getLastEventId() const
 void
 TimelineView::showEvent(QShowEvent *event)
 {
+        if (!topMessages_.empty()) {
+                renderTopEvents(topMessages_);
+                topMessages_.clear();
+        }
+
         if (!bottomMessages_.empty()) {
                 renderBottomEvents(bottomMessages_);
                 bottomMessages_.clear();