feat: allow using a pattern of file to specify multiple configurations of recurring tasks

Author: ThomasCrambert

lib/solid_queue.rb

@@ -41,6 +41,8 @@ module SolidQueue
   mattr_accessor :clear_finished_jobs_after, default: 1.day
   mattr_accessor :default_concurrency_control_period, default: 3.minutes
 
+  mattr_accessor :recurring_config_file_pattern, default: SolidQueue::Configuration::DEFAULT_RECURRING_SCHEDULE_FILE_PATH
+
   delegate :on_start, :on_stop, :on_exit, to: Supervisor
 
   [ Dispatcher, Scheduler, Worker ].each do |process|

lib/solid_queue/configuration.rb

@@ -154,7 +154,15 @@ def processes_config
 
       def recurring_tasks_config
         @recurring_tasks_config ||= begin
-          config_from options[:recurring_schedule_file]
+            if options.key?(:recurring_schedule_config_pattern)
+          matching_configurations = Dir.glob(Rails.root.join(options[:recurring_schedule_config_pattern]))
+            matching_configurations
+               .each_with_object({}) do |config_file, recurring_configuration|
+                recurring_configuration.merge!(config_from config_file)
+              end
+            else
+              config_from options[:recurring_schedule_file]
+            end
         end
       end
 

test/dummy/config/recurring_matching_pattern_a.yml

@@ -0,0 +1,5 @@
+periodic_store_result_a:
+  class: StoreResultJob
+  queue: default
+  args: [ 42, { status: "custom_status" } ]
+  schedule: every second

test/dummy/config/recurring_matching_pattern_b.yml

@@ -0,0 +1,5 @@
+periodic_store_result_b:
+  class: StoreResultJob
+  queue: default
+  args: [ 42, { status: "custom_status" } ]
+  schedule: every second

test/unit/configuration_test.rb

@@ -68,6 +68,7 @@ class ConfigurationTest < ActiveSupport::TestCase
     assert_processes configuration, :scheduler, 1
 
     scheduler = configuration.configured_processes.second.instantiate
+    assert_equal 1, scheduler.recurring_schedule.configured_tasks.count
     assert_has_recurring_task scheduler, key: "periodic_store_result", class_name: "StoreResultJob", schedule: "every second"
   end
 
@@ -77,6 +78,7 @@ class ConfigurationTest < ActiveSupport::TestCase
     assert_processes configuration, :scheduler, 1
 
     scheduler = configuration.configured_processes.first.instantiate
+    assert_equal 1, scheduler.recurring_schedule.configured_tasks.count
     assert_has_recurring_task scheduler, key: "periodic_store_result", class_name: "StoreResultJob", schedule: "every second"
   end
 
@@ -143,6 +145,20 @@ class ConfigurationTest < ActiveSupport::TestCase
       configuration.errors.full_messages.first
   end
 
+  test 'multiple recurring configuration files' do
+    configuration = SolidQueue::Configuration.new(recurring_schedule_config_pattern: 'config/recurring_matching_pattern_*.yml')
+
+    assert configuration.valid?
+    assert_processes configuration, :scheduler, 1
+
+    scheduler = configuration.configured_processes.find { |process| process.kind == :scheduler }.instantiate
+
+    assert_equal 2, scheduler.recurring_schedule.configured_tasks.count
+    assert_has_recurring_task scheduler, key: "periodic_store_result_a", class_name: "StoreResultJob", schedule: "every second"
+    assert_has_recurring_task scheduler, key: "periodic_store_result_b", class_name: "StoreResultJob", schedule: "every second"
+  ensure
+  end
+
   private
     def assert_processes(configuration, kind, count, **attributes)
       processes = configuration.configured_processes.select { |p| p.kind == kind }
@@ -159,7 +175,6 @@ def assert_processes(configuration, kind, count, **attributes)
     end
 
     def assert_has_recurring_task(scheduler, key:, **attributes)
-      assert_equal 1, scheduler.recurring_schedule.configured_tasks.count
       task = scheduler.recurring_schedule.configured_tasks.detect { |t| t.key == key }
 
       attributes.each do |attr, value|