refactor(cache): workflow for community contributes list/add

Author: mydearxym

lib/groupher_server/statistics/delegates/contribute.ex

@@ -13,32 +13,42 @@ defmodule GroupherServer.Statistics.Delegate.Contribute do
   @user_contribute_months get_config(:general, :user_contribute_months)
 
   @doc """
-  update community's contributes record
+  update user's contributes record
   """
-  def make_contribute(%Community{id: id}) do
+  def make_contribute(%User{id: id}) do
     today = Timex.today() |> Date.to_iso8601()
 
-    case ORM.find_by(CommunityContribute, community_id: id, date: today) do
+    case ORM.find_by(UserContribute, user_id: id, date: today) do
       {:ok, contribute} ->
-        contribute |> inc_contribute_count(:community) |> done
+        contribute |> inc_contribute_count(:user) |> done
 
       {:error, _} ->
-        CommunityContribute |> ORM.create(%{community_id: id, date: today, count: 1})
+        UserContribute |> ORM.create(%{user_id: id, date: today, count: 1})
     end
   end
 
   @doc """
-  update user's contributes record
+  update community's contributes record
   """
-  def make_contribute(%User{id: id}) do
+  def make_contribute(%Community{id: id}) do
     today = Timex.today() |> Date.to_iso8601()
 
-    case ORM.find_by(UserContribute, user_id: id, date: today) do
+    case ORM.find_by(CommunityContribute, community_id: id, date: today) do
       {:ok, contribute} ->
-        contribute |> inc_contribute_count(:user) |> done
+        result = contribute |> inc_contribute_count(:community) |> done
+
+        # TODO:  move to background job
+        list_contributes_digest(%Community{id: id})
+        result
 
       {:error, _} ->
-        UserContribute |> ORM.create(%{user_id: id, date: today, count: 1})
+        result =
+          CommunityContribute
+          |> ORM.create(%{community_id: id, date: today, count: 1})
+
+        # TODO:  move to background job
+        list_contributes_digest(%Community{id: id})
+        result
     end
   end
 
@@ -61,7 +71,7 @@ defmodule GroupherServer.Statistics.Delegate.Contribute do
   Returns the list of community_contribute by latest 6 days.
   """
   def list_contributes_digest(%Community{id: id}) do
-    scope = "community.contributes.#{id}"
+    scope = Cache.get_scope(:community_contributes, id)
 
     case Cache.get(scope) do
       {:ok, result} ->
@@ -76,12 +86,13 @@ defmodule GroupherServer.Statistics.Delegate.Contribute do
     end
   end
 
+  # TODO:  mv to helper/cache, also 规范一下 scope
   defp cache_result({:ok, result}, scope) do
-    IO.inspect scope, label: "put cashe"
     Cache.put(scope, result)
     {:ok, result}
   end
 
+  # TODO:  mv to helper/cache, also 规范一下 scope
   defp cache_result({:error, result}, _scope) do
     {:error, result}
   end

lib/helper/cache.ex

@@ -9,7 +9,13 @@ defmodule Helper.Cache do
   {:ok, "b"}
   """
   def get(cache_key) do
-    Cachex.get(:site_cache, cache_key)
+    case Cachex.get(:site_cache, cache_key) do
+      {:ok, nil} ->
+        {:error, nil}
+
+      {:ok, result} ->
+        {:ok, result}
+    end
   end
 
   @doc """
@@ -20,4 +26,9 @@ defmodule Helper.Cache do
   def put(cache_key, cache_value) do
     Cachex.put(:site_cache, cache_key, cache_value)
   end
+
+  @doc """
+  cache scope of community contributes digest
+  """
+  def get_scope(:community_contributes, id), do: "community.contributes.#{id}"
 end

test/groupher_server/statistics/statistics_test.exs

@@ -121,6 +121,7 @@ defmodule GroupherServer.Test.Statistics do
       assert second.count == 2
     end
 
+    @tag :wip
     test "should return recent #{@community_contribute_days} days community contributes by default",
          ~m(community)a do
       seven_days_ago = Timex.shift(Timex.today(), days: -@community_contribute_days)
@@ -146,5 +147,26 @@ defmodule GroupherServer.Test.Statistics do
       {:ok, contributes} = Statistics.list_contributes_digest(%Community{id: community.id})
       assert length(contributes) == @community_contribute_days + 1
     end
+
+    alias Helper.Cache
+    @tag :wip
+    test "the contributes data should be cached after first query", ~m(community)a do
+      scope = Cache.get_scope(:community_contributes, community.id)
+      assert {:error, nil} = Cache.get(scope)
+
+      {:ok, contributes} = Statistics.list_contributes_digest(%Community{id: community.id})
+
+      assert {:ok, contributes} = Cache.get(scope)
+    end
+
+    @tag :wip
+    test "cache should be update after make contributes", ~m(community)a do
+      scope = Cache.get_scope(:community_contributes, community.id)
+      assert {:error, nil} = Cache.get(scope)
+
+      Statistics.make_contribute(%Community{id: community.id})
+
+      assert {:ok, _} = Cache.get(scope)
+    end
   end
 end

test/helper/cache_test.exs

@@ -7,13 +7,13 @@ defmodule GroupherServer.Test.Helper.Cache do
   describe "[cache test]" do
     @tag :wip
     test "cache get unexsit key should get nil" do
-      assert {:ok, nil} = Cache.get("no exsit")
-      assert {:ok, nil} = Cache.get(:no_exsit)
+      assert {:error, nil} = Cache.get("no exsit")
+      assert {:error, nil} = Cache.get(:no_exsit)
     end
 
     @tag :wip
     test "cache put should work" do
-      assert {:ok, nil} = Cache.get(:data)
+      assert {:error, nil} = Cache.get(:data)
 
       assert {:ok, true} = Cache.put(:data, "value")
       assert {:ok, "value"} = Cache.get(:data)