crates/db_views/src/private_message_view.rs

   1 use crate::structs::PrivateMessageView;
   2 use diesel::{
   3   debug_query,
   4   pg::Pg,
   5   result::Error,
   6   BoolExpressionMethods,
   7   ExpressionMethods,
   8   JoinOnDsl,
   9   QueryDsl,
  10 };
  11 use diesel_async::RunQueryDsl;
  12 use lemmy_db_schema::{
  13   aliases,
  14   newtypes::{PersonId, PrivateMessageId},
  15   schema::{person, private_message},
  16   source::{person::Person, private_message::PrivateMessage},
  17   traits::JoinView,
  18   utils::{get_conn, limit_and_offset, DbConn, DbPool, ListFn, Queries, ReadFn},
  19 };
  20 use tracing::debug;
  21
  22 type PrivateMessageViewTuple = (PrivateMessage, Person, Person);
  23
  24 fn queries<'a>() -> Queries<
  25   impl ReadFn<'a, PrivateMessageView, PrivateMessageId>,
  26   impl ListFn<'a, PrivateMessageView, (PrivateMessageQuery, PersonId)>,
  27 > {
  28   let all_joins = |query: private_message::BoxedQuery<'a, Pg>| {
  29     query
  30       .inner_join(person::table.on(private_message::creator_id.eq(person::id)))
  31       .inner_join(
  32         aliases::person1.on(private_message::recipient_id.eq(aliases::person1.field(person::id))),
  33       )
  34   };
  35
  36   let selection = (
  37     private_message::all_columns,
  38     person::all_columns,
  39     aliases::person1.fields(person::all_columns),
  40   );
  41
  42   let read = move |mut conn: DbConn<'a>, private_message_id: PrivateMessageId| async move {
  43     all_joins(private_message::table.find(private_message_id).into_boxed())
  44       .order_by(private_message::published.desc())
  45       .select(selection)
  46       .first::<PrivateMessageViewTuple>(&mut conn)
  47       .await
  48   };
  49
  50   let list = move |mut conn: DbConn<'a>,
  51                    (options, recipient_id): (PrivateMessageQuery, PersonId)| async move {
  52     let mut query = all_joins(private_message::table.into_boxed()).select(selection);
  53
  54     // If its unread, I only want the ones to me
  55     if options.unread_only {
  56       query = query.filter(private_message::read.eq(false));
  57       if let Some(i) = options.creator_id {
  58         query = query.filter(private_message::creator_id.eq(i))
  59       }
  60       query = query.filter(private_message::recipient_id.eq(recipient_id));
  61     }
  62     // Otherwise, I want the ALL view to show both sent and received
  63     else {
  64       query = query.filter(
  65         private_message::recipient_id
  66           .eq(recipient_id)
  67           .or(private_message::creator_id.eq(recipient_id)),
  68       );
  69       if let Some(i) = options.creator_id {
  70         query = query.filter(
  71           private_message::creator_id
  72             .eq(i)
  73             .or(private_message::recipient_id.eq(i)),
  74         )
  75       }
  76     }
  77
  78     let (limit, offset) = limit_and_offset(options.page, options.limit)?;
  79
  80     query = query
  81       .filter(private_message::deleted.eq(false))
  82       .limit(limit)
  83       .offset(offset)
  84       .order_by(private_message::published.desc());
  85
  86     debug!(
  87       "Private Message View Query: {:?}",
  88       debug_query::<Pg, _>(&query)
  89     );
  90
  91     query.load::<PrivateMessageViewTuple>(&mut conn).await
  92   };
  93
  94   Queries::new(read, list)
  95 }
  96
  97 impl PrivateMessageView {
  98   pub async fn read(
  99     pool: &mut DbPool<'_>,
 100     private_message_id: PrivateMessageId,
 101   ) -> Result<Self, Error> {
 102     queries().read(pool, private_message_id).await
 103   }
 104
 105   /// Gets the number of unread messages
 106   pub async fn get_unread_messages(
 107     pool: &mut DbPool<'_>,
 108     my_person_id: PersonId,
 109   ) -> Result<i64, Error> {
 110     use diesel::dsl::count;
 111     let conn = &mut get_conn(pool).await?;
 112     private_message::table
 113       .filter(private_message::read.eq(false))
 114       .filter(private_message::recipient_id.eq(my_person_id))
 115       .filter(private_message::deleted.eq(false))
 116       .select(count(private_message::id))
 117       .first::<i64>(conn)
 118       .await
 119   }
 120 }
 121
 122 #[derive(Default)]
 123 pub struct PrivateMessageQuery {
 124   pub unread_only: bool,
 125   pub page: Option<i64>,
 126   pub limit: Option<i64>,
 127   pub creator_id: Option<PersonId>,
 128 }
 129
 130 impl PrivateMessageQuery {
 131   pub async fn list(
 132     self,
 133     pool: &mut DbPool<'_>,
 134     recipient_id: PersonId,
 135   ) -> Result<Vec<PrivateMessageView>, Error> {
 136     queries().list(pool, (self, recipient_id)).await
 137   }
 138 }
 139
 140 impl JoinView for PrivateMessageView {
 141   type JoinTuple = PrivateMessageViewTuple;
 142   fn from_tuple(a: Self::JoinTuple) -> Self {
 143     Self {
 144       private_message: a.0,
 145       creator: a.1,
 146       recipient: a.2,
 147     }
 148   }
 149 }
 150
 151 #[cfg(test)]
 152 mod tests {
 153   #![allow(clippy::unwrap_used)]
 154   #![allow(clippy::indexing_slicing)]
 155
 156   use crate::private_message_view::PrivateMessageQuery;
 157   use lemmy_db_schema::{
 158     source::{
 159       instance::Instance,
 160       person::{Person, PersonInsertForm},
 161       private_message::{PrivateMessage, PrivateMessageInsertForm},
 162     },
 163     traits::Crud,
 164     utils::build_db_pool_for_tests,
 165   };
 166   use serial_test::serial;
 167
 168   #[tokio::test]
 169   #[serial]
 170   async fn test_crud() {
 171     let message_content = String::new();
 172     let pool = &build_db_pool_for_tests().await;
 173     let pool = &mut pool.into();
 174
 175     let instance = Instance::read_or_create(pool, "my_domain.tld".to_string())
 176       .await
 177       .unwrap();
 178
 179     let timmy_form = PersonInsertForm::builder()
 180       .name("timmy_rav".into())
 181       .admin(Some(true))
 182       .public_key("pubkey".to_string())
 183       .instance_id(instance.id)
 184       .build();
 185
 186     let timmy = Person::create(pool, &timmy_form).await.unwrap();
 187
 188     let sara_form = PersonInsertForm::builder()
 189       .name("sara_rav".into())
 190       .public_key("pubkey".to_string())
 191       .instance_id(instance.id)
 192       .build();
 193
 194     let sara = Person::create(pool, &sara_form).await.unwrap();
 195
 196     let jess_form = PersonInsertForm::builder()
 197       .name("jess_rav".into())
 198       .public_key("pubkey".to_string())
 199       .instance_id(instance.id)
 200       .build();
 201
 202     let jess = Person::create(pool, &jess_form).await.unwrap();
 203
 204     let sara_timmy_message_form = PrivateMessageInsertForm::builder()
 205       .creator_id(sara.id)
 206       .recipient_id(timmy.id)
 207       .content(message_content.clone())
 208       .build();
 209     let _inserted_sara_timmy_message_form = PrivateMessage::create(pool, &sara_timmy_message_form)
 210       .await
 211       .unwrap();
 212
 213     let sara_jess_message_form = PrivateMessageInsertForm::builder()
 214       .creator_id(sara.id)
 215       .recipient_id(jess.id)
 216       .content(message_content.clone())
 217       .build();
 218     let _inserted_sara_jess_message_form = PrivateMessage::create(pool, &sara_jess_message_form)
 219       .await
 220       .unwrap();
 221
 222     let timmy_sara_message_form = PrivateMessageInsertForm::builder()
 223       .creator_id(timmy.id)
 224       .recipient_id(sara.id)
 225       .content(message_content.clone())
 226       .build();
 227     let _inserted_timmy_sara_message_form = PrivateMessage::create(pool, &timmy_sara_message_form)
 228       .await
 229       .unwrap();
 230
 231     let jess_timmy_message_form = PrivateMessageInsertForm::builder()
 232       .creator_id(jess.id)
 233       .recipient_id(timmy.id)
 234       .content(message_content.clone())
 235       .build();
 236     let _inserted_jess_timmy_message_form = PrivateMessage::create(pool, &jess_timmy_message_form)
 237       .await
 238       .unwrap();
 239
 240     let timmy_messages = PrivateMessageQuery {
 241       unread_only: false,
 242       creator_id: Option::None,
 243       ..Default::default()
 244     }
 245     .list(pool, timmy.id)
 246     .await
 247     .unwrap();
 248
 249     assert_eq!(timmy_messages.len(), 3);
 250     assert_eq!(timmy_messages[0].creator.id, jess.id);
 251     assert_eq!(timmy_messages[0].recipient.id, timmy.id);
 252     assert_eq!(timmy_messages[1].creator.id, timmy.id);
 253     assert_eq!(timmy_messages[1].recipient.id, sara.id);
 254     assert_eq!(timmy_messages[2].creator.id, sara.id);
 255     assert_eq!(timmy_messages[2].recipient.id, timmy.id);
 256
 257     let timmy_unread_messages = PrivateMessageQuery {
 258       unread_only: true,
 259       creator_id: Option::None,
 260       ..Default::default()
 261     }
 262     .list(pool, timmy.id)
 263     .await
 264     .unwrap();
 265
 266     assert_eq!(timmy_unread_messages.len(), 2);
 267     assert_eq!(timmy_unread_messages[0].creator.id, jess.id);
 268     assert_eq!(timmy_unread_messages[0].recipient.id, timmy.id);
 269     assert_eq!(timmy_unread_messages[1].creator.id, sara.id);
 270     assert_eq!(timmy_unread_messages[1].recipient.id, timmy.id);
 271
 272     let timmy_sara_messages = PrivateMessageQuery {
 273       unread_only: false,
 274       creator_id: Some(sara.id),
 275       ..Default::default()
 276     }
 277     .list(pool, timmy.id)
 278     .await
 279     .unwrap();
 280
 281     assert_eq!(timmy_sara_messages.len(), 2);
 282     assert_eq!(timmy_sara_messages[0].creator.id, timmy.id);
 283     assert_eq!(timmy_sara_messages[0].recipient.id, sara.id);
 284     assert_eq!(timmy_sara_messages[1].creator.id, sara.id);
 285     assert_eq!(timmy_sara_messages[1].recipient.id, timmy.id);
 286
 287     let timmy_sara_unread_messages = PrivateMessageQuery {
 288       unread_only: true,
 289       creator_id: Some(sara.id),
 290       ..Default::default()
 291     }
 292     .list(pool, timmy.id)
 293     .await
 294     .unwrap();
 295
 296     assert_eq!(timmy_sara_unread_messages.len(), 1);
 297     assert_eq!(timmy_sara_unread_messages[0].creator.id, sara.id);
 298     assert_eq!(timmy_sara_unread_messages[0].recipient.id, timmy.id);
 299   }
 300 }