sidekiq 2.10.0 → 2.10.1

data/Changes.md

@@ -1,3 +1,13 @@
+2.10.1
+-----------
+
+- Remove need for the i18n gem. (brandonhilkert)
+- Improve redis connection info logging on startup for debugging
+purposes [#858]
+- Revert sinatra/slim as runtime dependencies
+- Add `find_job` method to sidekiq/api
+
+
 2.10.0
 -----------
 

data/README.md

@@ -78,7 +78,7 @@ The mailing list is the preferred place to ask questions on usage. If you are en
 License
 -----------------
 
-Please see LICENSE for licensing details.
+Please see [LICENSE](https://github.com/mperham/sidekiq/blob/master/LICENSE) for licensing details.
 
 
 Author

data/lib/sidekiq/api.rb

@@ -137,6 +137,10 @@ module Sidekiq
       end
     end
 
+    def find_job(jid)
+      self.detect { |j| j.jid == jid }
+    end
+
     def clear
       Sidekiq.redis do |conn|
         conn.multi do
@@ -223,7 +227,7 @@ module Sidekiq
         results.map do |message|
           msg = Sidekiq.load_json(message)
           msg['retry_count'] = msg['retry_count'] - 1
-          conn.rpush("queue:#{msg['queue']}", Sidekiq.dump_json(msg))
+          conn.lpush("queue:#{msg['queue']}", Sidekiq.dump_json(msg))
         end
       end
     end
@@ -279,6 +283,10 @@ module Sidekiq
       end
     end
 
+    def find_job(jid)
+      self.detect { |j| j.jid == jid }
+    end
+
     def delete(score, jid = nil)
       if jid
         elements = Sidekiq.redis do |conn|

data/lib/sidekiq/cli.rb

@@ -48,7 +48,7 @@ module Sidekiq
         end
       end
 
-      logger.info "Booting Sidekiq #{Sidekiq::VERSION} with Redis at #{redis {|x| x.client.id}}"
+      redis {} # noop to connect redis and print info
       logger.info "Running in #{RUBY_DESCRIPTION}"
       logger.info Sidekiq::LICENSE
 

data/lib/sidekiq/redis_connection.rb

@@ -3,33 +3,49 @@ require 'redis'
 
 module Sidekiq
   class RedisConnection
-    def self.create(options={})
-      url = options[:url] || determine_redis_provider || 'redis://localhost:6379/0'
-      # need a connection for Fetcher and Retry
-      size = options[:size] || (Sidekiq.server? ? (Sidekiq.options[:concurrency] + 2) : 5)
+    class << self
 
-      ConnectionPool.new(:timeout => 1, :size => size) do
-        build_client(url, options[:namespace], options[:driver] || 'ruby')
+      def create(options={})
+        url = options[:url] || determine_redis_provider || 'redis://localhost:6379/0'
+        # need a connection for Fetcher and Retry
+        size = options[:size] || (Sidekiq.server? ? (Sidekiq.options[:concurrency] + 2) : 5)
+
+        log_info(url, options)
+
+        ConnectionPool.new(:timeout => 1, :size => size) do
+          build_client(url, options[:namespace], options[:driver] || 'ruby')
+        end
       end
-    end
 
-    def self.build_client(url, namespace, driver)
-      client = Redis.connect(:url => url, :driver => driver)
-      if namespace
-        require 'redis/namespace'
-        Redis::Namespace.new(namespace, :redis => client)
-      else
-        client
+      private
+
+      def build_client(url, namespace, driver)
+        client = Redis.connect(:url => url, :driver => driver)
+        if namespace
+          require 'redis/namespace'
+          Redis::Namespace.new(namespace, :redis => client)
+        else
+          client
+        end
       end
-    end
-    private_class_method :build_client
-
-    # Not public
-    def self.determine_redis_provider
-      # REDISTOGO_URL is only support for legacy reasons
-      return ENV['REDISTOGO_URL'] if ENV['REDISTOGO_URL']
-      provider = ENV['REDIS_PROVIDER'] || 'REDIS_URL'
-      ENV[provider]
+
+      def log_info(url, options)
+        opts = options.dup
+        opts.delete(:url)
+        if Sidekiq.server?
+          Sidekiq.logger.info("Booting #{Sidekiq::NAME} #{Sidekiq::VERSION} using #{url} with options #{opts}")
+        else
+          Sidekiq.logger.info("#{Sidekiq::NAME} client using #{url} with options #{opts}")
+        end
+      end
+
+      def determine_redis_provider
+        # REDISTOGO_URL is only support for legacy reasons
+        return ENV['REDISTOGO_URL'] if ENV['REDISTOGO_URL']
+        provider = ENV['REDIS_PROVIDER'] || 'REDIS_URL'
+        ENV[provider]
+      end
+
     end
   end
 end

data/lib/sidekiq/scheduled.rb

@@ -40,7 +40,7 @@ module Sidekiq
                   if conn.zrem(sorted_set, message)
                     conn.multi do
                       conn.sadd('queues', msg['queue'])
-                      conn.rpush("queue:#{msg['queue']}", message)
+                      conn.lpush("queue:#{msg['queue']}", message)
                     end
                     logger.debug("enqueued #{sorted_set}: #{message}") if logger.debug?
                   end

data/lib/sidekiq/version.rb

@@ -1,3 +1,3 @@
 module Sidekiq
-  VERSION = "2.10.0"
+  VERSION = "2.10.1"
 end

data/lib/sidekiq/web.rb

@@ -1,27 +1,35 @@
 require 'sinatra/base'
 require 'slim'
 require 'sidekiq/paginator'
-require 'i18n'
 
 module Sidekiq
   class Web < Sinatra::Base
     include Sidekiq::Paginator
 
     dir = File.expand_path(File.dirname(__FILE__) + "/../../web")
-    I18n.load_path += Dir[File.join(dir, 'locales', '*.yml').to_s]
 
     set :public_folder, "#{dir}/assets"
     set :views,  "#{dir}/views"
     set :root, "#{dir}/public"
+    set :locales, "#{dir}/locales"
     set :slim, :pretty => true
 
     helpers do
+      def strings
+        @strings ||= begin
+          Dir["#{settings.locales}/*.yml"].inject({}) do |memo, file|
+            memo.merge(YAML.load(File.read(file)))
+          end
+        end
+      end
+
       def get_locale
         (request.env["HTTP_ACCEPT_LANGUAGE"] || 'en')[0,2]
       end
 
       def t(msg, options={})
-        I18n.t(msg, options.merge(:locale => get_locale))
+        string = strings[get_locale].fetch(msg) || strings['en'].fetch(msg)
+        string % options
       end
 
       def reset_worker_list
@@ -94,6 +102,16 @@ module Sidekiq
       end
 
       def tabs
+        @tabs ||= {
+          "Dashboard" => '',
+          "Workers"   => 'workers',
+          "Queues"    => 'queues',
+          "Retries"   => 'retries',
+          "Scheduled" => 'scheduled',
+        }
+      end
+
+      def custom_tabs
         self.class.tabs
       end
 
@@ -240,13 +258,7 @@ module Sidekiq
     end
 
     def self.tabs
-      @tabs ||= {
-        "Dashboard" => '',
-        "Workers"   => 'workers',
-        "Queues"    => 'queues',
-        "Retries"   => 'retries',
-        "Scheduled" => 'scheduled',
-      }
+      @custom_tabs ||= {}
     end
 
   end

data/sidekiq.gemspec

@@ -19,9 +19,8 @@ Gem::Specification.new do |gem|
   gem.add_dependency                  'connection_pool', '~> 1.0'
   gem.add_dependency                  'celluloid', '~> 0.12.0'
   gem.add_dependency                  'multi_json', '~> 1'
-  gem.add_dependency                  'sinatra'
-  gem.add_dependency                  'slim'
-  gem.add_dependency                  'i18n'
+  gem.add_development_dependency      'sinatra'
+  gem.add_development_dependency      'slim'
   gem.add_development_dependency      'minitest', '~> 4'
   gem.add_development_dependency      'rake'
   gem.add_development_dependency      'actionmailer', '~> 3'

data/test/helper.rb

@@ -6,7 +6,9 @@ end
 ENV['RACK_ENV'] = ENV['RAILS_ENV'] = 'test'
 if ENV.has_key?("SIMPLECOV")
   require 'simplecov'
-  SimpleCov.start
+  SimpleCov.start do
+    add_filter "/test/"
+  end
 end
 
 begin

data/test/test_api.rb

@@ -179,6 +179,22 @@ class TestApi < MiniTest::Unit::TestCase
       assert_equal 0, q.size
     end
 
+    it 'can find job by id in sorted sets' do
+      q = Sidekiq::Queue.new
+      job_id = ApiWorker.perform_in(100, 1, 'jason')
+      job = Sidekiq::ScheduledSet.new.find_job(job_id)
+      refute_nil job
+      assert_equal job_id, job.jid
+    end
+
+    it 'can find job by id in queues' do
+      q = Sidekiq::Queue.new
+      job_id = ApiWorker.perform_async(1, 'jason')
+      job = q.find_job(job_id)
+      refute_nil job
+      assert_equal job_id, job.jid
+    end
+
     it 'can clear a queue' do
       q = Sidekiq::Queue.new
       2.times { ApiWorker.perform_async(1, 'mike') }
@@ -278,7 +294,7 @@ class TestApi < MiniTest::Unit::TestCase
 
       s = '12345'
       data = Sidekiq.dump_json({ 'payload' => {}, 'queue' => 'default', 'run_at' => Time.now.to_i })
-      Sidekiq.redis do |c| 
+      Sidekiq.redis do |c|
         c.multi do
           c.sadd('workers', s)
           c.set("worker:#{s}", data)

data/test/test_fetch.rb

@@ -2,42 +2,43 @@ require 'helper'
 require 'sidekiq/fetch'
 
 class TestFetcher < MiniTest::Unit::TestCase
-
-  def setup
-    Sidekiq.redis = { :namespace => 'fuzzy' }
-    Sidekiq.redis do |conn|
-      conn.flushdb
-      conn.rpush('queue:basic', 'msg')
+  describe 'fetcher' do
+    before do
+      Sidekiq.redis = { :namespace => 'fuzzy' }
+      Sidekiq.redis do |conn|
+        conn.flushdb
+        conn.rpush('queue:basic', 'msg')
+      end
     end
-  end
 
-  def test_basic_fetch_retrieve
-    fetch = Sidekiq::BasicFetch.new(:queues => ['basic', 'bar'])
-    uow = fetch.retrieve_work
-    refute_nil uow
-    assert_equal 'basic', uow.queue_name
-    assert_equal 'msg', uow.message
-    q = Sidekiq::Queue.new('basic')
-    assert_equal 0, q.size
-    uow.requeue
-    assert_equal 1, q.size
-    assert_nil uow.acknowledge
-  end
+    it 'retrieves' do
+      fetch = Sidekiq::BasicFetch.new(:queues => ['basic', 'bar'])
+      uow = fetch.retrieve_work
+      refute_nil uow
+      assert_equal 'basic', uow.queue_name
+      assert_equal 'msg', uow.message
+      q = Sidekiq::Queue.new('basic')
+      assert_equal 0, q.size
+      uow.requeue
+      assert_equal 1, q.size
+      assert_nil uow.acknowledge
+    end
 
-  def test_basic_fetch_strict_retrieve
-    fetch = Sidekiq::BasicFetch.new(:queues => ['basic', 'bar', 'bar'], :strict => true)
-    cmd = fetch.queues_cmd
-    assert_equal cmd, ['queue:basic', 'queue:bar', 1]
-  end
+    it 'retrieves with strict setting' do
+      fetch = Sidekiq::BasicFetch.new(:queues => ['basic', 'bar', 'bar'], :strict => true)
+      cmd = fetch.queues_cmd
+      assert_equal cmd, ['queue:basic', 'queue:bar', 1]
+    end
 
-  def test_basic_fetch_bulk_requeue
-    q1 = Sidekiq::Queue.new('foo')
-    q2 = Sidekiq::Queue.new('bar')
-    assert_equal 0, q1.size
-    assert_equal 0, q2.size
-    uow = Sidekiq::BasicFetch::UnitOfWork
-    Sidekiq::BasicFetch.bulk_requeue([uow.new('fuzzy:queue:foo', 'bob'), uow.new('fuzzy:queue:foo', 'bar'), uow.new('fuzzy:queue:bar', 'widget')])
-    assert_equal 2, q1.size
-    assert_equal 1, q2.size
+    it 'bulk requeues' do
+      q1 = Sidekiq::Queue.new('foo')
+      q2 = Sidekiq::Queue.new('bar')
+      assert_equal 0, q1.size
+      assert_equal 0, q2.size
+      uow = Sidekiq::BasicFetch::UnitOfWork
+      Sidekiq::BasicFetch.bulk_requeue([uow.new('fuzzy:queue:foo', 'bob'), uow.new('fuzzy:queue:foo', 'bar'), uow.new('fuzzy:queue:bar', 'widget')])
+      assert_equal 2, q1.size
+      assert_equal 1, q2.size
+    end
   end
 end

data/test/test_redis_connection.rb

@@ -33,7 +33,7 @@ class TestRedisConnection < MiniTest::Unit::TestCase
         ENV[v] = nil
       end
       ENV[var] = uri
-      assert_equal uri, Sidekiq::RedisConnection.determine_redis_provider
+      assert_equal uri, Sidekiq::RedisConnection.send(:determine_redis_provider)
       ENV[var] = nil
     end
 

data/web/locales/en.yml

@@ -59,3 +59,4 @@ en:
   ThreeMonths: 3 months
   SixMonths: 6 months
   Batches: Batches
+  Failures: Failures

data/web/views/_nav.slim

@@ -10,3 +10,7 @@
         - else
           li class="#{(current_path =~ Regexp.new(url)) ? 'active':''}"
             a href='#{{root_path}}#{{url}}' = t(title)
+
+      - custom_tabs.each do |title, url|
+          li class="#{(current_path =~ Regexp.new(url)) ? 'active':''}"
+            a href='#{{root_path}}#{{url}}' = title

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq
 version: !ruby/object:Gem::Version
-  version: 2.10.0
+  version: 2.10.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-12 00:00:00.000000000 Z
+date: 2013-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -99,7 +99,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -115,23 +115,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: i18n
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false