sneakers 2.7.0 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '09f8536528b4fa33c1d597f1ca8f513d5ca8f37b'
-  data.tar.gz: c24a191dc06d4457c9f5ac7bfd8f089ca7ed175f
+  metadata.gz: b012bf95d1ffd483c544a1e58a11775dd1932726
+  data.tar.gz: 5df9669b11a6870968f08483ae1d4bef08becbeb
 SHA512:
-  metadata.gz: 8e24898e348b40e79640d216fa9c56b63bf8c94340f23b4e54a4a163fdcbee8c7628a3db7f3128d3ed0220e9e7f83b36239917e610a9ca5b9c481108847cc61c
-  data.tar.gz: 369b932fef00b62847c74e070cd6248203505bf87ff3d932de8eb9ef80bcd65dd7732d59f7b47def85b4746c4b9cce0e933c0bb0b6845fe2f40f8f6a33b8e07b
+  metadata.gz: 9875ccd366feeb446faaf1c7d9b2aceb8fd3712aaf67e989329eba05ee4c4dc45e0cc5df718a399eeb7302c924b2d131491db75ce9bb824162ae94a734872889
+  data.tar.gz: 7e6e444e6801cc7ddf4bbbfcd197efe6633cda6f004bce71759414aef978669ae1b29136c9135621fffe4b40986546fe237c9b9dd4d6298862416ff5042f97e1

data/.gitignore

@@ -8,3 +8,4 @@ tmp/
 .ruby-version
 .ruby-gemset
 .bundle/*
+*.gem

data/.travis.yml

@@ -4,14 +4,15 @@ services:
 sudo: false
 cache: bundler
 language: ruby
+before_install:
+  - gem install bundler
 rvm:
   - ruby-head
-  - "2.4.1"
-  - "2.3.4"
-  - "2.2.7"
+  - "2.5.1"
+  - "2.4.2"
+  - "2.3.5"
+  - "2.2.8"
 matrix:
   include:
-    - rvm: 2.2.5
+    - rvm: 2.4.1
       env: INTEGRATION_LOG=1 INTEGRATION=1
-
-

data/ChangeLog.md

@@ -1,5 +1,66 @@
 # Sneakers Change Log
 
+## Changes Between 2.10.0 and 2.11.0
+
+This releases includes bug fixes, support for more queue-binding options, better
+management of the Bunny dependency, and improved documentation. Following is a
+list of the notable changes:
+
+### Rescue from ScriptError
+
+Fixes a bug that would cause Sneakers workers to freeze if an exception
+descending from `ScriptError`, such as `NotImplementedError`, is raised
+
+Contributed by @sharshenov
+
+GitHub Pull Request: [373](https://github.com/jondot/sneakers/pull/373)
+
+### Loosen Bunny dependency to minor version
+
+The dependency on Bunny is now pinned to the minor version instead of patch,
+allowing users to benefit from non-breaking updates to Bunny without having to
+wait for a Sneakers release.
+
+Contributed by @olivierlacan
+
+GitHub Pull Request: [#372](https://github.com/jondot/sneakers/pull/372)
+
+### Support `:bind_arguments` on bind
+
+It is now possible to set arguments on a queue when connecting to a headers
+exchange
+
+Contributed by @nerikj
+
+GitHub Pull Request: [#358](https://github.com/jondot/sneakers/pull/358)
+
+### Other contributions
+
+This release also contains contributions from @ivan-kolmychek (bumping up Bunny
+dependency), @michaelklishin (improving code style), and @darren987469 (adding
+examples to the README)
+
+## Changes Between 2.8.0 and 2.10.0
+
+This release contains **minor breaking API changes**.
+
+### Worker Timeouts are No Longer Enforced
+
+This is a **breaking change** for `Sneakers::Worker` implementations.
+
+Timeouts can be disruptive and dangerous depending on what the workers do but not having them can also
+lead to operational headaches.
+
+The outcome of [a lengthy discussion](https://github.com/jondot/sneakers/issues/343) on possible
+alternatives to the timeout mechanisms is that only applications
+can know where it is safe to enforce a timeout (and how).
+
+`Sneakers::Worker` implementations are now expected to enforce timeouts
+in a way that makes sense (and is safe) to them.
+
+GitHub issues: [#343](https://github.com/jondot/sneakers/issues/343).
+
+
 ## Changes Between 2.6.0 and 2.7.0
 
 This release requires Ruby 2.2 and has **breaking API changes**

data/Dockerfile

@@ -1,13 +1,28 @@
 FROM ruby:2.3-alpine
 
 RUN apk add --no-cache git
+
 RUN apk --update add --virtual build_deps \
-build-base ruby-dev libc-dev linux-headers \
-openssl-dev
+                               build-base \
+                               ruby-dev \
+                               libc-dev \
+                               linux-headers \
+                               openssl-dev
+
+RUN mkdir /myapp
 
-ADD . /sneakers
 WORKDIR /sneakers
 
+COPY lib/sneakers/version.rb /sneakers/lib/sneakers/version.rb
+
+COPY sneakers.gemspec /sneakers/sneakers.gemspec
+
+COPY Gemfile /sneakers/Gemfile
+
+COPY Gemfile.lock /sneakers/Gemfile.lock
+
 RUN bundle --jobs=4 --retry=3
 
+COPY . /sneakers
+
 CMD rake test

data/Dockerfile.slim

@@ -1,13 +1,20 @@
 FROM ruby:2.3-alpine
 
 RUN apk add --no-cache git
+
 ADD . /sneakers
+
 WORKDIR /sneakers
 
 RUN apk --update add --virtual build_deps \
-build-base ruby-dev libc-dev linux-headers \
-openssl-dev && \
-bundle --jobs=4 --retry=3 && \
-apk del  build_deps
+                               build-base \
+                               ruby-dev \
+                               libc-dev \
+                               linux-headers \
+                               openssl-dev && \
+
+    bundle --jobs=4 --retry=3 && \
+
+    apk del build_deps
 
 CMD rake test

data/README.md

@@ -4,47 +4,47 @@
 
 ```
       __
-  ,--'  >  
-  `=====   
+  ,--'  >
+  `=====
 
 ```
 
-
 A high-performance RabbitMQ background processing framework for
 Ruby.
 
-
 Sneakers is being used in production for both I/O and CPU intensive workloads, and have achieved the goals of high-performance and 0-maintenance, as designed.
 
-
-Visit the [wiki](https://github.com/jondot/sneakers/wiki) for
-documentation and [GitHub releases](https://github.com/jondot/sneakers/releases) for release
-notes.
-
-[![Build Status](https://travis-ci.org/jondot/sneakers.svg?branch=master)](https://travis-ci.org/jondot/sneakers)
-
-
 ## Installation
 
 Add this line to your application's Gemfile:
 
-``` ruby
+```ruby
 gem 'sneakers'
 ```
 
 And then execute:
 
-``` shell-session
+```shell-session
 $ bundle
 ```
 
 Or install it yourself as:
 
-``` shell-session
+```shell-session
 $ gem install sneakers
 ```
 
-## Quick start 
+## Documentation
+
+A quick start guide is available in the section below.
+
+Visit the [wiki](https://github.com/jondot/sneakers/wiki) for more detailed
+documentation and [GitHub releases](https://github.com/jondot/sneakers/releases) for release
+notes.
+
+A [change log](./ChangeLog.md) is also available.
+
+## Quick start
 
 Set up a Gemfile
 
@@ -60,7 +60,6 @@ then create a worker named as `Processor`.
 
 > touch boot.rb
 
-
 ```ruby
 require 'sneakers'
 require 'redis'
@@ -86,7 +85,6 @@ end
 
 Let's test it out quickly from the command line:
 
-
 ```shell-session
 $ sneakers work Processor --require boot.rb
 ```
@@ -103,6 +101,20 @@ If you go to your RabbitMQ admin now, you'll see a new queue named `logs` was cr
 }
 ```
 
+Publish a message with the [bunny](https://github.com/ruby-amqp/bunny) gem RabbitMQ client:
+
+```ruby
+require 'bunny'
+
+conn = Bunny.new
+conn.start
+
+ch = conn.create_channel
+ch.default_exchange.publish({ type: 'error', message: 'HALP!', error: 'CODE001' }.to_json, routing_key: 'logs')
+
+conn.close
+```
+
 And this is the output you should see at your terminal.
 
 ```
@@ -112,7 +124,6 @@ And this is the output you should see at your terminal.
 2013-10-11T19:26:40Z p-4719 t-ovqgyrx8g INFO: log log
 ```
 
-
 We'll count errors and error types with Redis.
 
 ``` shell-session
@@ -120,11 +131,8 @@ $ redis-cli monitor
 1381520329.888581 [0 127.0.0.1:49182] "incr" "processor:CODE001"
 ```
 
-
 We're basically done with the ceremonies and all is left is to do some real work.
 
-
-
 ### Looking at metrics
 
 Let's use the `logging_metrics` provider just for the sake of fun of seeing the metrics as they happen.
@@ -135,7 +143,7 @@ require 'sneakers'
 require 'redis'
 require 'json'
 require 'sneakers/metrics/logging_metrics'
-Sneakers.configure :metrics => Sneakers::Metrics::LoggingMetrics.new
+Sneakers.configure(metrics: Sneakers::Metrics::LoggingMetrics.new)
 
 # ... rest of code
 ```
@@ -150,7 +158,6 @@ Now push a message again and you'll see:
 
 Which increments `started` and `handled.ack`, and times the work unit.
 
-
 From here, you can continue over to the
 [Wiki](https://github.com/jondot/sneakers/wiki)
 
@@ -161,7 +168,7 @@ If you use Docker, there's some benefits to be had and you can use both
 integration tests or a sample worker without setting up RabbitMQ or the
 environment needed locally on your development box.
 
-* To build a container run `docker build .`
+* To build a container run `docker build . -t sneakers_sneakers`
 * To run non-integration tests within a docker container, run `docker run --rm
   sneakers_sneakers:latest`
 * To run full integration tests within a docker topology including RabbitMQ,
@@ -176,23 +183,20 @@ environment needed locally on your development box.
   It generates a more compact image, while the "regular" `Dockerfile` generates
   a fatter image - yet faster to iterate when developing
 
-
 # Compatibility
 
-* Sneakers 1.1.x and up (using the new generation Bunny 2.x) - Ruby 2.x.x
-* Sneakers 1.x.x and down - Ruby 1.9.x, 2.x.x
+* Sneakers 2.7.x and later (using Bunny 2.9) - Ruby 2.2.x
+* Sneakers 1.1.x and later (using Bunny 2.x) - Ruby 2.x
+* Sneakers 1.x.x and earlier - Ruby 1.9.x, 2.x
 
 # Contributing
 
 Fork, implement, add tests, pull request, get my everlasting thanks and a respectable place here :).
 
-
 ### Thanks:
 
 To all Sneakers [Contributors](https://github.com/jondot/sneakers/graphs/contributors) - you make this happen, thanks!
 
-
-
 # Copyright
 
-Copyright (c) 2015 [Dotan Nahum](http://gplus.to/dotan) [@jondot](http://twitter.com/jondot). See [LICENSE](LICENSE.txt) for further details.
+Copyright (c) 2015-2018 [Dotan Nahum](http://gplus.to/dotan) [@jondot](http://twitter.com/jondot). See [LICENSE](LICENSE.txt) for further details.

data/{docker-compose.yaml → docker-compose.yml}

@@ -1,17 +1,20 @@
-version: '2'
+version: '3'
+
 services:
   sneakers:
     build: .
     depends_on:
       - rabbitmq
       - redis
+
   rabbitmq:
-    image: rabbitmq:management
+    image: rabbitmq:management-alpine
     ports:
       - "5672:5672"
       - "15672:15672"
+
   redis:
-    image: redis
+    image: redis:alpine
     ports:
       - "6379:6379"
 

data/lib/sneakers/configuration.rb

@@ -37,7 +37,6 @@ module Sneakers
       :amqp_heartbeat     => 30,
 
       # workers
-      :timeout_job_after  => 5,
       :prefetch           => 10,
       :threads            => 10,
       :share_threads      => false,

data/lib/sneakers/errors.rb

@@ -1,5 +1,2 @@
-require 'timeout'
-
 module Sneakers
-  class WorkerTimeout < Timeout::Error; end
 end

data/lib/sneakers/handlers/maxretry.rb

@@ -5,7 +5,7 @@ module Sneakers
   module Handlers
     #
     # Maxretry uses dead letter policies on Rabbitmq to requeue and retry
-    # messages after failure (rejections, errors and timeouts). When the maximum
+    # messages after failure (rejections and errors). When the maximum
     # number of retries is reached it will put the message on an error queue.
     # This handler will only retry at the queue level. To accomplish that, the
     # setup is a bit complex.
@@ -101,10 +101,6 @@ module Sneakers
         handle_retry(hdr, props, msg, err)
       end
 
-      def timeout(hdr, props, msg)
-        handle_retry(hdr, props, msg, :timeout)
-      end
-
       def noop(hdr, props, msg)
 
       end

data/lib/sneakers/handlers/oneshot.rb

@@ -18,10 +18,6 @@ module Sneakers
         reject(hdr, props, msg)
       end
 
-      def timeout(hdr, props, msg)
-        reject(hdr, props, msg)
-      end
-
       def noop(hdr, props, msg)
 
       end

data/lib/sneakers/queue.rb

@@ -38,7 +38,11 @@ class Sneakers::Queue
 
     if exchange_name.length > 0
       routing_keys.each do |key|
-        queue.bind(@exchange, :routing_key => key)
+        if @opts[:bind_arguments]
+          queue.bind(@exchange, routing_key: key, arguments: @opts[:bind_arguments])
+        else
+          queue.bind(@exchange, routing_key: key)
+        end
       end
     end
 
@@ -49,7 +53,7 @@ class Sneakers::Queue
     handler_klass = worker.opts[:handler] || Sneakers::CONFIG.fetch(:handler)
     handler = handler_klass.new(@channel, queue, worker.opts)
 
-    @consumer = queue.subscribe(:block => false, :manual_ack => @opts[:ack]) do | delivery_info, metadata, msg |
+    @consumer = queue.subscribe(block: false, manual_ack: @opts[:ack]) do | delivery_info, metadata, msg |
       worker.do_work(delivery_info, metadata, msg, handler)
     end
     nil
@@ -72,10 +76,10 @@ class Sneakers::Queue
   end
 
   def create_bunny_connection
-    Bunny.new(@opts[:amqp], :vhost => @opts[:vhost],
-                            :heartbeat => @opts[:heartbeat],
-                            :properties => @opts.fetch(:properties, {}),
-                            :logger => Sneakers::logger)
+    Bunny.new(@opts[:amqp], vhost: @opts[:vhost],
+                            heartbeat: @opts[:heartbeat],
+                            properties: @opts.fetch(:properties, {}),
+                            logger: Sneakers::logger)
   end
   private :create_bunny_connection
 end

data/lib/sneakers/version.rb

@@ -1,3 +1,3 @@
 module Sneakers
-  VERSION = "2.7.0"
+  VERSION = "2.11.0"
 end

data/lib/sneakers/worker.rb

@@ -1,6 +1,5 @@
 require 'sneakers/queue'
 require 'sneakers/support/utils'
-require 'timeout'
 
 module Sneakers
   module Worker
@@ -18,7 +17,6 @@ module Sneakers
       opts = Sneakers::CONFIG.merge(opts)
 
       @should_ack =  opts[:ack]
-      @timeout_after = opts[:timeout_job_after]
       @pool = pool || Concurrent::FixedThreadPool.new(opts[:threads] || Sneakers::Configuration::DEFAULTS[:threads])
       @call_with_params = respond_to?(:work_with_params)
       @content_type = opts[:content_type]
@@ -57,21 +55,15 @@ module Sneakers
 
       begin
         metrics.increment("work.#{self.class.name}.started")
-        Timeout.timeout(@timeout_after, WorkerTimeout) do
-          metrics.timing("work.#{self.class.name}.time") do
-            deserialized_msg = ContentType.deserialize(msg, @content_type || metadata && metadata[:content_type])
-            if @call_with_params
-              res = work_with_params(deserialized_msg, delivery_info, metadata)
-            else
-              res = work(deserialized_msg)
-            end
+        metrics.timing("work.#{self.class.name}.time") do
+          deserialized_msg = ContentType.deserialize(msg, @content_type || metadata && metadata[:content_type])
+          if @call_with_params
+            res = work_with_params(deserialized_msg, delivery_info, metadata)
+          else
+            res = work(deserialized_msg)
           end
         end
-      rescue WorkerTimeout => ex
-        res = :timeout
-        worker_error(ex, log_msg: log_msg(msg), class: self.class.name,
-                     message: msg, delivery_info: delivery_info, metadata: metadata)
-      rescue => ex
+      rescue StandardError, ScriptError => ex
         res = :error
         error = ex
         worker_error(ex, log_msg: log_msg(msg), class: self.class.name,
@@ -83,8 +75,6 @@ module Sneakers
         if res == :ack
           # note to future-self. never acknowledge multiple (multiple=true) messages under threads.
           handler.acknowledge(delivery_info, metadata, msg)
-        elsif res == :timeout
-          handler.timeout(delivery_info, metadata, msg)
         elsif res == :error
           handler.error(delivery_info, metadata, msg, error)
         elsif res == :reject

data/sneakers.gemspec

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'sneakers/version'
@@ -18,22 +17,24 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(/^bin/).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(/^(test|spec|features)\//)
   gem.require_paths = ['lib']
+
   gem.add_dependency 'serverengine', '~> 2.0.5'
-  gem.add_dependency 'bunny', '~> 2.9.2'
+  gem.add_dependency 'bunny', '~> 2.12'
   gem.add_dependency 'concurrent-ruby', '~> 1.0'
   gem.add_dependency 'thor'
+  gem.add_dependency 'rake'
 
   # for integration environment (see .travis.yml and integration_spec)
   gem.add_development_dependency 'rabbitmq_http_api_client'
   gem.add_development_dependency 'redis'
 
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'minitest'
   gem.add_development_dependency 'rr'
   gem.add_development_dependency 'unparser', '0.2.2' # keep below 0.2.5 for ruby 2.0 compat.
-  gem.add_development_dependency 'guard-minitest'
   gem.add_development_dependency 'metric_fu'
   gem.add_development_dependency 'simplecov'
   gem.add_development_dependency 'simplecov-rcov-text'
-  gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'minitest'
   gem.add_development_dependency 'guard'
+  gem.add_development_dependency 'guard-minitest'
 end

data/spec/sneakers/queue_spec.rb

@@ -74,6 +74,17 @@ describe Sneakers::Queue do
         q.subscribe(@mkworker)
       end
 
+      it "supports setting arguments when binding" do
+        mock(@mkchan).queue("downloads", :durable => true) { @mkqueue }
+        q = Sneakers::Queue.new("downloads",
+                                queue_vars.merge(:bind_arguments => { "os" => "linux", "cores" => 8 }))
+
+        mock(@mkqueue).bind(@mkex, :routing_key => "downloads", :arguments => { "os" => "linux", "cores" => 8 })
+        mock(@mkqueue).subscribe(:block => false, :manual_ack => true)
+
+        q.subscribe(@mkworker)
+      end
+
       it "will use whatever handler the worker specifies" do
         mock(@mkchan).queue("downloads", :durable => true) { @mkqueue }
         @handler = Object.new

data/spec/sneakers/runner_spec.rb

@@ -4,7 +4,7 @@ require 'sneakers'
 require 'sneakers/runner'
 
 describe Sneakers::Runner do
-  let(:logger) { Logger.new('logtest.log') }
+  let(:logger) { Logger.new('log/logtest.log') }
 
   describe "with configuration that specifies a logger object" do
     before do
@@ -27,7 +27,7 @@ describe Sneakers::Runner do
 end
 
 describe Sneakers::RunnerConfig do
-  let(:logger) { Logger.new("logtest.log") }
+  let(:logger) { Logger.new("log/logtest.log") }
   let(:runner_config) { Sneakers::Runner.new([]).instance_variable_get("@runnerconfig") }
 
   describe "with a connection" do

data/spec/sneakers/worker_handlers_spec.rb

@@ -1,6 +1,5 @@
 require 'spec_helper'
 require 'sneakers'
-require 'timeout'
 require 'sneakers/handlers/oneshot'
 require 'sneakers/handlers/maxretry'
 require 'json'
@@ -77,13 +76,7 @@ describe 'Handlers' do
         worker.do_work(@header, nil, :requeue, @handler)
       end
 
-      it 'should work and handle user-land timeouts' do
-        mock(channel).reject(37, false)
-
-        worker.do_work(@header, nil, :timeout, @handler)
-      end
-
-      it 'should work and handle user-land error' do
+      it 'should work and handle user code error' do
         mock(channel).reject(37, false)
 
         worker.do_work(@header, nil, StandardError.new('boom!'), @handler)
@@ -198,7 +191,6 @@ describe 'Handlers' do
 
     # it 'allows overriding the retry exchange name'
     # it 'allows overriding the error exchange name'
-    # it 'allows overriding the retry timeout'
 
     describe '#do_work' do
       before do
@@ -289,36 +281,6 @@ describe 'Handlers' do
 
       end
 
-      describe 'timeouts' do
-        describe 'more retries ahead' do
-          it 'should reject the message' do
-            mock(channel).reject(37, false)
-
-            worker.do_work(@header, @props_with_x_death, :timeout, @handler)
-          end
-        end
-
-        describe 'no more retries left' do
-          let(:max_retries) { 1 }
-
-          it 'sends the rejection to the error queue' do
-            mock(@header).routing_key { '#' }
-            mock(channel).acknowledge(37, false)
-            @error_exchange.extend MockPublish
-
-            worker.do_work(@header, @props_with_x_death, :timeout, @handler)
-            @error_exchange.called.must_equal(true)
-            @error_exchange.opts.must_equal({ :routing_key => '#' })
-            data = JSON.parse(@error_exchange.data)
-            data['error'].must_equal('timeout')
-            data['num_attempts'].must_equal(2)
-            data['payload'].must_equal(Base64.encode64(:timeout.to_s))
-            data['properties'].must_equal(Base64.encode64(@props_with_x_death.to_json))
-            Time.parse(data['failed_at']).wont_be_nil
-          end
-        end
-      end
-
       describe 'exceptions' do
         describe 'more retries ahead' do
           it 'should reject the message' do
@@ -360,33 +322,6 @@ describe 'Handlers' do
       it 'should work and handle noops' do
         worker.do_work(@header, @props, :wait, @handler)
       end
-
-      # Since we encode in json, we want to make sure if the actual payload is
-      # json, then it's something you can get back out.
-      describe 'JSON payloads' do
-        let(:max_retries) { 1 }
-
-        it 'properly encodes the json payload' do
-          mock(@header).routing_key { '#' }
-          mock(channel).acknowledge(37, false)
-          @error_exchange.extend MockPublish
-
-          payload = {
-            data: 'hello',
-            response: :timeout
-          }
-          worker.do_work(@header, @props_with_x_death, payload.to_json, @handler)
-          @error_exchange.called.must_equal(true)
-          @error_exchange.opts.must_equal({ :routing_key => '#' })
-          data = JSON.parse(@error_exchange.data)
-          data['error'].must_equal('timeout')
-          data['num_attempts'].must_equal(2)
-          data['payload'].must_equal(Base64.encode64(payload.to_json))
-          data['properties'].must_equal(Base64.encode64(@props_with_x_death.to_json))
-        end
-
-      end
-
     end
   end
 end

data/spec/sneakers/worker_spec.rb

@@ -1,6 +1,5 @@
 require 'spec_helper'
 require 'sneakers'
-require 'timeout'
 require 'serverengine'
 
 class DummyWorker
@@ -21,7 +20,6 @@ class DummyWorker
              :ack => false,
              :threads => 50,
              :prefetch => 40,
-             :timeout_job_after => 1,
              :exchange => 'dummy',
              :heartbeat => 5
 
@@ -37,16 +35,6 @@ class DefaultsWorker
   end
 end
 
-class TimeoutWorker
-  include Sneakers::Worker
-  from_queue 'defaults',
-    :timeout_job_after => 0.5,
-    :ack => true
-
-  def work(msg)
-  end
-end
-
 class AcksWorker
   include Sneakers::Worker
   from_queue 'defaults',
@@ -110,8 +98,7 @@ end
 class MetricsWorker
   include Sneakers::Worker
   from_queue 'defaults',
-             :ack => true,
-             :timeout_job_after => 0.5
+             :ack => true
 
   def work(msg)
     metrics.increment "foobar"
@@ -122,8 +109,7 @@ end
 class WithParamsWorker
   include Sneakers::Worker
   from_queue 'defaults',
-             :ack => true,
-             :timeout_job_after => 0.5
+             :ack => true
 
   def work_with_params(msg, delivery_info, metadata)
     msg
@@ -144,21 +130,6 @@ end
 
 TestPool ||= Concurrent::ImmediateExecutor
 
-def with_test_queuefactory(ctx, ack=true, msg=nil, nowork=false)
-  qf = Object.new
-  q = Object.new
-  s = Object.new
-  hdr = Object.new
-  mock(qf).build_queue(anything, anything, anything) { q }
-  mock(q).subscribe(anything){ s }
-
-  mock(s).each(anything) { |h,b| b.call(hdr, msg) unless nowork }
-  mock(hdr).ack{true} if !nowork && ack
-  mock(hdr).reject{true} if !nowork && !ack
-
-  mock(ctx).queue_factory { qf } # should return our own
-end
-
 describe Sneakers::Worker do
   before do
     @queue = Object.new
@@ -168,7 +139,7 @@ describe Sneakers::Worker do
     stub(@queue).exchange { @exchange }
 
     Sneakers.clear!
-    Sneakers.configure(:daemonize => true, :log => 'sneakers.log')
+    Sneakers.configure(daemonize: true, log: 'sneakers.log')
     Sneakers::Worker.configure_metrics
   end
 
@@ -202,7 +173,6 @@ describe Sneakers::Worker do
           :workers => 4,
           :log => "sneakers.log",
           :pid_path => "sneakers.pid",
-          :timeout_job_after => 5,
           :prefetch => 10,
           :threads => 10,
           :share_threads => false,
@@ -241,7 +211,6 @@ describe Sneakers::Worker do
           :workers => 4,
           :log => "sneakers.log",
           :pid_path => "sneakers.pid",
-          :timeout_job_after => 1,
           :prefetch => 40,
           :threads => 50,
           :share_threads => false,
@@ -280,7 +249,6 @@ describe Sneakers::Worker do
           :workers => 4,
           :log => "sneakers.log",
           :pid_path => "sneakers.pid",
-          :timeout_job_after => 5,
           :prefetch => 10,
           :threads => 10,
           :share_threads => false,
@@ -404,26 +372,23 @@ describe Sneakers::Worker do
       w.do_work(header, nil, "msg", handler)
     end
 
-    it "should log exceptions from workers" do
+    it "should catch script exceptions from a bad work" do
+      w = AcksWorker.new(@queue, TestPool.new)
+      mock(w).work("msg").once{ raise ScriptError }
       handler = Object.new
       header = Object.new
-      w = AcksWorker.new(@queue, TestPool.new)
-      mock(w).work("msg").once{ raise "foo" }
-      mock(w.logger).error(/error="foo" error_class=RuntimeError worker_class=AcksWorker backtrace=/)
       mock(handler).error(header, nil, "msg", anything)
+      mock(w.logger).error(/\[Exception error="ScriptError" error_class=ScriptError worker_class=AcksWorker backtrace=.*/)
       w.do_work(header, nil, "msg", handler)
     end
 
-    it "should timeout if a work takes too long" do
-      w = TimeoutWorker.new(@queue, TestPool.new)
-      stub(w).work("msg"){ sleep 10 }
-
+    it "should log exceptions from workers" do
       handler = Object.new
       header = Object.new
-
-      mock(handler).timeout(header, nil, "msg")
-      mock(w.logger).error(/error="execution expired" error_class=Sneakers::WorkerTimeout worker_class=TimeoutWorker backtrace=/)
-
+      w = AcksWorker.new(@queue, TestPool.new)
+      mock(w).work("msg").once{ raise "foo" }
+      mock(w.logger).error(/error="foo" error_class=RuntimeError worker_class=AcksWorker backtrace=/)
+      mock(handler).error(header, nil, "msg", anything)
       w.do_work(header, nil, "msg", handler)
     end
 
@@ -456,14 +421,7 @@ describe Sneakers::Worker do
         @worker.do_work(@delivery_info, nil, :requeue, handler)
       end
 
-      it "should work and handle user-land timeouts" do
-        handler = Object.new
-        mock(handler).timeout(@delivery_info, nil, :timeout)
-
-        @worker.do_work(@delivery_info, nil, :timeout, handler)
-      end
-
-      it "should work and handle user-land error" do
+      it "should work and handle user code errors" do
         handler = Object.new
         mock(handler).error(@delivery_info, nil, :error, anything)
 
@@ -557,7 +515,6 @@ describe Sneakers::Worker do
       # We don't care how these are called, we're focusing on metrics here.
       stub(@handler).acknowledge
       stub(@handler).reject
-      stub(@handler).timeout
       stub(@handler).error
       stub(@handler).noop
 
@@ -594,12 +551,6 @@ describe Sneakers::Worker do
       @w.do_work(@delivery_info, nil, 'msg', @handler)
     end
 
-    it 'should be able to meter timeouts' do
-      mock(@w.metrics).increment("work.MetricsWorker.handled.timeout").once
-      mock(@w).work('msg'){ sleep 10 }
-      @w.do_work(@delivery_info, nil, 'msg', @handler)
-    end
-
     it 'defaults to noop when no response is specified' do
       mock(@w.metrics).increment("foobar").once
       mock(@w.metrics).increment("work.MetricsWorker.handled.noop").once

data/spec/sneakers/workergroup_spec.rb

@@ -40,7 +40,7 @@ class StubbedWorker
 end
 
 describe Sneakers::WorkerGroup do
-  let(:logger) { Logger.new('logtest.log') }
+  let(:logger) { Logger.new('log/logtest.log') }
   let(:connection) { Bunny.new(host: 'any-host.local') }
   let(:runner) { Sneakers::Runner.new([DefaultsWorker]) }
   let(:runner_config) { runner.instance_variable_get('@runnerconfig') }

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 require 'bundler/setup'
 require 'simplecov'
 require 'resolv'
+
 SimpleCov.start do
   add_filter "/spec/"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sneakers
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.11.0
 platform: ruby
 authors:
 - Dotan Nahum
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-22 00:00:00.000000000 Z
+date: 2019-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: serverengine
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.9.2
+        version: '2.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.9.2
+        version: '2.12'
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -67,13 +67,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rabbitmq_http_api_client
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: redis
+  name: rabbitmq_http_api_client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rr
+  name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,21 +109,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: unparser
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-minitest
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: metric_fu
+  name: rr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,7 +151,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: unparser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+- !ruby/object:Gem::Dependency
+  name: metric_fu
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -165,7 +179,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov-rcov-text
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -179,7 +193,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: simplecov-rcov-text
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -193,7 +207,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -207,7 +221,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard
+  name: guard-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -239,7 +253,7 @@ files:
 - README.md
 - Rakefile
 - bin/sneakers
-- docker-compose.yaml
+- docker-compose.yml
 - examples/benchmark_worker.rb
 - examples/max_retry_handler.rb
 - examples/metrics_worker.rb
@@ -272,6 +286,7 @@ files:
 - lib/sneakers/version.rb
 - lib/sneakers/worker.rb
 - lib/sneakers/workergroup.rb
+- log/.gitkeep
 - scripts/local_integration
 - scripts/local_worker
 - sneakers.gemspec
@@ -312,7 +327,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Fast background processing framework for Ruby and RabbitMQ