good_job 2.4.2 → 2.6.2

data/lib/good_job/execution.rb

@@ -6,10 +6,14 @@ module GoodJob
   #   class Execution < ActiveRecord::Base; end
   class Execution < Object.const_get(GoodJob.active_record_parent_class)
     include Lockable
+    include Filterable
 
     # Raised if something attempts to execute a previously completed Execution again.
     PreviouslyPerformedError = Class.new(StandardError)
 
+    # String separating Error Class from Error Message
+    ERROR_MESSAGE_SEPARATOR = ": "
+
     # ActiveJob jobs without a +queue_name+ attribute are placed on this queue.
     DEFAULT_QUEUE_NAME = 'default'
     # ActiveJob jobs without a +priority+ attribute are given this priority.
@@ -50,6 +54,16 @@ module GoodJob
       end
     end
 
+    def self._migration_pending_warning
+      ActiveSupport::Deprecation.warn(<<~DEPRECATION)
+        GoodJob has pending database migrations. To create the migration files, run:
+            rails generate good_job:update
+        To apply the migration files, run:
+            rails db:migrate
+      DEPRECATION
+      nil
+    end
+
     # Get Jobs with given ActiveJob ID
     # @!method active_job_id
     # @!scope class
@@ -143,24 +157,6 @@ module GoodJob
       end
     end)
 
-    # Get Jobs in display order with optional keyset pagination.
-    # @!method display_all(after_scheduled_at: nil, after_id: nil)
-    # @!scope class
-    # @param after_scheduled_at [DateTime, String, nil]
-    #   Display records scheduled after this time for keyset pagination
-    # @param after_id [Numeric, String, nil]
-    #   Display records after this ID for keyset pagination
-    # @return [ActiveRecord::Relation]
-    scope :display_all, (lambda do |after_scheduled_at: nil, after_id: nil|
-      query = order(Arel.sql('COALESCE(scheduled_at, created_at) DESC, id DESC'))
-      if after_scheduled_at.present? && after_id.present?
-        query = query.where(Arel.sql('(COALESCE(scheduled_at, created_at), id) < (:after_scheduled_at, :after_id)'), after_scheduled_at: after_scheduled_at, after_id: after_id)
-      elsif after_scheduled_at.present?
-        query = query.where(Arel.sql('(COALESCE(scheduled_at, created_at)) < (:after_scheduled_at)'), after_scheduled_at: after_scheduled_at)
-      end
-      query
-    end)
-
     # Finds the next eligible Execution, acquire an advisory lock related to it, and
     # executes the job.
     # @return [ExecutionResult, nil]
@@ -222,7 +218,15 @@ module GoodJob
 
         if CurrentThread.cron_key
           execution_args[:cron_key] = CurrentThread.cron_key
-        elsif CurrentThread.active_job_id == active_job.job_id
+
+          @cron_at_index = column_names.include?('cron_at') && connection.index_name_exists?(:good_jobs, :index_good_jobs_on_cron_key_and_cron_at) unless instance_variable_defined?(:@cron_at_index)
+
+          if @cron_at_index
+            execution_args[:cron_at] = CurrentThread.cron_at
+          else
+            _migration_pending_warning
+          end
+        elsif CurrentThread.active_job_id && CurrentThread.active_job_id == active_job.job_id
           execution_args[:cron_key] = CurrentThread.execution.cron_key
         end
 
@@ -233,7 +237,7 @@ module GoodJob
         execution.save!
         active_job.provider_job_id = execution.id
 
-        CurrentThread.execution.retried_good_job_id = execution.id if CurrentThread.execution && CurrentThread.execution.active_job_id == active_job.job_id
+        CurrentThread.execution.retried_good_job_id = execution.id if CurrentThread.active_job_id && CurrentThread.active_job_id == active_job.job_id
 
         execution
       end
@@ -253,7 +257,7 @@ module GoodJob
       result = execute
 
       job_error = result.handled_error || result.unhandled_error
-      self.error = "#{job_error.class}: #{job_error.message}" if job_error
+      self.error = [job_error.class, ERROR_MESSAGE_SEPARATOR, job_error.message].join if job_error
 
       if result.unhandled_error && GoodJob.retry_on_unhandled_error
         save!
@@ -273,29 +277,39 @@ module GoodJob
       self.class.unscoped.unfinished.owns_advisory_locked.exists?(id: id)
     end
 
+    def active_job
+      ActiveJob::Base.deserialize(active_job_data)
+    end
+
     private
 
+    def active_job_data
+      serialized_params.deep_dup
+                       .tap do |job_data|
+        job_data["provider_job_id"] = id
+      end
+    end
+
     # @return [ExecutionResult]
     def execute
-      GoodJob::CurrentThread.reset
-      GoodJob::CurrentThread.execution = self
-
-      job_data = serialized_params.deep_dup
-      job_data["provider_job_id"] = id
-
-      # DEPRECATION: Remove deprecated `good_job:` parameter in GoodJob v3
-      ActiveSupport::Notifications.instrument("perform_job.good_job", { good_job: self, execution: self, process_id: GoodJob::CurrentThread.process_id, thread_name: GoodJob::CurrentThread.thread_name }) do
-        value = ActiveJob::Base.execute(job_data)
-
-        if value.is_a?(Exception)
-          handled_error = value
-          value = nil
+      GoodJob::CurrentThread.within do |current_thread|
+        current_thread.reset
+        current_thread.execution = self
+
+        # DEPRECATION: Remove deprecated `good_job:` parameter in GoodJob v3
+        ActiveSupport::Notifications.instrument("perform_job.good_job", { good_job: self, execution: self, process_id: current_thread.process_id, thread_name: current_thread.thread_name }) do
+          value = ActiveJob::Base.execute(active_job_data)
+
+          if value.is_a?(Exception)
+            handled_error = value
+            value = nil
+          end
+          handled_error ||= current_thread.error_on_retry || current_thread.error_on_discard
+
+          ExecutionResult.new(value: value, handled_error: handled_error)
+        rescue StandardError => e
+          ExecutionResult.new(value: nil, unhandled_error: e)
         end
-        handled_error ||= GoodJob::CurrentThread.error_on_retry || GoodJob::CurrentThread.error_on_discard
-
-        ExecutionResult.new(value: value, handled_error: handled_error)
-      rescue StandardError => e
-        ExecutionResult.new(value: nil, unhandled_error: e)
       end
     end
   end

data/lib/good_job/filterable.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+module GoodJob
+  # Shared methods for filtering Execution/Job records from the +good_jobs+ table.
+  module Filterable
+    extend ActiveSupport::Concern
+
+    included do
+      # Get records in display order with optional keyset pagination.
+      # @!method display_all(after_scheduled_at: nil, after_id: nil)
+      # @!scope class
+      # @param after_scheduled_at [DateTime, String, nil]
+      #   Display records scheduled after this time for keyset pagination
+      # @param after_id [Numeric, String, nil]
+      #   Display records after this ID for keyset pagination
+      # @return [ActiveRecord::Relation]
+      scope :display_all, (lambda do |after_scheduled_at: nil, after_id: nil|
+        query = order(Arel.sql('COALESCE(scheduled_at, created_at) DESC, id DESC'))
+        if after_scheduled_at.present? && after_id.present?
+          query = query.where(Arel.sql('(COALESCE(scheduled_at, created_at), id) < (:after_scheduled_at, :after_id)'), after_scheduled_at: after_scheduled_at, after_id: after_id)
+        elsif after_scheduled_at.present?
+          query = query.where(Arel.sql('(COALESCE(scheduled_at, created_at)) < (:after_scheduled_at)'), after_scheduled_at: after_scheduled_at)
+        end
+        query
+      end)
+
+      # Search records by text query.
+      # @!method search_text(query)
+      # @!scope class
+      # @param query [String]
+      #   Search Query
+      # @return [ActiveRecord::Relation]
+      scope :search_text, (lambda do |query|
+        query = query.to_s.strip
+        next if query.blank?
+
+        tsvector = "(to_tsvector('english', serialized_params) || to_tsvector('english', id::text) || to_tsvector('english', COALESCE(error, '')::text))"
+        where("#{tsvector} @@ to_tsquery(?)", query)
+          .order(sanitize_sql_for_order([Arel.sql("ts_rank(#{tsvector}, to_tsquery(?))"), query]) => 'DESC')
+      end)
+    end
+  end
+end

data/lib/good_job/notifier.rb

@@ -25,10 +25,17 @@ module GoodJob # :nodoc:
       max_queue: 1,
       fallback_policy: :discard,
     }.freeze
-    # Seconds to wait if database cannot be connected to
-    RECONNECT_INTERVAL = 5
     # Seconds to block while LISTENing for a message
     WAIT_INTERVAL = 1
+    # Seconds to wait if database cannot be connected to
+    RECONNECT_INTERVAL = 5
+    # Connection errors that will wait {RECONNECT_INTERVAL} before reconnecting
+    CONNECTION_ERRORS = %w[
+      ActiveRecord::ConnectionNotEstablished
+      ActiveRecord::StatementInvalid
+      PG::UnableToSend
+      PG::Error
+    ].freeze
 
     # @!attribute [r] instances
     #   @!scope class
@@ -115,15 +122,18 @@ module GoodJob # :nodoc:
       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 })
+
+        connection_error = CONNECTION_ERRORS.any? do |error_string|
+          error_class = error_string.safe_constantize
+          next unless error_class
+
+          thread_error.is_a? error_class
+        end
       end
 
       return if shutdown?
 
-      if thread_error.is_a?(ActiveRecord::ConnectionNotEstablished) || thread_error.is_a?(ActiveRecord::StatementInvalid)
-        listen(delay: RECONNECT_INTERVAL)
-      else
-        listen
-      end
+      listen(delay: connection_error ? RECONNECT_INTERVAL : 0)
     end
 
     private

data/lib/good_job/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module GoodJob
   # GoodJob gem version.
-  VERSION = '2.4.2'
+  VERSION = '2.6.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 2.4.2
+  version: 2.6.2
 platform: ruby
 authors:
 - Ben Sheldon
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-19 00:00:00.000000000 Z
+date: 2021-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -126,16 +126,16 @@ dependencies:
   name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.35.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.35.0
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
@@ -280,16 +280,16 @@ dependencies:
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.142'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.142'
 - !ruby/object:Gem::Dependency
   name: sigdump
   requirement: !ruby/object:Gem::Requirement
@@ -346,31 +346,37 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
+- engine/app/assets/scripts.js
 - engine/app/assets/style.css
 - engine/app/assets/vendor/bootstrap/bootstrap.bundle.min.js
 - engine/app/assets/vendor/bootstrap/bootstrap.min.css
-- engine/app/assets/vendor/chartist/chartist.css
-- engine/app/assets/vendor/chartist/chartist.js
+- engine/app/assets/vendor/chartjs/chart.min.js
+- engine/app/assets/vendor/rails_ujs.js
+- engine/app/charts/good_job/scheduled_by_queue_chart.rb
 - engine/app/controllers/good_job/assets_controller.rb
 - engine/app/controllers/good_job/base_controller.rb
-- engine/app/controllers/good_job/cron_schedules_controller.rb
+- engine/app/controllers/good_job/cron_entries_controller.rb
 - engine/app/controllers/good_job/executions_controller.rb
 - engine/app/controllers/good_job/jobs_controller.rb
 - engine/app/filters/good_job/base_filter.rb
 - engine/app/filters/good_job/executions_filter.rb
 - engine/app/filters/good_job/jobs_filter.rb
 - engine/app/helpers/good_job/application_helper.rb
-- engine/app/models/good_job/active_job_job.rb
-- engine/app/views/good_job/cron_schedules/index.html.erb
+- engine/app/views/good_job/cron_entries/index.html.erb
+- engine/app/views/good_job/cron_entries/show.html.erb
+- engine/app/views/good_job/executions/_table.erb
 - engine/app/views/good_job/executions/index.html.erb
+- engine/app/views/good_job/jobs/_table.erb
 - engine/app/views/good_job/jobs/index.html.erb
 - engine/app/views/good_job/jobs/show.html.erb
 - engine/app/views/good_job/shared/_chart.erb
-- engine/app/views/good_job/shared/_executions_table.erb
 - engine/app/views/good_job/shared/_filter.erb
-- engine/app/views/good_job/shared/_jobs_table.erb
+- engine/app/views/good_job/shared/icons/_arrow_clockwise.html.erb
 - engine/app/views/good_job/shared/icons/_check.html.erb
 - engine/app/views/good_job/shared/icons/_exclamation.html.erb
+- engine/app/views/good_job/shared/icons/_play.html.erb
+- engine/app/views/good_job/shared/icons/_skip_forward.html.erb
+- engine/app/views/good_job/shared/icons/_stop.html.erb
 - engine/app/views/good_job/shared/icons/_trash.html.erb
 - engine/app/views/layouts/good_job/base.html.erb
 - engine/config/routes.rb
@@ -380,10 +386,13 @@ files:
 - lib/generators/good_job/install_generator.rb
 - lib/generators/good_job/templates/install/migrations/create_good_jobs.rb.erb
 - lib/generators/good_job/templates/update/migrations/01_create_good_jobs.rb.erb
+- lib/generators/good_job/templates/update/migrations/02_add_cron_at_to_good_jobs.rb.erb
+- lib/generators/good_job/templates/update/migrations/03_add_cron_key_cron_at_index_to_good_jobs.rb.erb
 - lib/generators/good_job/update_generator.rb
 - lib/good_job.rb
 - lib/good_job/active_job_extensions.rb
 - lib/good_job/active_job_extensions/concurrency.rb
+- lib/good_job/active_job_job.rb
 - lib/good_job/adapter.rb
 - lib/good_job/cli.rb
 - lib/good_job/configuration.rb
@@ -393,6 +402,7 @@ files:
 - lib/good_job/daemon.rb
 - lib/good_job/execution.rb
 - lib/good_job/execution_result.rb
+- lib/good_job/filterable.rb
 - lib/good_job/job.rb
 - lib/good_job/job_performer.rb
 - lib/good_job/lockable.rb
@@ -412,7 +422,7 @@ metadata:
   documentation_uri: https://rdoc.info/github/bensheldon/good_job
   homepage_uri: https://github.com/bensheldon/good_job
   source_code_uri: https://github.com/bensheldon/good_job
-post_install_message:
+post_install_message: 
 rdoc_options:
 - "--title"
 - GoodJob - a multithreaded, Postgres-based ActiveJob backend for Ruby on Rails
@@ -435,8 +445,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.2.30
+signing_key: 
 specification_version: 4
 summary: A multithreaded, Postgres-based ActiveJob backend for Ruby on Rails
 test_files: []