fix(article-comments): replies edge case & add is_reply_to_others flag

Author: mydearxym

lib/groupher_server/cms/delegates/article_comment.ex

@@ -355,10 +355,6 @@ defmodule GroupherServer.CMS.Delegate.ArticleComment do
       |> Multi.run(:add_participator, fn _, _ ->
         add_participator_to_article(article, user)
       end)
-      # |> Multi.run(:mention_users, fn _, %{create_comment: comment} ->
-      #   Delivery.mention_from_comment(community, thread, content, comment, args, user)
-      #   {:ok, :pass}
-      # end)
       |> Repo.transaction()
       |> upsert_comment_result()
     end
@@ -368,7 +364,7 @@ defmodule GroupherServer.CMS.Delegate.ArticleComment do
   def reply_article_comment(comment_id, content, %User{} = user) do
     with {:ok, target_comment} <-
            ORM.find_by(ArticleComment, %{id: comment_id, is_deleted: false}),
-         replying_comment <- Repo.preload(target_comment, :reply_to),
+         replying_comment <- Repo.preload(target_comment, reply_to: :author),
          {thread, article} <- get_article(replying_comment),
          {:ok, info} <- match(thread),
          parent_comment <- get_parent_comment(replying_comment) do
@@ -394,6 +390,9 @@ defmodule GroupherServer.CMS.Delegate.ArticleComment do
       |> Multi.run(:add_participator, fn _, _ ->
         add_participator_to_article(article, user)
       end)
+      |> Multi.run(:set_meta_flag, fn _, %{create_reply_comment: replyed_comment} ->
+        update_reply_to_others_state(parent_comment, replying_comment, replyed_comment)
+      end)
       |> Multi.run(:add_reply_to, fn _, %{create_reply_comment: replyed_comment} ->
         replyed_comment
         |> Repo.preload(:reply_to)
@@ -467,7 +466,8 @@ defmodule GroupherServer.CMS.Delegate.ArticleComment do
   end
 
   # update comment's parent article's comments total count
-  defp update_article_comments_count(%ArticleComment{} = comment, opt \\ :inc) do
+  @spec update_article_comments_count(ArticleComment.t(), :inc | :dec) :: ArticleComment.t()
+  defp update_article_comments_count(%ArticleComment{} = comment, opt) do
     with {:ok, article_info} <- match(:comment_article, comment),
          {:ok, article} <- ORM.find(article_info.model, article_info.id) do
       count_query =
@@ -479,7 +479,7 @@ defmodule GroupherServer.CMS.Delegate.ArticleComment do
         :inc ->
           ORM.update(article, %{article_comments_count: cur_count - 1 + 1})
 
-        _ ->
+        :dec ->
           ORM.update(article, %{article_comments_count: Enum.max([0, cur_count - 1])})
       end
     end
@@ -515,9 +515,9 @@ defmodule GroupherServer.CMS.Delegate.ArticleComment do
     comment
   end
 
-  defp get_parent_comment(%ArticleComment{reply_to_id: _} = comment) do
-    Repo.preload(comment, :reply_to) |> Map.get(:reply_to)
-    # get_parent_comment(Repo.preload(comment, :reply_to))
+  defp get_parent_comment(%ArticleComment{reply_to_id: reply_to_id} = comment)
+       when not is_nil(reply_to_id) do
+    get_parent_comment(Repo.preload(comment.reply_to, reply_to: :author))
   end
 
   # 如果 replies 没有达到 @max_parent_replies_count, 则添加
@@ -563,18 +563,6 @@ defmodule GroupherServer.CMS.Delegate.ArticleComment do
 
   defp add_participator_to_article(_, _), do: {:ok, :pass}
 
-  defp get_article(%ArticleComment{post_id: post_id} = comment) when not is_nil(post_id) do
-    with {:ok, article} <- ORM.find(Post, comment.post_id, preload: [author: :user]) do
-      {:post, article}
-    end
-  end
-
-  defp get_article(%ArticleComment{job_id: job_id} = comment) when not is_nil(job_id) do
-    with {:ok, article} <- ORM.find(Job, comment.job_id, preload: [author: :user]) do
-      {:job, article}
-    end
-  end
-
   defp user_in_logins?([], _), do: false
   defp user_in_logins?(ids_list, %User{login: login}), do: Enum.member?(ids_list, login)
 
@@ -599,6 +587,18 @@ defmodule GroupherServer.CMS.Delegate.ArticleComment do
     %{paged_comments | entries: new_entries}
   end
 
+  defp get_article(%ArticleComment{post_id: post_id} = comment) when not is_nil(post_id) do
+    with {:ok, article} <- ORM.find(Post, comment.post_id, preload: [author: :user]) do
+      {:post, article}
+    end
+  end
+
+  defp get_article(%ArticleComment{job_id: job_id} = comment) when not is_nil(job_id) do
+    with {:ok, article} <- ORM.find(Job, comment.job_id, preload: [author: :user]) do
+      {:job, article}
+    end
+  end
+
   @spec get_full_comment(String.t()) :: {:ok, T.article_info()} | {:error, nil}
   defp get_full_comment(comment_id) do
     query = from(c in ArticleComment, where: c.id == ^comment_id, preload: :post, preload: :job)
@@ -633,6 +633,27 @@ defmodule GroupherServer.CMS.Delegate.ArticleComment do
     end
   end
 
+  # used in replies mode, for those reply to other user in replies box (for frontend)
+  # 用于回复模式，指代这条回复是回复“回复列表其他人的” （方便前端展示）
+  defp update_reply_to_others_state(parent_comment, replying_comment, replyed_comment) do
+    replying_comment = replying_comment |> Repo.preload(:author)
+    parent_comment = parent_comment |> Repo.preload(:author)
+    is_reply_to_others = parent_comment.author.id !== replying_comment.author.id
+
+    case is_reply_to_others do
+      true ->
+        new_meta =
+          replyed_comment.meta
+          |> Map.from_struct()
+          |> Map.merge(%{is_reply_to_others: is_reply_to_others})
+
+        ORM.update(replyed_comment, %{meta: new_meta})
+
+      false ->
+        {:ok, :pass}
+    end
+  end
+
   defp upsert_comment_result({:ok, %{create_article_comment: result}}), do: {:ok, result}
   defp upsert_comment_result({:ok, %{add_reply_to: result}}), do: {:ok, result}
   defp upsert_comment_result({:ok, %{check_article_author_upvoted: result}}), do: {:ok, result}

lib/groupher_server/cms/embeds/article_comment_meta.ex

@@ -5,11 +5,12 @@ defmodule GroupherServer.CMS.Embeds.ArticleCommentMeta do
   use Ecto.Schema
   import Ecto.Changeset
 
-  @optional_fields ~w(is_article_author_upvoted is_solution report_count)a
+  @optional_fields ~w(is_article_author_upvoted is_solution report_count is_reply_to_others)a
 
   @default_meta %{
     is_article_author_upvoted: false,
     is_solution: false,
+    is_reply_to_others: false,
     report_count: 0
   }
 
@@ -19,7 +20,9 @@ defmodule GroupherServer.CMS.Embeds.ArticleCommentMeta do
   embedded_schema do
     field(:is_article_author_upvoted, :boolean, default: false)
     field(:is_solution, :boolean, default: false)
-
+    # used in replies mode, for those reply to other user in replies box (for frontend)
+    # 用于回复模式，指代这条回复是回复“回复列表其他人的” （方便前端展示）
+    field(:is_reply_to_others, :boolean, default: false)
     field(:report_count, :integer, default: 0)
   end
 

lib/groupher_server_web/schema/cms/cms_types.ex

@@ -336,6 +336,8 @@ defmodule GroupherServerWeb.Schema.CMS.Types do
 
   object :article_comment_meta do
     field(:is_article_author_upvoted, :boolean)
+    field(:is_reply_to_others, :boolean)
+
     # field(:report_count, :boolean)
     # field(:is_solution, :boolean)
   end

test/groupher_server/cms/article_comment_replies_test.exs

@@ -65,33 +65,50 @@ defmodule GroupherServer.Test.CMS.ArticleCommentReplies do
       assert exist_in?(replyed_comment_2, parent_comment.replies)
     end
 
-    @tag :wip
+    @tag :wip2
     test "reply to reply inside a comment should belong same parent comment",
          ~m(post user user2)a do
-      parent_content = "parent comment"
-      reply_content_1 = "reply comment 1"
-      reply_content_2 = "reply comment 2"
-
-      {:ok, parent_comment} = CMS.create_article_comment(:post, post.id, parent_content, user)
-
-      {:ok, replyed_comment_1} =
-        CMS.reply_article_comment(parent_comment.id, reply_content_1, user2)
-
-      {:ok, replyed_comment_2} =
-        CMS.reply_article_comment(replyed_comment_1.id, reply_content_2, user2)
+      {:ok, parent_comment} = CMS.create_article_comment(:post, post.id, "parent comment", user)
 
-      # IO.inspect(replyed_comment_2, label: "replyed_comment_2")
+      {:ok, replyed_comment_1} = CMS.reply_article_comment(parent_comment.id, "reply 1", user2)
+      {:ok, replyed_comment_2} = CMS.reply_article_comment(replyed_comment_1.id, "reply 2", user2)
+      {:ok, replyed_comment_3} = CMS.reply_article_comment(replyed_comment_2.id, "reply 3", user)
 
       {:ok, parent_comment} = ORM.find(ArticleComment, parent_comment.id)
 
+      # IO.inspect(parent_comment.replies, label: "parent_comment.replies")
+
       assert exist_in?(replyed_comment_1, parent_comment.replies)
       assert exist_in?(replyed_comment_2, parent_comment.replies)
+      assert exist_in?(replyed_comment_3, parent_comment.replies)
 
       {:ok, replyed_comment_1} = ORM.find(ArticleComment, replyed_comment_1.id)
       {:ok, replyed_comment_2} = ORM.find(ArticleComment, replyed_comment_2.id)
+      {:ok, replyed_comment_3} = ORM.find(ArticleComment, replyed_comment_3.id)
 
       assert replyed_comment_1.reply_to_id == parent_comment.id
       assert replyed_comment_2.reply_to_id == replyed_comment_1.id
+      assert replyed_comment_3.reply_to_id == replyed_comment_2.id
+    end
+
+    @tag :wip2
+    test "reply to reply inside a comment should have is_reply_to_others flag in meta",
+         ~m(post user user2)a do
+      {:ok, parent_comment} = CMS.create_article_comment(:post, post.id, "parent comment", user)
+
+      {:ok, replyed_comment_1} = CMS.reply_article_comment(parent_comment.id, "reply 1", user2)
+      {:ok, replyed_comment_2} = CMS.reply_article_comment(replyed_comment_1.id, "reply 2", user2)
+      {:ok, replyed_comment_3} = CMS.reply_article_comment(replyed_comment_2.id, "reply 3", user)
+
+      {:ok, parent_comment} = ORM.find(ArticleComment, parent_comment.id)
+
+      {:ok, replyed_comment_1} = ORM.find(ArticleComment, replyed_comment_1.id)
+      {:ok, replyed_comment_2} = ORM.find(ArticleComment, replyed_comment_2.id)
+      {:ok, replyed_comment_3} = ORM.find(ArticleComment, replyed_comment_3.id)
+
+      assert not replyed_comment_1.meta.is_reply_to_others
+      assert replyed_comment_2.meta.is_reply_to_others
+      assert replyed_comment_3.meta.is_reply_to_others
     end
 
     @tag :wip

test/groupher_server_web/query/cms/article_comment_test.exs

@@ -17,86 +17,6 @@ defmodule GroupherServer.Test.Query.ArticleComment do
     {:ok, ~m(user_conn guest_conn post job user user2)a}
   end
 
-  describe "paged replies" do
-    @query """
-      query($id: ID!, $filter: CommentsFilter!) {
-        pagedCommentReplies(id: $id, filter: $filter) {
-          entries {
-            id
-            bodyHtml
-            author {
-              id
-              nickname
-            }
-            upvotesCount
-            emotions {
-              downvoteCount
-              latestDownvoteUsers {
-                login
-                nickname
-              }
-              viewerHasDownvoteed
-              beerCount
-              latestBeerUsers {
-                login
-                nickname
-              }
-              viewerHasBeered
-            }
-            isArticleAuthor
-            meta {
-              isArticleAuthorUpvoted
-            }
-            replyTo {
-              id
-              bodyHtml
-              floor
-              isArticleAuthor
-              author {
-                id
-                login
-              }
-            }
-            repliesCount
-            viewerHasUpvoted
-          }
-          totalPages
-          totalCount
-          pageSize
-          pageNumber
-        }
-    }
-    """
-    @tag :wip2
-    test "guest user can get paged replies", ~m(guest_conn post user user2)a do
-      comment = "test comment"
-      total_count = 2
-      page_size = 10
-      thread = :post
-
-      author_user = post.author.user
-      {:ok, parent_comment} = CMS.create_article_comment(thread, post.id, comment, user)
-
-      Enum.reduce(1..total_count, [], fn i, acc ->
-        {:ok, reply_comment} = CMS.reply_article_comment(parent_comment.id, "reply #{i}", user2)
-
-        acc ++ [reply_comment]
-      end)
-
-      {:ok, author_reply_comment} =
-        CMS.reply_article_comment(parent_comment.id, "author reply", author_user)
-
-      variables = %{id: parent_comment.id, filter: %{page: 1, size: page_size}}
-      results = guest_conn |> query_result(@query, variables, "pagedCommentReplies")
-
-      author_reply_comment =
-        Enum.find(results["entries"], &(&1["id"] == to_string(author_reply_comment.id)))
-
-      assert author_reply_comment["isArticleAuthor"]
-      assert results["entries"] |> length == total_count + 1
-    end
-  end
-
   describe "[baisc article post comment]" do
     @query """
     query($id: ID!) {
@@ -573,4 +493,84 @@ defmodule GroupherServer.Test.Query.ArticleComment do
       assert upvoted_comment["viewerHasUpvoted"]
     end
   end
+
+  describe "paged replies" do
+    @query """
+      query($id: ID!, $filter: CommentsFilter!) {
+        pagedCommentReplies(id: $id, filter: $filter) {
+          entries {
+            id
+            bodyHtml
+            author {
+              id
+              nickname
+            }
+            upvotesCount
+            emotions {
+              downvoteCount
+              latestDownvoteUsers {
+                login
+                nickname
+              }
+              viewerHasDownvoteed
+              beerCount
+              latestBeerUsers {
+                login
+                nickname
+              }
+              viewerHasBeered
+            }
+            isArticleAuthor
+            meta {
+              isArticleAuthorUpvoted
+            }
+            replyTo {
+              id
+              bodyHtml
+              floor
+              isArticleAuthor
+              author {
+                id
+                login
+              }
+            }
+            repliesCount
+            viewerHasUpvoted
+          }
+          totalPages
+          totalCount
+          pageSize
+          pageNumber
+        }
+    }
+    """
+    @tag :wip
+    test "guest user can get paged replies", ~m(guest_conn post user user2)a do
+      comment = "test comment"
+      total_count = 2
+      page_size = 10
+      thread = :post
+
+      author_user = post.author.user
+      {:ok, parent_comment} = CMS.create_article_comment(thread, post.id, comment, user)
+
+      Enum.reduce(1..total_count, [], fn i, acc ->
+        {:ok, reply_comment} = CMS.reply_article_comment(parent_comment.id, "reply #{i}", user2)
+
+        acc ++ [reply_comment]
+      end)
+
+      {:ok, author_reply_comment} =
+        CMS.reply_article_comment(parent_comment.id, "author reply", author_user)
+
+      variables = %{id: parent_comment.id, filter: %{page: 1, size: page_size}}
+      results = guest_conn |> query_result(@query, variables, "pagedCommentReplies")
+
+      author_reply_comment =
+        Enum.find(results["entries"], &(&1["id"] == to_string(author_reply_comment.id)))
+
+      assert author_reply_comment["isArticleAuthor"]
+      assert results["entries"] |> length == total_count + 1
+    end
+  end
 end