good_job 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fb26ee806945cc3f179365b97150d570d9054c7907a94044f28a2afdd46d389
-  data.tar.gz: ab7d3247d78ad394e729c4b4787157ea3b60b0eeb01d0a31a2c93694a3320a62
+  metadata.gz: 5a3b5327b3b95b67901f3be13858f0bbf9cf1d0818793ed653f084a77b8e6ff9
+  data.tar.gz: 056fd886d26d7ee60fd63d7f45714c7b843f7f4e6661b58a00dc4c6ec17d9b9c
 SHA512:
-  metadata.gz: 8065515ccdf0533d6069688a2afba7ffdb71a2ba9ad45660fda62b3c6c8347eff8e7d6a0a735bfcd974176a1e1e2e1168efd5dc74aa6fbe155326cb33f7700c3
-  data.tar.gz: 6e8877daa20867a5748b62a3e40130ee8a270c9c2db3ba1a8a460c76d33b9a48e6d8f127e779fe0808d245cc75276d36492adf7e70850640e729adbe2863e715
+  metadata.gz: 12221043ad332a684e062aae176d529bbd39da7998e9ae6d355bdb1f68f2f7ace21c4f4196ebe0306841a761161e564125f35c7522f30f3b2f718830bd15c788
+  data.tar.gz: 7d389ac1aafb614b813fdb1eb75ce7dceba40238111966d8031578ac88553d989cee08dcef03d72fd8e53ce3215692779e2e03c538ea90cb3a477361ef2442d8

data/CHANGELOG.md

@@ -1,14 +1,30 @@
 # Changelog
 
-## [0.3.0](https://github.com/bensheldon/good_job/tree/0.3.0) (2020-03-22)
+## [0.4.0](https://github.com/bensheldon/good_job/tree/0.4.0) (2020-03-30)
 
-[Full Changelog](https://github.com/bensheldon/good_job/compare/v0.2.1...0.3.0)
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v0.3.0...0.4.0)
+
+**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)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v0.2.2...v0.3.0)
 
 **Merged pull requests:**
 
 - Update development Ruby to 2.6.5 [\#22](https://github.com/bensheldon/good_job/pull/22) ([bensheldon](https://github.com/bensheldon))
 - Simplify the internal API, removing JobWrapper and InlineScheduler [\#21](https://github.com/bensheldon/good_job/pull/21) ([bensheldon](https://github.com/bensheldon))
 - Generate a new future for every executed job [\#20](https://github.com/bensheldon/good_job/pull/20) ([bensheldon](https://github.com/bensheldon))
+
+## [v0.2.2](https://github.com/bensheldon/good_job/tree/v0.2.2) (2020-03-08)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v0.2.1...v0.2.2)
+
+**Merged pull requests:**
+
 - Configuration for maximum number of job execution threads [\#18](https://github.com/bensheldon/good_job/pull/18) ([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/README.md

@@ -114,17 +114,10 @@ Package maintainers can release this gem with the following [gem-release](https:
 # Sign into rubygems
 $ gem signin
 
-# Increase the version number
-$ gem bump -v minor --no-commit
-
-# Update the changelog
-$ bundle exec rake changelog
-
-# Commit the version and changelog to git
+# Update version number, changelog, and create git commit:
 $ bundle exec rake commit_version
 
-# Push to rubygems.org
-$ gem release
+# ..and follow subsequent directions. 
 ```
 
 ## Contributing

data/lib/good_job/lockable.rb

@@ -5,36 +5,66 @@ module GoodJob
     RecordAlreadyAdvisoryLockedError = Class.new(StandardError)
 
     included do
+      scope :advisory_lock, (lambda do
+        original_query = self
+
+        cte_table = Arel::Table.new(:rows)
+        composed_cte = Arel::Nodes::As.new(cte_table, original_query.select(primary_key).except(:limit).arel)
+
+        query = cte_table.project(cte_table[:id])
+                  .with(composed_cte)
+                  .where(Arel.sql(sanitize_sql_for_conditions(["pg_try_advisory_lock(('x'||substr(md5(:table_name || \"#{cte_table.name}\".\"#{primary_key}\"::text), 1, 16))::bit(64)::bigint)", { table_name: table_name }])))
+
+        limit = original_query.arel.ast.limit
+        query.limit = limit.value if limit.present?
+
+        unscoped.where(arel_table[:id].in(query)).merge(original_query.only(:order))
+      end)
+
       scope :joins_advisory_locks, (lambda do
-        joins(<<~SQL)
+        join_sql = <<~SQL
           LEFT JOIN pg_locks ON pg_locks.locktype = 'advisory'
             AND pg_locks.objsubid = 1
-            AND pg_locks.classid = ('x'||substr(md5(good_jobs.id::text), 1, 16))::bit(32)::int
-            AND pg_locks.objid = (('x'||substr(md5(good_jobs.id::text), 1, 16))::bit(64) << 32)::bit(32)::int
+            AND pg_locks.classid = ('x'||substr(md5(:table_name || "#{table_name}"."#{primary_key}"::text), 1, 16))::bit(32)::int
+            AND pg_locks.objid = (('x'||substr(md5(:table_name || "#{table_name}"."#{primary_key}"::text), 1, 16))::bit(64) << 32)::bit(32)::int
         SQL
+
+        joins(sanitize_sql_for_conditions([join_sql, { table_name: table_name }]))
       end)
 
       scope :advisory_unlocked, -> { joins_advisory_locks.where(pg_locks: { locktype: nil }) }
+      scope :advisory_locked, -> { joins_advisory_locks.where.not(pg_locks: { locktype: nil }) }
+      scope :owns_advisory_locked, -> { joins_advisory_locks.where('"pg_locks"."pid" = pg_backend_pid()') }
 
       attr_accessor :create_with_advisory_lock
-
       after_create -> { advisory_lock }, if: :create_with_advisory_lock
     end
 
     class_methods do
-      def first_advisory_locked_row(query)
-        find_by_sql(<<~SQL).first
-          WITH rows AS (#{query.to_sql})
-          SELECT rows.*
-          FROM rows
-          WHERE pg_try_advisory_lock(('x'||substr(md5(id::text), 1, 16))::bit(64)::bigint)
-          LIMIT 1
-        SQL
+      def with_advisory_lock(&block)
+        records = advisory_lock.to_a
+        begin
+          block.call(records)
+        ensure
+          records.each(&:advisory_unlock)
+        end
       end
     end
 
     def advisory_lock
-      self.class.connection.execute(sanitize_sql_for_conditions(["SELECT 1 as one WHERE pg_try_advisory_lock(('x'||substr(md5(?), 1, 16))::bit(64)::bigint)", id])).ntuples.positive?
+      query = <<~SQL
+        SELECT 1 AS one
+        WHERE pg_try_advisory_lock(('x'||substr(md5(:table_name || :id::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?
+    end
+
+    def advisory_unlock
+      query = <<~SQL
+        SELECT 1 AS one
+        WHERE pg_advisory_unlock(('x'||substr(md5(:table_name || :id::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?
     end
 
     def advisory_lock!
@@ -45,38 +75,16 @@ module GoodJob
     def with_advisory_lock
       advisory_lock!
       yield
-    rescue StandardError => e
-      advisory_unlock unless e.is_a? RecordAlreadyAdvisoryLockedError
-      raise
+    ensure
+      advisory_unlock unless $ERROR_INFO.is_a? RecordAlreadyAdvisoryLockedError
     end
 
     def advisory_locked?
-      self.class.connection.execute(<<~SQL).ntuples.positive?
-        SELECT 1 as one
-        FROM pg_locks
-        WHERE
-          locktype = 'advisory'
-          AND objsubid = 1
-          AND classid = ('x'||substr(md5('#{id}'), 1, 16))::bit(32)::int
-          AND objid = (('x'||substr(md5('#{id}'), 1, 16))::bit(64) << 32)::bit(32)::int
-      SQL
+      self.class.advisory_locked.where(id: send(self.class.primary_key)).any?
     end
 
     def owns_advisory_lock?
-      self.class.connection.execute(<<~SQL).ntuples.positive?
-        SELECT 1 as one
-        FROM pg_locks
-        WHERE
-          locktype = 'advisory'
-          AND objsubid = 1
-          AND classid = ('x'||substr(md5('#{id}'), 1, 16))::bit(32)::int
-          AND objid = (('x'||substr(md5('#{id}'), 1, 16))::bit(64) << 32)::bit(32)::int
-          AND pid = pg_backend_pid()
-      SQL
-    end
-
-    def advisory_unlock
-      self.class.connection.execute("SELECT pg_advisory_unlock(('x'||substr(md5('#{id}'), 1, 16))::bit(64)::bigint)").first["pg_advisory_unlock"]
+      self.class.owns_advisory_locked.where(id: send(self.class.primary_key)).any?
     end
 
     def advisory_unlock!

data/lib/good_job/scheduler.rb

@@ -62,18 +62,18 @@ module GoodJob
 
     def create_thread
       future = Concurrent::Future.new(args: [ordered_query], executor: @pool) do |query|
-        executed_job = false
+        good_job = nil
 
         Rails.application.executor.wrap do
-          good_job = GoodJob::Job.first_advisory_locked_row(query)
-          break unless good_job
+          query.limit(1).with_advisory_lock do |good_jobs|
+            good_job = good_jobs.first
+            break unless good_job
 
-          executed_job = true
-          good_job.perform
-          good_job.advisory_unlock
+            good_job.perform
+          end
         end
 
-        executed_job
+        good_job
       end
       future.add_observer(self, :task_observer)
       future.execute
@@ -83,9 +83,9 @@ module GoodJob
       ActiveSupport::Notifications.instrument("finished_timer_task.good_job", { result: executed_task, error: error, time: time })
     end
 
-    def task_observer(time, executed_task, error)
-      ActiveSupport::Notifications.instrument("finished_job_task.good_job", { result: executed_task, error: error, time: time })
-      create_thread if executed_task
+    def task_observer(time, performed_job, error)
+      ActiveSupport::Notifications.instrument("finished_job_task.good_job", { good_job: performed_job, error: error, time: time })
+      create_thread if performed_job
     end
   end
 end

data/lib/good_job/version.rb

@@ -1,3 +1,3 @@
 module GoodJob
-  VERSION = '0.3.0'.freeze
+  VERSION = '0.4.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-22 00:00:00.000000000 Z
+date: 2020-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: foreman
+  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: gem-release
   requirement: !ruby/object:Gem::Requirement