Mastodon-compatible webhooks

Signed-off-by: nicole mikołajczyk <git@mkljczk.pl>

test/mix/tasks/pleroma/database_test.exs

@@ -416,7 +416,8 @@ defmodule Mix.Tasks.Pleroma.DatabaseTest do
                ["user_invite_tokens"],
                ["user_notes"],
                ["user_relationships"],
-               ["users"]
+               ["users"],
+               ["webhooks"]
              ]
     end
 

test/pleroma/user_test.exs

@@ -11,12 +11,14 @@ defmodule Pleroma.UserTest do
   alias Pleroma.User
   alias Pleroma.Web.ActivityPub.ActivityPub
   alias Pleroma.Web.CommonAPI
+  alias Pleroma.Webhook.Notify
 
   use Pleroma.DataCase, async: false
   use Oban.Testing, repo: Pleroma.Repo
 
   import Pleroma.Factory
   import ExUnit.CaptureLog
+  import Mock
   import Swoosh.TestAssertions
 
   setup do
@@ -719,6 +721,14 @@ defmodule Pleroma.UserTest do
 
       assert user.is_confirmed
     end
+
+    test_with_mock "triggers webhooks", Notify, trigger_webhooks: fn _, _ -> nil end do
+      cng = User.register_changeset(%User{}, @full_user_data)
+
+      {:ok, registered_user} = User.register(cng)
+
+      assert_called(Notify.trigger_webhooks(registered_user, :"account.created"))
+    end
   end
 
   describe "user registration, with :account_activation_required" do

test/pleroma/web/activity_pub/activity_pub_test.exs

@@ -17,6 +17,7 @@ defmodule Pleroma.Web.ActivityPub.ActivityPubTest do
   alias Pleroma.Web.ActivityPub.Utils
   alias Pleroma.Web.AdminAPI.AccountView
   alias Pleroma.Web.CommonAPI
+  alias Pleroma.Webhook.Notify
 
   import ExUnit.CaptureLog
   import Mock
@@ -1715,6 +1716,29 @@ defmodule Pleroma.Web.ActivityPub.ActivityPubTest do
       assert Repo.aggregate(Object, :count, :id) == 1
       assert Repo.aggregate(Notification, :count, :id) == 0
     end
+
+    test_with_mock "triggers webhooks",
+                   %{
+                     reporter: reporter,
+                     context: context,
+                     target_account: target_account,
+                     reported_activity: reported_activity,
+                     content: content
+                   },
+                   Notify,
+                   [:passthrough],
+                   trigger_webhooks: fn _, _ -> nil end do
+      {:ok, activity} =
+        ActivityPub.flag(%{
+          actor: reporter,
+          context: context,
+          account: target_account,
+          statuses: [reported_activity],
+          content: content
+        })
+
+      assert_called(Notify.trigger_webhooks(activity, :"report.created"))
+    end
   end
 
   test "fetch_activities/2 returns activities addressed to a list " do

test/pleroma/web/admin_api/controllers/webhook_controller_test.exs

@@ -0,0 +1,84 @@
+# Pleroma: A lightweight social networking server
+# Copyright © 2017-2022 Pleroma Authors <https://pleroma.social/>
+# SPDX-License-Identifier: AGPL-3.0-only
+
+defmodule Pleroma.Web.AdminAPI.WebhookControllerTest do
+  use Pleroma.Web.ConnCase, async: true
+
+  import Pleroma.Factory
+
+  alias Pleroma.Webhook
+
+  setup do
+    admin = insert(:user, is_admin: true)
+    token = insert(:oauth_admin_token, user: admin)
+
+    conn =
+      build_conn()
+      |> assign(:user, admin)
+      |> assign(:token, token)
+
+    {:ok, %{admin: admin, token: token, conn: conn}}
+  end
+
+  describe "GET /api/pleroma/admin/webhook" do
+    test "lists existing webhooks", %{conn: conn} do
+      Webhook.create(%{url: "https://example.com/webhook1", events: [:"report.created"]})
+      Webhook.create(%{url: "https://example.com/webhook2", events: [:"account.created"]})
+
+      response =
+        conn
+        |> get("/api/pleroma/admin/webhooks")
+        |> json_response_and_validate_schema(:ok)
+
+      assert length(response) == 2
+    end
+  end
+
+  describe "POST /api/pleroma/admin/webhooks" do
+    test "creates a webhook", %{conn: conn} do
+      %{"id" => id} =
+        conn
+        |> put_req_header("content-type", "application/json")
+        |> post("/api/pleroma/admin/webhooks", %{
+          url: "http://example.com/webhook",
+          events: ["account.created"]
+        })
+        |> json_response_and_validate_schema(:ok)
+
+      assert %{url: "http://example.com/webhook", events: [:"account.created"]} = Webhook.get(id)
+    end
+  end
+
+  describe "PATCH /api/pleroma/admin/webhooks" do
+    test "edits a webhook", %{conn: conn} do
+      %{id: id} =
+        Webhook.create(%{url: "https://example.com/webhook1", events: [:"report.created"]})
+
+      conn
+      |> put_req_header("content-type", "application/json")
+      |> patch("/api/pleroma/admin/webhooks/#{id}", %{
+        events: ["report.created", "account.created"]
+      })
+      |> json_response_and_validate_schema(:ok)
+
+      assert %{events: [:"report.created", :"account.created"]} = Webhook.get(id)
+    end
+  end
+
+  describe "DELETE /api/pleroma/admin/webhooks" do
+    test "deletes a webhook", %{conn: conn} do
+      %{id: id} =
+        Webhook.create(%{url: "https://example.com/webhook1", events: [:"report.created"]})
+
+      conn
+      |> put_req_header("content-type", "application/json")
+      |> delete("/api/pleroma/admin/webhooks/#{id}")
+      |> json_response_and_validate_schema(:ok)
+
+      assert [] =
+               Webhook
+               |> Pleroma.Repo.all()
+    end
+  end
+end

test/pleroma/webhook/notify_test.exs

@@ -0,0 +1,75 @@
+# Pleroma: A lightweight social networking server
+# Copyright © 2017-2022 Pleroma Authors <https://pleroma.social/>
+# SPDX-License-Identifier: AGPL-3.0-only
+
+defmodule Pleroma.Webhook.NotifyTest do
+  use Pleroma.DataCase, async: true
+
+  alias Pleroma.Webhook
+  alias Pleroma.Webhook.Notify
+
+  import Pleroma.Factory
+
+  test "triggers a webhook for a report" do
+    %{id: activity_id} = activity = insert(:report_activity)
+
+    url = "https://example.com/webhook"
+
+    Webhook.create(%{url: url, events: [:"report.created"]})
+
+    Tesla.Mock.mock(fn %{url: ^url, body: body} = _ ->
+      report =
+        body
+        |> Jason.decode!()
+        |> Map.get("object")
+
+      assert %{"id" => ^activity_id} = report
+
+      %Tesla.Env{status: 200, body: ""}
+    end)
+
+    [job] = Notify.trigger_webhooks(activity, :"report.created")
+
+    Pleroma.Workers.WebhookWorker.perform(job)
+  end
+
+  test "triggers a webhook for an account" do
+    %{id: account_id} = user = insert(:user)
+
+    url = "https://example.com/webhook"
+
+    Webhook.create(%{url: url, events: [:"account.created"]})
+
+    Tesla.Mock.mock(fn %{url: ^url, body: body} = _ ->
+      report =
+        body
+        |> Jason.decode!()
+        |> Map.get("object")
+
+      assert %{"id" => ^account_id} = report
+
+      %Tesla.Env{status: 200, body: ""}
+    end)
+
+    [job] = Notify.trigger_webhooks(user, :"account.created")
+
+    Pleroma.Workers.WebhookWorker.perform(job)
+  end
+
+  test "notifies have a valid signature" do
+    activity = insert(:report_activity)
+
+    %{secret: secret} =
+      webhook = Webhook.create(%{url: "https://example.com/webhook", events: [:"report.created"]})
+
+    Tesla.Mock.mock(fn %{url: "https://example.com/webhook", body: body, headers: headers} = _ ->
+      {"X-Hub-Signature", "sha256=" <> signature} =
+        Enum.find(headers, fn {key, _} -> key == "X-Hub-Signature" end)
+
+      assert signature == :crypto.mac(:hmac, :sha256, secret, body) |> Base.encode16()
+      %Tesla.Env{status: 200, body: ""}
+    end)
+
+    Notify.report_created(webhook, activity)
+  end
+end

test/pleroma/webhook_test.exs

@@ -0,0 +1,56 @@
+# Pleroma: A lightweight social networking server
+# Copyright © 2017-2022 Pleroma Authors <https://pleroma.social/>
+# SPDX-License-Identifier: AGPL-3.0-only
+
+defmodule Pleroma.WebhookTest do
+  use Pleroma.DataCase, async: true
+
+  alias Pleroma.Webhook
+
+  test "creating a webhook" do
+    %{id: id} = Webhook.create(%{url: "https://example.com/webhook", events: [:"report.created"]})
+
+    assert %{url: "https://example.com/webhook"} = Webhook.get(id)
+  end
+
+  test "editing a webhook" do
+    %{id: id} =
+      webhook = Webhook.create(%{url: "https://example.com/webhook", events: [:"report.created"]})
+
+    Webhook.update(webhook, %{events: [:"account.created"]})
+
+    assert %{events: [:"account.created"]} = Webhook.get(id)
+  end
+
+  test "filter webhooks by type" do
+    %{id: id1} =
+      Webhook.create(%{url: "https://example.com/webhook1", events: [:"report.created"]})
+
+    %{id: id2} =
+      Webhook.create(%{
+        url: "https://example.com/webhook2",
+        events: [:"account.created", :"report.created"]
+      })
+
+    Webhook.create(%{url: "https://example.com/webhook3", events: [:"account.created"]})
+
+    assert [%{id: ^id1}, %{id: ^id2}] = Webhook.get_by_type(:"report.created")
+  end
+
+  test "change webhook state" do
+    %{id: id, enabled: true} =
+      webhook = Webhook.create(%{url: "https://example.com/webhook", events: [:"report.created"]})
+
+    Webhook.set_enabled(webhook, false)
+    assert %{enabled: false} = Webhook.get(id)
+  end
+
+  test "rotate webhook secrets" do
+    %{id: id, secret: secret} =
+      webhook = Webhook.create(%{url: "https://example.com/webhook", events: [:"report.created"]})
+
+    Webhook.rotate_secret(webhook)
+    %{secret: new_secret} = Webhook.get(id)
+    assert secret != new_secret
+  end
+end