good_job 1.3.5 → 1.6.0

data/lib/good_job/log_subscriber.rb

@@ -218,13 +218,13 @@ module GoodJob
     #
     %w(info debug warn error fatal unknown).each do |level|
       class_eval <<-METHOD, __FILE__, __LINE__ + 1
-        def #{level}(progname = nil, tags: [], &block)
-          return unless logger
-
-          tag_logger(*tags) do
-            logger.#{level}(progname, &block)
-          end
-        end
+        def #{level}(progname = nil, tags: [], &block)   # def info(progname = nil, tags: [], &block)
+          return unless logger                           #   return unless logger
+                                                         #
+          tag_logger(*tags) do                           #   tag_logger(*tags) do
+            logger.#{level}(progname, &block)            #     logger.info(progname, &block)
+          end                                            #   end
+        end                                              #
       METHOD
     end
   end

data/lib/good_job/notifier.rb

@@ -9,6 +9,9 @@ module GoodJob # :nodoc:
   # When a message is received, the notifier passes the message to each of its recipients.
   #
   class Notifier
+    # Raised if the Database adapter does not implement LISTEN.
+    AdapterCannotListenError = Class.new(StandardError)
+
     # Default Postgres channel for LISTEN/NOTIFY
     CHANNEL = 'good_job'.freeze
     # Defaults for instance of Concurrent::ThreadPoolExecutor
@@ -90,6 +93,20 @@ module GoodJob # :nodoc:
       !@pool.running?
     end
 
+    # Invoked on completion of ThreadPoolExecutor task
+    # @!visibility private
+    # @return [void]
+    def listen_observer(_time, _result, thread_error)
+      return if thread_error.is_a? AdapterCannotListenError
+
+      if thread_error
+        GoodJob.on_thread_error.call(thread_error) if GoodJob.on_thread_error.respond_to?(:call)
+        ActiveSupport::Notifications.instrument("notifier_notify_error.good_job", { error: thread_error })
+      end
+
+      listen unless shutdown?
+    end
+
     private
 
     def create_pool
@@ -100,7 +117,7 @@ module GoodJob # :nodoc:
       future = Concurrent::Future.new(args: [@recipients, @pool, @listening], executor: @pool) do |recipients, pool, listening|
         with_listen_connection do |conn|
           ActiveSupport::Notifications.instrument("notifier_listen.good_job") do
-            conn.async_exec "LISTEN #{CHANNEL}"
+            conn.async_exec("LISTEN #{CHANNEL}").clear
           end
 
           ActiveSupport::Dependencies.interlock.permit_concurrent_loads do
@@ -120,14 +137,11 @@ module GoodJob # :nodoc:
               listening.make_false
             end
           end
-        end
-      rescue StandardError => e
-        ActiveSupport::Notifications.instrument("notifier_notify_error.good_job", { error: e })
-        raise
-      ensure
-        @listening.make_false
-        ActiveSupport::Notifications.instrument("notifier_unlisten.good_job") do
-          conn.async_exec "UNLISTEN *"
+        ensure
+          listening.make_false
+          ActiveSupport::Notifications.instrument("notifier_unlisten.good_job") do
+            conn.async_exec("UNLISTEN *").clear
+          end
         end
       end
 
@@ -135,16 +149,14 @@ module GoodJob # :nodoc:
       future.execute
     end
 
-    def listen_observer(_time, _result, _thread_error)
-      listen unless shutdown?
-    end
-
     def with_listen_connection
       ar_conn = ActiveRecord::Base.connection_pool.checkout.tap do |conn|
         ActiveRecord::Base.connection_pool.remove(conn)
       end
       pg_conn = ar_conn.raw_connection
-      pg_conn.exec("SET application_name = #{pg_conn.escape_identifier(self.class.name)}")
+      raise AdapterCannotListenError unless pg_conn.respond_to? :wait_for_notify
+
+      pg_conn.async_exec("SET application_name = #{pg_conn.escape_identifier(self.class.name)}").clear
       yield pg_conn
     ensure
       ar_conn&.disconnect!

data/lib/good_job/poller.rb

@@ -19,6 +19,9 @@ module GoodJob # :nodoc:
     #   @return [array<GoodJob:Poller>]
     cattr_reader :instances, default: [], instance_reader: false
 
+    # Creates GoodJob::Poller from a GoodJob::Configuration instance.
+    # @param configuration [GoodJob::Configuration]
+    # @return [GoodJob::Poller]
     def self.from_configuration(configuration)
       GoodJob::Poller.new(poll_interval: configuration.poll_interval)
     end

data/lib/good_job/railtie.rb

@@ -1,8 +1,12 @@
 module GoodJob
   # Ruby on Rails integration.
   class Railtie < ::Rails::Railtie
-    initializer "good_job.logger" do
-      ActiveSupport.on_load(:good_job) { self.logger = ::Rails.logger }
+    config.good_job = ActiveSupport::OrderedOptions.new
+
+    initializer "good_job.logger" do |_app|
+      ActiveSupport.on_load(:good_job) do
+        self.logger = ::Rails.logger
+      end
       GoodJob::LogSubscriber.attach_to :good_job
     end
 

data/lib/good_job/scheduler.rb

@@ -8,7 +8,7 @@ module GoodJob # :nodoc:
   # periodically checking for available tasks, executing tasks within a thread,
   # and efficiently scaling active threads.
   #
-  # Every scheduler has a single {Performer} that will execute tasks.
+  # Every scheduler has a single {JobPerformer} that will execute tasks.
   # The scheduler is responsible for calling its performer efficiently across threads managed by an instance of +Concurrent::ThreadPoolExecutor+.
   # If a performer does not have work, the thread will go to sleep.
   # The scheduler maintains an instance of +Concurrent::TimerTask+, which wakes sleeping threads and causes them to check whether the performer has new work.
@@ -22,7 +22,7 @@ module GoodJob # :nodoc:
       max_threads: Configuration::DEFAULT_MAX_THREADS,
       auto_terminate: true,
       idletime: 60,
-      max_queue: -1,
+      max_queue: 0,
       fallback_policy: :discard,
     }.freeze
 
@@ -40,19 +40,7 @@ module GoodJob # :nodoc:
         queue_string, max_threads = queue_string_and_max_threads.split(':')
         max_threads = (max_threads || configuration.max_threads).to_i
 
-        job_query = GoodJob::Job.queue_string(queue_string)
-        parsed = GoodJob::Job.queue_parser(queue_string)
-        job_filter = proc do |state|
-          if parsed[:exclude]
-            parsed[:exclude].exclude?(state[:queue_name])
-          elsif parsed[:include]
-            parsed[:include].include? state[:queue_name]
-          else
-            true
-          end
-        end
-        job_performer = GoodJob::Performer.new(job_query, :perform_with_advisory_lock, name: queue_string, filter: job_filter)
-
+        job_performer = GoodJob::JobPerformer.new(queue_string)
         GoodJob::Scheduler.new(job_performer, max_threads: max_threads)
       end
 
@@ -63,7 +51,7 @@ module GoodJob # :nodoc:
       end
     end
 
-    # @param performer [GoodJob::Performer]
+    # @param performer [GoodJob::JobPerformer]
     # @param max_threads [Numeric, nil] number of seconds between polls for jobs
     def initialize(performer, max_threads: nil)
       raise ArgumentError, "Performer argument must implement #next" unless performer.respond_to?(:next)
@@ -170,10 +158,13 @@ module GoodJob # :nodoc:
       # @return [Integer]
       def ready_worker_count
         synchronize do
-          workers_still_to_be_created = @max_length - @pool.length
-          workers_created_but_waiting = @ready.length
-
-          workers_still_to_be_created + workers_created_but_waiting
+          if Concurrent.on_jruby?
+            @executor.getMaximumPoolSize - @executor.getActiveCount
+          else
+            workers_still_to_be_created = @max_length - @pool.length
+            workers_created_but_waiting = @ready.length
+            workers_still_to_be_created + workers_created_but_waiting
+          end
         end
       end
     end

data/lib/good_job/version.rb

@@ -1,4 +1,4 @@
 module GoodJob
   # GoodJob gem version.
-  VERSION = '1.3.5'.freeze
+  VERSION = '1.6.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 1.3.5
+  version: 1.6.0
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-17 00:00:00.000000000 Z
+date: 2021-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -52,20 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.2
-- !ruby/object:Gem::Dependency
-  name: pg
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -262,34 +248,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rbtrace
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -399,12 +357,13 @@ files:
 - lib/good_job/cli.rb
 - lib/good_job/configuration.rb
 - lib/good_job/current_execution.rb
+- lib/good_job/daemon.rb
 - lib/good_job/job.rb
+- lib/good_job/job_performer.rb
 - lib/good_job/lockable.rb
 - lib/good_job/log_subscriber.rb
 - lib/good_job/multi_scheduler.rb
 - lib/good_job/notifier.rb
-- lib/good_job/performer.rb
 - lib/good_job/poller.rb
 - lib/good_job/railtie.rb
 - lib/good_job/scheduler.rb
@@ -441,7 +400,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.4
 signing_key:
 specification_version: 4
 summary: A multithreaded, Postgres-based ActiveJob backend for Ruby on Rails

data/lib/good_job/performer.rb

@@ -1,60 +0,0 @@
-module GoodJob
-  #
-  # Performer queries the database for jobs and performs them on behalf of a
-  # {Scheduler}. It mainly functions as glue between a {Scheduler} and the jobs
-  # it should be executing.
-  #
-  # The Performer enforces a callable that does not rely on scoped/closure
-  # variables because they might not be available when executed in a different
-  # thread.
-  #
-  class Performer
-    # @!attribute [r] name
-    # @return [String]
-    #   a meaningful name to identify the performer in logs and for debugging.
-    #   This is usually set to the list of queues the performer will query,
-    #   e.g. +"-transactional_messages,batch_processing"+.
-    attr_reader :name
-
-    # @param target [Object]
-    #   An object that can perform jobs. It must respond to +method_name+ by
-    #   finding and performing jobs and is usually a {Job} query,
-    #   e.g. +GoodJob::Job.where(queue_name: ['queue1', 'queue2'])+.
-    # @param method_name [Symbol]
-    #   The name of a method on +target+ that finds and performs jobs.
-    # @param name [String]
-    #   A name for the performer to be used in logs and for debugging.
-    # @param filter [#call]
-    #   Used to determine whether the performer should be used in GoodJob's
-    #   current state. GoodJob state is a +Hash+ that will be passed as the
-    #   first argument to +filter+ and includes info like the current queue.
-    def initialize(target, method_name, name: nil, filter: nil)
-      @target = target
-      @method_name = method_name
-      @name = name
-      @filter = filter
-    end
-
-    # Find and perform any eligible jobs.
-    def next
-      @target.public_send(@method_name)
-    end
-
-    # Tests whether this performer should be used in GoodJob's current state by
-    # calling the +filter+ callable set in {#initialize}. Always returns +true+
-    # if there is no filter.
-    #
-    # For example, state will be a LISTEN/NOTIFY message that is passed down
-    # from the Notifier to the Scheduler. The Scheduler is able to ask
-    # its performer "does this message relate to you?", and if not, ignore it
-    # to minimize thread wake-ups, database queries, and thundering herds.
-    #
-    # @return [Boolean] whether the performer's {#next} method should be
-    #   called in the current state.
-    def next?(state = {})
-      return true unless @filter.respond_to?(:call)
-
-      @filter.call(state)
-    end
-  end
-end