update

crates/signed_core/src/inbox.rs

@@ -4,7 +4,7 @@ use std::time::Duration;
 use nostr::prelude::*;
 use serde::{Deserialize, Serialize};
 
-use crate::{COVER_NOTE_KIND, RepoAddr};
+use crate::{COVER_NOTE_KIND, RepoAddr, activity_subject};
 
 /// Window before `now` that an advanced cutoff retreats to.
 const ADVANCE_WINDOW: Duration = Duration::from_secs(3 * 24 * 60 * 60);
@@ -12,33 +12,92 @@ const ADVANCE_WINDOW: Duration = Duration::from_secs(3 * 24 * 60 * 60);
 /// Window before `now` that a mark-all cutoff retreats to.
 const MARK_ALL_WINDOW: Duration = Duration::from_secs(10 * 24 * 60 * 60);
 
-/// A thread of notification events sharing one root
+/// A thread of notification and own-activity events sharing one root.
 #[derive(Debug, Clone)]
 pub struct InboxItem {
-    /// The root issue, patch or pull request the notifications belong to.
+    /// The root issue, patch or pull request the events belong to.
     pub root: EventId,
+    /// The root event itself, when it is known locally.
+    pub root_event: Option<Event>,
     /// Kind of the root event, when it is known locally.
     pub root_kind: Option<Kind>,
     /// Repository the root belongs to, from the root's `a` tag.
     pub address: Option<RepoAddr>,
-    /// Events in the group, newest first.
+    /// Notification events directed at the user, newest first.
     pub events: Vec<Event>,
+    /// The user's own events in the thread, newest first.
+    pub own_events: Vec<Event>,
     /// Unread event ids, oldest first.
     pub unread_ids: Vec<EventId>,
-    /// Whether every event in the group is archived.
+    /// Whether every notification event in the thread is archived.
     pub archived: bool,
 }
 
 impl InboxItem {
-    /// Timestamp of the newest event in the group.
+    /// Title of the thread, read from its root issue/patch/PR when known.
+    pub fn title(&self) -> String {
+        self.root_event
+            .as_ref()
+            .or_else(|| self.own_events.first())
+            .or_else(|| self.events.first())
+            .map(activity_subject)
+            .unwrap_or_else(|| "Untitled".to_string())
+    }
+
+    /// Kind shown for the thread.
+    pub fn kind(&self) -> Option<Kind> {
+        self.root_kind.or_else(|| {
+            self.root_event
+                .as_ref()
+                .or_else(|| self.own_events.first())
+                .or_else(|| self.events.first())
+                .map(|event| event.kind)
+        })
+    }
+
+    /// Timestamp of the newest event in the thread.
     pub fn latest_activity(&self) -> Timestamp {
-        self.events
-            .first()
+        self.root_event
+            .as_ref()
+            .into_iter()
+            .chain(self.own_events.first())
+            .chain(self.events.first())
             .map(|event| event.created_at)
+            .max()
             .unwrap_or_default()
     }
 
-    /// Whether the group has an unread event still visible in the inbox.
+    /// Up to `limit` events of the thread, oldest first.
+    pub fn timeline(&self, limit: usize) -> Vec<Event> {
+        let mut seen: HashSet<EventId> = HashSet::new();
+        let mut events: Vec<Event> = Vec::new();
+
+        if let Some(root) = &self.root_event {
+            seen.insert(root.id);
+            events.push(root.clone());
+        }
+
+        let mut rest: Vec<Event> = self
+            .own_events
+            .iter()
+            .chain(self.events.iter())
+            .filter(|event| seen.insert(event.id))
+            .cloned()
+            .collect();
+
+        rest.sort_by(|a, b| {
+            b.created_at
+                .cmp(&a.created_at)
+                .then_with(|| b.id.to_hex().cmp(&a.id.to_hex()))
+        });
+        rest.truncate(limit.saturating_sub(events.len()));
+        events.extend(rest);
+
+        events.sort_by_key(|event| event.created_at);
+        events
+    }
+
+    /// Whether the thread has an unread event still visible in the inbox.
     pub fn is_unread(&self) -> bool {
         !self.archived && !self.unread_ids.is_empty()
     }
@@ -53,7 +112,9 @@ impl InboxItem {
             .map(|event| event.id)
             .collect();
 
-        self.archived = self.events.iter().all(|event| state.is_archived(event));
+        // A thread without notification events is never archived.
+        self.archived =
+            !self.events.is_empty() && self.events.iter().all(|event| state.is_archived(event));
     }
 }
 
@@ -97,10 +158,17 @@ where
     }
 }
 
-/// Group notification events by root, newest activity first.
-pub fn group<E, L>(events: E, me: PublicKey, state: &InboxReadState, lookup: &L) -> Vec<InboxItem>
+/// Group notification events and the user's own events into one item per thread.
+pub fn group<E, O, L>(
+    events: E,
+    own: O,
+    me: PublicKey,
+    state: &InboxReadState,
+    lookup: &L,
+) -> Vec<InboxItem>
 where
     E: IntoIterator<Item = Event>,
+    O: IntoIterator<Item = Event>,
     L: Fn(EventId) -> Option<Event>,
 {
     let mut groups: HashMap<EventId, Vec<Event>> = HashMap::new();
@@ -114,14 +182,23 @@ where
         groups.entry(root).or_default().push(event);
     }
 
-    let mut items: Vec<InboxItem> = groups
+    let mut own_groups: HashMap<EventId, Vec<Event>> = HashMap::new();
+    for event in own {
+        let root = notification_root(&event, lookup).unwrap_or(event.id);
+        own_groups.entry(root).or_default().push(event);
+    }
+
+    let mut roots: Vec<EventId> = groups.keys().chain(own_groups.keys()).copied().collect();
+    roots.sort();
+    roots.dedup();
+
+    let mut items: Vec<InboxItem> = roots
         .into_iter()
-        .map(|(root, mut events)| {
-            events.sort_by(|a, b| {
-                b.created_at
-                    .cmp(&a.created_at)
-                    .then_with(|| b.id.to_hex().cmp(&a.id.to_hex()))
-            });
+        .map(|root| {
+            let mut events = groups.remove(&root).unwrap_or_default();
+            let mut own_events = own_groups.remove(&root).unwrap_or_default();
+            sort_newest_first(&mut events);
+            sort_newest_first(&mut own_events);
 
             let root_event = lookup(root);
 
@@ -131,7 +208,9 @@ where
                 address: root_event
                     .as_ref()
                     .and_then(|event| event.tags.coordinates().next()),
+                root_event,
                 events,
+                own_events,
                 unread_ids: Vec::new(),
                 archived: false,
             };
@@ -149,6 +228,15 @@ where
     items
 }
 
+/// Sort thread events newest first, ties broken by id.
+fn sort_newest_first(events: &mut [Event]) {
+    events.sort_by(|a, b| {
+        b.created_at
+            .cmp(&a.created_at)
+            .then_with(|| b.id.to_hex().cmp(&a.id.to_hex()))
+    });
+}
+
 /// Read and archive state of the inbox, a high-water-mark model.
 #[derive(Clone, Debug, Default, PartialEq, Eq, Serialize, Deserialize)]
 pub struct InboxReadState {
@@ -392,6 +480,15 @@ mod tests {
         signed(author, Kind::GitIssue, Vec::new(), at)
     }
 
+    fn titled_issue(author: &Keys, title: &str, at: u64) -> Event {
+        signed(
+            author,
+            Kind::GitIssue,
+            vec![Tag::parse(["subject", title]).expect("valid subject tag")],
+            at,
+        )
+    }
+
     #[test]
     fn issue_and_pull_request_are_their_own_root() {
         let events = [
@@ -496,6 +593,7 @@ mod tests {
         let events = [issue.clone(), comment.clone(), other_issue.clone(), mine];
         let items = group(
             events,
+            Vec::new(),
             me.public_key(),
             &InboxReadState::default(),
             &lookup(&[]),
@@ -518,6 +616,7 @@ mod tests {
         let events = [issue.clone(), older.clone(), newer.clone()];
         let items = group(
             events,
+            Vec::new(),
             me.public_key(),
             &InboxReadState::default(),
             &lookup(&[]),
@@ -532,6 +631,7 @@ mod tests {
         };
         let items = group(
             [issue.clone(), older, newer],
+            Vec::new(),
             me.public_key(),
             &state,
             &lookup(&[]),
@@ -557,6 +657,7 @@ mod tests {
         let events = [issue.clone(), comment];
         let items = group(
             events.clone(),
+            Vec::new(),
             me.public_key(),
             &InboxReadState::default(),
             &lookup(&events),
@@ -566,6 +667,59 @@ mod tests {
         assert_eq!(items[0].address, issue.tags.coordinates().next());
     }
 
+    #[test]
+    fn group_merges_own_events_into_the_matching_thread() {
+        let me = keys(1);
+        let issue = titled_issue(&me, "Add retry logic", 100);
+        let mine = signed(
+            &me,
+            Kind::Comment,
+            vec![
+                uppercase_e_tag(&issue),
+                Tag::parse(["K", "1621"]).expect("K tag"),
+            ],
+            150,
+        );
+        let reply = signed(
+            &keys(2),
+            Kind::Comment,
+            vec![
+                uppercase_e_tag(&issue),
+                Tag::parse(["K", "1621"]).expect("K tag"),
+            ],
+            200,
+        );
+
+        let context = [issue.clone(), mine.clone(), reply.clone()];
+        let items = group(
+            [reply.clone()],
+            [issue.clone(), mine.clone()],
+            me.public_key(),
+            &InboxReadState::default(),
+            &lookup(&context),
+        );
+
+        assert_eq!(items.len(), 1);
+        assert_eq!(items[0].root, issue.id);
+        assert_eq!(
+            items[0].root_event.as_ref().map(|event| event.id),
+            Some(issue.id)
+        );
+        assert_eq!(items[0].kind(), Some(Kind::GitIssue));
+        assert_eq!(items[0].title(), "Add retry logic");
+        assert_eq!(items[0].events, vec![reply.clone()]);
+        // The own events are kept apart from the notifications, newest first.
+        assert_eq!(items[0].own_events, vec![mine.clone(), issue.clone()]);
+        assert_eq!(
+            items[0]
+                .timeline(5)
+                .iter()
+                .map(|event| event.id)
+                .collect::<Vec<_>>(),
+            vec![issue.id, mine.id, reply.id]
+        );
+    }
+
     #[test]
     fn mark_all_read_marks_known_recent_events() {
         let me = keys(1);
@@ -663,9 +817,11 @@ mod tests {
         let second = issue(&keys(2), now.as_secs() - 1000);
         let mut item = InboxItem {
             root: first.id,
+            root_event: None,
             root_kind: None,
             address: None,
             events: vec![second.clone(), first.clone()],
+            own_events: Vec::new(),
             unread_ids: Vec::new(),
             archived: false,
         };