Merge pull request #335 from lardawge/ls/add-support-for-override-worker-queue-names

Add support for overridden worker queue names

Author: lardawge

lib/backgrounder/support/backends.rb

@@ -10,10 +10,10 @@ def self.included(base)
         module ClassMethods
           attr_reader :queue_options
 
-          def backend(queue_name=nil, args={})
+          def backend(backend_name=nil, args={})
             return @backend if @backend
-            @queue_options = args
-            @backend = queue_name
+            @queue_options = set_queue_name_default(args)
+            @backend = backend_name
           end
 
           def enqueue_for_backend(worker, class_name, subject_id, mounted_as)
@@ -23,17 +23,29 @@ def enqueue_for_backend(worker, class_name, subject_id, mounted_as)
           private
 
           def enqueue_active_job(worker, *args)
-            worker.perform_later(*args.map(&:to_s))
+            options = if worker.new.queue_name != 'default'
+              queue_options.except(:queue)
+            else
+              queue_options
+            end
+
+            worker.set(options).perform_later(*args.map(&:to_s))
           end
 
           def enqueue_sidekiq(worker, *args)
-            override_queue_name = worker.sidekiq_options['queue'] == 'default' || worker.sidekiq_options['queue'].nil?
+            override_queue_name = worker.sidekiq_options['queue'] == 'default'
             args = sidekiq_queue_options(override_queue_name, 'class' => worker, 'args' => args.map(&:to_s))
             worker.client_push(args)
           end
 
           private
 
+          def set_queue_name_default(options)
+            options.tap do |opts|
+              opts[:queue] ||= :carrierwave
+            end
+          end
+
           def sidekiq_queue_options(override_queue_name, args)
             if override_queue_name && queue_options[:queue]
               args['queue'] = queue_options[:queue]

lib/carrierwave_backgrounder.rb

@@ -22,15 +22,6 @@ def self.configure
         @worker_klass = 'CarrierWave::Workers::ActiveJob'
         require 'backgrounder/workers/active_job/process_asset'
         require 'backgrounder/workers/active_job/store_asset'
-
-        queue_name = queue_options[:queue] || 'carrierwave'
-
-        ::CarrierWave::Workers::ActiveJob::ProcessAsset.class_eval do
-          queue_as queue_name
-        end
-        ::CarrierWave::Workers::ActiveJob::StoreAsset.class_eval do
-          queue_as queue_name
-        end
       when :sidekiq
         @worker_klass = 'CarrierWave::Workers'
 
@@ -43,8 +34,8 @@ def self.configure
       end
     end
 
-    def self.suppress_record_not_found_errors(surpress_errors = true)
-      @suppress_not_found_errors = surpress_errors
+    def self.suppress_record_not_found_errors(suppress_errors = true)
+      @suppress_not_found_errors = suppress_errors
     end
   end
 end

spec/backgrounder/support/backends_spec.rb

@@ -44,7 +44,9 @@ module CarrierWave::Backgrounder
         let(:args) { ['FakeClass', 1, :image] }
 
         it 'invokes client_push on the class with passed args' do
-          expect(MockSidekiqWorker).to receive(:client_push).with({ 'class' => MockSidekiqWorker, 'args' => args.map(&:to_s) })
+          expect(MockSidekiqWorker).to receive(:client_push).with({ 'class' => MockSidekiqWorker,
+                                                                    'args' => args.map(&:to_s),
+                                                                    'queue' => :carrierwave  })
           mock_module.backend :sidekiq
           mock_module.enqueue_for_backend(MockSidekiqWorker, *args)
         end

spec/integrations/queue_name_spec.rb

@@ -0,0 +1,68 @@
+require 'rails_helper'
+
+RSpec.describe 'Queue Name', clear_images: true do
+  let(:user) { User.new }
+
+  context 'when using built in worker' do
+    context 'when queue name is passed in via config' do
+      before do
+        CarrierWave::Backgrounder.instance_variable_set(:@queue_options, queue: 'carrierwaver')
+      end
+
+      after do
+        CarrierWave::Backgrounder.instance_variable_set(:@queue_options, queue: 'carrierwave')
+      end
+
+      it 'uses the config queue name' do
+        user.update(avatar: load_file('test-1.jpg'))
+        expect(Sidekiq::Queues["carrierwaver"].size).to eql(1)
+      end
+    end
+
+    context 'when not queue name is not set' do
+      it 'uses the default name carrierwave' do
+        user.update(avatar: load_file('test-1.jpg'))
+        expect(Sidekiq::Queues["carrierwave"].size).to eql(1)
+      end
+    end
+  end
+
+  context 'when using a subclassed worker' do
+    context 'when queue name is passed in via config' do
+      before do
+        CarrierWave::Backgrounder.instance_variable_set(:@queue_options, queue: 'carrierwaver')
+      end
+
+      after do
+        CarrierWave::Backgrounder.instance_variable_set(:@queue_options, queue: 'carrierwave')
+      end
+
+      it 'uses the config queue name' do
+        user.update(portrait: load_file('test-1.jpg'))
+        expect(Sidekiq::Queues["carrierwaver"].size).to eql(1)
+      end
+    end
+
+    context 'when not queue name is not set' do
+      it 'uses the default name carrierwave' do
+        user.update(portrait: load_file('test-1.jpg'))
+        expect(Sidekiq::Queues["carrierwave"].size).to eql(1)
+      end
+    end
+
+    context 'when overridden via subclassed worker' do
+      before do
+        PortraitProcessJob.queue_as :custom_queue
+      end
+
+      after do
+        PortraitProcessJob.queue_as :carrierwave
+      end
+
+      it 'uses the queue name passed in' do
+        user.update(portrait: load_file('test-1.jpg'))
+        expect(Sidekiq::Queues["custom_queue"].size).to eql(1)
+      end
+    end
+  end
+end

spec/rails_helper.rb

@@ -7,6 +7,19 @@
 require 'rspec/rails'
 require 'backgrounder/railtie'
 
+if ENV['QUEUE_ADAPTER'] == 'sidekiq'
+  Object.send(:remove_const, :PortraitProcessJob) if defined?(PortraitProcessJob)
+  class PortraitProcessJob
+    include CarrierWave::Workers::ProcessAssetMixin
+    include Sidekiq::Worker
+  end
+else
+  Object.send(:remove_const, :PortraitProcessJob) if defined?(PortraitProcessJob)
+  class PortraitProcessJob < ::ActiveJob::Base
+    include CarrierWave::Workers::ProcessAssetMixin
+  end
+end
+
 begin
   ActiveRecord::Migration.maintain_test_schema!
 rescue ActiveRecord::PendingMigrationError => e

spec/support/dummy_app/Gemfile

@@ -1,13 +1,13 @@
 source "https://rubygems.org"
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-ruby "3.0.0"
+ruby "3.4.5"
 
 # Bundle edge Rails instead: gem "rails", github: "rails/rails", branch: "main"
 gem "rails", "~> 8.0.2"
 
 # Use sqlite3 as the database for Active Record
-gem "sqlite3", "~> 1.4"
+gem "sqlite3", "~> 2.7"
 
 # Use the Puma web server [https://github.com/puma/puma]
 # gem "puma", "~> 5.0"

spec/support/dummy_app/app/jobs/portrait_process_job.rb

@@ -0,0 +1,5 @@
+class PortraitProcessJob
+  def perform(*args)
+    # Do something later
+  end
+end

spec/support/dummy_app/app/models/user.rb

@@ -7,4 +7,7 @@ class User < ApplicationRecord
   mount_uploaders :images, AvatarUploader
   store_in_background :images
   serialize :images, coder: JSON
+
+  mount_uploader :portrait, AvatarUploader
+  store_in_background :portrait, PortraitProcessJob
 end

spec/support/dummy_app/db/migrate/20250926184915_add_columns_for_portrait.rb

@@ -0,0 +1,7 @@
+class AddColumnsForPortrait < ActiveRecord::Migration[8.0]
+  def change
+    add_column :users, :portrait, :string
+    add_column :users, :portrait_tmp, :string
+    add_column :users, :portrait_processing, :boolean, null: false, default:false
+  end
+end

spec/support/dummy_app/db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema[7.0].define(version: 2023_08_11_155811) do
+ActiveRecord::Schema[8.0].define(version: 2025_09_26_184915) do
   create_table "admins", force: :cascade do |t|
     t.string "avatar"
     t.boolean "avatar_processing", default: false, null: false
@@ -29,6 +29,8 @@
     t.string "images"
     t.string "images_tmp"
     t.boolean "images_processing", default: false, null: false
+    t.string "portrait"
+    t.string "portrait_tmp"
+    t.boolean "portrait_processing", default: false, null: false
   end
-
 end