good_job 1.3.5 → 1.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46b04fbfe44919834c406101ee18f2b53f5cc05e076525f7243e346fa966ca94
-  data.tar.gz: 798738a1f2b0c7f21457921c2c640cdc78151a09262dfa7d8a383e8778282b9d
+  metadata.gz: 8b5d625792328475faca2679c6718f344fc5162cac639be09f91197c998f2fdf
+  data.tar.gz: 4aef2c4ae814f2a0606c18e875c91e56f8a1411394c37d45f4e1141be719f080
 SHA512:
-  metadata.gz: 841c85e7b4d9fa28d1fcdbb7c6a48771438f24ae33a264a80afdff1c9730a3438b98aa5d82f54bd1d4c979b2dab64997fbf6d64036bc96fdac6c851f70e0f68f
-  data.tar.gz: 9c2d11c56e3db986aa5bbecc85a317396a19ba1c838b97d32cd16f21b9cd29b6c154be817879d8c8a8925da645d298442c0ebc39aba3d5bba707ed01558b55c5
+  metadata.gz: d309e288c89c65ec809cf7f9e138026b229aed9abb6ee667343c56ed1e96fb0833be36b7e1f1c6b064168957f537d572e2ceb5ecad0f6e754108762ace9fbd3b
+  data.tar.gz: c1b83122c14edcbe619c6198fae270f9dbb0398888232f96e8956be23ca0f5798422181a21ea08735a0089ad3a92c0405ee69731a8a205f3fe9c99ba2b27bb36

data/CHANGELOG.md

@@ -1,9 +1,37 @@
 # Changelog
 
+## [v1.3.6](https://github.com/bensheldon/good_job/tree/v1.3.6) (2020-12-30)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v1.3.5...v1.3.6)
+
+**Implemented enhancements:**
+
+- Call GoodJob.on\_thread\_error when Notifier thread raises exception [\#185](https://github.com/bensheldon/good_job/pull/185) ([bensheldon](https://github.com/bensheldon))
+- Improve dashboard UI, fix button state, add unfiltering [\#181](https://github.com/bensheldon/good_job/pull/181) ([bensheldon](https://github.com/bensheldon))
+
+**Fixed bugs:**
+
+- Replace ActiveRecord execute usage and avoid potential memory leakage [\#187](https://github.com/bensheldon/good_job/issues/187)
+- Does good\_job hold on to advisory locks for finished jobs? [\#177](https://github.com/bensheldon/good_job/issues/177)
+
+**Merged pull requests:**
+
+- Run tests with Rails default configuration to enable Zeitwerk [\#190](https://github.com/bensheldon/good_job/pull/190) ([bensheldon](https://github.com/bensheldon))
+- Update all Lockable queries to use exec\_query instead of execute; clear async\_exec results [\#189](https://github.com/bensheldon/good_job/pull/189) ([bensheldon](https://github.com/bensheldon))
+- Have Lockable\#advisory\_locked? directly query pg\_locks table [\#188](https://github.com/bensheldon/good_job/pull/188) ([bensheldon](https://github.com/bensheldon))
+- Update development gems, including Rails v6.1 and Rails HEAD [\#186](https://github.com/bensheldon/good_job/pull/186) ([bensheldon](https://github.com/bensheldon))
+- Update Appraisals for Rails 6.1 [\#183](https://github.com/bensheldon/good_job/pull/183) ([bensheldon](https://github.com/bensheldon))
+- Add Ruby 3 to CI test matrix [\#182](https://github.com/bensheldon/good_job/pull/182) ([bensheldon](https://github.com/bensheldon))
+
 ## [v1.3.5](https://github.com/bensheldon/good_job/tree/v1.3.5) (2020-12-17)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v1.3.4...v1.3.5)
 
+**Fixed bugs:**
+
+-  Ensure advisory lock CTE is MATERIALIZED on Postgres v12+ [\#179](https://github.com/bensheldon/good_job/pull/179) ([bensheldon](https://github.com/bensheldon))
+- Ensure that deleted jobs are unlocked [\#178](https://github.com/bensheldon/good_job/pull/178) ([bensheldon](https://github.com/bensheldon))
+
 **Closed issues:**
 
 - not running jobs [\#168](https://github.com/bensheldon/good_job/issues/168)
@@ -11,15 +39,13 @@
 
 **Merged pull requests:**
 
--  Ensure advisory lock CTE is MATERIALIZED on Postgres v12+ [\#179](https://github.com/bensheldon/good_job/pull/179) ([bensheldon](https://github.com/bensheldon))
-- Ensure that deleted jobs are unlocked [\#178](https://github.com/bensheldon/good_job/pull/178) ([bensheldon](https://github.com/bensheldon))
 - Add Appraisal for Rails 6.1-rc2 [\#175](https://github.com/bensheldon/good_job/pull/175) ([bensheldon](https://github.com/bensheldon))
 
 ## [v1.3.4](https://github.com/bensheldon/good_job/tree/v1.3.4) (2020-12-02)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v1.3.3...v1.3.4)
 
-**Merged pull requests:**
+**Fixed bugs:**
 
 - Fix job ordering for Rails 6.1 [\#174](https://github.com/bensheldon/good_job/pull/174) ([morgoth](https://github.com/morgoth))
 
@@ -27,7 +53,7 @@
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v1.3.2...v1.3.3)
 
-**Merged pull requests:**
+**Implemented enhancements:**
 
 - UI: Admin UI with filters and space efficient layout [\#173](https://github.com/bensheldon/good_job/pull/173) ([zealot128](https://github.com/zealot128))
 
@@ -428,6 +454,7 @@
 **Merged pull requests:**
 
 - Improve ActiveRecord usage for advisory locking [\#24](https://github.com/bensheldon/good_job/pull/24) ([bensheldon](https://github.com/bensheldon))
+- Remove support for Rails 5.1 [\#23](https://github.com/bensheldon/good_job/pull/23) ([bensheldon](https://github.com/bensheldon))
 
 ## [v0.3.0](https://github.com/bensheldon/good_job/tree/v0.3.0) (2020-03-22)
 
@@ -446,7 +473,6 @@
 
 **Merged pull requests:**
 
-- Remove support for Rails 5.1 [\#23](https://github.com/bensheldon/good_job/pull/23) ([bensheldon](https://github.com/bensheldon))
 - Gracefully shutdown Scheduler when executable receives TERM or INT [\#17](https://github.com/bensheldon/good_job/pull/17) ([bensheldon](https://github.com/bensheldon))
 - Update Appraisals [\#16](https://github.com/bensheldon/good_job/pull/16) ([bensheldon](https://github.com/bensheldon))
 

data/engine/app/controllers/good_job/dashboards_controller.rb

@@ -42,11 +42,11 @@ module GoodJob
         GoodJob::Job.group("serialized_params->>'job_class'").count
       end
 
-      def to_query(override)
+      def to_params(override)
         {
           state: params[:state],
           job_class: params[:job_class],
-        }.merge(override).delete_if { |_, v| v.nil? }.to_query
+        }.merge(override).delete_if { |_, v| v.nil? }
       end
     end
 

data/engine/app/views/good_job/dashboards/index.html.erb

@@ -8,18 +8,30 @@
       <small>Filter by job class</small>
       <br>
       <% @filter.job_classes.each do |name, count| %>
-        <a href='<%= request.path + "?#{@filter.to_query(job_class: name)}" %>' class='btn btn-sm btn-outline-secondary <%= "active" if params[:job_class] == name %>'>
-          <%= name %> (<%= count %>)
-        </a>
+        <% if params[:job_class] == name %>
+          <%= link_to(root_path(@filter.to_params(job_class: nil)), class: 'btn btn-sm btn-outline-secondary active', role: "button", "aria-pressed": true)  do %>
+            <%= name %> (<%= count %>)
+          <% end %>
+        <% else %>
+          <%= link_to(root_path(@filter.to_params(job_class: name)), class: 'btn btn-sm btn-outline-secondary', role: "button") do %>
+            <%= name %> (<%= count %>)
+          <% end %>
+        <% end %>
       <% end %>
     </div>
     <div>
       <small>Filter by state</small>
       <br>
       <% @filter.states.each do |name, count| %>
-        <a href='<%= request.path + "?#{@filter.to_query(state: name)}" %>' class='btn btn-sm btn-outline-secondary <%= "active" if params[:state] == name %>'>
-          <%= name %> (<%= count %>)
-        </a>
+        <% if params[:state] == name %>
+          <%= link_to(root_path(@filter.to_params(state: nil)), class: 'btn btn-sm btn-outline-secondary active', role: "button", "aria-pressed": true)  do %>
+            <%= name %> (<%= count %>)
+          <% end %>
+        <% else %>
+          <%= link_to(root_path(@filter.to_params(state: name)), class: 'btn btn-sm btn-outline-secondary', role: "button") do %>
+            <%= name %> (<%= count %>)
+          <% end %>
+        <% end %>
       <% end %>
     </div>
   </div>
@@ -28,7 +40,7 @@
 <% if @filter.jobs.present? %>
   <%= render 'shared/jobs_table', jobs: @filter.jobs %>
 
-  <nav aria-label="Job pagination">
+  <nav aria-label="Job pagination" class="mt-3">
     <ul class="pagination">
       <li class="page-item">
         <%= link_to({ after_scheduled_at: (@filter.last.scheduled_at || @filter.last.created_at), after_id: @filter.last.id }, class: "page-link") do %>

data/engine/app/views/layouts/good_job/base.html.erb

@@ -6,14 +6,14 @@
   <%= csp_meta_tag %>
 
   <style>
-    <%= render file: GoodJob::Engine.root.join("app", "assets", "vendor", "bootstrap", "bootstrap.css") %>
-    <%= render file: GoodJob::Engine.root.join("app", "assets", "vendor", "chartist", "chartist.css") %>
-    <%= render file: GoodJob::Engine.root.join("app", "assets", "style.css") %>
+    <%== render file: GoodJob::Engine.root.join("app", "assets", "vendor", "bootstrap", "bootstrap.css") %>
+    <%== render file: GoodJob::Engine.root.join("app", "assets", "vendor", "chartist", "chartist.css") %>
+    <%== render file: GoodJob::Engine.root.join("app", "assets", "style.css") %>
   </style>
 
   <script>
-    <%= render file: GoodJob::Engine.root.join("app", "assets", "vendor", "bootstrap", "bootstrap-native.js") %>
-    <%= render file: GoodJob::Engine.root.join("app", "assets", "vendor", "chartist", "chartist.js") %>
+    <%== render file: GoodJob::Engine.root.join("app", "assets", "vendor", "bootstrap", "bootstrap-native.js") %>
+    <%== render file: GoodJob::Engine.root.join("app", "assets", "vendor", "chartist", "chartist.js") %>
   </script>
 </head>
 <body>

data/engine/app/views/shared/_chart.erb

@@ -1,7 +1,7 @@
 <div id="chart"></div>
 
 <script>
-  new Chartist.Line('#chart', <%= raw chart_data.to_json %>, {
+  new Chartist.Line('#chart', <%== chart_data.to_json %>, {
     height: '300px',
     fullWidth: true,
     chartPadding: {

data/engine/app/views/shared/_jobs_table.erb

@@ -1,26 +1,28 @@
-<div class="table-responsive">
-  <table class="table table-bordered table-hover table-sm">
-    <thead>
-      <th>GoodJob ID</th>
-      <th>ActiveJob ID</th>
-      <th>Job Class</th>
-      <th>Queue</th>
-      <th>Scheduled At</th>
-      <th>Error</th>
-      <th>ActiveJob Params</th>
-    </thead>
-    <tbody>
-      <% jobs.each do |job| %>
-        <tr id="<%= dom_id(job) %>">
-          <td><%= link_to job.id, active_job_path(job.serialized_params['job_id'], anchor: dom_id(job)) %></td>
-          <td><%= link_to job.serialized_params['job_id'], active_job_path(job.serialized_params['job_id']) %></td>
-          <td><%= job.serialized_params['job_class'] %></td>
-          <td><%= job.queue_name %></td>
-          <td><%= job.scheduled_at || job.created_at %></td>
-          <td><%= job.error %></td>
-          <td><pre><%= JSON.pretty_generate(job.serialized_params) %></pre></td>
-        </tr>
-      <% end %>
-    </tbody>
-  </table>
+<div class="card my-3">
+  <div class="table-responsive">
+    <table class="table card-table table-bordered table-hover table-sm mb-0">
+      <thead>
+        <th>GoodJob ID</th>
+        <th>ActiveJob ID</th>
+        <th>Job Class</th>
+        <th>Queue</th>
+        <th>Scheduled At</th>
+        <th>Error</th>
+        <th>ActiveJob Params</th>
+      </thead>
+      <tbody>
+        <% jobs.each do |job| %>
+          <tr id="<%= dom_id(job) %>">
+            <td><%= link_to job.id, active_job_path(job.serialized_params['job_id'], anchor: dom_id(job)) %></td>
+            <td><%= link_to job.serialized_params['job_id'], active_job_path(job.serialized_params['job_id']) %></td>
+            <td><%= job.serialized_params['job_class'] %></td>
+            <td><%= job.queue_name %></td>
+            <td><%= job.scheduled_at || job.created_at %></td>
+            <td><%= job.error %></td>
+            <td><pre><%= JSON.pretty_generate(job.serialized_params) %></pre></td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
 </div>

data/lib/good_job/configuration.rb

@@ -58,9 +58,7 @@ module GoodJob
     def rails_execution_mode
       if execution_mode(default: nil)
         execution_mode
-      elsif Rails.env.development?
-        :inline
-      elsif Rails.env.test?
+      elsif Rails.env.development? || Rails.env.test?
         :inline
       else
         :external

data/lib/good_job/job.rb

@@ -139,7 +139,7 @@ module GoodJob
       unfinished.priority_ordered.only_scheduled.limit(1).with_advisory_lock do |good_jobs|
         good_job = good_jobs.first
         # TODO: Determine why some records are fetched without an advisory lock at all
-        break unless good_job&.owns_advisory_lock?
+        break unless good_job&.executable?
 
         result, error = good_job.perform
       end
@@ -216,6 +216,12 @@ module GoodJob
       [result, job_error]
     end
 
+    # Tests whether this job is safe to be executed by this thread.
+    # @return [Boolean]
+    def executable?
+      self.class.unscoped.unfinished.owns_advisory_locked.exists?(id: id)
+    end
+
     private
 
     def execute

data/lib/good_job/lockable.rb

@@ -141,9 +141,9 @@ module GoodJob
       end
 
       def supports_cte_materialization_specifiers?
-        return @supports_cte_materialization_specifiers if defined?(@supports_cte_materialization_specifiers)
+        return @_supports_cte_materialization_specifiers if defined?(@_supports_cte_materialization_specifiers)
 
-        @supports_cte_materialization_specifiers = ActiveRecord::Base.connection.postgresql_version >= 120000
+        @_supports_cte_materialization_specifiers = ActiveRecord::Base.connection.postgresql_version >= 120000
       end
     end
 
@@ -153,10 +153,11 @@ module GoodJob
     # all remaining locks).
     # @return [Boolean] whether the lock was acquired.
     def advisory_lock
-      where_sql = <<~SQL.squish
-        pg_try_advisory_lock(('x' || substr(md5(:table_name || :id::text), 1, 16))::bit(64)::bigint)
+      query = <<~SQL.squish
+        SELECT 1 AS one
+        WHERE pg_try_advisory_lock(('x'||substr(md5($1 || $2::text), 1, 16))::bit(64)::bigint)
       SQL
-      self.class.unscoped.exists?([where_sql, { table_name: self.class.table_name, id: send(self.class.primary_key) }])
+      self.class.connection.exec_query(query, 'GoodJob::Lockable Advisory Lock', [[nil, self.class.table_name], [nil, send(self.class.primary_key)]]).any?
     end
 
     # Releases an advisory lock on this record if it is locked by this database
@@ -166,9 +167,9 @@ module GoodJob
     def advisory_unlock
       query = <<~SQL.squish
         SELECT 1 AS one
-        WHERE pg_advisory_unlock(('x'||substr(md5(:table_name || :id::text), 1, 16))::bit(64)::bigint)
+        WHERE pg_advisory_unlock(('x'||substr(md5($1 || $2::text), 1, 16))::bit(64)::bigint)
       SQL
-      self.class.connection.execute(sanitize_sql_for_conditions([query, { table_name: self.class.table_name, id: send(self.class.primary_key) }])).ntuples.positive?
+      self.class.connection.exec_query(query, 'GoodJob::Lockable Advisory Unlock', [[nil, self.class.table_name], [nil, send(self.class.primary_key)]]).any?
     end
 
     # Acquires an advisory lock on this record or raises
@@ -205,13 +206,30 @@ module GoodJob
     # Tests whether this record has an advisory lock on it.
     # @return [Boolean]
     def advisory_locked?
-      self.class.unscoped.advisory_locked.exists?(id: send(self.class.primary_key))
+      query = <<~SQL.squish
+        SELECT 1 AS one
+        FROM pg_locks
+        WHERE pg_locks.locktype = 'advisory'
+          AND pg_locks.objsubid = 1
+          AND pg_locks.classid = ('x' || substr(md5($1 || $2::text), 1, 16))::bit(32)::int
+          AND pg_locks.objid = (('x' || substr(md5($1 || $2::text), 1, 16))::bit(64) << 32)::bit(32)::int
+      SQL
+      self.class.connection.exec_query(query, 'GoodJob::Lockable Advisory Locked?', [[nil, self.class.table_name], [nil, send(self.class.primary_key)]]).any?
     end
 
     # Tests whether this record is locked by the current database session.
     # @return [Boolean]
     def owns_advisory_lock?
-      self.class.unscoped.owns_advisory_locked.exists?(id: send(self.class.primary_key))
+      query = <<~SQL.squish
+        SELECT 1 AS one
+        FROM pg_locks
+        WHERE pg_locks.locktype = 'advisory'
+          AND pg_locks.objsubid = 1
+          AND pg_locks.classid = ('x' || substr(md5($1 || $2::text), 1, 16))::bit(32)::int
+          AND pg_locks.objid = (('x' || substr(md5($1 || $2::text), 1, 16))::bit(64) << 32)::bit(32)::int
+          AND pg_locks.pid = pg_backend_pid()
+      SQL
+      self.class.connection.exec_query(query, 'GoodJob::Lockable Owns Advisory Lock?', [[nil, self.class.table_name], [nil, send(self.class.primary_key)]]).any?
     end
 
     # Releases all advisory locks on the record that are held by the current

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

@@ -90,6 +90,18 @@ module GoodJob # :nodoc:
       !@pool.running?
     end
 
+    # Invoked on completion of ThreadPoolExecutor task
+    # @!visibility private
+    # @return [void]
+    def listen_observer(_time, _result, thread_error)
+      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 +112,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 +132,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 +144,12 @@ 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)}")
+      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/version.rb

@@ -1,4 +1,4 @@
 module GoodJob
   # GoodJob gem version.
-  VERSION = '1.3.5'.freeze
+  VERSION = '1.3.6'.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.3.6
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-17 00:00:00.000000000 Z
+date: 2020-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -441,7 +441,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: A multithreaded, Postgres-based ActiveJob backend for Ruby on Rails