Merge branch 'use-jobs-in-webpush' into 'develop'

Use PleromaJobQueue in Pleroma.Web.Push

See merge request pleroma/pleroma!1023

config/config.exs

@@ -367,6 +367,7 @@
 config :pleroma_job_queue, :queues,
   federator_incoming: 50,
   federator_outgoing: 50,
+  web_push: 50,
   mailer: 10,
   transmogrifier: 20,
   scheduled_activities: 10

docs/config.md

@@ -319,6 +319,7 @@ Pleroma has the following queues:
 * `federator_incoming` - Incoming federation
 * `mailer` - Email sender, see [`Pleroma.Mailer`](#pleroma-mailer)
 * `transmogrifier` - Transmogrifier
+* `web_push` - Web push notifications
 * `scheduled_activities` - Scheduled activities, see [`Pleroma.ScheduledActivities`](#pleromascheduledactivity)
 
 Example:

lib/pleroma/application.ex

@@ -111,8 +111,8 @@ def start(_type, _args) do
         [
           worker(Pleroma.Web.Federator.RetryQueue, []),
           worker(Pleroma.Stats, []),
-          worker(Pleroma.Web.Push, []),
+          worker(Task, [&Pleroma.Web.Push.init/0], restart: :temporary, id: :web_push_init),
-          worker(Task, [&Pleroma.Web.Federator.init/0], restart: :temporary)
+          worker(Task, [&Pleroma.Web.Federator.init/0], restart: :temporary, id: :federator_init)
         ] ++
         streamer_child() ++
         chat_child() ++

lib/pleroma/web/push/impl.ex

@@ -19,8 +19,8 @@ defmodule Pleroma.Web.Push.Impl do
   @types ["Create", "Follow", "Announce", "Like"]
 
   @doc "Performs sending notifications for user subscriptions"
-  @spec perform_send(Notification.t()) :: list(any)
+  @spec perform(Notification.t()) :: list(any) | :error
-  def perform_send(
+  def perform(
         %{activity: %{data: %{"type" => activity_type}, id: activity_id}, user_id: user_id} =
           notif
       )
@@ -50,7 +50,7 @@ def perform_send(
     end
   end
 
-  def perform_send(_) do
+  def perform(_) do
     Logger.warn("Unknown notification type")
     :error
   end

lib/pleroma/web/push/push.ex

@@ -3,18 +3,20 @@
 # SPDX-License-Identifier: AGPL-3.0-only
 
 defmodule Pleroma.Web.Push do
-  use GenServer
-
   alias Pleroma.Web.Push.Impl
 
   require Logger
 
-  ##############
+  def init do
-  # Client API #
+    unless enabled() do
-  ##############
+      Logger.warn("""
+      VAPID key pair is not found. If you wish to enabled web push, please run
 
-  def start_link do
+          mix web_push.gen.keypair
-    GenServer.start_link(__MODULE__, :ok, name: __MODULE__)
+
+      and add the resulting output to your configuration file.
+      """)
+    end
   end
 
   def vapid_config do
@@ -30,35 +32,5 @@ def enabled do
   end
 
   def send(notification),
-    do: GenServer.cast(__MODULE__, {:send, notification})
+    do: PleromaJobQueue.enqueue(:web_push, Impl, [notification])
-
-  ####################
-  # Server Callbacks #
-  ####################
-
-  @impl true
-  def init(:ok) do
-    if enabled() do
-      {:ok, nil}
-    else
-      Logger.warn("""
-      VAPID key pair is not found. If you wish to enabled web push, please run
-
-          mix web_push.gen.keypair
-
-      and add the resulting output to your configuration file.
-      """)
-
-      :ignore
-    end
-  end
-
-  @impl true
-  def handle_cast({:send, notification}, state) do
-    if enabled() do
-      Impl.perform_send(notification)
-    end
-
-    {:noreply, state}
-  end
 end

test/web/push/impl_test.exs

@@ -64,17 +64,19 @@ test "performs sending notifications" do
         }
       )
 
-    assert Impl.perform_send(notif) == [:ok, :ok]
+    assert Impl.perform(notif) == [:ok, :ok]
   end
 
+  @tag capture_log: true
   test "returns error if notif does not match " do
-    assert Impl.perform_send(%{}) == :error
+    assert Impl.perform(%{}) == :error
   end
 
   test "successful message sending" do
     assert Impl.push_message(@message, @sub, @api_key, %Subscription{}) == :ok
   end
 
+  @tag capture_log: true
   test "fail message sending" do
     assert Impl.push_message(
              @message,