Merge pull request #274 from steelstyle/feature/show-pending-moderation

Adds a method to retrieve actions pending moderation which are actionable by the logged in user.

Author: Betree

apps/cf/lib/moderation/moderation.ex

@@ -11,7 +11,7 @@ defmodule CF.Moderation do
 
   -------------
 
-  Some usefull commands for testing:
+  Some useful commands for testing:
   # Insert 5 comments with 10 flags on each
   DB.Factory.insert_list(5, :comment) |> Enum.map(&DB.Factory.with_action/1) |> CF.TestUtils.flag_comments(10)
   # Update flags
@@ -53,11 +53,7 @@ defmodule CF.Moderation do
     UserPermissions.check!(user, :collective_moderation)
 
     UserAction
-    |> where([a], a.user_id != ^user.id)
-    |> without_user_feedback(user)
-    |> join(:inner, [a, _], f in Flag, f.action_id == a.id)
-    |> group_by([a, _, _], a.id)
-    |> being_reported()
+    |> requiring_moderation(user)
     |> preload([a, _, _], [:user])
     |> order_by(fragment("RANDOM()"))
     |> select([a, _, _], a)
@@ -66,6 +62,21 @@ defmodule CF.Moderation do
     |> moderation_entry()
   end
 
+  @doc """
+  Get the count of actions for which number of flags is above the limit and for which
+  user hasn't voted yet. Will raise if `user` doesn't have permission to moderate.
+  """
+  @spec unread_count!(DB.Schema.User.t()) :: any
+  def unread_count!(user) do
+    UserPermissions.check!(user, :collective_moderation)
+
+    UserAction
+    |> requiring_moderation(user)
+    |> select([a, _, _], a)
+    |> subquery
+    |> Repo.aggregate(:count, :id)
+  end
+
   @doc """
   Record user feedback for a flagged action
   Will raise if `user` doesn't have permission to moderate
@@ -132,6 +143,15 @@ defmodule CF.Moderation do
     end)
   end
 
+  defp requiring_moderation(query, user) do
+    query
+    |> where([a], a.user_id != ^user.id)
+    |> without_user_feedback(user)
+    |> join(:inner, [a, _], f in Flag, f.action_id == a.id)
+    |> group_by([a, _, _], a.id)
+    |> being_reported()
+  end
+
   defp moderation_entry(action = %UserAction{}) do
     %ModerationEntry{
       action: action,

apps/cf/test/moderation/moderation_test.exs

@@ -1,9 +1,80 @@
 defmodule CF.ModerationTest do
   use CF.DataCase
-  #  import CF.TestUtils, only: [flag_comments: 2]
+
+  import CF.TestUtils, only: [flag_comments: 2]
+
+  alias CF.Moderation
+  alias DB.Schema.UserAction
+
   doctest CF.Moderation
 
   # TODO can only give one feedback
   # TODO cannot give feedback on an action which is not reported
   # TODO Make sure user doesn't get and cannot give feedback on its own actions or actions he's targeted by
+
+  describe "unread_count" do
+    test "no moderation entries if all open actions belong to users" do
+      user = insert(:user, reputation: 1000)
+      limit = max(Moderation.nb_flags_to_report(:create, :comment), 0)
+
+      Enum.each(1..5, fn x ->
+        comment =
+          insert(:comment, %{user: user, text: "Own comment" <> to_string(x)})
+          |> with_action()
+
+        flag_comments([comment], limit)
+      end)
+
+      count = Moderation.unread_count!(user)
+      assert count == 0
+    end
+
+    test "count pending actions from other users" do
+      user = insert(:user, reputation: 1000)
+      limit = Moderation.nb_flags_to_report(:create, :comment)
+
+      comment =
+        insert(:comment, %{user: user, text: "Own comment"})
+        |> with_action()
+
+      flag_comments([comment], limit)
+
+      Enum.each(1..8, fn x ->
+        comment = insert(:comment, %{text: "User comment " <> to_string(x)}) |> with_action()
+        flag_comments([comment], limit)
+        Repo
+      end)
+
+      count = Moderation.unread_count!(user)
+      assert count == 8
+    end
+
+    test "count pending actions from other users, unless already moderated" do
+      user = insert(:user, reputation: 1000)
+      limit = Moderation.nb_flags_to_report(:create, :comment)
+      comment = insert(:comment, %{user: user, text: "Own comment"}) |> with_action()
+      flag_comments([comment], limit)
+
+      Enum.each(1..8, fn x ->
+        comment = insert(:comment, %{text: "User comment" <> to_string(x)}) |> with_action()
+        flag_comments([comment], limit)
+
+        # Produce feedback for two of the actions.
+        if rem(x, 3) == 0 do
+          action =
+            Repo.get_by!(
+              UserAction,
+              entity: :comment,
+              type: :create,
+              comment_id: comment.id
+            )
+
+          Moderation.feedback!(user, action.id, 1, 1)
+        end
+      end)
+
+      count = Moderation.unread_count!(user)
+      assert count == 6
+    end
+  end
 end

apps/cf_graphql/lib/resolvers/users.ex

@@ -5,6 +5,8 @@ defmodule CF.Graphql.Resolvers.Users do
 
   import Ecto.Query
 
+  alias CF.Moderation
+
   alias Kaur.Result
 
   alias DB.Repo
@@ -78,6 +80,14 @@ defmodule CF.Graphql.Resolvers.Users do
     |> Result.ok()
   end
 
+  @doc """
+  Resolve user actions history
+  """
+  def pending_moderations(user, _, _) do
+    Moderation.unread_count!(user)
+    |> Result.ok()
+  end
+
   @doc """
   Get videos added by this user
   """

apps/cf_graphql/lib/schema/types/user.ex

@@ -59,6 +59,12 @@ defmodule CF.Graphql.Schema.Types.User do
       resolve(&Resolvers.Notifications.for_user/3)
     end
 
+    @desc "Actions pending moderation"
+    field :actions_pending_moderation, :integer do
+      middleware(Middleware.RequireAuthentication)
+      resolve(&Resolvers.Users.pending_moderations/3)
+    end
+
     @desc "User subscriptions"
     field :subscriptions, list_of(:notifications_subscription) do
       middleware(Middleware.RequireAuthentication)