]> Untitled Git - lemmy.git/blob - crates/db_schema/src/impls/comment.rs
Automatically resolve report when post/comment is removed (#3850)
[lemmy.git] / crates / db_schema / src / impls / comment.rs
1 use crate::{
2   newtypes::{CommentId, DbUrl, PersonId},
3   schema::comment::dsl::{ap_id, comment, content, creator_id, deleted, path, removed, updated},
4   source::comment::{
5     Comment,
6     CommentInsertForm,
7     CommentLike,
8     CommentLikeForm,
9     CommentSaved,
10     CommentSavedForm,
11     CommentUpdateForm,
12   },
13   traits::{Crud, Likeable, Saveable},
14   utils::{get_conn, naive_now, DbPool, DELETED_REPLACEMENT_TEXT},
15 };
16 use diesel::{
17   dsl::{insert_into, sql_query},
18   result::Error,
19   ExpressionMethods,
20   QueryDsl,
21 };
22 use diesel_async::RunQueryDsl;
23 use diesel_ltree::Ltree;
24 use url::Url;
25
26 impl Comment {
27   pub async fn permadelete_for_creator(
28     pool: &mut DbPool<'_>,
29     for_creator_id: PersonId,
30   ) -> Result<Vec<Self>, Error> {
31     let conn = &mut get_conn(pool).await?;
32
33     diesel::update(comment.filter(creator_id.eq(for_creator_id)))
34       .set((
35         content.eq(DELETED_REPLACEMENT_TEXT),
36         deleted.eq(true),
37         updated.eq(naive_now()),
38       ))
39       .get_results::<Self>(conn)
40       .await
41   }
42
43   pub async fn update_removed_for_creator(
44     pool: &mut DbPool<'_>,
45     for_creator_id: PersonId,
46     new_removed: bool,
47   ) -> Result<Vec<Self>, Error> {
48     let conn = &mut get_conn(pool).await?;
49     diesel::update(comment.filter(creator_id.eq(for_creator_id)))
50       .set((removed.eq(new_removed), updated.eq(naive_now())))
51       .get_results::<Self>(conn)
52       .await
53   }
54
55   pub async fn create(
56     pool: &mut DbPool<'_>,
57     comment_form: &CommentInsertForm,
58     parent_path: Option<&Ltree>,
59   ) -> Result<Comment, Error> {
60     let conn = &mut get_conn(pool).await?;
61
62     // Insert, to get the id
63     let inserted_comment = insert_into(comment)
64       .values(comment_form)
65       .on_conflict(ap_id)
66       .do_update()
67       .set(comment_form)
68       .get_result::<Self>(conn)
69       .await;
70
71     if let Ok(comment_insert) = inserted_comment {
72       let comment_id = comment_insert.id;
73
74       // You need to update the ltree column
75       let ltree = Ltree(if let Some(parent_path) = parent_path {
76         // The previous parent will already have 0 in it
77         // Append this comment id
78         format!("{}.{}", parent_path.0, comment_id)
79       } else {
80         // '0' is always the first path, append to that
81         format!("{}.{}", 0, comment_id)
82       });
83
84       let updated_comment = diesel::update(comment.find(comment_id))
85         .set(path.eq(ltree))
86         .get_result::<Self>(conn)
87         .await;
88
89       // Update the child count for the parent comment_aggregates
90       // You could do this with a trigger, but since you have to do this manually anyway,
91       // you can just have it here
92       if let Some(parent_path) = parent_path {
93         // You have to update counts for all parents, not just the immediate one
94         // TODO if the performance of this is terrible, it might be better to do this as part of a
95         // scheduled query... although the counts would often be wrong.
96         //
97         // The child_count query for reference:
98         // select c.id, c.path, count(c2.id) as child_count from comment c
99         // left join comment c2 on c2.path <@ c.path and c2.path != c.path
100         // group by c.id
101
102         let parent_id = parent_path.0.split('.').nth(1);
103
104         if let Some(parent_id) = parent_id {
105           let top_parent = format!("0.{}", parent_id);
106           let update_child_count_stmt = format!(
107             "
108 update comment_aggregates ca set child_count = c.child_count
109 from (
110   select c.id, c.path, count(c2.id) as child_count from comment c
111   join comment c2 on c2.path <@ c.path and c2.path != c.path
112   and c.path <@ '{top_parent}'
113   group by c.id
114 ) as c
115 where ca.comment_id = c.id"
116           );
117
118           sql_query(update_child_count_stmt).execute(conn).await?;
119         }
120       }
121       updated_comment
122     } else {
123       inserted_comment
124     }
125   }
126   pub async fn read_from_apub_id(
127     pool: &mut DbPool<'_>,
128     object_id: Url,
129   ) -> Result<Option<Self>, Error> {
130     let conn = &mut get_conn(pool).await?;
131     let object_id: DbUrl = object_id.into();
132     Ok(
133       comment
134         .filter(ap_id.eq(object_id))
135         .first::<Comment>(conn)
136         .await
137         .ok()
138         .map(Into::into),
139     )
140   }
141
142   pub fn parent_comment_id(&self) -> Option<CommentId> {
143     let mut ltree_split: Vec<&str> = self.path.0.split('.').collect();
144     ltree_split.remove(0); // The first is always 0
145     if ltree_split.len() > 1 {
146       let parent_comment_id = ltree_split.get(ltree_split.len() - 2);
147       parent_comment_id.and_then(|p| p.parse::<i32>().map(CommentId).ok())
148     } else {
149       None
150     }
151   }
152 }
153
154 #[async_trait]
155 impl Crud for Comment {
156   type InsertForm = CommentInsertForm;
157   type UpdateForm = CommentUpdateForm;
158   type IdType = CommentId;
159
160   /// This is unimplemented, use [[Comment::create]]
161   async fn create(_pool: &mut DbPool<'_>, _comment_form: &Self::InsertForm) -> Result<Self, Error> {
162     unimplemented!();
163   }
164
165   async fn update(
166     pool: &mut DbPool<'_>,
167     comment_id: CommentId,
168     comment_form: &Self::UpdateForm,
169   ) -> Result<Self, Error> {
170     let conn = &mut get_conn(pool).await?;
171     diesel::update(comment.find(comment_id))
172       .set(comment_form)
173       .get_result::<Self>(conn)
174       .await
175   }
176 }
177
178 #[async_trait]
179 impl Likeable for CommentLike {
180   type Form = CommentLikeForm;
181   type IdType = CommentId;
182   async fn like(pool: &mut DbPool<'_>, comment_like_form: &CommentLikeForm) -> Result<Self, Error> {
183     use crate::schema::comment_like::dsl::{comment_id, comment_like, person_id};
184     let conn = &mut get_conn(pool).await?;
185     insert_into(comment_like)
186       .values(comment_like_form)
187       .on_conflict((comment_id, person_id))
188       .do_update()
189       .set(comment_like_form)
190       .get_result::<Self>(conn)
191       .await
192   }
193   async fn remove(
194     pool: &mut DbPool<'_>,
195     person_id_: PersonId,
196     comment_id_: CommentId,
197   ) -> Result<usize, Error> {
198     use crate::schema::comment_like::dsl::{comment_id, comment_like, person_id};
199     let conn = &mut get_conn(pool).await?;
200     diesel::delete(
201       comment_like
202         .filter(comment_id.eq(comment_id_))
203         .filter(person_id.eq(person_id_)),
204     )
205     .execute(conn)
206     .await
207   }
208 }
209
210 #[async_trait]
211 impl Saveable for CommentSaved {
212   type Form = CommentSavedForm;
213   async fn save(
214     pool: &mut DbPool<'_>,
215     comment_saved_form: &CommentSavedForm,
216   ) -> Result<Self, Error> {
217     use crate::schema::comment_saved::dsl::{comment_id, comment_saved, person_id};
218     let conn = &mut get_conn(pool).await?;
219     insert_into(comment_saved)
220       .values(comment_saved_form)
221       .on_conflict((comment_id, person_id))
222       .do_update()
223       .set(comment_saved_form)
224       .get_result::<Self>(conn)
225       .await
226   }
227   async fn unsave(
228     pool: &mut DbPool<'_>,
229     comment_saved_form: &CommentSavedForm,
230   ) -> Result<usize, Error> {
231     use crate::schema::comment_saved::dsl::{comment_id, comment_saved, person_id};
232     let conn = &mut get_conn(pool).await?;
233     diesel::delete(
234       comment_saved
235         .filter(comment_id.eq(comment_saved_form.comment_id))
236         .filter(person_id.eq(comment_saved_form.person_id)),
237     )
238     .execute(conn)
239     .await
240   }
241 }
242
243 #[cfg(test)]
244 mod tests {
245   #![allow(clippy::unwrap_used)]
246   #![allow(clippy::indexing_slicing)]
247
248   use crate::{
249     newtypes::LanguageId,
250     source::{
251       comment::{
252         Comment,
253         CommentInsertForm,
254         CommentLike,
255         CommentLikeForm,
256         CommentSaved,
257         CommentSavedForm,
258         CommentUpdateForm,
259       },
260       community::{Community, CommunityInsertForm},
261       instance::Instance,
262       person::{Person, PersonInsertForm},
263       post::{Post, PostInsertForm},
264     },
265     traits::{Crud, Likeable, Saveable},
266     utils::build_db_pool_for_tests,
267   };
268   use diesel_ltree::Ltree;
269   use serial_test::serial;
270
271   #[tokio::test]
272   #[serial]
273   async fn test_crud() {
274     let pool = &build_db_pool_for_tests().await;
275     let pool = &mut pool.into();
276
277     let inserted_instance = Instance::read_or_create(pool, "my_domain.tld".to_string())
278       .await
279       .unwrap();
280
281     let new_person = PersonInsertForm::builder()
282       .name("terry".into())
283       .public_key("pubkey".to_string())
284       .instance_id(inserted_instance.id)
285       .build();
286
287     let inserted_person = Person::create(pool, &new_person).await.unwrap();
288
289     let new_community = CommunityInsertForm::builder()
290       .name("test community".to_string())
291       .title("nada".to_owned())
292       .public_key("pubkey".to_string())
293       .instance_id(inserted_instance.id)
294       .build();
295
296     let inserted_community = Community::create(pool, &new_community).await.unwrap();
297
298     let new_post = PostInsertForm::builder()
299       .name("A test post".into())
300       .creator_id(inserted_person.id)
301       .community_id(inserted_community.id)
302       .build();
303
304     let inserted_post = Post::create(pool, &new_post).await.unwrap();
305
306     let comment_form = CommentInsertForm::builder()
307       .content("A test comment".into())
308       .creator_id(inserted_person.id)
309       .post_id(inserted_post.id)
310       .build();
311
312     let inserted_comment = Comment::create(pool, &comment_form, None).await.unwrap();
313
314     let expected_comment = Comment {
315       id: inserted_comment.id,
316       content: "A test comment".into(),
317       creator_id: inserted_person.id,
318       post_id: inserted_post.id,
319       removed: false,
320       deleted: false,
321       path: Ltree(format!("0.{}", inserted_comment.id)),
322       published: inserted_comment.published,
323       updated: None,
324       ap_id: inserted_comment.ap_id.clone(),
325       distinguished: false,
326       local: true,
327       language_id: LanguageId::default(),
328     };
329
330     let child_comment_form = CommentInsertForm::builder()
331       .content("A child comment".into())
332       .creator_id(inserted_person.id)
333       .post_id(inserted_post.id)
334       .build();
335
336     let inserted_child_comment =
337       Comment::create(pool, &child_comment_form, Some(&inserted_comment.path))
338         .await
339         .unwrap();
340
341     // Comment Like
342     let comment_like_form = CommentLikeForm {
343       comment_id: inserted_comment.id,
344       post_id: inserted_post.id,
345       person_id: inserted_person.id,
346       score: 1,
347     };
348
349     let inserted_comment_like = CommentLike::like(pool, &comment_like_form).await.unwrap();
350
351     let expected_comment_like = CommentLike {
352       id: inserted_comment_like.id,
353       comment_id: inserted_comment.id,
354       post_id: inserted_post.id,
355       person_id: inserted_person.id,
356       published: inserted_comment_like.published,
357       score: 1,
358     };
359
360     // Comment Saved
361     let comment_saved_form = CommentSavedForm {
362       comment_id: inserted_comment.id,
363       person_id: inserted_person.id,
364     };
365
366     let inserted_comment_saved = CommentSaved::save(pool, &comment_saved_form).await.unwrap();
367
368     let expected_comment_saved = CommentSaved {
369       id: inserted_comment_saved.id,
370       comment_id: inserted_comment.id,
371       person_id: inserted_person.id,
372       published: inserted_comment_saved.published,
373     };
374
375     let comment_update_form = CommentUpdateForm {
376       content: Some("A test comment".into()),
377       ..Default::default()
378     };
379
380     let updated_comment = Comment::update(pool, inserted_comment.id, &comment_update_form)
381       .await
382       .unwrap();
383
384     let read_comment = Comment::read(pool, inserted_comment.id).await.unwrap();
385     let like_removed = CommentLike::remove(pool, inserted_person.id, inserted_comment.id)
386       .await
387       .unwrap();
388     let saved_removed = CommentSaved::unsave(pool, &comment_saved_form)
389       .await
390       .unwrap();
391     let num_deleted = Comment::delete(pool, inserted_comment.id).await.unwrap();
392     Comment::delete(pool, inserted_child_comment.id)
393       .await
394       .unwrap();
395     Post::delete(pool, inserted_post.id).await.unwrap();
396     Community::delete(pool, inserted_community.id)
397       .await
398       .unwrap();
399     Person::delete(pool, inserted_person.id).await.unwrap();
400     Instance::delete(pool, inserted_instance.id).await.unwrap();
401
402     assert_eq!(expected_comment, read_comment);
403     assert_eq!(expected_comment, inserted_comment);
404     assert_eq!(expected_comment, updated_comment);
405     assert_eq!(expected_comment_like, inserted_comment_like);
406     assert_eq!(expected_comment_saved, inserted_comment_saved);
407     assert_eq!(
408       format!("0.{}.{}", expected_comment.id, inserted_child_comment.id),
409       inserted_child_comment.path.0,
410     );
411     assert_eq!(1, like_removed);
412     assert_eq!(1, saved_removed);
413     assert_eq!(1, num_deleted);
414   }
415 }