tuisky 0.2.2

TUI client for Bluesky
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
use super::super::types::FeedSourceInfo;
use super::super::{Watch, Watcher};
use bsky_sdk::Result;
use bsky_sdk::api::app::bsky::feed::defs::{
    FeedViewPost, FeedViewPostReasonRefs, PostViewEmbedRefs, ReplyRefParentRefs,
};
use bsky_sdk::api::types::Union;
use bsky_sdk::api::types::string::Cid;
use bsky_sdk::moderation::decision::DecisionContext;
use bsky_sdk::preference::{FeedViewPreference, FeedViewPreferenceData};
use bsky_sdk::{BskyAgent, preference::Preferences};
use indexmap::IndexMap;
use std::sync::Arc;
use std::time::Duration;
use tokio::sync::{Mutex, broadcast, watch};
use tokio::time;

impl Watcher {
    pub fn feed(
        &self,
        feed_info: FeedSourceInfo,
    ) -> impl Watch<Output = Vec<FeedViewPost>> + use<> {
        let (tx, _) = broadcast::channel(1);
        FeedWatcher {
            feed_info,
            agent: self.agent.clone(),
            preferences: self.preferences(),
            period: Duration::from_secs(self.config.intervals.feed),
            tx,
            current: Default::default(),
        }
    }
}

pub struct FeedWatcher<W> {
    feed_info: FeedSourceInfo,
    agent: Arc<BskyAgent>,
    preferences: W,
    period: Duration,
    tx: broadcast::Sender<()>,
    current: Arc<Mutex<IndexMap<Cid, FeedViewPost>>>,
}

impl<W> Watch for FeedWatcher<W>
where
    W: Watch<Output = Preferences>,
{
    type Output = Vec<FeedViewPost>;

    fn subscribe(&self) -> tokio::sync::watch::Receiver<Self::Output> {
        let (tx, rx) = watch::channel(Default::default());
        let updater = Updater {
            agent: self.agent.clone(),
            current: self.current.clone(),
            feed_info: Arc::new(self.feed_info.clone()),
            tx,
        };
        let (mut preferences, mut quit) = (self.preferences.subscribe(), self.tx.subscribe());
        let mut interval = time::interval(self.period);
        tokio::spawn(async move {
            // skip the first tick
            interval.tick().await;
            loop {
                let tick = interval.tick();
                tokio::select! {
                    changed = preferences.changed() => {
                        if changed.is_ok() {
                            let preferences = preferences.borrow_and_update().clone();
                            let updater = updater.clone();
                            tokio::spawn(async move {
                                updater.clone().update(&preferences).await;
                            });
                        } else {
                            break log::warn!("preferences channel closed");
                        }
                    }
                    _ = tick => {
                        let preferences = preferences.borrow().clone();
                        let updater = updater.clone();
                        tokio::spawn(async move {
                            updater.update(&preferences).await;
                        });
                    }
                    _ = quit.recv() => {
                        break;
                    }
                }
            }
            log::debug!("quit");
        });
        rx
    }
    fn unsubscribe(&self) {
        if let Err(e) = self.tx.send(()) {
            log::error!("failed to send quit: {e}");
        }
        self.preferences.unsubscribe();
    }
    fn refresh(&self) {
        self.preferences.refresh();
    }
}

#[derive(Clone)]
struct Updater {
    agent: Arc<BskyAgent>,
    current: Arc<Mutex<IndexMap<Cid, FeedViewPost>>>,
    feed_info: Arc<FeedSourceInfo>,
    tx: watch::Sender<Vec<FeedViewPost>>,
}

impl Updater {
    async fn update(&self, preferences: &Preferences) {
        match self.calculate_feed(preferences).await {
            Ok(feed) => {
                self.tx.send(feed).ok();
            }
            Err(e) => {
                log::error!("failed to get feed view posts: {e}");
            }
        }
    }
    async fn calculate_feed(&self, preferences: &Preferences) -> Result<Vec<FeedViewPost>> {
        // TODO: It should not be necessary to get moderator every time unless moderation_prefs has been changed?
        let (moderator, feed) = tokio::join!(self.agent.moderator(preferences), self.get_feed());
        let moderator = moderator?;
        let mut feed = feed?;
        feed.reverse();
        let mut ret = {
            let mut feed_map = self.current.lock().await;
            update_feeds(&feed, &mut feed_map);
            feed_map.values().rev().cloned().collect::<Vec<_>>()
        };
        // filter by moderator
        ret.retain(|feed_view_post| {
            let decision = moderator.moderate_post(&feed_view_post.post);
            let ui = decision.ui(DecisionContext::ContentList);
            // TODO: use other results?
            !ui.filter()
        });
        // filter by preferences (following timeline only)
        if matches!(self.feed_info.as_ref(), FeedSourceInfo::Timeline(_)) {
            let pref = if let Some(pref) = preferences.feed_view_prefs.get("home") {
                pref.clone()
            } else {
                FeedViewPreferenceData::default().into()
            };
            ret.retain(|feed_view_post| filter_feed(feed_view_post, &pref));
        }
        Ok(ret)
    }
    async fn get_feed(&self) -> Result<Vec<FeedViewPost>> {
        Ok(match self.feed_info.as_ref() {
            FeedSourceInfo::Feed(generator_view) => {
                self.agent
                    .api
                    .app
                    .bsky
                    .feed
                    .get_feed(
                        bsky_sdk::api::app::bsky::feed::get_feed::ParametersData {
                            cursor: None,
                            feed: generator_view.uri.clone(),
                            limit: 30.try_into().ok(),
                        }
                        .into(),
                    )
                    .await?
                    .data
                    .feed
            }
            FeedSourceInfo::List(list_view) => {
                self.agent
                    .api
                    .app
                    .bsky
                    .feed
                    .get_list_feed(
                        bsky_sdk::api::app::bsky::feed::get_list_feed::ParametersData {
                            cursor: None,
                            limit: 30.try_into().ok(),
                            list: list_view.uri.clone(),
                        }
                        .into(),
                    )
                    .await?
                    .data
                    .feed
            }
            FeedSourceInfo::Timeline(_) => {
                self.agent
                    .api
                    .app
                    .bsky
                    .feed
                    .get_timeline(
                        bsky_sdk::api::app::bsky::feed::get_timeline::ParametersData {
                            algorithm: None,
                            cursor: None,
                            limit: 30.try_into().ok(),
                        }
                        .into(),
                    )
                    .await?
                    .data
                    .feed
            }
        })
    }
}

fn update_feeds(feed: &[FeedViewPost], feed_map: &mut IndexMap<Cid, FeedViewPost>) {
    for post in feed {
        if let Some(entry) = feed_map.get_mut(&post.post.cid) {
            // Is the feed view a new repost?
            if match (&entry.reason, &post.reason) {
                (
                    Some(Union::Refs(FeedViewPostReasonRefs::ReasonRepost(curr))),
                    Some(Union::Refs(FeedViewPostReasonRefs::ReasonRepost(next))),
                ) => curr.indexed_at < next.indexed_at,
                (None, Some(_)) => true,
                _ => false,
            } {
                // Remove the old entry
                feed_map.swap_remove(&post.post.cid);
            } else {
                // Just update the post
                entry.post = post.post.clone();
                continue;
            }
        }
        feed_map.insert(post.post.cid.clone(), post.clone());
    }
}

fn filter_feed(feed_view_post: &FeedViewPost, pref: &FeedViewPreference) -> bool {
    // is repost?
    if matches!(
        &feed_view_post.reason,
        Some(Union::Refs(FeedViewPostReasonRefs::ReasonRepost(_)))
    ) {
        return !pref.hide_reposts;
    }
    // is reply?
    if let Some(reply) = &feed_view_post.reply {
        let is_self_reply = matches!(&reply.parent,
            Union::Refs(ReplyRefParentRefs::PostView(post_view))
                if post_view.author.did == feed_view_post.post.author.did
        );
        if pref.hide_replies {
            return is_self_reply;
        }
        if feed_view_post.post.like_count.unwrap_or_default() < pref.hide_replies_by_like_count {
            return is_self_reply;
        }
        if pref.hide_replies_by_unfollowed {
            return matches!(&reply.parent,
                Union::Refs(ReplyRefParentRefs::PostView(parent))
                    if parent.author.viewer.as_ref().map(|viewer| viewer.following.is_some()).unwrap_or_default()
            );
        }
    }
    // is quote post?
    else if matches!(
        &feed_view_post.post.embed,
        Some(Union::Refs(
            PostViewEmbedRefs::AppBskyEmbedRecordView(_)
                | PostViewEmbedRefs::AppBskyEmbedRecordWithMediaView(_)
        ))
    ) {
        return !pref.hide_quote_posts;
    }
    true
}

#[cfg(test)]
mod tests {
    use super::*;
    use bsky_sdk::api::app::bsky::actor::defs::{ProfileViewBasic, ProfileViewBasicData};
    use bsky_sdk::api::app::bsky::feed::defs::{FeedViewPostData, PostViewData, ReasonRepostData};
    use bsky_sdk::api::types::{Unknown, string::Datetime};
    use std::collections::BTreeMap;

    fn feed_view_post(cid: Cid, reason_indexed_at: Option<Datetime>) -> FeedViewPost {
        fn profile_view_basic() -> ProfileViewBasic {
            ProfileViewBasicData {
                associated: None,
                avatar: None,
                created_at: None,
                did: "did:fake:post.test".parse().expect("invalid did"),
                display_name: None,
                handle: "post.test".parse().expect("invalid handle"),
                labels: None,
                pronouns: None,
                status: None,
                verification: None,
                viewer: None,
            }
            .into()
        }

        FeedViewPostData {
            feed_context: None,
            post: PostViewData {
                author: profile_view_basic(),
                bookmark_count: None,
                cid,
                embed: None,
                indexed_at: Datetime::now(),
                labels: None,
                like_count: None,
                quote_count: None,
                record: Unknown::Object(BTreeMap::new()),
                reply_count: None,
                repost_count: None,
                threadgate: None,
                uri: String::new(),
                viewer: None,
            }
            .into(),
            reason: reason_indexed_at.map(|indexed_at| {
                Union::Refs(FeedViewPostReasonRefs::ReasonRepost(Box::new(
                    ReasonRepostData {
                        by: profile_view_basic(),
                        cid: None,
                        indexed_at,
                        uri: None,
                    }
                    .into(),
                )))
            }),
            reply: None,
            req_id: None,
        }
        .into()
    }

    #[test]
    fn update_feed_views() {
        let cids = [
            "bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a"
                .parse::<Cid>()
                .expect("invalid cid"),
            "bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz3a"
                .parse::<Cid>()
                .expect("invalid cid"),
            "bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz4a"
                .parse::<Cid>()
                .expect("invalid cid"),
        ];
        let mut feed_map = IndexMap::new();
        // Empty feeds
        update_feeds(&Vec::new(), &mut feed_map);
        assert_eq!(feed_map.len(), 0);
        // New feed
        update_feeds(&[feed_view_post(cids[0].clone(), None)], &mut feed_map);
        assert_eq!(feed_map.len(), 1);
        // Duplicate feed
        update_feeds(&[feed_view_post(cids[0].clone(), None)], &mut feed_map);
        assert_eq!(feed_map.len(), 1);
        // Duplicated and new feed
        update_feeds(
            &[
                feed_view_post(cids[0].clone(), None),
                feed_view_post(cids[1].clone(), None),
            ],
            &mut feed_map,
        );
        assert_eq!(feed_map.len(), 2);
        assert_eq!(feed_map[0].post.cid, cids[0]);
        assert_eq!(feed_map[1].post.cid, cids[1]);
        // New and duplicated feed
        update_feeds(
            &[
                feed_view_post(cids[2].clone(), None),
                feed_view_post(cids[1].clone(), None),
            ],
            &mut feed_map,
        );
        assert_eq!(feed_map.len(), 3);
        assert_eq!(feed_map[0].post.cid, cids[0]);
        assert_eq!(feed_map[1].post.cid, cids[1]);
        assert_eq!(feed_map[2].post.cid, cids[2]);
        // Duplicated, but updated feed
        update_feeds(
            &[
                feed_view_post(cids[1].clone(), Some(Datetime::now())),
                feed_view_post(cids[2].clone(), None),
            ],
            &mut feed_map,
        );
        assert_eq!(feed_map.len(), 3);
        println!("{:?}", feed_map.keys().collect::<Vec<_>>());
        assert_eq!(feed_map[0].post.cid, cids[0]);
        assert_eq!(feed_map[1].post.cid, cids[2]);
        assert_eq!(feed_map[2].post.cid, cids[1]);
        assert!(feed_map[0].reason.is_none());
        assert!(feed_map[1].reason.is_none());
        assert!(feed_map[2].reason.is_some());
        // Duplicated, but updated feed
        update_feeds(
            &[
                feed_view_post(cids[0].clone(), Some(Datetime::now())),
                feed_view_post(cids[1].clone(), Some(Datetime::now())),
            ],
            &mut feed_map,
        );
        assert_eq!(feed_map.len(), 3);
        println!("{:?}", feed_map.keys().collect::<Vec<_>>());
        assert_eq!(feed_map[1].post.cid, cids[2]);
        assert_eq!(feed_map[0].post.cid, cids[0]);
        assert_eq!(feed_map[2].post.cid, cids[1]);
        assert!(feed_map[0].reason.is_some());
        assert!(feed_map[1].reason.is_none());
        assert!(feed_map[2].reason.is_some());
    }
}