refactor(delivery): redesign && rewrite (#404)

* refactor(delivery): back up mentions and notification

* refactor(delivery): back up mentions and notification

* refactor(delivery): back up mentions and notification wip

* refactor(delivery): wip

* refactor(delivery): wip

* refactor(delivery): wip

* refactor(delivery): wip

* refactor(delivery): wip

* refactor(delivery): re-org mention & dir, naming

* refactor(delivery): move cite ORM opt to delegate & fmt, naming

* refactor(delivery): fix dup case

* refactor(delivery): wip

* refactor(delivery): mention wip

* refactor(delivery): cite fix

* refactor(delivery): more test on mention

* refactor(delivery): better naming

* refactor(delivery): better naming

* refactor(delivery): mini improve

* refactor(delivery): rename fetch instead of paged_mention

* refactor(delivery): notification wip

* refactor(delivery): notification wip

* refactor(delivery): notification wip

* refactor(delivery): notification wip, cool

* refactor(delivery): use common atom key

* refactor(delivery): upvote hooks

* refactor(delivery): upvote hooks for job & blog tests

* refactor(delivery): collect hooks & tests

* refactor(delivery): rename type -> thread in notification

* refactor(delivery): fix test

* refactor(delivery): fix test

* refactor(delivery): enhence test

* refactor(cite): naming adjust

* refactor(mention): rename type -> thread

* refactor(mention): clean up

* refactor(mention): mention thread clean up

* refactor(mention): fix test

* refactor(mention): fix test

* refactor(notify): test for follow

* refactor(notify): hooks for follow & test

* refactor(notify): wip

* refactor(notify): mark read & re-org ORM functions

* refactor(notify): clean up

* refactor(notify): remove old delivery system

* refactor(notify): remove mention parse when create article

* refactor(notify): refactor account mailbox tests

* refactor(notify): fix notify update

* refactor(mailbox): mark read test & re-org

* refactor(mailbox): remove old account mails tables

* refactor(mailbox): read_all test

* refactor(mailbox): paged mentions & test

* refactor(mailbox): paged notification & test

* refactor(mailbox): read in filter

* refactor(mailbox): clean up wip

* refactor(mailbox): fix tests

Author: mydearxym

config/config.exs

@@ -47,7 +47,11 @@ config :groupher_server, :general,
   user_achieve_upvote_weight: 1,
   user_achieve_watch_weight: 1,
   user_achieve_collect_weight: 2,
-  user_achieve_follow_weight: 3
+  user_achieve_follow_weight: 3,
+  # others
+  # 在这个时间段内，多条提醒消息将被合并为一条
+  notify_group_interval_hour: 1,
+  nofity_actions: [:upvote, :comment, :reply, :collect, :follow]
 
 config :groupher_server, :customization,
   theme: "cyan",

lib/groupher_server/accounts/accounts.ex

@@ -7,7 +7,7 @@ defmodule GroupherServer.Accounts do
     Fans,
     CollectFolder,
     Publish,
-    Mails,
+    Mailbox,
     Profile,
     UpvotedArticles,
     Search,
@@ -62,17 +62,12 @@ defmodule GroupherServer.Accounts do
   # upvoted articles
   defdelegate paged_upvoted_articles(user_id, filter), to: UpvotedArticles
 
-  # mentions
-  defdelegate fetch_mentions(user, filter), to: Mails
+  defdelegate mailbox_status(user), to: Mailbox
+  defdelegate update_mailbox_status(user_id), to: Mailbox
+  defdelegate mark_read(type, ids, user_id), to: Mailbox
+  defdelegate mark_read_all(tyoe, user_id), to: Mailbox
 
-  # notifications
-  defdelegate fetch_notifications(user, filter), to: Mails
-  defdelegate fetch_sys_notifications(user, filter), to: Mails
-
-  # common message
-  defdelegate mailbox_status(user), to: Mails
-  defdelegate mark_mail_read_all(user, opt), to: Mails
-  defdelegate mark_mail_read(mail, user), to: Mails
+  defdelegate paged_mailbox_messages(type, user, filter), to: Mailbox
 
   # customization
   defdelegate get_customization(user), to: Customization

lib/groupher_server/accounts/delegates/fans.ex

@@ -7,10 +7,11 @@ defmodule GroupherServer.Accounts.Delegate.Fans do
   import Helper.ErrorCode
   import ShortMaps
 
-  alias Helper.{ORM, QueryBuilder, SpecType}
+  alias Helper.{ORM, QueryBuilder, Later, SpecType}
   alias GroupherServer.{Accounts, Repo}
 
-  alias GroupherServer.Accounts.Model.{User, Embeds, UserFollower, UserFollowing}
+  alias Accounts.Model.{User, Embeds, UserFollower, UserFollowing}
+  alias Accounts.Delegate.Hooks
 
   alias Ecto.Multi
 
@@ -20,27 +21,30 @@ defmodule GroupherServer.Accounts.Delegate.Fans do
   follow a user
   """
   @spec follow(User.t(), User.t()) :: {:ok, User.t()} | SpecType.gq_error()
-  def follow(%User{id: user_id}, %User{id: follower_id}) do
-    with true <- to_string(user_id) !== to_string(follower_id),
-         {:ok, target_user} <- ORM.find(User, follower_id) do
+  def follow(%User{} = user, %User{} = follower) do
+    with true <- to_string(user.id) !== to_string(follower.id),
+         {:ok, target_user} <- ORM.find(User, follower.id) do
       Multi.new()
       |> Multi.insert(
         :create_follower,
-        UserFollower.changeset(%UserFollower{}, %{user_id: target_user.id, follower_id: user_id})
+        UserFollower.changeset(%UserFollower{}, %{user_id: target_user.id, follower_id: user.id})
       )
       |> Multi.insert(
         :create_following,
         UserFollowing.changeset(%UserFollowing{}, %{
-          user_id: user_id,
+          user_id: user.id,
           following_id: target_user.id
         })
       )
       |> Multi.run(:update_user_follow_info, fn _, _ ->
-        update_user_follow_info(target_user, user_id, :add)
+        update_user_follow_info(target_user, user.id, :add)
       end)
       |> Multi.run(:add_achievement, fn _, _ ->
         Accounts.achieve(%User{id: target_user.id}, :inc, :follow)
       end)
+      |> Multi.run(:after_hooks, fn _, _ ->
+        Later.run({Hooks.Notify, :handle, [:follow, user, follower]})
+      end)
       |> Repo.transaction()
       |> result()
     else
@@ -53,22 +57,25 @@ defmodule GroupherServer.Accounts.Delegate.Fans do
   undo a follow action to a user
   """
   @spec undo_follow(User.t(), User.t()) :: {:ok, User.t()} | SpecType.gq_error()
-  def undo_follow(%User{id: user_id}, %User{id: follower_id}) do
-    with true <- to_string(user_id) !== to_string(follower_id),
-         {:ok, target_user} <- ORM.find(User, follower_id) do
+  def undo_follow(%User{} = user, %User{} = follower) do
+    with true <- to_string(user.id) !== to_string(follower.id),
+         {:ok, target_user} <- ORM.find(User, follower.id) do
       Multi.new()
       |> Multi.run(:delete_follower, fn _, _ ->
-        ORM.findby_delete!(UserFollower, %{user_id: target_user.id, follower_id: user_id})
+        ORM.findby_delete!(UserFollower, %{user_id: target_user.id, follower_id: user.id})
       end)
       |> Multi.run(:delete_following, fn _, _ ->
-        ORM.findby_delete!(UserFollowing, %{user_id: user_id, following_id: target_user.id})
+        ORM.findby_delete!(UserFollowing, %{user_id: user.id, following_id: target_user.id})
       end)
       |> Multi.run(:update_user_follow_info, fn _, _ ->
-        update_user_follow_info(target_user, user_id, :remove)
+        update_user_follow_info(target_user, user.id, :remove)
       end)
       |> Multi.run(:minus_achievement, fn _, _ ->
         Accounts.achieve(%User{id: target_user.id}, :dec, :follow)
       end)
+      |> Multi.run(:after_hooks, fn _, _ ->
+        Later.run({Hooks.Notify, :handle, [:undo, :follow, user, follower]})
+      end)
       |> Repo.transaction()
       |> result()
     else

lib/groupher_server/accounts/delegates/hooks/notify.ex

@@ -0,0 +1,26 @@
+defmodule GroupherServer.Accounts.Delegate.Hooks.Notify do
+  @moduledoc """
+  notify hooks, for upvote, collect, comment, reply
+  """
+  alias GroupherServer.{Accounts, Delivery}
+  alias Accounts.Model.User
+
+  # 发布评论是特殊情况，单独处理
+  def handle(:follow, %User{} = user, %User{} = from_user) do
+    notify_attrs = %{
+      action: :follow,
+      user_id: user.id
+    }
+
+    Delivery.send(:notify, notify_attrs, from_user)
+  end
+
+  def handle(:undo, :follow, %User{} = user, %User{} = from_user) do
+    notify_attrs = %{
+      action: :follow,
+      user_id: user.id
+    }
+
+    Delivery.revoke(:notify, notify_attrs, from_user)
+  end
+end

lib/groupher_server/accounts/delegates/mailbox.ex

@@ -0,0 +1,44 @@
+defmodule GroupherServer.Accounts.Delegate.Mailbox do
+  import Ecto.Query, warn: false
+
+  import Helper.Utils, only: [done: 1]
+
+  alias GroupherServer.{Accounts, Delivery}
+
+  alias Accounts.Model.{Embeds, User}
+  alias Helper.ORM
+
+  @default_mailbox_status Embeds.UserMailbox.default_status()
+
+  def mailbox_status(%User{mailbox: nil}), do: @default_mailbox_status |> done
+  def mailbox_status(%User{mailbox: mailbox}), do: mailbox |> done
+
+  def mark_read(type, ids, %User{} = user) do
+    Delivery.mark_read(type, ids, user)
+  end
+
+  def mark_read_all(type, %User{} = user), do: Delivery.mark_read_all(type, user)
+
+  def paged_mailbox_messages(type, user, filter) do
+    Delivery.fetch(type, user, filter)
+  end
+
+  @doc "update messages count in mailbox"
+  def update_mailbox_status(user_id) do
+    with {:ok, user} <- ORM.find(User, user_id),
+         {:ok, unread_mentions_count} <- Delivery.unread_count(:mention, user_id),
+         {:ok, unread_notifications_count} <- Delivery.unread_count(:notification, user_id) do
+      unread_total_count = unread_mentions_count + unread_notifications_count
+      is_empty = unread_total_count < 1
+
+      mailbox = %{
+        unread_mentions_count: unread_mentions_count,
+        unread_notifications_count: unread_notifications_count,
+        unread_total_count: unread_total_count,
+        is_empty: is_empty
+      }
+
+      user |> ORM.update_embed(:mailbox, mailbox)
+    end
+  end
+end

lib/groupher_server/accounts/delegates/mails.ex

@@ -72,8 +72,7 @@ defmodule GroupherServer.Accounts.Delegate.Profile do
   """
   def update_subscribe_count(user_id) do
     with {:ok, user} <- ORM.find(User, user_id) do
-      count_query = from(s in CommunitySubscriber, where: s.user_id == ^user.id)
-      count = Repo.aggregate(count_query, :count)
+      {:ok, count} = from(s in CommunitySubscriber, where: s.user_id == ^user.id) |> ORM.count()
 
       user |> ORM.update(%{subscribed_communities_count: count})
     end

lib/groupher_server/accounts/delegates/profile.ex

@@ -0,0 +1,31 @@
+defmodule GroupherServer.Accounts.Model.Embeds.UserMailbox do
+  @moduledoc """
+  general article meta info for articles
+  """
+  use Ecto.Schema
+  use Accessible
+
+  import Ecto.Changeset
+
+  @optional_fields ~w(is_empty unread_total_count unread_mentions_count unread_notifications_count)a
+
+  def default_status() do
+    %{
+      is_empty: true,
+      unread_total_count: 0,
+      unread_mentions_count: 0,
+      unread_notifications_count: 0
+    }
+  end
+
+  embedded_schema do
+    field(:is_empty, :boolean, default: true)
+    field(:unread_total_count, :integer, default: 0)
+    field(:unread_mentions_count, :integer, default: 0)
+    field(:unread_notifications_count, :integer, default: 0)
+  end
+
+  def changeset(struct, params) do
+    struct |> cast(params, @optional_fields)
+  end
+end