Apply deprecation path instead of removal

Author: zzak

activejob/CHANGELOG.md

@@ -1,7 +1,8 @@
-*   Remove `sucker_punch` as an adapter option [since author himself recommends using AJ's own AsyncAdapter](https://github.com/brandonhilkert/sucker_punch?tab=readme-ov-file#faq).
+*   Deprecate `sucker_punch` as an adapter option.
+
     If you're using this adapter, change to `adapter: async` for the same functionality.
 
-    *Dino Maric*
+    *Dino Maric, zzak*
 
 *   Use `RAILS_MAX_THREADS` in `ActiveJob::AsyncAdapter`. If it is not set, use 5 as default.
 

activejob/lib/active_job/queue_adapter.rb

@@ -50,6 +50,7 @@ def queue_adapter=(name_or_adapter)
         case name_or_adapter
         when Symbol, String
           queue_adapter = ActiveJob::QueueAdapters.lookup(name_or_adapter).new
+          queue_adapter.try(:check_adapter)
           assign_adapter(name_or_adapter.to_s, queue_adapter)
         else
           if queue_adapter?(name_or_adapter)

activejob/lib/active_job/queue_adapters/sucker_punch_adapter.rb

@@ -18,6 +18,13 @@ module QueueAdapters
     #
     #   Rails.application.config.active_job.queue_adapter = :sucker_punch
     class SuckerPunchAdapter < AbstractAdapter
+      def check_adapter
+        ActiveJob.deprecator.warn <<~MSG.squish
+          The `sucker_punch` adapter is deprecated and will be removed in Rails 8.1.
+          Please use the `async` adapter instead.
+        MSG
+      end
+
       def enqueue(job) # :nodoc:
         if JobWrapper.respond_to?(:perform_async)
           # sucker_punch 2.0 API

activejob/test/cases/adapter_test.rb

@@ -6,4 +6,31 @@ class AdapterTest < ActiveSupport::TestCase
   test "should load #{ENV['AJ_ADAPTER']} adapter" do
     assert_equal "active_job/queue_adapters/#{ENV['AJ_ADAPTER']}_adapter".classify, ActiveJob::Base.queue_adapter.class.name
   end
+
+  if adapter_is?(:sucker_punch)
+    test "sucker_punch adapter should be deprecated" do
+      before_adapter = ActiveJob::Base.queue_adapter
+
+      msg = <<~MSG.squish
+        The `sucker_punch` adapter is deprecated and will be removed in Rails 8.1.
+        Please use the `async` adapter instead.
+      MSG
+      assert_deprecated(msg, ActiveJob.deprecator) do
+        ActiveJob::Base.queue_adapter = :sucker_punch
+      end
+
+    ensure
+      ActiveJob::Base.queue_adapter = before_adapter
+    end
+
+    test "sucker_punch check_adapter should warn" do
+      msg = <<~MSG.squish
+        The `sucker_punch` adapter is deprecated and will be removed in Rails 8.1.
+        Please use the `async` adapter instead.
+      MSG
+      assert_deprecated(msg, ActiveJob.deprecator) do
+        ActiveJob::Base.queue_adapter.check_adapter
+      end
+    end
+  end
 end