exceptional_synchrony 1.0.1 → 1.3.0

data/test/unit/limited_work_queue_test.rb

@@ -4,13 +4,13 @@ describe ExceptionalSynchrony::LimitedWorkQueue do
   end
 
   it "should raise an exception if created with a limit < 1" do
-    assert_raises(ArgumentError) do
+    expect(assert_raises(ArgumentError) do
       ExceptionalSynchrony::LimitedWorkQueue.new(@em, 0)
-    end.message.must_match /must be positive/
+    end.message).must_match(/must be positive/)
 
-    assert_raises(ArgumentError) do
+    expect(assert_raises(ArgumentError) do
       ExceptionalSynchrony::LimitedWorkQueue.new(@em, -2)
-    end.message.must_match /must be positive/
+    end.message).must_match(/must be positive/)
   end
 
   describe "when created" do
@@ -21,9 +21,9 @@ describe ExceptionalSynchrony::LimitedWorkQueue do
     it "should run non-blocking jobs immediately" do
       c = 0
       ExceptionalSynchrony::EMP.run_and_stop do
-        @queue.add { c+=1 }
-        @queue.add { c+=1 }
-        @queue.add { c+=1 }
+        @queue.add! { c+=1 }
+        @queue.add! { c+=1 }
+        @queue.add! { c+=1 }
       end
       assert_equal 3, c
     end
@@ -46,9 +46,9 @@ describe ExceptionalSynchrony::LimitedWorkQueue do
     it "should allow objects to be queued instead of Procs" do
       c = 0
       ExceptionalSynchrony::EMP.run_and_stop do
-        @queue.add(LWQTestProc.new { c+=1 })
-        @queue.add(LWQTestProc.new { c+=1 })
-        @queue.add(LWQTestProc.new { c+=1 })
+        @queue.add!(LWQTestProc.new { c+=1 })
+        @queue.add!(LWQTestProc.new { c+=1 })
+        @queue.add!(LWQTestProc.new { c+=1 })
       end
       assert_equal 3, c
     end
@@ -71,17 +71,17 @@ describe ExceptionalSynchrony::LimitedWorkQueue do
       end
 
       ExceptionalSynchrony::EMP.run_and_stop do
-        @queue.add(job_proc)
+        @queue.add!(job_proc)
       end
     end
 
     it "should allow objects to merge themselves into the queue (canceling itself)" do
       c = 0
       ExceptionalSynchrony::EMP.run_and_stop do
-        @queue.add(LWQTestProc.new { @em.sleep(0.001); c+=1 })
-        @queue.add(LWQTestProc.new { @em.sleep(0.001); c+=2 })
-        @queue.add(LWQTestProcWithMergeDrop.new(-> { c+=4 }) { @em.sleep(0.001); c+=8 })
-        @queue.add(LWQTestProcWithMergeDrop.new(-> { c+=16 }) { @em.sleep(0.001); c+=32 }) # will get merged (by canceling self)
+        @queue.add!(LWQTestProc.new { @em.sleep(0.001); c+=1 })
+        @queue.add!(LWQTestProc.new { @em.sleep(0.001); c+=2 })
+        @queue.add!(LWQTestProcWithMergeDrop.new(-> { c+=4 }) { @em.sleep(0.001); c+=8 })
+        @queue.add!(LWQTestProcWithMergeDrop.new(-> { c+=16 }) { @em.sleep(0.001); c+=32 }) # will get merged (by canceling self)
         @em.sleep(0.050)
       end
       assert_equal 1+2+8+16, c
@@ -99,15 +99,35 @@ describe ExceptionalSynchrony::LimitedWorkQueue do
     it "should allow objects to merge themselves into the queue (canceling/replacing earlier)" do
       c = 0
       ExceptionalSynchrony::EMP.run_and_stop do
-        @queue.add(LWQTestProc.new { @em.sleep(0.001); c+=1 })
-        @queue.add(LWQTestProc.new { @em.sleep(0.001); c+=2 })
-        @queue.add(LWQTestProcWithMergeReplace.new(-> { c+=4 }) { @em.sleep(0.001); c+=8 })
-        @queue.add(LWQTestProcWithMergeReplace.new(-> { c+=16 }) { @em.sleep(0.001); c+=32 }) # will get merged with above (replacing above)
+        @queue.add!(LWQTestProc.new { @em.sleep(0.001); c+=1 })
+        @queue.add!(LWQTestProc.new { @em.sleep(0.001); c+=2 })
+        @queue.add!(LWQTestProcWithMergeReplace.new(-> { c+=4 }) { @em.sleep(0.001); c+=8 })
+        @queue.add!(LWQTestProcWithMergeReplace.new(-> { c+=16 }) { @em.sleep(0.001); c+=32 }) # will get merged with above (replacing above)
         @em.sleep(0.050)
       end
       assert_equal 1+2+4+32, c
     end
 
+    it "should ensure that the queue continues to function even when an exception is raised" do
+      mock(ExceptionHandling).log_error(anything, /LimitedWorkQueue encountered an exception/).twice
+      ExceptionalSynchrony::EMP.run_and_stop do
+        c = 0
+        last_start = nil; end_0 = nil; end_1 = nil
+        @queue.add! { c += 1; @em.sleep(0.001); end_0 = c+=1; raise "Boom" }
+        @queue.add! { c += 1; @em.sleep(0.001); end_1 = c+=1; raise "Boom" }
+        @queue.add! { last_start = c+= 1; @em.sleep(0.001); c+=1 }
+
+        3.times do
+          @em.sleep(0.030)
+          break if c == 6
+        end
+
+        assert last_start && last_start > 3, "Unexpected value for last_start: #{last_start.inspect}"
+        assert [end_0, end_1].any? {|e| last_start > e }
+        assert_equal 6, c
+      end
+    end
+
     it "should run 2 blocking tasks in parallel and only start 3rd when one of the first 2 finishes" do
       stub_request(:get, "http://www.google.com/").
           to_return(:status => 200, :body => "1", :headers => {})
@@ -121,12 +141,12 @@ describe ExceptionalSynchrony::LimitedWorkQueue do
       ExceptionalSynchrony::EMP.run_and_stop do
         c = -1
         started2 = nil; ended0 = nil; ended1 = nil
-        @queue.add { c+=1; @em.sleep(0.001); ExceptionalSynchrony::EMP.connection.new("http://www.google.com").get; ended0 = c+=1 }
-        @queue.add { c+=1; @em.sleep(0.001); ExceptionalSynchrony::EMP.connection.new("http://www.cnn.com").get; ended1 = c+=1 }
-        @queue.add { started2 = c+=1; ExceptionalSynchrony::EMP.connection.new("http://news.ycombinator.com").get; c+=1 }
+        @queue.add! { c+=1; @em.sleep(0.001); ExceptionalSynchrony::EMP.connection.new("http://www.google.com").get; ended0 = c+=1 }
+        @queue.add! { c+=1; @em.sleep(0.001); ExceptionalSynchrony::EMP.connection.new("http://www.cnn.com").get; ended1 = c+=1 }
+        @queue.add! { started2 = c+=1; ExceptionalSynchrony::EMP.connection.new("http://news.ycombinator.com").get; c+=1 }
 
         3.times do
-          @em.sleep(0.005)
+          @em.sleep(0.030)
           break if c == 5
         end
 
@@ -135,5 +155,183 @@ describe ExceptionalSynchrony::LimitedWorkQueue do
         assert started2 > ended0 || started2 > ended1, [ended0, ended1, started2].inspect
       end
     end
+
+    describe '#paused?' do
+      it 'should return false when @paused is false' do
+        @queue.instance_variable_set(:@paused, false)
+        assert_equal false, @queue.paused?
+      end
+
+      it 'should return true when @paused is true' do
+        @queue.instance_variable_set(:@paused, false)
+        assert_equal false, @queue.paused?
+      end
+    end
+
+    describe '#pause!' do
+      it 'should set @paused to true if @paused is currently false' do
+        assert_equal false, @queue.instance_variable_get('@paused')
+        @queue.pause!
+        assert_equal true, @queue.instance_variable_get('@paused')
+      end
+
+      it 'should set @paused to true if @paused is currently true' do
+        @queue.instance_variable_set(:@paused, true)
+        assert_equal true, @queue.instance_variable_get('@paused')
+        @queue.pause!
+        assert_equal true, @queue.instance_variable_get('@paused')
+      end
+    end
+
+    describe '#unpause!' do
+      it 'should set @paused to false if @paused is currently false' do
+        assert_equal false, @queue.instance_variable_get('@paused')
+        @queue.unpause!
+        assert_equal false, @queue.instance_variable_get('@paused')
+      end
+
+      it 'should set @paused to false if @paused is currently true' do
+        @queue.instance_variable_set(:@paused, true)
+        assert_equal true, @queue.instance_variable_get('@paused')
+        @queue.unpause!
+        assert_equal false, @queue.instance_variable_get('@paused')
+      end
+    end
+
+    describe '#add!' do
+      it 'should run jobs added to the queue when paused? is false' do
+        assert_equal false, @queue.paused? # queue#paused is false be default
+        counter = 0
+        ExceptionalSynchrony::EMP.run_and_stop do
+          3.times { @queue.add! { counter+=1 } }
+        end
+
+        assert_equal 0, @queue.instance_variable_get("@job_procs").size
+        assert_equal 3, counter
+      end
+
+      it 'should not run jobs added to the queue when paused? is true' do
+        @queue.pause!
+        assert_equal true, @queue.paused?
+        counter = 0
+        ExceptionalSynchrony::EMP.run_and_stop do
+          3.times { @queue.add! { counter+=1 } }
+        end
+
+        mock(@queue).work!.never
+        assert_equal 3, @queue.instance_variable_get("@job_procs").size
+        assert_equal 0, counter
+      end
+
+      it 'should have a method alias to #add for callers using the previous #add method' do
+        assert_equal @queue.method(:add!), @queue.method(:add)
+      end
+    end
+
+    describe '#items' do
+      it 'should return job_procs array' do
+        assert_equal 0, @queue.items.size
+        job_procs = Array.new(3) { Proc.new { puts 'Hello World' } }
+        @queue.instance_variable_set(:@job_procs, job_procs)
+        assert_equal 3, @queue.items.size
+      end
+    end
+
+    describe '#work!' do
+      before do
+        @queue = ExceptionalSynchrony::LimitedWorkQueue.new(@em, 2)
+      end
+
+      it 'should run items in queue' do
+        counter = 0
+        job_procs = Array.new(3) { Proc.new { counter += 1} }
+        @queue.instance_variable_set(:@job_procs, job_procs)
+        mock.proxy(Fiber).new.with_any_args.times(3)
+        @queue.work!
+
+        assert_equal 0, @queue.instance_variable_get("@job_procs").size
+        assert_equal 3, counter
+      end
+
+      it 'should run items already in queue, even if queue is paused' do
+        @queue.pause!
+        counter = 4
+        job_procs = Array.new(3) { Proc.new { counter += 1} }
+        @queue.instance_variable_set(:@job_procs, job_procs)
+        assert_equal 3, @queue.instance_variable_get("@job_procs").size
+        mock.proxy(Fiber).new.with_any_args.times(3)
+
+        @queue.work!
+
+        assert_equal 7, counter
+        assert_equal 0, @queue.instance_variable_get("@job_procs").size
+      end
+
+      it 'should not run if queue_empty' do
+        stub(@queue).queue_empty? { true }
+        counter = 0
+        job_procs = Array.new(3) { Proc.new { counter += 1} }
+        @queue.instance_variable_set(:@job_procs, job_procs)
+        assert_equal 3, @queue.instance_variable_get("@job_procs").size
+        mock(Fiber).new.never
+
+        @queue.work!
+        assert_equal 0, counter
+      end
+
+      it 'should not run if workers are full' do
+        stub(@queue).workers_full? { true }
+        counter = 0
+        job_procs = Array.new(3) { Proc.new { counter += 1} }
+        @queue.instance_variable_set(:@job_procs, job_procs)
+
+        assert_equal 3, @queue.instance_variable_get("@job_procs").size
+        mock(Fiber).new.never
+
+        @queue.work!
+        assert_equal 0, counter
+      end
+    end
+
+    describe '#workers_full?' do
+      before do
+        @queue = ExceptionalSynchrony::LimitedWorkQueue.new(@em, 2) # limit the number of active workers to 2 max
+      end
+
+      it 'should return true if the number of current workers is greater than the queue\'s defined worker limit' do
+        @queue.instance_variable_set(:@worker_count, 20)
+        @queue.instance_variable_set(:@limit, 10)
+        assert_equal true, @queue.workers_full?
+      end
+
+      it 'should return true if the current number of workers is equal to the queue\'s defined worker limit' do
+        @queue.instance_variable_set(:@worker_count, 10)
+        @queue.instance_variable_set(:@limit, 10)
+        assert_equal true, @queue.workers_full?
+      end
+
+      it 'should return false if the current number of workers is less than the queue\'s defined worker limit' do
+        @queue.instance_variable_set(:@worker_count, 5)
+        @queue.instance_variable_set(:@limit, 10)
+        assert_equal false, @queue.workers_full?
+      end
+    end
+
+    describe '#queue_empty?' do
+      before do
+        @queue = ExceptionalSynchrony::LimitedWorkQueue.new(@em, 2)
+      end
+
+      it 'should return true if queue is empty' do
+        @queue.instance_variable_set(:@job_procs, [])
+        assert_equal true, @queue.queue_empty?
+      end
+
+      it 'should return false if queue is not empty' do
+        @queue.instance_variable_set(:@job_procs, [Proc.new { 'hello'}])
+        assert_equal false, @queue.queue_empty?
+      end
+    end
+
   end
 end

data/test/unit/parallel_sync_test.rb

@@ -56,15 +56,15 @@ describe ExceptionalSynchrony::ParallelSync do
     stub_request(:get, "http://news.ycombinator.com/").
         to_return(:status => 200, :body => "3", :headers => {})
 
-    assert_raises(NotImplementedError) do
+    expect(assert_raises(NotImplementedError) do
       ExceptionalSynchrony::EMP.run_and_stop do
-        responses = ExceptionalSynchrony::ParallelSync.parallel(@em) do |parallel|
+        ExceptionalSynchrony::ParallelSync.parallel(@em) do |parallel|
           parallel.add { ExceptionalSynchrony::EMP.connection.new("http://www.google.com").get; raise NotImplementedError, "Not implemented!" }
           parallel.add { ExceptionalSynchrony::EMP.connection.new("http://www.cnn.com").get }
           parallel.add { ExceptionalSynchrony::EMP.connection.new("http://news.ycombinator.com").get }
         end
       end
-    end.to_s.must_match(/Not implemented!/)
+    end.to_s).must_match(/Not implemented!/)
   end
 
   it "should pass several exceptions through and raise them on the other side" do
@@ -77,15 +77,15 @@ describe ExceptionalSynchrony::ParallelSync do
     stub_request(:get, "http://news.ycombinator.com/").
         to_return(:status => 200, :body => "3", :headers => {})
 
-    assert_raises(NotImplementedError) do
+    expect(assert_raises(NotImplementedError) do
       ExceptionalSynchrony::EMP.run_and_stop do
-        responses = ExceptionalSynchrony::ParallelSync.parallel(@em) do |parallel|
+        ExceptionalSynchrony::ParallelSync.parallel(@em) do |parallel|
           parallel.add { ExceptionalSynchrony::EMP.connection.new("http://www.google.com").get; raise NotImplementedError, "Not implemented!" }
           parallel.add { ExceptionalSynchrony::EMP.connection.new("http://www.cnn.com").get; raise LoadError, "A load error occurred" }
           parallel.add { ExceptionalSynchrony::EMP.connection.new("http://news.ycombinator.com").get; raise IndexError, "An index error occurred" }
         end
       end
-    end.message.must_match(/Not implemented!.*LoadError: A load error occurred.*IndexError: An index error occurred/m)
+    end.message).must_match(/Not implemented!.*LoadError: A load error occurred.*IndexError: An index error occurred/m)
   end
 
   class TestProc

metadata

@@ -1,154 +1,102 @@
 --- !ruby/object:Gem::Specification
 name: exceptional_synchrony
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.3.0
 platform: ruby
 authors:
-- Colin Kelley
-autorequire: 
+- Invoca
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2014-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: exception_handling
+  name: em-synchrony
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: eventmachine
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.3
-- !ruby/object:Gem::Dependency
-  name: em-synchrony
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.3
 - !ruby/object:Gem::Dependency
   name: em-http-request
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: hobo_support
+  name: eventmachine
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: thor
-  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: minitest
-  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: webmock
+  name: exception_handling
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.1
-  type: :development
+        version: '2.2'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.1
+        version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: rr
+  name: invoca-utils
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.2
-  type: :development
+        version: '0.3'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: '0.3'
 description: ''
-email: colin@invoca.com
+email: development@invoca.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .ruby-gemset
+- ".dependabot/config.yml"
+- ".gitignore"
+- ".jenkins/Jenkinsfile"
+- ".jenkins/ruby_build_pod.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - README.md
 - Rakefile
-- Thorfile
 - exceptional_synchrony.gemspec
 - lib/exceptional_synchrony.rb
 - lib/exceptional_synchrony/callback_exceptions.rb
@@ -164,25 +112,26 @@ files:
 homepage: https://github.com/Invoca/exceptional_synchrony
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  source_code_uri: https://github.com/Invoca/exceptional_synchrony
+  allowed_push_host: https://rubygems.org
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.3
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Extensions to EventMachine/Synchrony to work well with exceptions
 test_files: []