Improve user_game_report

Author: vtm9

services/app/apps/codebattle/lib/codebattle/user_game_report.ex

@@ -7,50 +7,55 @@ defmodule Codebattle.UserGameReport do
 
   alias Codebattle.Game
   alias Codebattle.Repo
+  alias Codebattle.Tournament
   alias Codebattle.User
 
   @derive {Jason.Encoder,
            only: [
+             :comment,
+             :game_id,
              :id,
-             :reported_user_id,
-             :reporter_id,
+             :offender,
              :reason,
-             :comment,
-             :state
+             :reporter,
+             :state,
+             :tournament_id
            ]}
 
   @type t :: %__MODULE__{}
 
   @states ~w(pending processed)a
-  @reasons ~w(bot_cheated bot_wrong_solution user_copypasted)a
+  @reasons ~w(cheater wrong_solution copypaste)a
 
   schema "user_game_reports" do
     field(:reason, Ecto.Enum, values: @reasons)
     field(:state, Ecto.Enum, values: @states, default: :pending)
     field(:comment, :string)
 
     belongs_to(:game, Game)
+    belongs_to(:tournament, Tournament)
     belongs_to(:reporter, User)
-    belongs_to(:reported_user, User, foreign_key: :reported_user_id)
+    belongs_to(:offender, User, foreign_key: :offender_id)
 
     timestamps()
   end
 
   def changeset(struct = %__MODULE__{}, params \\ %{}) do
     struct
     |> cast(params, [
+      :comment,
       :game_id,
-      :reporter_id,
-      :reported_user_id,
+      :offender_id,
       :reason,
-      :comment
+      :reporter_id,
+      :tournament_id
     ])
     |> validate_required([
+      :comment,
       :game_id,
-      :reporter_id,
-      :reported_user_id,
+      :offender_id,
       :reason,
-      :comment
+      :reporter_id
     ])
   end
 
@@ -63,6 +68,14 @@ defmodule Codebattle.UserGameReport do
     __MODULE__
     |> where([ugr], ugr.game_id == ^game_id)
     |> Repo.all()
+    |> Repo.preload([:offender, :reporter])
+  end
+
+  def list_by_tournament(tournament_id) do
+    __MODULE__
+    |> where([ugr], ugr.tournament_id == ^tournament_id)
+    |> Repo.all()
+    |> Repo.preload([:offender, :reporter])
   end
 
   def create(params) do

services/app/apps/codebattle/lib/codebattle_web/channels/tournament_admin_channel.ex

@@ -7,6 +7,7 @@ defmodule CodebattleWeb.TournamentAdminChannel do
   alias Codebattle.Tournament
   alias Codebattle.Tournament.Helpers
   alias Codebattle.Tournament.TournamentResult
+  alias Codebattle.UserGameReport
 
   def join("tournament_admin:" <> tournament_id, _payload, socket) do
     current_user = socket.assigns.current_user
@@ -35,6 +36,13 @@ defmodule CodebattleWeb.TournamentAdminChannel do
     {:noreply, socket}
   end
 
+  def handle_in("tournament:ban:list_reports", _params, socket) do
+    tournament_id = socket.assigns.tournament_info.id
+    reports = UserGameReport.list_by_tournament(tournament_id)
+
+    {:reply, {:ok, %{reports: reports}}, socket}
+  end
+
   def handle_in("tournament:ban:player", %{"user_id" => user_id}, socket) do
     tournament_id = socket.assigns.tournament_info.id
 

services/app/apps/codebattle/lib/codebattle_web/controllers/api/v1/user_game_report_controller.ex

@@ -5,19 +5,19 @@ defmodule CodebattleWeb.Api.V1.UserGameReportController do
   alias Codebattle.UserGameReport
 
   def create(conn, %{
-        "id" => game_id,
-        "user_id" => reported_user_id,
+        "game_id" => game_id,
+        "offender_id" => offender_id,
         "reason" => reason,
         "comment" => comment
       }) do
     reporter = conn.assigns.current_user
     game = Game.Context.get_game!(game_id)
 
     is_reporter_player = Game.Helpers.player?(game, reporter.id)
-    is_reported_user_player = Game.Helpers.player?(game, reported_user_id)
-    is_reported_himself = reporter.id == reported_user_id
+    is_offender_player = Game.Helpers.player?(game, offender_id)
+    is_reported_himself = reporter.id == offender_id
 
-    case {is_reporter_player, is_reported_himself, is_reported_user_player} do
+    case {is_reporter_player, is_reported_himself, is_offender_player} do
       {false, _, _} ->
         conn |> put_status(:forbidden) |> json(%{errors: ["not_a_player_of_game"]})
 
@@ -27,13 +27,14 @@ defmodule CodebattleWeb.Api.V1.UserGameReportController do
       {_, _, false} ->
         conn
         |> put_status(:unprocessable_entity)
-        |> json(%{errors: [:reported_user_not_a_player_of_game]})
+        |> json(%{errors: [:offender_not_a_player_of_game]})
 
       {_, _, true} ->
         case UserGameReport.create(%{
                game_id: game.id,
                reporter_id: reporter.id,
-               reported_user_id: reported_user_id,
+               tournament_id: game.tournament_id,
+               offender_id: offender_id,
                reason: reason,
                comment: comment
              }) do

services/app/apps/codebattle/lib/codebattle_web/router.ex

@@ -134,7 +134,7 @@ defmodule CodebattleWeb.Router do
       get("/:user_id/activity", ActivityController, :show)
 
       scope("/games") do
-        resources("/:id/user_game_reports", UserGameReportController, only: [:create])
+        resources("/:game_id/user_game_reports", UserGameReportController, only: [:create])
       end
     end
   end

services/app/apps/codebattle/priv/repo/migrations/20241210085949_add_bot_reports.exs

@@ -0,0 +1,14 @@
+defmodule Codebattle.Repo.Migrations.AddBotReports do
+  use Ecto.Migration
+
+  def change do
+    alter table(:user_game_reports) do
+      add :tournament_id, :integer
+      add :offender_id, :integer
+      remove :reported_user_id
+    end
+
+    create index(:user_game_reports, [:tournament_id])
+    create index(:user_game_reports, [:game_id])
+  end
+end

services/app/apps/codebattle/test/codebattle_web/controllers/api/v1/user_game_report_controller_test.exs

@@ -18,8 +18,8 @@ defmodule CodebattleWeb.Api.V1.UserGameReportControllerTest do
       {:ok, game} = Game.Context.create_game(game_params)
 
       params = %{
-        "user_id" => bot.id,
-        "reason" => "bot_cheated",
+        "offender_id" => bot.id,
+        "reason" => "cheater",
         "comment" => "Bot is cheating"
       }
 
@@ -33,22 +33,22 @@ defmodule CodebattleWeb.Api.V1.UserGameReportControllerTest do
                "user_game_report" => %{
                  "id" => user_game_report_id,
                  "reporter_id" => reporter_id,
-                 "reported_user_id" => reported_user_id,
+                 "offender_id" => offender_id,
                  "state" => "pending",
-                 "reason" => "bot_cheated",
+                 "reason" => "cheater",
                  "comment" => "Bot is cheating"
                }
              } = response
 
       assert reporter_id == user.id
-      assert reported_user_id == bot.id
+      assert offender_id == bot.id
 
       user_game_report =
-        UserGameReport.get!(user_game_report_id) |> Repo.preload([:reporter, :reported_user])
+        UserGameReport.get!(user_game_report_id) |> Repo.preload([:reporter, :offender])
 
       assert user_game_report.state == :pending
       assert user_game_report.reporter.id == user.id
-      assert user_game_report.reported_user.id == bot.id
+      assert user_game_report.offender.id == bot.id
     end
 
     test "player cannot report himself", %{conn: conn} do
@@ -62,9 +62,9 @@ defmodule CodebattleWeb.Api.V1.UserGameReportControllerTest do
       {:ok, game} = Game.Context.create_game(game_params)
 
       params = %{
-        "user_id" => user.id,
-        "reason" => "cheating",
-        "comment" => "Bot is cheating"
+        "offender_id" => user.id,
+        "reason" => "copypaste",
+        "comment" => "User are cheating"
       }
 
       response =
@@ -88,8 +88,8 @@ defmodule CodebattleWeb.Api.V1.UserGameReportControllerTest do
       {:ok, game} = Game.Context.create_game(game_params)
 
       params = %{
-        "user_id" => other_user.id,
-        "reason" => "cheating",
+        "offender_id" => other_user.id,
+        "reason" => "cheater",
         "comment" => "Bot is cheating"
       }
 
@@ -99,7 +99,7 @@ defmodule CodebattleWeb.Api.V1.UserGameReportControllerTest do
         |> post(Routes.api_v1_user_game_report_path(conn, :create, game.id), params)
         |> json_response(422)
 
-      assert %{"errors" => ["reported_user_not_a_player_of_game"]} = response
+      assert %{"errors" => ["offender_not_a_player_of_game"]} = response
     end
 
     test "player which is not game player cannot report player of the game", %{conn: conn} do
@@ -114,8 +114,8 @@ defmodule CodebattleWeb.Api.V1.UserGameReportControllerTest do
       {:ok, game} = Game.Context.create_game(game_params)
 
       params = %{
-        "user_id" => user.id,
-        "reason" => "cheating",
+        "offender_id" => user.id,
+        "reason" => "cheater",
         "comment" => "Bot is cheating"
       }
 
@@ -139,8 +139,8 @@ defmodule CodebattleWeb.Api.V1.UserGameReportControllerTest do
       {:ok, game} = Game.Context.create_game(game_params)
 
       params = %{
-        "user_id" => bot.id,
-        "reason" => "bot_cheated"
+        "offender_id" => bot.id,
+        "reason" => "wrong_solution"
       }
 
       response =
@@ -163,7 +163,7 @@ defmodule CodebattleWeb.Api.V1.UserGameReportControllerTest do
       {:ok, game} = Game.Context.create_game(game_params)
 
       params = %{
-        "user_id" => bot.id,
+        "offender_id" => bot.id,
         "reason" => "not_existed_reason",
         "comment" => "Some comment"
       }