sucker_punch 2.0.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed0c4d4c1a73adb49bc0978312f0f82b58cf375f
-  data.tar.gz: 8ba1cc2b966c1862ea88d84372f65fe78a5b97d4
+  metadata.gz: f9888e735e4566c4c0d789d328c78553caa09e35
+  data.tar.gz: 5e70f216542d0bc65fb5fbb1757dfce2ce529100
 SHA512:
-  metadata.gz: 6ae1cbb00a767473ac432b7a16fea5af8d507f2cd5ae3a15ada78a2ee18469fd48279acf82133c85a536958d1218af3c9a276e062a06140520385e8d69deda14
-  data.tar.gz: d854f9292c2d629f711736c04a0fd33e9220991f4f07901548c663d60eb757687a2fc3ef013cf4b7ee3e73240ff90522aea787ec6305c0ccbfb4c28518f7122d
+  metadata.gz: 295aceab156ca6df316d095be72b2052591a0a4895893ce75e4751db160b8eb675dac3385757c94f0776b90587c292bcf4a1b666df6a3c387d471a4569e1c520
+  data.tar.gz: 49db7fbff4f68c9015566162ba26794365d535a5dfc0a9957dc107e4006ec7baae125ad52c1b0ff29c813f080aaf1919c0b2b0bec4e8ac6498adda43fa254d18

data/.travis.yml

@@ -4,7 +4,8 @@ rvm:
   - 2.0.0
   - 2.1.8
   - 2.2.4
-  - 2.3.0
+  - 2.3.4
+  - 2.4.1
   - ruby-head
 
 matrix:

data/CHANGES.md

@@ -1,3 +1,8 @@
+2.0.3
+-------
+- Rewrite shutdown strategy to fix bug related to premature shutdown when only
+    1 job is in enqueued when a job has more than 1 worker
+
 2.0.2
 -------
 - Don't consider global shutdown bool when exhausting the queue during

data/README.md

@@ -14,8 +14,7 @@ crunching, or social platform manipulation. No reason to hold up a
 user when you can do these things in the background within the same
 process as your web application...
 
-Sucker Punch is built on top of [concurrent-ruby]
-(https://github.com/ruby-concurrency/concurrent-ruby). Each job is setup as
+Sucker Punch is built on top of [concurrent-ruby](https://github.com/ruby-concurrency/concurrent-ruby). Each job is setup as
 a pool, which equates to its own queue with individual workers working against
 the jobs. Unlike most other background processing libraries, Sucker
 Punch's jobs are stored in memory. The benefit to this is there is no
@@ -270,11 +269,11 @@ gem 'sucker_punch'
 And then configure the backend to use Sucker Punch:
 
 ```Ruby
-# config/initializers/sucker_punch.rb
-Rails.application.configure do
+# config/application.rb
+class Application < Rails::Application
+  # ...
   config.active_job.queue_adapter = :sucker_punch
 end
-
 ```
 
 If you want to use Sucker Punch version `2.0.0+` with Rails `< 5.0.0`, be sure

data/lib/generators/sucker_punch/templates/job.rb

@@ -1,6 +1,6 @@
-class <%= class_name %>Job 
+class <%= class_name %>Job
   include SuckerPunch::Job
-  
+
   def perform
     raise NotImplementedError
   end

data/lib/sucker_punch/queue.rb

@@ -66,21 +66,43 @@ module SuckerPunch
       queues
     end
 
+    PAUSE_TIME = STDOUT.tty? ? 0.1 : 0.5
+
     def self.shutdown_all
+      deadline = Time.now + SuckerPunch.shutdown_timeout
+
       if SuckerPunch::RUNNING.make_false
+        # If a job is enqueued right before the script exits
+        # (command line, rake task, etc.), the system needs an
+        # interval to allow the enqueue jobs to make it in to the system
+        # otherwise the queue will look idle
+        sleep PAUSE_TIME
 
         queues = all
-        latch = Concurrent::CountDownLatch.new(queues.length)
 
-        queues.each do |queue|
-          queue.post(latch) { |l| l.count_down }
-          queue.shutdown
-        end
+        # Issue shutdown to each queue and let them wrap up their work. This
+        # prevents new jobs from being enqueued and lets the pool clean up
+        # after itself
+        queues.each { |queue| queue.shutdown }
+
+        # return if every queue is empty and workers in every queue are idle
+        return if queues.all? { |queue| queue.idle? }
+
+        SuckerPunch.logger.info("Pausing to allow workers to finish...")
 
-        unless latch.wait(SuckerPunch.shutdown_timeout)
-          queues.each { |queue| queue.kill }
-          SuckerPunch.logger.info("Queued jobs didn't finish before shutdown_timeout...killing remaining jobs")
+        remaining = deadline - Time.now
+
+        # Continue to loop through each queue and test if it's idle, while
+        # respecting the shutdown timeout
+        while remaining > PAUSE_TIME
+          return if queues.all? { |queue| queue.idle? }
+          sleep PAUSE_TIME
+          remaining = deadline - Time.now
         end
+
+        # Queues haven't finished work. Aggressively kill them.
+        SuckerPunch.logger.warn("Queued jobs didn't finish before shutdown_timeout...killing remaining jobs")
+        queues.each { |queue| queue.kill }
       end
     end
 
@@ -115,6 +137,10 @@ module SuckerPunch
       synchronize { @running }
     end
 
+    def idle?
+      enqueued_jobs == 0 && busy_workers == 0
+    end
+
     def ==(other)
       pool == other.pool
     end
@@ -146,15 +172,12 @@ module SuckerPunch
     end
 
     def kill
-      if can_initiate_shutdown?
-        @pool.kill
-      end
+      @pool.kill
     end
 
     def shutdown
-      if can_initiate_shutdown?
-        @pool.shutdown
-      end
+      synchronize { @running = false }
+      @pool.shutdown
     end
 
     protected
@@ -162,19 +185,6 @@ module SuckerPunch
     def pool
       @pool
     end
-
-    private
-
-    def can_initiate_shutdown?
-      synchronize do
-        if @running
-          @running = false
-          true
-        else
-          false
-        end
-      end
-    end
   end
 end
 

data/lib/sucker_punch/version.rb

@@ -1,3 +1,3 @@
 module SuckerPunch
-  VERSION = "2.0.2"
+  VERSION = "2.0.3"
 end

data/sucker_punch.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |gem|
   gem.authors       = ["Brandon Hilkert"]
   gem.email         = ["brandonhilkert@gmail.com"]
   gem.description   = %q{Asynchronous processing library for Ruby}
-  gem.summary       = %q{Sucker Punch is a Ruby asynchronous processing using Celluloid, heavily influenced by Sidekiq and girl_friday.}
+  gem.summary       = %q{Sucker Punch is a Ruby asynchronous processing using concurrent-ruby, heavily influenced by Sidekiq and girl_friday.}
   gem.homepage      = "https://github.com/brandonhilkert/sucker_punch"
   gem.license       = "MIT"
 
@@ -18,7 +18,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.post_install_message = "Sucker Punch v2.0 introduces backwards-incompatible changes.\nPlease see https://github.com/brandonhilkert/sucker_punch/blob/master/CHANGES.md#20 for details."
+  gem.post_install_message = "Sucker Punch v2.0 introduces backwards-incompatible changes.\nPlease see https://github.com/brandonhilkert/sucker_punch/blob/master/CHANGES.md#200 for details."
 
   gem.add_development_dependency "rake", "~> 10.0"
   gem.add_development_dependency "minitest"

data/test/sucker_punch/queue_test.rb

@@ -82,33 +82,29 @@ module SuckerPunch
       assert_equal true, queue.running?
     end
 
-    def test_jobs_can_be_posted_to_pool
-      arr = []
-      fake_pool = FakePool.new
-      queue = SuckerPunch::Queue.new "fake", fake_pool
-      queue.post(1, 2) { |args| arr.push args }
-      assert_equal [1, 2], arr.first
+    def test_idle_considers_queue_workers_and_length
+      queue = SuckerPunch::Queue.find_or_create(FakeNilJob.to_s)
+      assert_equal true, queue.idle?
     end
 
-    def test_jobs_arent_posted_if_queue_isnt_running
+    def test_jobs_can_be_posted_to_pool
       arr = []
       fake_pool = FakePool.new
-      queue = SuckerPunch::Queue.new "fake", fake_pool
-      queue.kill
+      queue     = SuckerPunch::Queue.new "fake", fake_pool
       queue.post(1, 2) { |args| arr.push args }
-      assert arr.empty?
+      assert_equal [1, 2], arr.first
     end
 
     def test_kill_sends_kill_to_pool
       fake_pool = FakePool.new
-      queue = SuckerPunch::Queue.new "fake", fake_pool
+      queue     = SuckerPunch::Queue.new "fake", fake_pool
       queue.kill
       assert_equal :kill, fake_pool.signals.first
     end
 
     def test_shutdown_sends_shutdown_to_pool
       fake_pool = FakePool.new
-      queue = SuckerPunch::Queue.new "fake", fake_pool
+      queue     = SuckerPunch::Queue.new "fake", fake_pool
       queue.shutdown
       assert_equal :shutdown, fake_pool.signals.first
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sucker_punch
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
 platform: ruby
 authors:
 - Brandon Hilkert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-25 00:00:00.000000000 Z
+date: 2017-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -104,7 +104,7 @@ licenses:
 metadata: {}
 post_install_message: |-
   Sucker Punch v2.0 introduces backwards-incompatible changes.
-  Please see https://github.com/brandonhilkert/sucker_punch/blob/master/CHANGES.md#20 for details.
+  Please see https://github.com/brandonhilkert/sucker_punch/blob/master/CHANGES.md#200 for details.
 rdoc_options: []
 require_paths:
 - lib
@@ -120,11 +120,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: Sucker Punch is a Ruby asynchronous processing using Celluloid, heavily influenced
-  by Sidekiq and girl_friday.
+summary: Sucker Punch is a Ruby asynchronous processing using concurrent-ruby, heavily
+  influenced by Sidekiq and girl_friday.
 test_files:
 - test/sucker_punch/async_syntax_test.rb
 - test/sucker_punch/counter_test.rb