Merge pull request 'Accept body parameters for /api/pleroma/notification_settings' (#738) from Oneric/akkoma:notif-setting-parameters into develop

Reviewed-on: https://akkoma.dev/AkkomaGang/akkoma/pulls/738

lib/pleroma/web/api_spec/operations/twitter_util_operation.ex

@@ -150,7 +150,7 @@ defmodule Pleroma.Web.ApiSpec.TwitterUtilOperation do
           "removes the contents of a message from the push notification"
         )
       ],
-      requestBody: nil,
+      requestBody: request_body("Parameters", update_notification_settings_request()),
       responses: %{
         200 =>
           Operation.response("Success", "application/json", %Schema{
@@ -432,4 +432,22 @@ defmodule Pleroma.Web.ApiSpec.TwitterUtilOperation do
       }
     }
   end
+
+  defp update_notification_settings_request do
+    %Schema{
+      title: "UpdateNotificationSettings",
+      description: "PUT paramenters (query, form or JSON) for updating notification settings",
+      type: :object,
+      properties: %{
+        block_from_strangers: %Schema{
+          type: :boolean,
+          description: "blocks notifications from accounts you do not follow"
+        },
+        hide_notification_contents: %Schema{
+          type: :boolean,
+          description: "removes the contents of a message from the push notification"
+        }
+      }
+    }
+  end
 end

lib/pleroma/web/twitter_api/controllers/util_controller.ex

@@ -184,7 +184,13 @@ defmodule Pleroma.Web.TwitterAPI.UtilController do
     json(conn, emoji)
   end
 
-  def update_notificaton_settings(%{assigns: %{user: user}} = conn, params) do
+  def update_notificaton_settings(
+        %{assigns: %{user: user}, body_params: body_params} = conn,
+        params
+      ) do
+    # OpenApiSpex 3.x prevents Plug's usual parameter premerging
+    params = Map.merge(params, body_params)
+
     with {:ok, _} <- User.update_notification_settings(user, params) do
       json(conn, %{status: "success"})
     end

test/pleroma/web/twitter_api/util_controller_test.exs

@@ -24,7 +24,7 @@ defmodule Pleroma.Web.TwitterAPI.UtilControllerTest do
   describe "PUT /api/pleroma/notification_settings" do
     setup do: oauth_access(["write:accounts"])
 
-    test "it updates notification settings", %{user: user, conn: conn} do
+    test "it updates notification settings via url paramters", %{user: user, conn: conn} do
       conn
       |> put(
         "/api/pleroma/notification_settings?#{URI.encode_query(%{block_from_strangers: true})}"
@@ -39,6 +39,57 @@ defmodule Pleroma.Web.TwitterAPI.UtilControllerTest do
              } == user.notification_settings
     end
 
+    test "it updates notification settings via JSON body params", %{user: user, conn: conn} do
+      conn
+      |> put_req_header("content-type", "application/json")
+      |> put(
+        "/api/pleroma/notification_settings",
+        %{"block_from_strangers" => true}
+      )
+      |> json_response_and_validate_schema(:ok)
+
+      user = refresh_record(user)
+
+      assert %Pleroma.User.NotificationSetting{
+               block_from_strangers: true,
+               hide_notification_contents: false
+             } == user.notification_settings
+    end
+
+    test "it updates notification settings via form data", %{user: user, conn: conn} do
+      conn
+      |> put_req_header("content-type", "multipart/form-data")
+      |> put(
+        "/api/pleroma/notification_settings",
+        %{:block_from_strangers => true}
+      )
+      |> json_response_and_validate_schema(:ok)
+
+      user = refresh_record(user)
+
+      assert %Pleroma.User.NotificationSetting{
+               block_from_strangers: true,
+               hide_notification_contents: false
+             } == user.notification_settings
+    end
+
+    test "it updates notification settings via urlencoded body", %{user: user, conn: conn} do
+      conn
+      |> put_req_header("content-type", "application/x-www-form-urlencoded")
+      |> put(
+        "/api/pleroma/notification_settings",
+        "block_from_strangers=true"
+      )
+      |> json_response_and_validate_schema(:ok)
+
+      user = refresh_record(user)
+
+      assert %Pleroma.User.NotificationSetting{
+               block_from_strangers: true,
+               hide_notification_contents: false
+             } == user.notification_settings
+    end
+
     test "it updates notification settings to enable hiding contents", %{user: user, conn: conn} do
       conn
       |> put(
@@ -53,6 +104,27 @@ defmodule Pleroma.Web.TwitterAPI.UtilControllerTest do
                hide_notification_contents: true
              } == user.notification_settings
     end
+
+    # we already test all body variants for block_from_strangers, so just one should suffice here
+    test "it updates notification settings to enable hiding contents via JSON body params", %{
+      user: user,
+      conn: conn
+    } do
+      conn
+      |> put_req_header("content-type", "application/json")
+      |> put(
+        "/api/pleroma/notification_settings",
+        %{"hide_notification_contents" => true}
+      )
+      |> json_response_and_validate_schema(:ok)
+
+      user = refresh_record(user)
+
+      assert %Pleroma.User.NotificationSetting{
+               block_from_strangers: false,
+               hide_notification_contents: true
+             } == user.notification_settings
+    end
   end
 
   describe "GET /api/pleroma/frontend_configurations" do