refactor(cited-article): doc & naming adjust

Author: mydearxym

lib/groupher_server/cms/delegates/article_curd.ex

@@ -18,7 +18,7 @@ defmodule GroupherServer.CMS.Delegate.ArticleCURD do
 
   alias Accounts.Model.User
   alias CMS.Model.{Author, Community, PinnedArticle, Embeds}
-  alias CMS.Delegate.{ArticleCommunity, ArticleComment, ArticleTag, CommunityCURD}
+  alias CMS.Delegate.{ArticleCommunity, ArticleComment, ArticleTag, CommunityCURD, CiteTasks}
 
   alias Ecto.Multi
 
@@ -149,12 +149,6 @@ defmodule GroupherServer.CMS.Delegate.ArticleCURD do
       |> Multi.run(:create_article, fn _, _ ->
         do_create_article(info.model, attrs, author, community)
       end)
-      |> Multi.run(:block_tasks, fn _, %{create_article: article} ->
-        # ArticleCommunity.mirror_article(thread, article.id, community.id)
-        # Later
-        # BlockTasks.handle(article)
-        {:ok, :pass}
-      end)
       |> Multi.run(:mirror_article, fn _, %{create_article: article} ->
         ArticleCommunity.mirror_article(thread, article.id, community.id)
       end)
@@ -170,6 +164,9 @@ defmodule GroupherServer.CMS.Delegate.ArticleCURD do
       |> Multi.run(:update_user_published_meta, fn _, _ ->
         Accounts.update_published_states(uid, thread)
       end)
+      |> Multi.run(:block_tasks, fn _, %{create_article: article} ->
+        Later.run({CiteTasks, :handle, [article]})
+      end)
       # TODO: run mini tasks
       |> Multi.run(:mention_users, fn _, %{create_article: article} ->
         # article.body |> Jason.decode!() |> 各种小 task
@@ -452,7 +449,7 @@ defmodule GroupherServer.CMS.Delegate.ArticleCURD do
 
   # create done
   defp result({:ok, %{set_active_at_timestamp: result}}) do
-    Later.exec({__MODULE__, :notify_admin_new_article, [result]})
+    Later.run({__MODULE__, :notify_admin_new_article, [result]})
     {:ok, result}
   end
 

lib/groupher_server/cms/delegates/block_tasks.ex renamed to lib/groupher_server/cms/delegates/cite_tasks.ex

@@ -1,7 +1,28 @@
-defmodule GroupherServer.CMS.Delegate.BlockTasks do
+defmodule GroupherServer.CMS.Delegate.CiteTasks do
   @moduledoc """
   run tasks in every article blocks if need
+
+  current task: "cite link" and "mention"
+
+  ## cite link
+
+  我被站内哪些文章或评论引用了，是值得关注的事
+  我引用了谁不重要，帖子里链接已经表明了, 这和 github issue 的双向链接不一样，因为一般不需要关注这个
+  帖子是否解决，是否被 merge 等状态。
+
+  基本结构：
+
+  cited_thread, cited_article_id, [xxx_article]_id, [block_id, block2_id],
+
+  POST post_333 -> cited_article_333, [block_id, block2_id]]
+
+  cited_type, cited_content_id, [contents]_id, [block_id, cited_block_id],
+
+  cited_type: thread or comment
+  content: article or comment
+  # cited_article_comment_id, [xxx_article]_id, [block_id, block2_id, ...],
   """
+
   import Ecto.Query, warn: false
   import Helper.Utils, only: [get_config: 2, thread_of_article: 1, done: 1]
   import GroupherServer.CMS.Helper.Matcher
@@ -17,47 +38,24 @@ defmodule GroupherServer.CMS.Delegate.BlockTasks do
   @article_threads get_config(:article, :threads)
   @valid_article_prefix Enum.map(@article_threads, &"#{@site_host}/#{&1}/")
 
-  """
-  我被谁引用了 是最重要的信息
-  我引用了谁不重要，自己扫帖子就行了
-  cited_thread, cited_article_id, [xxx_article]_id, [block_id, cited_block_id],
-
-  POST post_333 -> cited_article_333, [[block_3, cited_block_23]]
-
-  cited_type, cited_content_id, [contents]_id, [block_id, cited_block_id],
-
-  cited_type: thread or comment
-  content: article or comment
-  # cited_article_comment_id, [xxx_article]_id, [block_id, cited_block_id],
-  """
-
-  # reference
-  # mention
-
   def handle(%{body: body} = article) do
-    with {:ok, body_map} <- Jason.decode(body) do
-      run_tasks(:cite, article, body_map["blocks"])
-      # run_tasks(:mention, article, body_map["blocks"])
+    with {:ok, %{"blocks" => blocks}} <- Jason.decode(body),
+         article <- Repo.preload(article, author: :user) do
+      Multi.new()
+      |> Multi.run(:delete_all_cited_contents, fn _, _ ->
+        delete_all_cited_contents(article)
+      end)
+      |> Multi.run(:update_cited_info, fn _, _ ->
+        blocks
+        |> Enum.reduce([], &(&2 ++ parse_cited_info_per_block(article, &1)))
+        |> merge_same_cited_article_block
+        |> update_cited_info
+      end)
+      |> Repo.transaction()
+      |> result()
     end
   end
 
-  defp run_tasks(:cite, article, blocks) do
-    article = article |> Repo.preload(author: :user)
-
-    Multi.new()
-    |> Multi.run(:delete_all_cited_contents, fn _, _ ->
-      delete_all_cited_contents(article)
-    end)
-    |> Multi.run(:update_cited_info, fn _, _ ->
-      blocks
-      |> Enum.reduce([], &(&2 ++ parse_cited_info_per_block(article, &1)))
-      |> merge_same_cited_article_block
-      |> update_cited_info
-    end)
-    |> Repo.transaction()
-    |> result()
-  end
-
   # delete all records before insert_all, this will dynamiclly update
   # those cited info when update article
   # 插入引用记录之前先全部清除，这样可以在更新文章的时候自动计算引用信息
@@ -150,11 +148,7 @@ defmodule GroupherServer.CMS.Delegate.BlockTasks do
     ...
   ]
   """
-  defp parse_cited_info_per_block(article, %{
-         "id" => block_id,
-         "data" => %{"text" => text}
-       }) do
-    #
+  defp parse_cited_info_per_block(article, %{"id" => block_id, "data" => %{"text" => text}}) do
     links_in_block = Floki.find(text, "a[href]")
 
     Enum.reduce(links_in_block, [], fn link, acc ->

lib/groupher_server/statistics/delegates/contribute.ex

@@ -134,7 +134,7 @@ defmodule GroupherServer.Statistics.Delegate.Contribute do
   end
 
   defp cache_contribute_later(%Community{id: id}) do
-    Later.exec({__MODULE__, :get_contributes_then_cache, [%Community{id: id}]})
+    Later.run({__MODULE__, :get_contributes_then_cache, [%Community{id: id}]})
   end
 
   defp do_get_contributes(%Community{id: id}) do

lib/helper/later.ex

@@ -5,10 +5,12 @@ defmodule Helper.Later do
 
   @doc """
   ## Example
-  iex> Later.exec({__MODULE__, :get_contributes_then_cache, [%Community{id: id}]})
+  iex> Later.run({__MODULE__, :get_contributes_then_cache, [%Community{id: id}]})
   {:ok, _}
   """
-  def exec({mod, func, args}) do
+  def run({mod, func, args}) do
     Rihanna.enqueue({mod, func, args})
+    # weather enqueue success or not, just return {:ok, :pass}, or Multi.Job will be rollback
+    {:ok, :pass}
   end
 end

test/groupher_server/cms/cite_content_test.exs renamed to test/groupher_server/cms/cite_contents/cite_post_test.exs

@@ -8,7 +8,7 @@ defmodule GroupherServer.Test.CMS.CiteContent do
 
   alias CMS.Model.Post
 
-  alias CMS.Delegate.BlockTasks
+  alias CMS.Delegate.CiteTasks
 
   @site_host get_config(:general, :site_host)
 
@@ -29,7 +29,7 @@ defmodule GroupherServer.Test.CMS.CiteContent do
   end
 
   describe "[cite basic]" do
-    # @tag :wip
+    @tag :wip
     test "cited multi post should work", ~m(user community post2 post3 post4 post5 post_attrs)a do
       body =
         mock_rich_text(
@@ -49,8 +49,8 @@ defmodule GroupherServer.Test.CMS.CiteContent do
       post_attrs = post_attrs |> Map.merge(%{body: body})
       {:ok, post_n} = CMS.create_article(community, :post, post_attrs, user)
 
-      BlockTasks.handle(post)
-      BlockTasks.handle(post_n)
+      CiteTasks.handle(post)
+      CiteTasks.handle(post_n)
 
       {:ok, post2} = ORM.find(Post, post2.id)
       {:ok, post3} = ORM.find(Post, post3.id)
@@ -70,7 +70,7 @@ defmodule GroupherServer.Test.CMS.CiteContent do
       body = mock_rich_text(~s(the <a href=#{@site_host}/post/#{post.id} />))
       {:ok, post} = CMS.update_article(post, %{body: body})
 
-      BlockTasks.handle(post)
+      CiteTasks.handle(post)
 
       {:ok, post} = ORM.find(Post, post.id)
       assert post.meta.citing_count == 0

test/groupher_server/statistics/statistics_test.exs

@@ -222,7 +222,7 @@ defmodule GroupherServer.Test.Statistics do
 
       Statistics.make_contribute(%Community{id: community.id})
 
-      # res = Later.exec({IO, :puts, ["Work, work, work, work, work."]})
+      # res = Later.run({IO, :puts, ["Work, work, work, work, work."]})
       # Process.sleep(1000)
       # IO.inspect(res, label: "res")