sucker_punch 2.0.0.beta1 → 2.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa1e2aa3c637a849298159655805260a18ce9315
-  data.tar.gz: 2a138d958c61e7c1e014ff7e9d682e8c9a5f78e4
+  metadata.gz: 805f11babbfd83d6221c804f50749d0f37acef55
+  data.tar.gz: a440db16a4fb7062aea253a4aa090211f3a5aed2
 SHA512:
-  metadata.gz: 03d99e04ebd2fc6aaa07e91242673411727a5cbc50d350d3b83a9a2b28fb81ec90bc26eb7c4d83b3f840da0881928b784b3c07e077205ad1d41333d627dac5ed
-  data.tar.gz: 588214f4b4d233352bf06ae84ad6b2948e575e2b089c7b7fe9b39d9dceecccc4b9f189fd24a6945119b4ffb2cdbd2962529ba43779b213aef65b297f60790fca
+  metadata.gz: 2649c57a07871e7fb765e43b1923d626b62ae73ea143016053dd5a5d213da49d02c6da529d475ec108ff94233fb6694d522e71c68d99004c6bc934dfe4610166
+  data.tar.gz: b313fa9e6681e2f0839fab9da0f1bbb1b7bf1b51bb9897df49157235881656de697471349652f93ce71584578b66b242566d4372b31d41637a7ba9ac680f5a4b

data/.travis.yml

@@ -2,23 +2,11 @@ language: ruby
 rvm:
   - rbx-2
   - 2.0.0
-  - 2.1.0
-  - 2.2.0
+  - 2.1.8
+  - 2.2.4
   - 2.3.0
   - ruby-head
-  - jruby-9.0.1.0
-  - jruby-9.0.3.0
-  - jruby-9.0.4.0
-  - jruby-head
-
-jdk:
-  - oraclejdk8
 
 matrix:
   allow_failures:
     - rvm: rbx-2
-    - rvm: jruby-head
-
-before_script:
-  - "echo $JAVA_OPTS"
-  - "export JAVA_OPTS=-Xmx1024m"

data/CHANGES.md

@@ -1,3 +1,9 @@
+2.0.0.beta2
+-------
+
+- Made concurrent tests more reliable
+- Quieted overly verbose shutdown logs
+
 2.0.0.beta1
 -------
 

data/README.md

@@ -41,6 +41,33 @@ Or install it yourself as:
 
     $ gem install sucker_punch
 
+## Backwards Compatibility
+
+In version `~> 2.0.0`, the syntax to enqueue an asynchronous background job has changed from:
+
+```ruby
+LogJob.new.async.perform(...)
+```
+
+to:
+
+
+```ruby
+LogJob.perform_async(...)
+```
+
+If you're upgrading from a pre-`2.0.0` release and want to retain the old
+syntax `LogJob.new.async.perform(...)`, you can include
+`sucker_punch/async_syntax` in your application.
+
+For Rails, you could add an initializer:
+
+```ruby
+# config/initializers/sucker_punch.rb
+
+require 'sucker_punch/async_syntax'
+```
+
 ## Usage
 
 Each job acts as its own queue and should be a separate Ruby class that:
@@ -252,6 +279,16 @@ end
 
 ```
 
+If you want to use Sucker Punch version `2.0.0+` with Rails `< 5.0.0`, be sure
+to include the backwards compatibility module in an initializer:
+
+
+```ruby
+# config/initializers/sucker_punch.rb
+
+require 'sucker_punch/async_syntax'
+```
+
 ## Troubleshooting
 
 ### Initializers for forking servers (Unicorn, Passenger, etc.)

data/lib/sucker_punch.rb

@@ -52,7 +52,6 @@ end
 
 at_exit do
   SuckerPunch::Queue.shutdown_all
-  SuckerPunch.logger.info("All is quiet...byebye")
 end
 
 require 'sucker_punch/railtie' if defined?(::Rails)

data/lib/sucker_punch/queue.rb

@@ -68,7 +68,6 @@ module SuckerPunch
 
     def self.shutdown_all
       if SuckerPunch::RUNNING.make_false
-        SuckerPunch.logger.info("Shutdown triggered...executing remaining in-process jobs")
 
         queues = all
         latch = Concurrent::CountDownLatch.new(queues.length)
@@ -78,11 +77,9 @@ module SuckerPunch
           queue.shutdown
         end
 
-        if latch.wait(SuckerPunch.shutdown_timeout)
-          SuckerPunch.logger.info("Remaining jobs have finished")
-        else
+        unless latch.wait(SuckerPunch.shutdown_timeout)
           queues.each { |queue| queue.kill }
-          SuckerPunch.logger.info("Remaining jobs didn't finish in time...killing remaining jobs")
+          SuckerPunch.logger.info("Queued jobs didn't finish before shutdown_timeout...killing remaining jobs")
         end
       end
     end
@@ -93,7 +90,8 @@ module SuckerPunch
       :max_length,
       :min_length,
       :length,
-      :queue_length#,
+      :queue_length,
+      :wait_for_termination#,
       #:idletime,
       #:max_queue,
       #:largest_length,

data/lib/sucker_punch/version.rb

@@ -1,3 +1,3 @@
 module SuckerPunch
-  VERSION = "2.0.0.beta1"
+  VERSION = "2.0.0.beta2"
 end

data/sucker_punch.gemspec

@@ -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 Version 2.0 introduces backwards-incompatible changes. Please 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#20 for details."
 
   gem.add_development_dependency "rake", "~> 10.0"
   gem.add_development_dependency "minitest"

data/test/sucker_punch/job_test.rb

@@ -15,7 +15,7 @@ module SuckerPunch
       arr = Concurrent::Array.new
       latch = Concurrent::CountDownLatch.new
       FakeLatchJob.perform_async(arr, latch)
-      latch.wait(0.2)
+      latch.wait(1)
       assert_equal 1, arr.size
     end
 
@@ -24,7 +24,7 @@ module SuckerPunch
       arr = Concurrent::Array.new
       latch = Concurrent::CountDownLatch.new
       FakeLatchJob.perform_async(arr, latch)
-      latch.wait(0.2)
+      latch.wait(1)
       assert_equal 0, arr.size
     end
 
@@ -32,7 +32,7 @@ module SuckerPunch
       arr = Concurrent::Array.new
       latch = Concurrent::CountDownLatch.new
       FakeLatchJob.perform_in(0.1, arr, latch)
-      latch.wait(0.2)
+      latch.wait(1)
       assert_equal 1, arr.size
     end
 
@@ -41,7 +41,7 @@ module SuckerPunch
       arr = Concurrent::Array.new
       latch = Concurrent::CountDownLatch.new
       FakeLatchJob.perform_in(0.1, arr, latch)
-      latch.wait(0.2)
+      latch.wait(1)
       assert_equal 0, arr.size
     end
 
@@ -84,34 +84,47 @@ module SuckerPunch
     end
 
     def test_busy_workers_is_incremented_during_job_execution
-      FakeSlowJob.perform_async
-      sleep 0.1
-      assert SuckerPunch::Counter::Busy.new(FakeSlowJob.to_s).value > 0
+      job_class = Class.new(FakeBusyJob)
+      latch1 = Concurrent::CountDownLatch.new
+      latch2 = Concurrent::CountDownLatch.new
+      job_class.perform_async(latch1, latch2)
+      latch1.wait(1)
+      actual = SuckerPunch::Counter::Busy.new(job_class.to_s).value
+      latch2.count_down
+      assert actual > 0
     end
 
     def test_processed_jobs_is_incremented_on_successful_completion
-      latch = Concurrent::CountDownLatch.new
-      2.times{ FakeLogJob.perform_async }
-      queue = SuckerPunch::Queue.find_or_create(FakeLogJob.to_s)
-      queue.post { latch.count_down }
-      latch.wait(0.2)
-      assert SuckerPunch::Counter::Processed.new(FakeLogJob.to_s).value > 0
+      job_class = Class.new(FakeLatchJob)
+      jobs = 3
+      latch = Concurrent::CountDownLatch.new(jobs)
+      jobs.times{ job_class.perform_async([], latch) }
+      latch.wait(1)
+      queue = SuckerPunch::Queue.find_or_create(job_class.to_s)
+      queue.shutdown
+      queue.wait_for_termination(1)
+      assert SuckerPunch::Counter::Processed.new(job_class.to_s).value == jobs
     end
 
     def test_processed_jobs_is_incremented_when_enqueued_with_perform_in
+      job_class = Class.new(FakeLatchJob)
       latch = Concurrent::CountDownLatch.new
-      FakeLatchJob.perform_in(0.1, [], latch)
-      latch.wait(0.2)
-      assert SuckerPunch::Counter::Processed.new(FakeLatchJob.to_s).value > 0
+      job_class.perform_in(0.0, [], latch)
+      latch.wait(1)
+      queue = SuckerPunch::Queue.find_or_create(job_class.to_s)
+      queue.shutdown
+      queue.wait_for_termination(1)
+      assert SuckerPunch::Counter::Processed.new(job_class.to_s).value == 1
     end
 
     def test_failed_jobs_is_incremented_when_job_raises
-      latch = Concurrent::CountDownLatch.new
-      2.times{ FakeErrorJob.perform_async }
-      queue = SuckerPunch::Queue.find_or_create(FakeErrorJob.to_s)
-      queue.post { latch.count_down }
-      latch.wait(0.2)
-      assert SuckerPunch::Counter::Failed.new(FakeErrorJob.to_s).value > 0
+      job_class = Class.new(FakeErrorJob)
+      jobs = 3
+      jobs.times{ job_class.perform_async }
+      queue = SuckerPunch::Queue.find_or_create(job_class.to_s)
+      queue.shutdown
+      queue.wait_for_termination(1)
+      assert SuckerPunch::Counter::Failed.new(job_class.to_s).value == jobs
     end
 
     private
@@ -124,6 +137,16 @@ module SuckerPunch
       end
     end
 
+    class FakeBusyJob
+      include SuckerPunch::Job
+      def perform(latch1, latch2)
+        # trigger the first latch to tell the test we're working
+        latch1.count_down
+        # wait for the test to tell us we can finish
+        latch2.wait(1)
+      end
+    end
+
     class FakeSlowJob
       include SuckerPunch::Job
       def perform

data/test/sucker_punch/queue_test.rb

@@ -30,7 +30,6 @@ module SuckerPunch
     end
 
     def test_same_queue_is_returned_on_subsequent_queries
-      SuckerPunch::Queue::QUEUES.clear
       queue = SuckerPunch::Queue.find_or_create(@queue)
       assert_equal queue, SuckerPunch::Queue.find_or_create(@queue)
     end
@@ -58,17 +57,13 @@ module SuckerPunch
     end
 
     def test_returns_queue_stats
-      latch = Concurrent::CountDownLatch.new
-
-      # run a job to setup workers
-      2.times { FakeNilJob.perform_async }
+      latch = Concurrent::CountDownLatch.new(2)
 
-      queue = SuckerPunch::Queue.find_or_create(FakeNilJob.to_s)
-      queue.post { latch.count_down }
-      latch.wait(0.1)
+      2.times{ FakeLatchJob.perform_async(latch) }
+      latch.wait(2)
 
       all_stats = SuckerPunch::Queue.stats
-      stats = all_stats[FakeNilJob.to_s]
+      stats = all_stats[FakeLatchJob.to_s]
       assert stats["workers"]["total"] > 0
       assert stats["workers"]["busy"] == 0
       assert stats["workers"]["idle"] > 0
@@ -87,13 +82,72 @@ 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
+    end
+
+    def test_jobs_arent_posted_if_queue_isnt_running
+      arr = []
+      fake_pool = FakePool.new
+      queue = SuckerPunch::Queue.new "fake", fake_pool
+      queue.kill
+      queue.post(1, 2) { |args| arr.push args }
+      assert arr.empty?
+    end
+
+    def test_kill_sends_kill_to_pool
+      fake_pool = FakePool.new
+      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.shutdown
+      assert_equal :shutdown, fake_pool.signals.first
+    end
+
     private
 
+    class FakeLatchJob
+      include SuckerPunch::Job
+      def perform(latch)
+        latch.count_down
+      end
+    end
+
     class FakeNilJob
       include SuckerPunch::Job
       def perform
         nil
       end
     end
+
+    class FakePool
+      attr_accessor :signals
+      def initialize
+        @signals = []
+      end
+
+      def post(*args, &block)
+        if block_given?
+          block.call(args)
+        end
+      end
+
+      def kill
+        self.signals.push :kill
+      end
+
+      def shutdown
+        self.signals.push :shutdown
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sucker_punch
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta1
+  version: 2.0.0.beta2
 platform: ruby
 authors:
 - Brandon Hilkert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-15 00:00:00.000000000 Z
+date: 2016-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -106,9 +106,9 @@ homepage: https://github.com/brandonhilkert/sucker_punch
 licenses:
 - MIT
 metadata: {}
-post_install_message: Sucker Punch Version 2.0 introduces backwards-incompatible changes.
-  Please see https://github.com/brandonhilkert/sucker_punch/blob/master/CHANGES.md#20
-  for details.
+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.
 rdoc_options: []
 require_paths:
 - lib