]> Untitled Git - lemmy.git/blob - crates/db_schema/src/impls/comment.rs
Cache & Optimize Woodpecker CI (#3450)
[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   async fn read(pool: &mut DbPool<'_>, comment_id: CommentId) -> Result<Self, Error> {
160     let conn = &mut get_conn(pool).await?;
161     comment.find(comment_id).first::<Self>(conn).await
162   }
163
164   async fn delete(pool: &mut DbPool<'_>, comment_id: CommentId) -> Result<usize, Error> {
165     let conn = &mut get_conn(pool).await?;
166     diesel::delete(comment.find(comment_id)).execute(conn).await
167   }
168
169   /// This is unimplemented, use [[Comment::create]]
170   async fn create(_pool: &mut DbPool<'_>, _comment_form: &Self::InsertForm) -> Result<Self, Error> {
171     unimplemented!();
172   }
173
174   async fn update(
175     pool: &mut DbPool<'_>,
176     comment_id: CommentId,
177     comment_form: &Self::UpdateForm,
178   ) -> Result<Self, Error> {
179     let conn = &mut get_conn(pool).await?;
180     diesel::update(comment.find(comment_id))
181       .set(comment_form)
182       .get_result::<Self>(conn)
183       .await
184   }
185 }
186
187 #[async_trait]
188 impl Likeable for CommentLike {
189   type Form = CommentLikeForm;
190   type IdType = CommentId;
191   async fn like(pool: &mut DbPool<'_>, comment_like_form: &CommentLikeForm) -> Result<Self, Error> {
192     use crate::schema::comment_like::dsl::{comment_id, comment_like, person_id};
193     let conn = &mut get_conn(pool).await?;
194     insert_into(comment_like)
195       .values(comment_like_form)
196       .on_conflict((comment_id, person_id))
197       .do_update()
198       .set(comment_like_form)
199       .get_result::<Self>(conn)
200       .await
201   }
202   async fn remove(
203     pool: &mut DbPool<'_>,
204     person_id_: PersonId,
205     comment_id_: CommentId,
206   ) -> Result<usize, Error> {
207     use crate::schema::comment_like::dsl::{comment_id, comment_like, person_id};
208     let conn = &mut get_conn(pool).await?;
209     diesel::delete(
210       comment_like
211         .filter(comment_id.eq(comment_id_))
212         .filter(person_id.eq(person_id_)),
213     )
214     .execute(conn)
215     .await
216   }
217 }
218
219 #[async_trait]
220 impl Saveable for CommentSaved {
221   type Form = CommentSavedForm;
222   async fn save(
223     pool: &mut DbPool<'_>,
224     comment_saved_form: &CommentSavedForm,
225   ) -> Result<Self, Error> {
226     use crate::schema::comment_saved::dsl::{comment_id, comment_saved, person_id};
227     let conn = &mut get_conn(pool).await?;
228     insert_into(comment_saved)
229       .values(comment_saved_form)
230       .on_conflict((comment_id, person_id))
231       .do_update()
232       .set(comment_saved_form)
233       .get_result::<Self>(conn)
234       .await
235   }
236   async fn unsave(
237     pool: &mut DbPool<'_>,
238     comment_saved_form: &CommentSavedForm,
239   ) -> Result<usize, Error> {
240     use crate::schema::comment_saved::dsl::{comment_id, comment_saved, person_id};
241     let conn = &mut get_conn(pool).await?;
242     diesel::delete(
243       comment_saved
244         .filter(comment_id.eq(comment_saved_form.comment_id))
245         .filter(person_id.eq(comment_saved_form.person_id)),
246     )
247     .execute(conn)
248     .await
249   }
250 }
251
252 #[cfg(test)]
253 mod tests {
254   #![allow(clippy::unwrap_used)]
255   #![allow(clippy::indexing_slicing)]
256
257   use crate::{
258     newtypes::LanguageId,
259     source::{
260       comment::{
261         Comment,
262         CommentInsertForm,
263         CommentLike,
264         CommentLikeForm,
265         CommentSaved,
266         CommentSavedForm,
267         CommentUpdateForm,
268       },
269       community::{Community, CommunityInsertForm},
270       instance::Instance,
271       person::{Person, PersonInsertForm},
272       post::{Post, PostInsertForm},
273     },
274     traits::{Crud, Likeable, Saveable},
275     utils::build_db_pool_for_tests,
276   };
277   use diesel_ltree::Ltree;
278   use serial_test::serial;
279
280   #[tokio::test]
281   #[serial]
282   async fn test_crud() {
283     let pool = &build_db_pool_for_tests().await;
284     let pool = &mut pool.into();
285
286     let inserted_instance = Instance::read_or_create(pool, "my_domain.tld".to_string())
287       .await
288       .unwrap();
289
290     let new_person = PersonInsertForm::builder()
291       .name("terry".into())
292       .public_key("pubkey".to_string())
293       .instance_id(inserted_instance.id)
294       .build();
295
296     let inserted_person = Person::create(pool, &new_person).await.unwrap();
297
298     let new_community = CommunityInsertForm::builder()
299       .name("test community".to_string())
300       .title("nada".to_owned())
301       .public_key("pubkey".to_string())
302       .instance_id(inserted_instance.id)
303       .build();
304
305     let inserted_community = Community::create(pool, &new_community).await.unwrap();
306
307     let new_post = PostInsertForm::builder()
308       .name("A test post".into())
309       .creator_id(inserted_person.id)
310       .community_id(inserted_community.id)
311       .build();
312
313     let inserted_post = Post::create(pool, &new_post).await.unwrap();
314
315     let comment_form = CommentInsertForm::builder()
316       .content("A test comment".into())
317       .creator_id(inserted_person.id)
318       .post_id(inserted_post.id)
319       .build();
320
321     let inserted_comment = Comment::create(pool, &comment_form, None).await.unwrap();
322
323     let expected_comment = Comment {
324       id: inserted_comment.id,
325       content: "A test comment".into(),
326       creator_id: inserted_person.id,
327       post_id: inserted_post.id,
328       removed: false,
329       deleted: false,
330       path: Ltree(format!("0.{}", inserted_comment.id)),
331       published: inserted_comment.published,
332       updated: None,
333       ap_id: inserted_comment.ap_id.clone(),
334       distinguished: false,
335       local: true,
336       language_id: LanguageId::default(),
337     };
338
339     let child_comment_form = CommentInsertForm::builder()
340       .content("A child comment".into())
341       .creator_id(inserted_person.id)
342       .post_id(inserted_post.id)
343       .build();
344
345     let inserted_child_comment =
346       Comment::create(pool, &child_comment_form, Some(&inserted_comment.path))
347         .await
348         .unwrap();
349
350     // Comment Like
351     let comment_like_form = CommentLikeForm {
352       comment_id: inserted_comment.id,
353       post_id: inserted_post.id,
354       person_id: inserted_person.id,
355       score: 1,
356     };
357
358     let inserted_comment_like = CommentLike::like(pool, &comment_like_form).await.unwrap();
359
360     let expected_comment_like = CommentLike {
361       id: inserted_comment_like.id,
362       comment_id: inserted_comment.id,
363       post_id: inserted_post.id,
364       person_id: inserted_person.id,
365       published: inserted_comment_like.published,
366       score: 1,
367     };
368
369     // Comment Saved
370     let comment_saved_form = CommentSavedForm {
371       comment_id: inserted_comment.id,
372       person_id: inserted_person.id,
373     };
374
375     let inserted_comment_saved = CommentSaved::save(pool, &comment_saved_form).await.unwrap();
376
377     let expected_comment_saved = CommentSaved {
378       id: inserted_comment_saved.id,
379       comment_id: inserted_comment.id,
380       person_id: inserted_person.id,
381       published: inserted_comment_saved.published,
382     };
383
384     let comment_update_form = CommentUpdateForm::builder()
385       .content(Some("A test comment".into()))
386       .build();
387
388     let updated_comment = Comment::update(pool, inserted_comment.id, &comment_update_form)
389       .await
390       .unwrap();
391
392     let read_comment = Comment::read(pool, inserted_comment.id).await.unwrap();
393     let like_removed = CommentLike::remove(pool, inserted_person.id, inserted_comment.id)
394       .await
395       .unwrap();
396     let saved_removed = CommentSaved::unsave(pool, &comment_saved_form)
397       .await
398       .unwrap();
399     let num_deleted = Comment::delete(pool, inserted_comment.id).await.unwrap();
400     Comment::delete(pool, inserted_child_comment.id)
401       .await
402       .unwrap();
403     Post::delete(pool, inserted_post.id).await.unwrap();
404     Community::delete(pool, inserted_community.id)
405       .await
406       .unwrap();
407     Person::delete(pool, inserted_person.id).await.unwrap();
408     Instance::delete(pool, inserted_instance.id).await.unwrap();
409
410     assert_eq!(expected_comment, read_comment);
411     assert_eq!(expected_comment, inserted_comment);
412     assert_eq!(expected_comment, updated_comment);
413     assert_eq!(expected_comment_like, inserted_comment_like);
414     assert_eq!(expected_comment_saved, inserted_comment_saved);
415     assert_eq!(
416       format!("0.{}.{}", expected_comment.id, inserted_child_comment.id),
417       inserted_child_comment.path.0,
418     );
419     assert_eq!(1, like_removed);
420     assert_eq!(1, saved_removed);
421     assert_eq!(1, num_deleted);
422   }
423 }