Add support for :skip_retries to Oban.ErrorReporter

Author: solnic

lib/sentry/integrations/oban/error_reporter.ex

@@ -31,13 +31,20 @@ defmodule Sentry.Integrations.Oban.ErrorReporter do
         %{job: job, kind: kind, reason: reason, stacktrace: stacktrace} = _metadata,
         config
       ) do
-    if report?(reason) do
+    if report?(reason) and should_report?(job, config) do
       report(job, kind, reason, stacktrace, config)
     else
       :ok
     end
   end
 
+  defp should_report?(job, config) do
+    case Keyword.get(config, :skip_retries) do
+      true -> job.attempt == job.max_attempts
+      _ -> true
+    end
+  end
+
   defp report(job, kind, reason, stacktrace, config) do
     stacktrace =
       case {apply(Oban.Worker, :from_string, [job.worker]), stacktrace} do

test/sentry/integrations/oban/error_reporter_test.exs

@@ -210,6 +210,43 @@ defmodule Sentry.Integrations.Oban.ErrorReporterTest do
       assert [event] = Sentry.Test.pop_sentry_reports()
       assert event.tags.custom_tag == "custom_value"
     end
+
+    test "with skip_retries: true, only reports final attempt failures" do
+      job =
+        %{"id" => "123", "entity" => "user", "type" => "delete"}
+        |> MyWorker.new()
+        |> Ecto.Changeset.apply_action!(:validate)
+
+      reason = %RuntimeError{message: "oops"}
+
+      Sentry.Test.start_collecting()
+
+      job_attempt_1 = Map.merge(job, %{attempt: 1, max_attempts: 3})
+
+      assert :ok =
+               ErrorReporter.handle_event(
+                 [:oban, :job, :exception],
+                 %{},
+                 %{job: job_attempt_1, kind: :error, reason: reason, stacktrace: []},
+                 skip_retries: true
+               )
+
+      assert [] = Sentry.Test.pop_sentry_reports()
+
+      job_attempt_3 = Map.merge(job, %{attempt: 3, max_attempts: 3})
+
+      assert :ok =
+               ErrorReporter.handle_event(
+                 [:oban, :job, :exception],
+                 %{},
+                 %{job: job_attempt_3, kind: :error, reason: reason, stacktrace: []},
+                 skip_retries: true
+               )
+
+      assert [event] = Sentry.Test.pop_sentry_reports()
+      assert event.original_exception == %RuntimeError{message: "oops"}
+      assert event.tags.oban_worker == "Sentry.Integrations.Oban.ErrorReporterTest.MyWorker"
+    end
   end
 
   ## Helpers