Add the ability to reply to a message (zed-industries#7170)

Feature - [x] Allow to click on reply to go to the real message - [x] In chat - [x] Show only a part of the message that you reply to - [x] In chat - [x] In reply preview TODO’s - [x] Fix migration - [x] timestamp(in filename) - [x] remove the reference to the reply_message_id - [x] Fix markdown cache for reply message - [x] Fix spacing when first message is a reply to you and you want to reply to that message. - [x] Fetch message that you replied to - [x] allow fetching messages that are not inside the current view - [x] When message is deleted, we should show a text like `message deleted` or something - [x] Show correct GitHub username + icon after `Replied to: ` - [x] Show correct message(now it's hard-coded) - [x] Add icon to reply + add the onClick logic - [x] Show message that you want to reply to - [x] Allow to click away the message that you want to reply to - [x] Fix hard-coded GitHub user + icon after `Reply tp:` - [x] Add tests <img width="242" alt="Screenshot 2024-02-06 at 20 51 40" src="https://github.com/zed-industries/zed/assets/62463826/a7a5f3e0-dee3-4d38-95db-258b169e4498"> <img width="240" alt="Screenshot 2024-02-06 at 20 52 02" src="https://github.com/zed-industries/zed/assets/62463826/3e136de3-4135-4c07-bd43-30089b677c0a"> Release Notes: - Added the ability to reply to a message. - Added highlight message when you click on mention notifications or a reply message. --------- Co-authored-by: Bennet Bo Fenner <53836821+bennetbo@users.noreply.github.com> Co-authored-by: Conrad Irwin <conrad.irwin@gmail.com>
RemcoSmitsDev · Feb 6, 2024 · 6c4b96e · 6c4b96e
1 parent 743f9b3
commit 6c4b96e
Show file tree

Hide file tree

Showing 12 changed files with 569 additions and 110 deletions.
diff --git a/crates/channel/src/channel_chat.rs b/crates/channel/src/channel_chat.rs
@@ -6,11 +6,12 @@ use client::{
     Client, Subscription, TypedEnvelope, UserId,
 };
 use futures::lock::Mutex;
-use gpui::{AppContext, AsyncAppContext, Context, EventEmitter, Model, ModelContext, Task};
+use gpui::{
+    AppContext, AsyncAppContext, Context, EventEmitter, Model, ModelContext, Task, WeakModel,
+};
 use rand::prelude::*;
 use std::{
     collections::HashSet,
-    mem,
     ops::{ControlFlow, Range},
     sync::Arc,
 };
@@ -26,6 +27,7 @@ pub struct ChannelChat {
     loaded_all_messages: bool,
     last_acknowledged_id: Option<u64>,
     next_pending_message_id: usize,
+    first_loaded_message_id: Option<u64>,
     user_store: Model<UserStore>,
     rpc: Arc<Client>,
     outgoing_messages_lock: Arc<Mutex<()>>,
@@ -37,6 +39,7 @@ pub struct ChannelChat {
 pub struct MessageParams {
     pub text: String,
     pub mentions: Vec<(Range<usize>, UserId)>,
+    pub reply_to_message_id: Option<u64>,
 }
 
 #[derive(Clone, Debug)]
@@ -47,6 +50,7 @@ pub struct ChannelMessage {
     pub sender: Arc<User>,
     pub nonce: u128,
     pub mentions: Vec<(Range<usize>, UserId)>,
+    pub reply_to_message_id: Option<u64>,
 }
 
 #[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
@@ -55,6 +59,15 @@ pub enum ChannelMessageId {
     Pending(usize),
 }
 
+impl Into<Option<u64>> for ChannelMessageId {
+    fn into(self) -> Option<u64> {
+        match self {
+            ChannelMessageId::Saved(id) => Some(id),
+            ChannelMessageId::Pending(_) => None,
+        }
+    }
+}
+
 #[derive(Clone, Debug, Default)]
 pub struct ChannelMessageSummary {
     max_id: ChannelMessageId,
@@ -96,28 +109,35 @@ impl ChannelChat {
         let response = client
             .request(proto::JoinChannelChat { channel_id })
             .await?;
-        let messages = messages_from_proto(response.messages, &user_store, &mut cx).await?;
-        let loaded_all_messages = response.done;
 
-        Ok(cx.new_model(|cx| {
+        let handle = cx.new_model(|cx| {
             cx.on_release(Self::release).detach();
-            let mut this = Self {
+            Self {
                 channel_id: channel.id,
-                user_store,
+                user_store: user_store.clone(),
                 channel_store,
-                rpc: client,
+                rpc: client.clone(),
                 outgoing_messages_lock: Default::default(),
                 messages: Default::default(),
                 acknowledged_message_ids: Default::default(),
-                loaded_all_messages,
+                loaded_all_messages: false,
                 next_pending_message_id: 0,
                 last_acknowledged_id: None,
                 rng: StdRng::from_entropy(),
+                first_loaded_message_id: None,
                 _subscription: subscription.set_model(&cx.handle(), &mut cx.to_async()),
-            };
-            this.insert_messages(messages, cx);
-            this
-        })?)
+            }
+        })?;
+        Self::handle_loaded_messages(
+            handle.downgrade(),
+            user_store,
+            client,
+            response.messages,
+            response.done,
+            &mut cx,
+        )
+        .await?;
+        Ok(handle)
     }
 
     fn release(&mut self, _: &mut AppContext) {
@@ -166,6 +186,7 @@ impl ChannelChat {
                     timestamp: OffsetDateTime::now_utc(),
                     mentions: message.mentions.clone(),
                     nonce,
+                    reply_to_message_id: message.reply_to_message_id,
                 },
                 &(),
             ),
@@ -183,6 +204,7 @@ impl ChannelChat {
                 body: message.text,
                 nonce: Some(nonce.into()),
                 mentions: mentions_to_proto(&message.mentions),
+                reply_to_message_id: message.reply_to_message_id,
             });
             let response = request.await?;
             drop(outgoing_message_guard);
@@ -227,22 +249,31 @@ impl ChannelChat {
                         before_message_id,
                     })
                     .await?;
-                let loaded_all_messages = response.done;
-                let messages = messages_from_proto(response.messages, &user_store, &mut cx).await?;
-                this.update(&mut cx, |this, cx| {
-                    this.loaded_all_messages = loaded_all_messages;
-                    this.insert_messages(messages, cx);
-                })?;
+                Self::handle_loaded_messages(
+                    this,
+                    user_store,
+                    rpc,
+                    response.messages,
+                    response.done,
+                    &mut cx,
+                )
+                .await?;
+
                 anyhow::Ok(())
             }
             .log_err()
         }))
     }
 
     pub fn first_loaded_message_id(&mut self) -> Option<u64> {
-        self.messages.first().and_then(|message| match message.id {
-            ChannelMessageId::Saved(id) => Some(id),
-            ChannelMessageId::Pending(_) => None,
+        self.first_loaded_message_id
+    }
+
+    /// Load a message by its id, if it's already stored locally.
+    pub fn find_loaded_message(&self, id: u64) -> Option<&ChannelMessage> {
+        self.messages.iter().find(|message| match message.id {
+            ChannelMessageId::Saved(message_id) => message_id == id,
+            ChannelMessageId::Pending(_) => false,
         })
     }
 
@@ -304,35 +335,84 @@ impl ChannelChat {
         }
     }
 
+    async fn handle_loaded_messages(
+        this: WeakModel<Self>,
+        user_store: Model<UserStore>,
+        rpc: Arc<Client>,
+        proto_messages: Vec<proto::ChannelMessage>,
+        loaded_all_messages: bool,
+        cx: &mut AsyncAppContext,
+    ) -> Result<()> {
+        let loaded_messages = messages_from_proto(proto_messages, &user_store, cx).await?;
+
+        let first_loaded_message_id = loaded_messages.first().map(|m| m.id);
+        let loaded_message_ids = this.update(cx, |this, _| {
+            let mut loaded_message_ids: HashSet<u64> = HashSet::default();
+            for message in loaded_messages.iter() {
+                if let Some(saved_message_id) = message.id.into() {
+                    loaded_message_ids.insert(saved_message_id);
+                }
+            }
+            for message in this.messages.iter() {
+                if let Some(saved_message_id) = message.id.into() {
+                    loaded_message_ids.insert(saved_message_id);
+                }
+            }
+            loaded_message_ids
+        })?;
+
+        let missing_ancestors = loaded_messages
+            .iter()
+            .filter_map(|message| {
+                if let Some(ancestor_id) = message.reply_to_message_id {
+                    if !loaded_message_ids.contains(&ancestor_id) {
+                        return Some(ancestor_id);
+                    }
+                }
+                None
+            })
+            .collect::<Vec<_>>();
+
+        let loaded_ancestors = if missing_ancestors.is_empty() {
+            None
+        } else {
+            let response = rpc
+                .request(proto::GetChannelMessagesById {
+                    message_ids: missing_ancestors,
+                })
+                .await?;
+            Some(messages_from_proto(response.messages, &user_store, cx).await?)
+        };
+        this.update(cx, |this, cx| {
+            this.first_loaded_message_id = first_loaded_message_id.and_then(|msg_id| msg_id.into());
+            this.loaded_all_messages = loaded_all_messages;
+            this.insert_messages(loaded_messages, cx);
+            if let Some(loaded_ancestors) = loaded_ancestors {
+                this.insert_messages(loaded_ancestors, cx);
+            }
+        })?;
+
+        Ok(())
+    }
+
     pub fn rejoin(&mut self, cx: &mut ModelContext<Self>) {
         let user_store = self.user_store.clone();
         let rpc = self.rpc.clone();
         let channel_id = self.channel_id;
         cx.spawn(move |this, mut cx| {
             async move {
                 let response = rpc.request(proto::JoinChannelChat { channel_id }).await?;
-                let messages = messages_from_proto(response.messages, &user_store, &mut cx).await?;
-                let loaded_all_messages = response.done;
-
-                let pending_messages = this.update(&mut cx, |this, cx| {
-                    if let Some((first_new_message, last_old_message)) =
-                        messages.first().zip(this.messages.last())
-                    {
-                        if first_new_message.id > last_old_message.id {
-                            let old_messages = mem::take(&mut this.messages);
-                            cx.emit(ChannelChatEvent::MessagesUpdated {
-                                old_range: 0..old_messages.summary().count,
-                                new_count: 0,
-                            });
-                            this.loaded_all_messages = loaded_all_messages;
-                        }
-                    }
-
-                    this.insert_messages(messages, cx);
-                    if loaded_all_messages {
-                        this.loaded_all_messages = loaded_all_messages;
-                    }
-
+                Self::handle_loaded_messages(
+                    this.clone(),
+                    user_store.clone(),
+                    rpc.clone(),
+                    response.messages,
+                    response.done,
+                    &mut cx,
+                )
+                .await?;
+
+                let pending_messages = this.update(&mut cx, |this, _| {
                     this.pending_messages().cloned().collect::<Vec<_>>()
                 })?;
 
@@ -342,6 +422,7 @@ impl ChannelChat {
                         body: pending_message.body,
                         mentions: mentions_to_proto(&pending_message.mentions),
                         nonce: Some(pending_message.nonce.into()),
+                        reply_to_message_id: pending_message.reply_to_message_id,
                     });
                     let response = request.await?;
                     let message = ChannelMessage::from_proto(
@@ -553,6 +634,7 @@ impl ChannelMessage {
                 .nonce
                 .ok_or_else(|| anyhow!("nonce is required"))?
                 .into(),
+            reply_to_message_id: message.reply_to_message_id,
         })
     }
 
@@ -642,6 +724,7 @@ impl<'a> From<&'a str> for MessageParams {
         Self {
             text: value.into(),
             mentions: Vec::new(),
+            reply_to_message_id: None,
         }
     }
 }
diff --git a/crates/channel/src/channel_store_tests.rs b/crates/channel/src/channel_store_tests.rs
@@ -184,6 +184,7 @@ async fn test_channel_messages(cx: &mut TestAppContext) {
                     sender_id: 5,
                     mentions: vec![],
                     nonce: Some(1.into()),
+                    reply_to_message_id: None,
                 },
                 proto::ChannelMessage {
                     id: 11,
@@ -192,6 +193,7 @@ async fn test_channel_messages(cx: &mut TestAppContext) {
                     sender_id: 6,
                     mentions: vec![],
                     nonce: Some(2.into()),
+                    reply_to_message_id: None,
                 },
             ],
             done: false,
@@ -239,6 +241,7 @@ async fn test_channel_messages(cx: &mut TestAppContext) {
             sender_id: 7,
             mentions: vec![],
             nonce: Some(3.into()),
+            reply_to_message_id: None,
         }),
     });
 
@@ -292,6 +295,7 @@ async fn test_channel_messages(cx: &mut TestAppContext) {
                     sender_id: 5,
                     nonce: Some(4.into()),
                     mentions: vec![],
+                    reply_to_message_id: None,
                 },
                 proto::ChannelMessage {
                     id: 9,
@@ -300,6 +304,7 @@ async fn test_channel_messages(cx: &mut TestAppContext) {
                     sender_id: 6,
                     nonce: Some(5.into()),
                     mentions: vec![],
+                    reply_to_message_id: None,
                 },
             ],
         },

diff --git a/crates/collab/migrations.sqlite/20221109000000_test_schema.sql b/crates/collab/migrations.sqlite/20221109000000_test_schema.sql
@@ -217,7 +217,8 @@ CREATE TABLE IF NOT EXISTS "channel_messages" (
     "sender_id" INTEGER NOT NULL REFERENCES users (id),
     "body" TEXT NOT NULL,
     "sent_at" TIMESTAMP,
-    "nonce" BLOB NOT NULL
+    "nonce" BLOB NOT NULL,
+    "reply_to_message_id" INTEGER DEFAULT NULL
 );
 CREATE INDEX "index_channel_messages_on_channel_id" ON "channel_messages" ("channel_id");
 CREATE UNIQUE INDEX "index_channel_messages_on_sender_id_nonce" ON "channel_messages" ("sender_id", "nonce");

diff --git a/crates/collab/migrations/20240203113741_add_reply_to_message.sql b/crates/collab/migrations/20240203113741_add_reply_to_message.sql
@@ -0,0 +1 @@
+ALTER TABLE channel_messages ADD reply_to_message_id INTEGER DEFAULT NULL
diff --git a/crates/collab/src/db/queries/messages.rs b/crates/collab/src/db/queries/messages.rs
@@ -161,6 +161,7 @@ impl Database {
                         upper_half: nonce.0,
                         lower_half: nonce.1,
                     }),
+                    reply_to_message_id: row.reply_to_message_id.map(|id| id.to_proto()),
                 }
             })
             .collect::<Vec<_>>();
@@ -207,6 +208,7 @@ impl Database {
         mentions: &[proto::ChatMention],
         timestamp: OffsetDateTime,
         nonce: u128,
+        reply_to_message_id: Option<MessageId>,
     ) -> Result<CreatedChannelMessage> {
         self.transaction(|tx| async move {
             let channel = self.get_channel_internal(channel_id, &*tx).await?;
@@ -245,6 +247,7 @@ impl Database {
                 sent_at: ActiveValue::Set(timestamp),
                 nonce: ActiveValue::Set(Uuid::from_u128(nonce)),
                 id: ActiveValue::NotSet,
+                reply_to_message_id: ActiveValue::Set(reply_to_message_id),
             })
             .on_conflict(
                 OnConflict::columns([

diff --git a/crates/collab/src/db/tables/channel_message.rs b/crates/collab/src/db/tables/channel_message.rs
@@ -12,6 +12,7 @@ pub struct Model {
     pub body: String,
     pub sent_at: PrimitiveDateTime,
     pub nonce: Uuid,
+    pub reply_to_message_id: Option<MessageId>,
 }
 
 impl ActiveModelBehavior for ActiveModel {}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		ALTER TABLE channel_messages ADD reply_to_message_id INTEGER DEFAULT NULL